2013-03-01 Mario Pulido <mario.pulido@artica.es>

* images/help/service1.png: New file for help.

	* godmode/tag/tag.php,
	godmode/agentes/agent_manager.php
	godmode/agentes/module_manager_editor_common.php: New hint help.

	* include/help/en/help_tags_config.php,
        include/help/en/help_agent_server.php,
        include/help/en/help_module_definition.php,
        include/help/en/help_view_services.php,
        include/help/es/help_module_definition.php,
        include/help/es/help_tags_config.php,
        include/help/es/help_agent_server.php: New and improved help files.




git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@7766 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
mariopulido 2013-03-01 11:13:58 +00:00
parent 73e7b20a88
commit 985654001e
12 changed files with 141 additions and 19 deletions

View File

@ -1,3 +1,20 @@
2013-03-01 Mario Pulido <mario.pulido@artica.es>
* images/help/service1.png: New file for help.
* godmode/tag/tag.php,
godmode/agentes/agent_manager.php
godmode/agentes/module_manager_editor_common.php: New hint help.
* include/help/en/help_tags_config.php,
include/help/en/help_agent_server.php,
include/help/en/help_module_definition.php,
include/help/en/help_view_services.php,
include/help/es/help_module_definition.php,
include/help/es/help_tags_config.php,
include/help/es/help_agent_server.php: New and improved help files.
2013-03-01 Miguel de Dios <miguel.dedios@artica.es> 2013-03-01 Miguel de Dios <miguel.dedios@artica.es>
* extras/pandoradb_migrate_4.0.x_to_5.0.mysql.sql: fixed bad * extras/pandoradb_migrate_4.0.x_to_5.0.mysql.sql: fixed bad

View File

@ -221,7 +221,7 @@ if ($new_agent) {
$server_name = reset(array_keys(servers_get_names())); $server_name = reset(array_keys(servers_get_names()));
} }
$table->data[6][1] = html_print_select (servers_get_names (), $table->data[6][1] = html_print_select (servers_get_names (),
'server_name', $server_name, '', __('None'), 0, true); 'server_name', $server_name, '', __('None'), 0, true). ' ' . ui_print_help_icon ('agent_server', true);
// Description // Description
$table->data[7][0] = __('Description'); $table->data[7][0] = __('Description');
@ -410,4 +410,4 @@ $(document).ready (function () {
$("select#id_os").pandoraSelectOS (); $("select#id_os").pandoraSelectOS ();
}); });
/* ]]> */ /* ]]> */
</script> </script>

View File

