Difference between revisions of "Pandora: Metaconsole: Documentation en: Installation"

From Pandora FMS Wiki
Jump to: navigation, search
(Installation and Configuration)
Line 5: Line 5:
  
  
In this section will be included all the aspects needed in order to install and configure a Metaconsole and their Instances.
+
In this section will be included all the aspects needed in order to install and configure a Metaconsole and their Instances(nodes).
  
  
Line 27: Line 27:
 
=== Instances===
 
=== Instances===
  
One Instance is a Pandora FMS Enterprise typical installation: '''One instance is composed of one Server and one Web Console'''. All details about how to install the Instances will be found in the documentation section [[Pandora:Documentation_en:Installing|Pandora FMS Installation]].
+
Una Instancia o nodo es una instalación típica de Pandora FMS Enterprise, compuesta por un '''servidor''' y una '''consola web'''
 +
 
 +
Para saber con detalle como instalar una instancia podemos visitar el siguiente [[Pandora:Documentation_es:Instalacion|enlace.]]
  
 
=== Metaconsole ===
 
=== Metaconsole ===
Line 36: Line 38:
 
{{Tip|It is not possible to use at the same license the Pandora FMS console and the Metaconsole}}
 
{{Tip|It is not possible to use at the same license the Pandora FMS console and the Metaconsole}}
  
''' The Metaconsole is only the Web Console''' It doesn't use server so it will not host agent neither monitors'''
+
Es necesario tener activo un servidor para poder realizar distintas operaciones referentes a la metaconsola como la “migración”, “autoprovisionamiento”, ejecución de servicios…
 +
 
 +
=== Metaconsole License Activation ===
  
