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

From Pandora FMS Wiki
Jump to: navigation, search
(How is information obtained and modified?)
 
(24 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
[[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]]
 +
  
 
= Architecture =
 
= Architecture =
  
The Metaconsole architecture is composed by a single central node: '''The Metaconsole''' along with as many server nodes as you want, which here we call '''Instances'''. Instances are normal installations of Pandora FMS. They consist of a web console in the ''front end'' and a server in the ''back end'' that processes the data received, performs remote checks,etc. '''The Metaconsole doesn't have its own server'''. From version 6.0 onward, the Metaconsole has been changed, and now has its own server.  
+
The Metaconsole architecture is made up by a single central node, '''the Metaconsole''' along with as many server nodes as desired, the '''Instances'''.  
 +
 
 +
'''Instances are normal Pandora FMS installations'''. They consist of a web console in the front end and a server in the back end that processes the received data, performs remote checks,etc.  
 +
 
 +
From version 6.0 onwards, '''the Metaconsole has been modified and it currently has its own server''', for previous versions the Metaconsole does not have its own server.
  
 
== Where does it store data? ==
 
== Where does it store data? ==
  
Some data can be found on the Instances, others on the Metaconsole, and others in both places. They need to be synchronized between themselves to work properly.
+
Some data can be found on the Instances, others on the Metaconsole, and others in both places. They need to be synchronized to work properly.
  
 
'''On Instances''':
 
'''On Instances''':
Line 20: Line 25:
 
* The Metaconsole configuration:
 
* The Metaconsole configuration:
 
* Components
 
* Components
* Reports* and the template reports
+
* Reports* and the report templates
 
* Network maps*
 
* Network maps*
 
* Visual maps*
 
* Visual maps*
 
* Netflow filters
 
* Netflow filters
  
'''In both''':
+
'''On both''':
* Users and profilesThe userLos usuarios y perfiles
+
* Users and profiles
 
* Groups
 
* Groups
 
* Templates, actions and alert commands
 
* Templates, actions and alert commands
Line 32: Line 37:
 
* Categories
 
* Categories
  
<nowiki>*</nowiki> Though these items are stored in the metaconsole, they are configurations that are used to view the Instance data, therefore are useless on their own.
+
<nowiki>*</nowiki> Though these items are stored in the Metaconsole, they are configurations used to view Instance data, therefore they are useless on their own.
  
== How is information obtained and modified? ==
+
== How is information retrieved and modified? ==
  
The Metaconsole obtains and modifies the Instances' information in two different ways:
+
The Metaconsole obtains and modifies Instance information in two different ways:
  
 +
* '''Active''': Access to the instance ''' Database or API''' remotely from the Metaconsole (this is the case for agents, modules, alerts, etc.).
  
* '''Active''': Accesses the instances' ''' Database or API''' remotelt from the Metaconsole (this is the case for agents,modules, alerts, etc).  
+
<center>
 
+
[[image:Metaconsola_Arquitecture_Active.png|600px]]
 +
</center>
  
<center><br><br>
+
* '''Passive''': Replicates data from instances to the Metaconsole '''Database''' (this is the case for events).
[[image:Metaconsola_Arquitecture_Active.png|600px]]
 
</center><br><br>
 
  
* '''Passive''': replicates data from instances to the Metaconsoloe '''Database''' (this is the case for events).
+
<center>
<center><br><br>
+
[[image:Metaconsola_Arquitecture_Passive.png|570px]]
[[image:Metaconsola_Arquitecture_Passive.png|400px]]
+
</center>
</center><br><br>
 
  
 
= Synchronization =
 
= Synchronization =
 +
The Metaconsole has tools for element synchronization, such as the synchronization of users and groups, which is essential for instance correct management. Synchronization is based on passing all the information created in the Metaconsole to the different instances in order to manage all the information from each and everyone of them from the Metaconsole.
  
There are two different types of Metaconsole synchronization tools:
+
For example, a user created in an instance, but not in the Metaconsole, cannot be managed from the Metaconsole. On the other hand, if there is a created user in the Metaconsole, and users are synchronized, this user will be in Instances and it will be possible to manage it from the Metaconsole.
 
 
* '''Synchronization utilities''':
 
:* Users
 
:* Groups
 
:* Alerts
 
:* Tags
 
* '''Propagation Utilities''':
 
:* Component Propagation (from the Metaconsole to the Instances)
 
:* Agent movements (From one instance to the other)
 
 
 
{{Tip|If you want to synchronize module categories, it has to be done manually by entering each Instance}}
 
 
 
== Synchronization utilities ==
 
 
 
 
 
Synchronization tools match the content between the Metaconsole and Instances to make sure its functioning correctly.
 
 
 
 
 
{{Warning|After modifying this data in the Metaconsole, it will be necessary to synchronize the data with Instances to avoid unusual behaviors.}}
 
 
 
{{Tip|Most of the synchronization process is done by name. In order to not have any problems with the exceptions we should follow the instructions listed on [[Pandora:Metaconsole:Documentation_en:Installation#Index_Scaling|Index scaling]] in the Metaconsole configuration section.}}
 
 
 
=== User Synchronization ===
 
 
 
In order for an user to operate with the Metaconsole, this user should exist both in the Metaconsole and the Instance.
 
 
 
{{Tip|Passwords don't necessarily have to coincide}}
 
 
 
{{Warning|Users should have the same permissions(ACLs, Tags and Wizard access) in the Metaconsole and Instances for it to correctly function}}
 
 
 
 
 
We'll later look at the tool to synchronize users and their profiles in the [[Pandora:Metaconsole:Documentation_en:Administration#Synchronization_Tools|Synchronization administration]] section .
 
  
 
<center><br><br>
 
<center><br><br>
Line 91: Line 64:
 
</center><br><br>
 
</center><br><br>
  
=== Group Synchronization===
+
= Propagation =
 
 
Groups should be synchronized in order to guarantee access to the data they have.
 
 
 
 
 
 
 
{{Warning|The ACLs that an user has on each group in the Metaconsole should correspond with the user accesses that have the same name in the instance.}}
 
 
 
We will later look at the tool to synchronize the groups in the [[Pandora:Metaconsole:Documentation_en:Administration#Synchronization_Tools|Administration]] section.
 
[[Pandora:Metaconsole:Documentation_es:Permissions#ACLs|More information on ACLs]]
 
 
 
<center><br><br>
 
[[image:Metaconsola_Groups_Sync.png|400px]]
 
</center><br><br>
 
 
 
=== Alert Synchronization===
 
 
 
Alert synchronization refers to the synchronization between the metaconsole and instances for templates, actions and alert command lines.
 
 
 
This synchronization is necessary because an alert is a link between a template -which includes a series of actions- and a module. Plus, each action has a command synchronized to it.
 
 
 
Alerts are configured and assigned from the Metaconsole with templates, actions and commands which are from the Metaconsole itself. For this configuration to be possible and coherent, the instance where the module that will be assigned an alert can be found must have the same templates, actions and commands.
 
 
 
There exists a tool to synchronize alerts, which can be seen in the Administration section of this Wiki.
 
 
 
 
 
{{Warning| The tool only synchronizes data structures. The commands are related to a script. Synchronization for said script must be secured manually entering the instances.}}
 
 
 
<center><br><br>
 
[[image:Metaconsola_Alerts_Sync.png|400px]]
 
</center><br><br>
 
 
 
=== Tag Synchronization ===
 
 
 
Tags are an access control mechanism which are complementary to groups, and therefore must also be synchronized to guarantee access to all related data.
 
 
 
{{Warning|The tags an user has on each Metaconsole group must correspond with a homonymous user's tags in the instance.}}
 
 
 
 
 
<center><br><br>
 
[[image:Metaconsola_Tags_Sync.png|400px]]
 
</center><br><br>
 
 
 
== Propagation Utilities ==
 
 
 
These tools are useful to copy or move data from one Instance to other or from the Metaconsole to the Instances.
 
 
 
Unlike the synchronization utilities, propagation is not necessary for the best performance of the Metaconsole. It is only a tool to make easier the availability of data in the Instances.
 
 
 
Tools for tag synchronization will be seen in the [[Pandora:Metaconsole:Documentation_es:Management#Sincronizaci.C3.B3n|Administration]]  part of the Wiki.
 
 
 
[[Pandora:Metaconsole:Documentation_es:Permissions#Tags|More information on tags]]
 
 
 
 
 
=== Propagation utilities ===
 
 
 
These tools are meant for copying or moving data from a particular instance to another, or from the Metaconsole to Instances.
 
 
 
Different from synchronization utilities, propagation isn't needed for the Metaconsole's optimum performance. It's only a tool to make data availability easier on Instances.
 
<center><br><br>
 
[[image:Metaconsola_Components_Prop.png|400px]]
 
</center><br><br>
 
 
 
=== Agent Movement ===
 
 
 
 
 
This tool allows moving agents from instance to instance.
 
 
 
  
{{Tip|To avoid involuntary mistakes, what's really done is copying the agents to the destined Instances, and deactivate them in the Instances of origin.}}
+
The Metaconsole has tools for element propagation, such component propagation or moving agents between instances (or nodes). Unlike synchronization, it is not a fundamental tool for the optimal functioning of the Metaconsole. It only provides data availability in instances, something that is necessary if, for example, policies that are applied in different instances (or nodes) are used.
  
 +
For example, you may want to move an agent from Instance A to Instance B to balance instance load, through this set of tools it can be easily achieved.
  
 
<center><br><br>
 
<center><br><br>
[[image:Metaconsola_Agents_Prop.png|400px]]
+
[[image:Metaconsola_Agents_Prop.png|350px]]
 
</center><br><br>
 
</center><br><br>
  

Latest revision as of 11:20, 27 October 2020

Go back to Pandora FMS documentation index


1 Architecture

The Metaconsole architecture is made up by a single central node, the Metaconsole along with as many server nodes as desired, the Instances.

Instances are normal Pandora FMS installations. They consist of a web console in the front end and a server in the back end that processes the received data, performs remote checks,etc.

From version 6.0 onwards, the Metaconsole has been modified and it currently has its own server, for previous versions the Metaconsole does not have its own server.

1.1 Where does it store data?

Some data can be found on the Instances, others on the Metaconsole, and others in both places. They need to be synchronized to work properly.

On Instances:

  • Agents
  • Modules
  • Alerts
  • Policies

On the Metaconsole:

  • The Metaconsole configuration:
  • Components
  • Reports* and the report templates
  • Network maps*
  • Visual maps*
  • Netflow filters

On both:

  • Users and profiles
  • Groups
  • Templates, actions and alert commands
  • Tags
  • Categories

* Though these items are stored in the Metaconsole, they are configurations used to view Instance data, therefore they are useless on their own.

1.2 How is information retrieved and modified?

The Metaconsole obtains and modifies Instance information in two different ways:

  • Active: Access to the instance Database or API remotely from the Metaconsole (this is the case for agents, modules, alerts, etc.).

Metaconsola Arquitecture Active.png

  • Passive: Replicates data from instances to the Metaconsole Database (this is the case for events).

Metaconsola Arquitecture Passive.png

2 Synchronization

The Metaconsole has tools for element synchronization, such as the synchronization of users and groups, which is essential for instance correct management. Synchronization is based on passing all the information created in the Metaconsole to the different instances in order to manage all the information from each and everyone of them from the Metaconsole.

For example, a user created in an instance, but not in the Metaconsole, cannot be managed from the Metaconsole. On the other hand, if there is a created user in the Metaconsole, and users are synchronized, this user will be in Instances and it will be possible to manage it from the Metaconsole.



Metaconsola Users Sync.png



3 Propagation

The Metaconsole has tools for element propagation, such component propagation or moving agents between instances (or nodes). Unlike synchronization, it is not a fundamental tool for the optimal functioning of the Metaconsole. It only provides data availability in instances, something that is necessary if, for example, policies that are applied in different instances (or nodes) are used.

For example, you may want to move an agent from Instance A to Instance B to balance instance load, through this set of tools it can be easily achieved.



Metaconsola Agents Prop.png



Return to the Pandora FMS documentation index