@ -308,9 +308,9 @@ $table_advanced->data[2][4] = html_print_input_text ('post_process',
$table_advanced->data[3][0] = __('Min. Value'); $table_advanced->data[3][0] = __('Min. Value');
$table_advanced->colspan[3][1] = 2; $table_advanced->colspan[3][1] = 2;
$table_advanced->data[3][1] = html_print_input_text ('min', $min, '', 5, 15, true, $disabledBecauseInPolicy); $table_advanced->data[3][1] = html_print_input_text ('min', $min, '', 5, 15, true, $disabledBecauseInPolicy). ' ' . ui_print_help_tip (__('Any value below this number is discarted.'), true);
$table_advanced->data[3][3] = __('Max. Value'); $table_advanced->data[3][3] = __('Max. Value');
$table_advanced->data[3][4] = html_print_input_text ('max', $max, '', 5, 15, true, $disabledBecauseInPolicy); $table_advanced->data[3][4] = html_print_input_text ('max', $max, '', 5, 15, true, $disabledBecauseInPolicy). ' ' . ui_print_help_tip (__('Any value over this number is discarted.'), true);
$table_advanced->data[4][0] = __('Export target'); $table_advanced->data[4][0] = __('Export target');
// Default text message for export target select and disabled option // Default text message for export target select and disabled option
@ -391,12 +391,10 @@ $table_advanced->data[11][1] = html_print_extended_select_for_cron ($hour, $minu
$table_advanced->colspan[11][1] = 4; $table_advanced->colspan[11][1] = 4;
$table_advanced->data[12][0] = __('Timeout'); $table_advanced->data[12][0] = __('Timeout');
$table_advanced->data[12][1] = html_print_input_text ('max_timeout', $table_advanced->data[12][1] = html_print_input_text ('max_timeout', $max_timeout, '', 5, 10, true). ' ' . ui_print_help_tip (__('Seconds that agent will wait for the execution of the module.'), true);
$max_timeout, '', 5, 10, true);
$table_advanced->data[12][2] = ''; $table_advanced->data[12][2] = '';
$table_advanced->data[12][3] = __('Retries'); $table_advanced->data[12][3] = __('Retries');
$table_advanced->data[12][4] = html_print_input_text ('max_retries', $table_advanced->data[12][4] = html_print_input_text ('max_retries', $max_retries, '', 5, 10, true). ' ' . ui_print_help_tip (__('Number of retries that the module will attempt to run.'), true);
$max_retries, '', 5, 10, true);
if (check_acl ($config['id_user'], 0, "PM")) { if (check_acl ($config['id_user'], 0, "PM")) {
$table_advanced->data[13][0] = __('Category'); $table_advanced->data[13][0] = __('Category');

View File

@ -78,7 +78,7 @@ if (defined('METACONSOLE')) {
else { else {
// Header // Header
ui_print_page_header (__('Tags configuration'), "images/setup.png", false, "", true, $buttons); ui_print_page_header (__('Tags configuration'), "images/setup.png", false, "tags_config", true, $buttons);
} }
@ -205,4 +205,4 @@ ui_require_jquery_file ('cluetip');
return false; return false;
}); });
/* ]]> */ /* ]]> */
</script> </script>

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

View File

@ -0,0 +1,27 @@
<?php
/**
* @package Include/help/en
*/
?>
<h1>Server field</h1>
In the field "server" there is a combo where you can choose the server that will do the checking.
Configuration at Servers
<br><br>
In Servers there are two modes of work:
<br><br>
<ul>
<blockquote>
<li>Master Mode.
<li>Non-Master Mode.
</ul>
<br>
The differences between them, and the importance that they have to work in HA mode, consist on that when there are several servers from the same kind( e.g: Network Servers).When a server falls, the first master server that could, will be in charge of the network modules of the down server that are waiting to be executed. The non-master servers does not do this.
<br><br>
This option is configured in the file /etc/pandora/pandora_server.conf through the master 1 token.
<br><br><i>
master 1
<br><br></i>
Being the value 1 to active it and 0 to deactivate it.

View File

@ -4,9 +4,12 @@
*/ */
?> ?>
<h1>Module definition</h1> <h1>Module definition</h1>
<p>
There are two modes for an agent: There are two modes for an agent:
</p>
<ul> <ul>
<li>Learning mode: all the modules sent by the agent are accepted. If modules are not defined, they will be automatically defined by the system. It is recommended to activate the agents in this mode and change it once the user is familiar with Pandora FMS.</li> <li><i>Learning mode:</i> all the modules sent by the agent are accepted. If modules are not defined, they will be automatically defined by the system. It is recommended to activate the agents in this mode and change it once the user is familiar with Pandora FMS.<br>From version 4.0.3, in this mode, Pandora console collect all the configuration specified by the agent configuration file the first time and thereafter any changes should be made through console, will not catch changes in config file.
<li>Normal mode: the modules in this mode must be configured manually. The self definition of the modules is not allowed in this mode.</li> </li>
<br>
<li><i>Normal mode:</i> the modules in this mode must be configured manually. The self definition of the modules is not allowed in this mode.</li>
</ul> </ul>

View File

@ -0,0 +1,19 @@
<?php
/**
* @package Include/help/en
*/
?>
<h1>Tags in Pandora FMS</h1>
The access to the modules can be configurated with a Tags system. A tags are configurated on the system, and be assigned to the choosed modules. In this way the access of the user can be limited to the modules with certain tags.
<br><br>
<i>
The Tags access doesnt replace the group access. Just complement it.</i>
<br><br>
<b> Form fields.</b>
<br><br>
<i>Name:</i> Tag name<br>
<i>Description:</i> Tag description<br>
<i>Url:</i> Extern link to add more extra information to the tag <br>
<i>Email:</i> Email address used in alerts associated to the tag
<br>

View File

@ -1,8 +1,21 @@
<?php <?php
/** /**
* @package Include/help/en * @package Include/help/en
*/ */
?> ?>
<h1>View Services</h1>
<p>This is the view of the list of the services with their status</p> <h1> Creating a new service</h1>
The service represents an association of agent modules and their value is calculated in real time. Because of that first of all you need to have all your devices that make a service monitored and with their module's values normalized to three status: Normal, Warning and Critical. You can learn more about them in their wiki sections: Monitoring with Pandora FMS and Monitoring with policies.
<br><br>
When you have all the devices monitored you can make group of them with the service. Inside each service you can add all modules you need to monitor the service. For example if you want to monitor the online shop service you need a module that monitors the content, another which monitors the comunication status and so on.
<br><br>
To create a new service just click on botton Create.
<br><br>
<?php html_print_image ("images/help/service1.png", false, array('width' => '550px')); ?>
<br><br>
At this moment we have a service created without items, so we have to add items to the service. To add a new item click on the oragne tool an the right top of Service Management tab and after in the botton Create. Then the form below will appear. In this form you must select a module of an agent to add. Also you must fill the fields related to the weight of this module inside the service for Normal, Warning and Critical status. The heavier a module the more important is within the service.

View File

@ -0,0 +1,26 @@
<?php
/**
* @package Include/help/es
*/
?>
<h1>Campo servidor</h1>
En el campo “server” hay un combo donde se elige el servidor que realizará los chequeos.
Configuración en los servidores
<br><br>
En los servidores existen dos modos de trabajo:
<br><br>
<ul>
<blockquote>
<li>Modo maestro.
<li>Modo no-maestro.
</ul>
<br>
La diferencia entre ellos, y la importancia que tienen para trabajar en modo HA consiste en que cuando existen varios servidores del mismo tipo, p.e: Network Servers, cuando un servidor cae, el primer servidor maestro que pueda, se hará cargo de los módulos de red pendientes de ejecutar del servidor caído. Los servidores no-maestros no realizan esta acción.
<br><br>
Esta opcion se configura en el fichero /etc/pandora/pandora_server.conf por medio del token de configuracion
<br><br><i>
master 1
<br><br></i>
Teniendo el valor 1 para activarlo y 0 para desactivarlo.

View File

@ -9,6 +9,7 @@
Existen dos modos para un agente: Existen dos modos para un agente:
</p> </p>
<ul> <ul>
<li>Modo aprendizaje: todos los módulos enviados por el agente se aceptan. Si los módulos no están definidos, el sistema los creará automáticamente. Se recomienda activar los agentes en este modo y cambiarlo una vez que se el operador se ha familiarizado con Pandora FMS.</li> <li><i>Modo aprendizaje:</i> todos los módulos enviados por el agente se aceptan. Si los módulos no están definidos, el sistema los creará automáticamente. Se recomienda activar los agentes en este modo y cambiarlo una vez que se el operador se ha familiarizado con Pandora FMS. A partir de la versión 4.0.3, en este modo Pandora recogerá en consola toda la configuración indicada por el fichero de configuración del agente la primera vez y a partir de entonces todas las modificaciones se deberán realizar a través de consola, no cogerá cambios en el fichero de configuración.</li>
<li>Modo normal: los módulos en este modo se deben configurar manualmente. No se permite la definición automática en este modo.</li> <br>
<li><i>Modo normal:</i> los módulos en este modo se deben configurar manualmente. No se permite la definición automática en este modo.</li>
</ul> </ul>

View File

@ -0,0 +1,18 @@
<?php
/**
* @package Include/help/es
*/
?>
<h1>Tags en Pandora FMS</h1>
El acceso a los módulos se puede configurar con un sistema de Etiquetas o Tags. Se configuran unos tags en el sistema, se asignan a los módulos que se quiera. De esta forma se puede limitar el acceso a un usuario a los módulos con determinados tags.
<br><br>
<i>El acceso por Tags no sustituye el acceso por grupos. Lo complementa.</i>
<br><br>
<b>Campos del formulario.</b>
<br><br>
<i>Name:</i> nombre del tag
<i>Description:</i> descripción del tag.
<i>Url:</i> Link externo para aportar información extra al tag
<i>Email:</i> Dirección de correo electrónico utilizada en alertas asociadas al tag
<br>