In some cases it could be necessary the server libraries to execute the database maintenance script in the Metaconsole. To simplify it, this is done installing the server but without firing it.  
+
Tras instalar la versión Enterprise de la Consola de Pandora FMS, sea cual sea el método de instalación, se deberá acceder a la consola de Pandora (http://IP/pandora_console/) y le aparecerá la siguiente pantalla de bienvenida para aceptar la licencia. Para saber más de como se activa la licencia podemos visitar el siguiente [[Pandora:QuickGuides_ES:Guia_Rapida_General#Activaci.C3.B3n_de_la_licencia_Enterprise|enlace.]]
  
=== Metaconsole Additional Configuration ===
+
{{Tip|Para poder activar la metaconsola necesita una licencia de metaconsola. Si activa la licencia de nodo le aparecerá la consola normal.}}
  
The Metaconsole, if the node events replication has been activated, store event data in its own database. For their maintenance these data can be deleted and/or move to the metaconsole history event ddb. THis is done, as in a pandora instance, through the execution of the ddbb maintenance script that is at''/usr/share/pandora_server/util/pandora_db.pl''. Usually, to launch it the server file is used, only that as it is a metaconsole, there is no server. To do this, get a copy o fhe file /etc/pandora/pandora_server.conf from one of the nodes, edit it, and modify the data related to the DDBB (hostname, DDBB name, user and password) and save the file, for example as:
+
== Metalicence ==
  
/etc/pandora/pandora_meta.conf
+
A partir de la versión 7.0NG de PandoraFMS disponemos de una licencia única para un entorno con Metaconsola. Esta licencia se aplica en la Metaconsola y se puede sincronizar en tantas instancias como se quiera permitiendo así la gestión centralizada de los distintos agentes que se desplegarán en las distintas instancias. Se podrán crear tantas instancias como se quiera, siempre y cuando no se sobrepase el número de agentes total dentro de la Metaconsola.
  
Create an script at  /etc/cron.daily/pandora_meta_db  with the following content:
+
Con esta licencia, si empezamos una instalación desde cero, primero deberemos instalar la Metaconsola validando su metalicencia. Una vez validado, registraremos cada una de las instancias deseadas, sincronizando posteriormente la licencia para que podamos trabajar sobre todas ellas.
  
/usr/share/pandora_server/util/pandora_db.pl /etc/pandora/pandora_meta.conf
+
<center>
 +
[[image:Meta_sincrolicencia.png]]
 +
</center>
  
And modify the permissions of it through chmod:
+
== Configuration ==
  
chmod 755 /etc/cron.daily/pandora_meta_db
+
In order for instances to communicate with the Metaconsole and vice versa, you should configure both sides correctly.
  
In order to could execute it, it is necessary that you have installed the necessary packages to execute (even if it doesn't) the Pandora FMS server and its Enterprise part.
+
=== Metaconsole ===
  
Execute it manually to check that it works and it doesn't report errors:
+
==== Alta y Configuración de las Instancias ====
  
/etc/cron.daily/pandora_meta_db
+
En el apartado de Metasetup, se podrán dar de alta y configurar las Instancias con las que se enlazará la Metaconsola.
  
=== Metaconsole License Activation ===
+
Para dar de alta una nueva instancia debemos de conocer una serie de parámetros referentes a la instancia que queremos manejar. Si se trata de un alta de una instancia que todavía no ha sido registrada con una licencia, los datos por defecto son:
  
After installing the Enterprise version's Pandora FMS Console by any installation method, you're required to access the Pandora Console (http://IP/pandora_console/). Subsequently, the following welcome screen to accept the license is going to appear:
+
* '''Server name''': localhost.localdomain
 +
* '''Auth token''': vacía
 +
* '''Console URL''': http://IP/pandora_console
 +
* '''API password''': vacía
 +
* '''DB host''': IP de la base de datos
 +
* '''DB name''': pandora
 +
* '''DB user''': pandora
 +
* '''DB password''': pandora
 +
* '''DB port''': 3306
 +
* '''Control user''': admin
 +
* '''Console password''': pandora
  
 
<center>
 
<center>
[[Image:license_accept.png]]
+
[[image:Configure_Instances_editor.png]]
 
</center>
 
</center>
  
After accepting the license, the Pandora FMS Database schema is going to change, adding required new tables for the use of the Enterprise Version. In this moment, a new screen to register the license key, which Artica has sent to you, is going to appear:
+
En caso de ser una instalación de Pandora donde ya hemos incluido una licencia válida en la instancia, tendremos que obtener dichos datos del setup de la instancia y la base de datos de la misma.
 +
 
 +
En la vista de las Instancias configuradas veremos que las instancias pueden ser modificadas, desactivadas y eliminadas.
 +
Existen unos indicadores que chequean cierta información de la configuración de cada instancia. Esos chequeos se realizan al cargar esta vista, pero también se pueden hacer individualmente haciendo click sobre ellos.
  
 
<center>
 
<center>
[[Image:license_setup.png]]
+
[[image:Configure_Instances_list_new.png]]
 
</center>
 
</center>
  
In order to activate the metaconsole you need a valid metaconsole license. If you use a standart pandora fms license then the standard console would appear after activating the license.
+
Los indicadores son los siguientes:
  
== Metalicence ==
+
* '''Base de datos''': Si hemos configurado mal la base de datos de la Instancia o no tenemos los permisos necesarios, el indicador estará en rojo y nos dará información del problema.
 +
* '''API''': Este indicador hará una prueba a la API de la Instancia. Si falla nos dará información del fallo.
 +
* '''Compatibilidad''': Este indicador hace un chequeo de algunos requisitos que tiene que haber entre Instancia y Metaconsola. El nombre del servidor de la Instancia, por ejemplo, debe coincidir con el nombre que se le dé en su configuración en la Metaconsola.
 +
* '''Replicación de eventos''': Este indicador indica si la Instancia tiene activada la replicación de eventos y si ya se han recibido eventos de la Instancia hace cuánto tiempo fue la última replicación.
 +
* '''Caché del agente''': Este indicador indica que los últimos estados de los agentes y módulos del nodo se han guardado correctamente en la base de datos de la metaconsola. Cuando un cambio se genera, solo ese cambio será modificado en la base de datos.
 +
* '''Sincronización''':  Este indicar hace referencia a la posibilidad de poder realizar la sincronización de los distintos elementos desde la metaconsola a las instancias.
 +
 
 +
Los tres primeros indicadores deben estar verdes para que la Instancia esté debidamente enlazada y comencemos a ver sus datos. En cambio, el indicador de Replicación de eventos solamente nos da información de esta característica.
 +
 
 +
{{Tip|Una Instancia puede estar bien configurada, pero sin replicar sus eventos}}
  
From version Pandora FMS 7.0NG onward Metaconsole is covered by a a single licence. The licence is unique to the Metaconsole and syncs with other instances allowing for centralized control of agents deployed in the environment, and enabling dynamic assignation of agents among different Pandora FMS instances, provided the total number of agents on the Metaconsole is not exceeded.
+
{{Tip|Una vez se haya escogido replicar los eventos, toda la gestión de los mismo se realizará desde la Metaconsola, dejando a los eventos de la instancia meramente informativos}}
  
According to this protocol, the Metaconsole is the first component to be installed, and, once registered, the other instances may be added.
 
  
=== Registering a new instance in the Metaconsole environment ===
+
==== Index Scaling ====
  
Carry out the normal installation process as with any other instance [[http://wiki.pandorafms.com/index.php?title=Pandora:Documentation_en:Installing#Pandora_FMS_Installation]] . Once the database is correctly set up introduce the licence:
+
La mayor parte de la sincronización entre metaconsola e instancias se realiza por nombre, independientemente del ID interno de los elementos, teniendo como excepción los grupos, tags, alertas, sistemas operativos y grupos de modulos, cuyos IDs es importante que estén sincronizados.
  
<center>
+
Para '''asegurar que los IDs de los grupos, tags, alertas, sistemas operativos y grupos de modulos que se sincronizan desde la metaconsola no existan en las instancias''', aumentaremos el valor AUTO_INCREMENT de las tablas tgrupo, ttag, talert_templates, talert_actions, talert_commands, tconfig_os y tmodule_group sensiblemente. De este modo, daremos un margen amplio por si se crean elementos en las instancias por causas ajenas a la metaconsola.  
[[Image:license_setup.png]]
 
</center>
 
  
And go to 
+
Para ello ejecutaremos en la base de datos de la metaconsola la siguiente consulta:  
[[Pandora:Documentation_en:Installing#Pandora_FMS_Installation_Order|register the node]] in the Metaconsole. Perform the necessary "grants" (fundamental for the Metaconsole database and nodes). Once all databases are accessible, register the instance on the Metaconsole.
 
  
In the Metasetup section the instances that link the Metaconsole can be configured.
+
ALTER TABLE tgrupo AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 +
ALTER TABLE ttag AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 +
ALTER TABLE talert_templates AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 +
ALTER TABLE talert_actions AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 +
ALTER TABLE talert_commands AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 +
ALTER TABLE tconfig_os AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 +
ALTER TABLE tmodule_group AUTO_INCREMENT <nowiki>=</nowiki> 3000;
  
Configuring an instance implies a series of parameters that must be configured and obtained from the instances themselves.
+
{{Tip|Si se sospecha que el número de elementos de una instancia creados de forma ajena a la metaconsola puede superar los 3000, se puede configurar un valor superior.}}
  
[[Pandora:Metaconsole:Documentation_en:Installation#Instances_Configuration|see 1.3.2.2 below]] :
+
==== Report scheduler / Pandora_DB maintance script  ====
  
<center>
+
Es preciso instalar los paquetes (open y enterprise) del servidor en el sistema donde esté instalado la metaconsola a fin de poder lanzar el script de mantenimiento de Base de datos ('''pandora_db'''). Debe asegurarse de que queda correctamente programado para su ejecución en el cron cada hora (tal y como se detalla en el siguiente Pandora:Documentation_es:Gestion_y_Administracion#Cron_Job |enlace.]]).
[[image:Configure_Instances_editor.png|1600px]]
 
</center>
 
  
When the instance has been created all the elements will be configured automatically and the instance will be correctly registered, allowing the Pandora FMS server to be booted and monitoring to be deployed.
+
Si va a utilizar los informes bajo demanda (enviados por email), necesita programar la ejecución de la extensión cron al igual que se hace en una consola Enterprise normal. Generalmente esto se hace metiendo en el cron la siguiente linea ajustando los paths locales que correspondan:
  
<center>
+
  */5 * * * * <user> wget -q -O - http://x.x.x.x/pandora_console/enterprise/extensions/cron/cron.php >> /var/www/pandora_console/pandora_console.log
[[image:Instancia_correcta.png|1600px]]
 
</center>
 
  
If you're updating a Pandora FMS licence, the licence must be activated on the Metaconsole (click Validate and Sync). The licence will automatically sync with all instances installed on the Metaconsole.
+
Por último, para configurar el SMTP de envío de emails, hay que editar los parámetros correspondientes en la sección de configuración de mail, que por defecto tienen los siguientes valores:
  
 
<center>
 
<center>
[[image:Sync_license.png|1600px]]
+
[[image:Mail_metaconsola.png]]
 
</center>
 
</center>
 
If any licences do not sync correctly, force sync in the licence section of the Metaconsole, or register the instance again on the Metaconsole.
 
 
== Configuration ==
 
 
In order for instances to communicate with the Metaconsole and vice versa, you should configure both sides correctly.
 
  
 
=== Instances ===
 
=== Instances ===
Line 136: Line 156:
 
===== Database=====
 
===== Database=====
  
It is necessary to know the database '''credentials''' to configure later the Instance in the Metaconsole (Host, Database, Users and Password). Another important thing is to ''' give permissions''' to the user so s/he can have remote access to the database. It is done with the MySQL GRANT command:
+
Como hemos dicho anteriormente se deberán saber las '''credenciales''' de la base de datos para configurar la instancia en la Metaconsola. (Host, Base de datos, Usuario y Contraseña).
 +
 
 +
Además de ello, otro punto importante es '''dar permisos''' al usuario para que acceda remotamente a la base de datos.
 +
Se hace con el comando GRANT de MySQL:
 +
 
 +
GRANT ALL PRIVILEGES on <MetaconsoleDatabaseName>.* to <UserName>@<HostAddress> IDENTIFIED BY <UserPass>;
 +
 
 +
Por ejemplo:
  
  GRANT ALL PRIVILEGES on <MetaconsoleDatabaseName>.* to <UserName>@<HostAddress> IDENTIFIED BY '<UserPass>';
+
  GRANT ALL PRIVILEGES on PandoraMetaBase.* to adminmeta@localhost IDENTIFIED BY pandora;
  
 
===== API =====
 
===== API =====
Line 147: Line 174:
 
* '''API password''': It is necessary to know the access password to the API that is configured in the Instance.
 
* '''API password''': It is necessary to know the access password to the API that is configured in the Instance.
 
* '''IPs List with access to the API''': In the Instance configuration, there is an IPs list that could have access to the API. It is possible to use <nowiki>'*'</nowiki> as wildcart to give access to all IPs or to one subnet
 
* '''IPs List with access to the API''': In the Instance configuration, there is an IPs list that could have access to the API. It is possible to use <nowiki>'*'</nowiki> as wildcart to give access to all IPs or to one subnet
 +
 +
<center>
 +
[[image:imagen_setup.png]]
 +
</center>
  
 
==== Auto-authentication ====
 
==== Auto-authentication ====
  
In some parts of the metaconsole there are accesses to the Instance Web Console.
+
En algunas partes de la metaconsola hay accesos a la Consola Web de la Instancia como, por ejemplo, en el visor de eventos al pinchar en el agente asociado a un evento (si lo hay) nos llevará a la vista de ese agente en la consola de la Instancia a la que pertenece. Para este acceso se utiliza Auto-autenticación. Esta autenticación se realiza con un ''hash'' para el que se necesita una cadena configurada en la Instancia: ''La contraseña de auto identificación''. Dicha contraseña la ponemos en el campo de “Auth token” de la configuración de la instancia en la metaconsola.
  
For example, in the event visor, when you click on the Agent that is associated to one event (if there is one) it will take us to the view of this agent in the console of the Instance to which it belongs.
+
<center>
 
+
[[image:autologin hash.png]]
For this access the Auto-authentication is used.
+
</center>
  
This authentication is done with a ''hash'' for which a string is necessary that is configured in the Instance: ''The autoidentification  password''.
+
{{Tip|Esta configuración no es necesaria para configurar la instancia en la Metaconsola, pero sin ella, al pinchar en uno de los enlaces que nos llevan a la instancia, tendremos que autenticarnos.}}
  
This configuration is not necessary to configure the Instance in the Metaconsole, but without it, if you click on one of the links that take us to the Instance, we should have to authenticate
 
  
 
==== Event Replication ====
 
==== Event Replication ====
Line 206: Line 236:
 
{{Warning|If you have activated the child nodes SELinux security, the event replication may not work. Please disable it.}}
 
{{Warning|If you have activated the child nodes SELinux security, the event replication may not work. Please disable it.}}
  
=== Metaconsole ===
+
==== Autoprovisión desde el nodo ====
 
 
==== Giving access to the Instances ====
 
  
Same way as the Instances give [[Pandora:Metaconsole:Documentation_en:Installation#Giving_access_to_the_Metaconsole|access to the Metaconsole]] to have a remote access to the database, the Metaconsole should do the same, so the Instances could replicate their events.
+
A partir de Pandora 7 puedes encontrar en el setup de configuración enterprise, la opción de dar de alta el nodo en la metaconsola introduciendo menos datos que en el formulario de nodos en la metaconsola.
  
 +
Ademas puedes chequear si esta llegas vía api a la metaconsola y chequear si esta dado de alta el nodo en la metaconsola.
  
==== Instances Configuration ====
+
<br>
 
 
In the Metasetup section, it will be possible to configure the Instances with which the Metaconsole will be linked.
 
 
 
The configuration of one instance has a serial of parameters that we should [[Pandora:Metaconsole:Documentation_en:Installation#Instances_2|configure and retrieve]] from the Instances:
 
 
 
 
<center>
 
<center>
[[image:Configure_Instances_editor.png|800px]]
+
[[Image:Autoprovision nodo formuario.png |850px]]
 
</center>
 
</center>
 +
<br>
  
In the view of the configured Instances, we will see that the Instances can be edited, disabled and deleted.
 
  
Besides, there are some indicators that checks some information of the configuration of each Instance. These checks are done when loading this view, but the can also be done individually clicking on them.
+
=== Metaconsole Additional Configuration ===
  
<center>
+
The Metaconsole, if the node events replication has been activated, store event data in its own database. For their maintenance these data can be deleted and/or move to the metaconsole history event ddb. THis is done, as in a pandora instance, through the execution of the ddbb maintenance script that is at''/usr/share/pandora_server/util/pandora_db.pl''. Usually, to launch it the server file is used, only that as it is a metaconsole, there is no server. To do this, get a copy o fhe file /etc/pandora/pandora_server.conf from one of the nodes, edit it, and modify the data related to the DDBB (hostname, DDBB name, user and password) and save the file, for example as:
[[image:Configure_Instances_list.png|800px]]
 
</center>
 
  
The indicators are these:
+
/etc/pandora/pandora_meta.conf
  
* '''Database''':If we haven't configured right the Instance database we won't have the necessary permission, the indicator will be red and it will give us information about the problem.
+
Create an script at  /etc/cron.daily/pandora_meta_db  with the following content:
* '''API''': This indicator will do a test to the Instance API. If it fails it will report information about the failure to us
 
* '''Compatibility''':This indicator will do a check of some requirements that should be between the Instance and the Metaconsole. The Instance server name, for example, should match with the name that we give to it in its configuration in the metaconsola.
 
* '''Event Replication''': This indicator shows if the Instance has activated the event replication and if the events from the Instance have been alredy received and how long ago was the last replication.
 
  
The three first indicators should be in green color so the Instance should be correctly linked and we start viewing their data.However, the event Replication events will give us only information about this feature.
+
/usr/share/pandora_server/util/pandora_db.pl /etc/pandora/pandora_meta.conf
  
{{Tip| One Instance could be configured correctly but with their events not replicated}}
+
And modify the permissions of it through chmod:
  
==== Index Scaling ====
+
chmod 755 /etc/cron.daily/pandora_meta_db
  
Most of the synching between the metaconsole and instances is performed according to name, independent from the elements' internal IDs.  
+
In order to could execute it, it is necessary that you have installed the necessary packages to execute (even if it doesn't) the Pandora FMS server and its Enterprise part.
  
As exceptions to this, there are groups, tags and alerts, that should have synchronized IDs as something important.
+
Execute it manually to check that it works and it doesn't report errors:
 
 
In order to '''make sure that the group, tag, alert, operating system and module group IDs that synchronize from the metaconsole don't exist on instances''', we'll raise the AUTO_INCREMENT value significantly in the tgroup, ttag, talert_templates, talert_actions, talert_commands, tconfig_os and tmodule_group. This way we'll give a larger margin in case elements are created on instances by causes external to the metaconsole. 
 
 
 
For this, we'll run the following query on the metaconsole database:
 
 
 
ALTER TABLE tgrupo AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 
ALTER TABLE ttag AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 
ALTER TABLE talert_templates AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 
ALTER TABLE talert_actions AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 
ALTER TABLE talert_commands AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 
ALTER TABLE tconfig_os AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 
ALTER TABLE tmodule_group AUTO_INCREMENT <nowiki>=</nowiki> 3000;
 
{{Tip|If we are suspicious that the number of elements from an instance created with independence to the metaconsole can go over 3000, we can give it a larger value.}}
 
 
 
==== Report scheduler / Pandora_DB maintance script  ====
 
 
 
Metaconsola doesnt have a "server", but you need to install packages (open & enterprise) in the system where metaconsole is executed because you need to launch each hour the ''pandora_db'' maintance script. Please be sure you scheduled it in cron, it's the piece of server which execute the metaconsole event purge and who moves the events not validated to the event history table.
 
 
 
If you also want to use on-demand reports sent by email, you need to setup the periodic execution of cron extension, in the same way you setup in a regular Enteprise console. Create a file called ''/etc/cron.d/pandora_cron_extension'' with following contents (adapt paths and IP address to the paths in your system).
 
 
 
  */5 * * * * <user> wget -q -O - http://x.x.x.x/pandora_console/enterprise/extensions/cron/cron.php >> /var/www/pandora_console/pandora_console.log
 
 
 
Remember also to setup the cron SMTP settings, by editing the file '/enterprise/extensions/cron/email_config.php':
 
 
 
<pre>
 
  //Please setup your config to send emails in cron job
 
  $cron_email_from = array('[email protected]' => 'Pandora FMS');
 
  $cron_email_smtpServer = 'mail.artica.es';
 
  $cron_email_smtpPort = 25;
 
  $cron_email_username = '';
 
  $cron_email_password = ;
 
</pre>
 
  
 +
/etc/cron.daily/pandora_meta_db
  
 
[[Pandora:Documentation_en#Part_6._Metaconsole|Go back to Pandora FMS documentation index]]
 
[[Pandora:Documentation_en#Part_6._Metaconsole|Go back to Pandora FMS documentation index]]
  
 
[[Category:Pandora FMS Metaconsole]]
 
[[Category:Pandora FMS Metaconsole]]

Revision as of 10:03, 25 September 2018

Go back to Pandora FMS documentation index


1 Installation and Configuration

In this section will be included all the aspects needed in order to install and configure a Metaconsole and their Instances(nodes).


1.1 Installation

The installations of the Instances and the Metaconsole requires to be hosted in servers that are communicated in both ways.

In order to do these we should verify that:

  • The Metaconsole can contact with the Instances
  • The Instances can contact with the Metaconsole

Info.png

The Instances don't need to be communicated between them at any moment

 


To understand better this requirement you can take a look to Metaconsole architecture.

The timezone setting should see the same. The more synchronized would be the Instances and Metaconsole would be, more exact will be the visualized data.

For example: If an Instance has 5 minutes of difference with the Metaconsole, the visualization of the time that have passed since their events were generated when these data are shown in the Metaconsole they will be false.

1.1.1 Instances

Una Instancia o nodo es una instalación típica de Pandora FMS Enterprise, compuesta por un servidor y una consola web

Para saber con detalle como instalar una instancia podemos visitar el siguiente enlace.

1.1.2 Metaconsole

A Metaconsole is a Pandora FMS Enterprise installation with a metaconsole license.


Info.png

It is not possible to use at the same license the Pandora FMS console and the Metaconsole

 


Es necesario tener activo un servidor para poder realizar distintas operaciones referentes a la metaconsola como la “migración”, “autoprovisionamiento”, ejecución de servicios…

1.1.3 Metaconsole License Activation

Tras instalar la versión Enterprise de la Consola de Pandora FMS, sea cual sea el método de instalación, se deberá acceder a la consola de Pandora (http://IP/pandora_console/) y le aparecerá la siguiente pantalla de bienvenida para aceptar la licencia. Para saber más de como se activa la licencia podemos visitar el siguiente enlace.

Info.png

Para poder activar la metaconsola necesita una licencia de metaconsola. Si activa la licencia de nodo le aparecerá la consola normal.

 


1.2 Metalicence

A partir de la versión 7.0NG de PandoraFMS disponemos de una licencia única para un entorno con Metaconsola. Esta licencia se aplica en la Metaconsola y se puede sincronizar en tantas instancias como se quiera permitiendo así la gestión centralizada de los distintos agentes que se desplegarán en las distintas instancias. Se podrán crear tantas instancias como se quiera, siempre y cuando no se sobrepase el número de agentes total dentro de la Metaconsola.

Con esta licencia, si empezamos una instalación desde cero, primero deberemos instalar la Metaconsola validando su metalicencia. Una vez validado, registraremos cada una de las instancias deseadas, sincronizando posteriormente la licencia para que podamos trabajar sobre todas ellas.

Meta sincrolicencia.png

1.3 Configuration

In order for instances to communicate with the Metaconsole and vice versa, you should configure both sides correctly.

1.3.1 Metaconsole

1.3.1.1 Alta y Configuración de las Instancias

En el apartado de Metasetup, se podrán dar de alta y configurar las Instancias con las que se enlazará la Metaconsola.

Para dar de alta una nueva instancia debemos de conocer una serie de parámetros referentes a la instancia que queremos manejar. Si se trata de un alta de una instancia que todavía no ha sido registrada con una licencia, los datos por defecto son:

  • Server name: localhost.localdomain
  • Auth token: vacía
  • Console URL: http://IP/pandora_console
  • API password: vacía
  • DB host: IP de la base de datos
  • DB name: pandora
  • DB user: pandora
  • DB password: pandora
  • DB port: 3306
  • Control user: admin
  • Console password: pandora

Configure Instances editor.png

En caso de ser una instalación de Pandora donde ya hemos incluido una licencia válida en la instancia, tendremos que obtener dichos datos del setup de la instancia y la base de datos de la misma.

En la vista de las Instancias configuradas veremos que las instancias pueden ser modificadas, desactivadas y eliminadas. Existen unos indicadores que chequean cierta información de la configuración de cada instancia. Esos chequeos se realizan al cargar esta vista, pero también se pueden hacer individualmente haciendo click sobre ellos.

Configure Instances list new.png

Los indicadores son los siguientes:

  • Base de datos: Si hemos configurado mal la base de datos de la Instancia o no tenemos los permisos necesarios, el indicador estará en rojo y nos dará información del problema.
  • API: Este indicador hará una prueba a la API de la Instancia. Si falla nos dará información del fallo.
  • Compatibilidad: Este indicador hace un chequeo de algunos requisitos que tiene que haber entre Instancia y Metaconsola. El nombre del servidor de la Instancia, por ejemplo, debe coincidir con el nombre que se le dé en su configuración en la Metaconsola.
  • Replicación de eventos: Este indicador indica si la Instancia tiene activada la replicación de eventos y si ya se han recibido eventos de la Instancia hace cuánto tiempo fue la última replicación.
  • Caché del agente: Este indicador indica que los últimos estados de los agentes y módulos del nodo se han guardado correctamente en la base de datos de la metaconsola. Cuando un cambio se genera, solo ese cambio será modificado en la base de datos.
  • Sincronización: Este indicar hace referencia a la posibilidad de poder realizar la sincronización de los distintos elementos desde la metaconsola a las instancias.

Los tres primeros indicadores deben estar verdes para que la Instancia esté debidamente enlazada y comencemos a ver sus datos. En cambio, el indicador de Replicación de eventos solamente nos da información de esta característica.

Info.png

Una Instancia puede estar bien configurada, pero sin replicar sus eventos

 


Info.png

Una vez se haya escogido replicar los eventos, toda la gestión de los mismo se realizará desde la Metaconsola, dejando a los eventos de la instancia meramente informativos

 



1.3.1.2 Index Scaling

La mayor parte de la sincronización entre metaconsola e instancias se realiza por nombre, independientemente del ID interno de los elementos, teniendo como excepción los grupos, tags, alertas, sistemas operativos y grupos de modulos, cuyos IDs es importante que estén sincronizados.

Para asegurar que los IDs de los grupos, tags, alertas, sistemas operativos y grupos de modulos que se sincronizan desde la metaconsola no existan en las instancias, aumentaremos el valor AUTO_INCREMENT de las tablas tgrupo, ttag, talert_templates, talert_actions, talert_commands, tconfig_os y tmodule_group sensiblemente. De este modo, daremos un margen amplio por si se crean elementos en las instancias por causas ajenas a la metaconsola.

Para ello ejecutaremos en la base de datos de la metaconsola la siguiente consulta:

ALTER TABLE tgrupo AUTO_INCREMENT = 3000;
ALTER TABLE ttag AUTO_INCREMENT = 3000;
ALTER TABLE talert_templates AUTO_INCREMENT = 3000;
ALTER TABLE talert_actions AUTO_INCREMENT = 3000;
ALTER TABLE talert_commands AUTO_INCREMENT = 3000;
ALTER TABLE tconfig_os AUTO_INCREMENT = 3000;
ALTER TABLE tmodule_group AUTO_INCREMENT = 3000;

Info.png

Si se sospecha que el número de elementos de una instancia creados de forma ajena a la metaconsola puede superar los 3000, se puede configurar un valor superior.

 


1.3.1.3 Report scheduler / Pandora_DB maintance script

Es preciso instalar los paquetes (open y enterprise) del servidor en el sistema donde esté instalado la metaconsola a fin de poder lanzar el script de mantenimiento de Base de datos (pandora_db). Debe asegurarse de que queda correctamente programado para su ejecución en el cron cada hora (tal y como se detalla en el siguiente Pandora:Documentation_es:Gestion_y_Administracion#Cron_Job |enlace.]]).

Si va a utilizar los informes bajo demanda (enviados por email), necesita programar la ejecución de la extensión cron al igual que se hace en una consola Enterprise normal. Generalmente esto se hace metiendo en el cron la siguiente linea ajustando los paths locales que correspondan:

 */5 * * * * <user> wget -q -O - http://x.x.x.x/pandora_console/enterprise/extensions/cron/cron.php >> /var/www/pandora_console/pandora_console.log

Por último, para configurar el SMTP de envío de emails, hay que editar los parámetros correspondientes en la sección de configuración de mail, que por defecto tienen los siguientes valores:

Mail metaconsola.png

1.3.2 Instances

In Instances, there are a series of parameters to ensure the access of your data with the Metaconsole.

1.3.2.1 Giving access to the Metaconsole

The Metaconsole could have access to one Instance in two different ways:

  • Remote access to the Data Base to see and edit the data stored in the instances.
  • Access to the to the API for some actions like the edition of configuration files or NetFlow monitoring

The Instance should be configured to guarantee both accesses to the Metaconsole.

1.3.2.1.1 Database

Como hemos dicho anteriormente se deberán saber las credenciales de la base de datos para configurar la instancia en la Metaconsola. (Host, Base de datos, Usuario y Contraseña).

Además de ello, otro punto importante es dar permisos al usuario para que acceda remotamente a la base de datos. Se hace con el comando GRANT de MySQL:

GRANT ALL PRIVILEGES on <MetaconsoleDatabaseName>.* to <UserName>@<HostAddress> IDENTIFIED BY <UserPass>;

Por ejemplo:

GRANT ALL PRIVILEGES on PandoraMetaBase.* to [email protected] IDENTIFIED BY pandora;
1.3.2.1.2 API

The access to the API Instance will be guaranteed with the following parameters:

  • User and password: It is necessary to know a valid user and password in the Instance.
  • API password: It is necessary to know the access password to the API that is configured in the Instance.
  • IPs List with access to the API: In the Instance configuration, there is an IPs list that could have access to the API. It is possible to use '*' as wildcart to give access to all IPs or to one subnet

Imagen setup.png

1.3.2.2 Auto-authentication

En algunas partes de la metaconsola hay accesos a la Consola Web de la Instancia como, por ejemplo, en el visor de eventos al pinchar en el agente asociado a un evento (si lo hay) nos llevará a la vista de ese agente en la consola de la Instancia a la que pertenece. Para este acceso se utiliza Auto-autenticación. Esta autenticación se realiza con un hash para el que se necesita una cadena configurada en la Instancia: La contraseña de auto identificación. Dicha contraseña la ponemos en el campo de “Auth token” de la configuración de la instancia en la metaconsola.

Autologin hash.png

Info.png

Esta configuración no es necesaria para configurar la instancia en la Metaconsola, pero sin ella, al pinchar en uno de los enlaces que nos llevan a la instancia, tendremos que autenticarnos.

 



1.3.2.3 Event Replication

In order that Instance events may be seen in the Metaconsole, these should have access to the Metaconsole database.

The Instances will replicate from time to time their events saving the date and hour of the last one to be replicated to continue from there the next time.

Besides the event replication, they will make the Metaconsole autovalidation effective. This is, for the events that are associated to one module, when they will replicate the event to the Metaconsole, they will validate all the previous events that are assigned to the same module.

To configure the event replication, in the Instance Enterprise Configuration section be should activate the Event Replication.

This will be configured:

  • Intervale: Every how many seconds the server will replicate the events generated from the last replication to the Metaconsole database.

Info.png

If is configured, for example 60 seconds, the first replication will happen 60 seconds after the server has been started.

 


  • Replication Mode: If all events will be replicated or only the ones that are validated.
  • Show list of events in the local console (only reading): When the event replication is activated, the event management will be done in the metaconsole and in the instance there is not access to them.With this option you will have access to a view of events in only reading mode.
  • Metaconsole Database Credentials : Host, Database, Users,Password and Port (Is the port is not indicted the port by default will be used).

Replication events setup.png

The event replication is done by the server. In the configuration file should be an enabled token:

Replication events conf token.png

Template warning.png

To do effective any configuration change in the event replication it will be necessary to restart the server.

 


Template warning.png

If you add in a metaconsole a new node which already contains lots of events, it could take a long time to copy all the events to the metaconsole

 


If you want to alter the date since node is going to synchronize events with the target metaconsola (for example, to force event replication from the current date), you need to execute this SQL sentence in the node database for versions of Pandora older than 5.1SP3:

UPDATE tconfig SET `value` = UNIX_TIMESTAMP() WHERE `token` = "replication_copy_last_utimestamp"

For versions newer than 5.1SP3 execute the following query:

UPDATE tconfig SET `value` = (SELECT MAX(id_evento) FROM tevento) WHERE `token` = "replication_copy_last_id";

Template warning.png

If you have activated the child nodes SELinux security, the event replication may not work. Please disable it.

 


1.3.2.4 Autoprovisión desde el nodo

A partir de Pandora 7 puedes encontrar en el setup de configuración enterprise, la opción de dar de alta el nodo en la metaconsola introduciendo menos datos que en el formulario de nodos en la metaconsola.

Ademas puedes chequear si esta llegas vía api a la metaconsola y chequear si esta dado de alta el nodo en la metaconsola.


Autoprovision nodo formuario.png



1.3.3 Metaconsole Additional Configuration

The Metaconsole, if the node events replication has been activated, store event data in its own database. For their maintenance these data can be deleted and/or move to the metaconsole history event ddb. THis is done, as in a pandora instance, through the execution of the ddbb maintenance script that is at/usr/share/pandora_server/util/pandora_db.pl. Usually, to launch it the server file is used, only that as it is a metaconsole, there is no server. To do this, get a copy o fhe file /etc/pandora/pandora_server.conf from one of the nodes, edit it, and modify the data related to the DDBB (hostname, DDBB name, user and password) and save the file, for example as:

/etc/pandora/pandora_meta.conf

Create an script at /etc/cron.daily/pandora_meta_db with the following content:

/usr/share/pandora_server/util/pandora_db.pl /etc/pandora/pandora_meta.conf

And modify the permissions of it through chmod:

chmod 755 /etc/cron.daily/pandora_meta_db

In order to could execute it, it is necessary that you have installed the necessary packages to execute (even if it doesn't) the Pandora FMS server and its Enterprise part.

Execute it manually to check that it works and it doesn't report errors:

/etc/cron.daily/pandora_meta_db

Go back to Pandora FMS documentation index