diff --git a/de/docs/configuration/import-module.md b/de/docs/configuration/import-module.md new file mode 100644 index 0000000..812dea2 --- /dev/null +++ b/de/docs/configuration/import-module.md @@ -0,0 +1,141 @@ +# Import Modul EE + +Das Import Modul ist eines der umfangreichsten und komplexesten Module in openITCOCKPIT. Über das Import Modul können Hosts aus anderen Systemen importiert werden. Dabei kann es sich um einen klassischen CSV Import handeln oder den Import aus einer Configuration Management Datenbank (CMDB) wie i-doit oder iTop handeln. Auch dient das Modul dem Import neuer openITCOCKPIT Agenten im Pushmodus. Für alle Importer ermöglicht es zudem die regelbasierte Zuweisung von Servicechecks. Dabei untersützt es diverse Methoden, bis hin zur Statusübernahme aus anderen Monitoringsystemen. + +## Installation des Modules + +Navigieren Sie zu `Verwaltung -> Systemwerkzeuge -> Paketmanager` und installieren Sie das *ImportModule* + +## Host-Standardeinstellungen + +In einem ersten Schritt muss unter *Host-Standardeinstellungen* mindestens eine Standarddefinition angelegt werden. Mit den Host-Standardeinstellungen werden die Parameter Hosttemplate, Container, Satellitensystem und zugewiesene Services festgelegt. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Host-Standardeinstellungen` und erstellen Sie über den Button **New** eine neue Definition. + +![](/images/import-module/host_defaults.png) + +Mit der Auswahl eines Containers wird festgelegt, in welchen Container die neuen Host importiert werden sollen. Mittels Hosttemplate kann definiert werden, welche Vorlage bei neu importierten Hosts als Basis genutzt werden soll. Durch die Auswahl weiterer Shared Container kann auch direkt ein Aufbau spezieller Sichten realisiert werden. Als letztes Hostdetail wird noch ausgewählt, ob die neuen Hosts auf dem Mastersystem oder einem Satelliten angelegt werden sollen. + +In den optionalen Sektionen können schließlich die Regeln für die automatische Servicezuweisung definiert werden. + +![](/images/import-module/servicetemplategroup_matches.png) + +Das Bild zeigt exemplarische die Zuweisung von Servicetemplate Groups, bei denen eines der Attribute Hostname, Description, Address oder Software mit einem regulären Ausdruck verglichen wird. Sofern der reguläre Ausdruck gefunden wird, erfolgt eine Zuweisung der ausgewählten Servicetemplate Group. + +## Importer + +Über die Importer wird der eigentliche Datenimport realisiert. Dabei gibt es unterschiedliche Arten von Importern. + +- **CSV** + - Ermöglicht den Import von CSV-Dateien +- **openITCOCKPIT Agent** + - Neben der Möglichkeit einen Host über Wizards aufzunehmen, kann der openITCOCKPIT Agent auch Datenquelle für einen Import sein. +- **CMDB** + - Im Bereich der CMDBs ein Import aus iTop und i-doit ausgewählt werden +- **External monitoring Systems** + - Neben klassischen CMDBs können auch andere Monitoringsystem, wie beispielsweise Icinga2, als Datenquellen genutzt werden. Die Besonderheit dabei ist, dass nicht nur die Hosts, sondern auch die Statusinformationen aus dem externen Monitoringsystem ermittelt und dargestellt werden. +- **CMDB + External monitoring System** + - Eine Kombination der Methoden ist ebenfalls möglich, dabei erfolgt der Import auf Basis der Informationen aus der CMDB und wird mit den Informationen aus dem externen Monitoringsystem verglichen. Auch in diesem Fall werden nicht nur Hosts importiert, sondern auch die Statusinformationen aus dem externen Monitoring mit übernommen. + +### CSV Import + +Nach der Definition einer Host-Standardeinstellungen-Vorlage können direkt Importer für CSV-Dateien erstellt werden. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Importeure` + +![](/images/import-module/csv_settings.png) + +Wichtig sind insbesondere die richtigen Attribute im Mapping und die Auswahl einer Host-Standardeinstellungen-Vorlage, damit die Zuordnungen richtig erfolgen können. + +![](/images/import-module/csv_mapping.png) + +Eine funktionierende CSV-Datei für den Import könnte wie folgt aussehen: + +``` +hostname;address;description;software +srvweb04.itsm.love;127.10.10.1;Web server 1;Linux-local,nginx +srvweb05.itsm.love;127.10.10.2;Web server 2;Linux-local,nginx +srvmysqldb01.itsm.love;127.0.0.1;MySQL DB Server;Linux-local,mysql +``` + +### openITCOCKPIT Agent + +Für den Import von openITCOCKPIT Agents benötigt man eine spezielle Host-Standardeinstellung. Hierbei erfolgt die Zuordnung über die Agent Checks. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Host-Standardeinstellungen` + +![](/images/import-module/agent_checks_matches.png) + +Alle weiteren Parameter verhalten sich analog zu anderen Host-Standardeinstellungen und werden daher an dieser Stelle nicht mehr beschrieben. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Importeure` + +Die Einstellungen des Importers sind dann ähnlichen denen eines CSV-Importers. Wichtig ist als Datenquelle den openITCOCKPIT Agent auszuwählen und bei den Host Default Zuweisungen das richtige Template auszuwählen. + +![](/images/import-module/agent_host_defaults_assignment.png) + +### CMDB + +Bevor eine CMDB als Datenquelle dienen kann, muss diese zuerst als externes System erstellt werden. + +Dabei müssen die CMDB spezifischen Verbindungsdaten eingeben werden. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Externe Systeme` + +![](/images/import-module/ext_systems_conn_settings.png) + +Darüber hinaus ist zu definieren, welche Objekttypen aus der CMDB in den Import mit einbezogen werden sollen. + +![](/images/import-module/ext_systems_object_types.png) + +Nachdem die CMDB als externes System eingerichtet wurde, kann der Importer wie gewohnt erstellt werden. Als Datenquelle ist die entsprechende CMDB (i-doit, iTop, ...) in Kombination mit dem Externen System, das abgefragt werden soll, auszuwählen. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Importeure` + +![](/images/import-module/importer_cmdb_source.png) + +!!! info "Hinweis" + Durch den Import der Hosts werden die Hosts auch im Assetinformationen aus der CMDB erweitert. + +### Externes Monitoring System + +Wie schon bei der CMDB muss vor Erstellung eines Importers erst das externe Monitoring System angelegt werden. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Externes Monitoring` + +Nachdem das System angelegt wurde, kann der Importer erzeugt werden. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Importeure` + +![](/images/import-module/importer_ext_mon_source.png) + +### CMDB + Externes Monitoring System + +Die Kombination erfordert ein definiertes externes Monitoring System und ein externes System. Die Erstellung erfolgt entprechend den Punkten Externes Monitoring System und CMDB. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Importeure` + +Der Importer kann nun mit beiden Datenquellen erstellt werden. + +![](/images/import-module/importer_both_source.png) + +## Import der Daten + +Nachdem alle Vorbereitungen getroffen wurden, kann nun der Import durchgeführt werden. + +Navigieren Sie zu `Verwaltung -> Objektimport -> Importierte Hosts` + +Über den Button **Import starten** kann der gewünschte Importer ausgewählt werden. + +![](/images/import-module/start_import.png) + +Bei erfolgreicher Verbindung werden alle zu importierenden Systeme aufgelistet und man kann über den Button **Starte Datenimport** den Import beginnen. + +![](/images/import-module/hosts_for_import.png) + +Im nächsten Schritt erhält man eine Übersicht mit allen Hosts, den zugewiesenen Services und weiteren Informationen. Die Übernahme in das Monitoring erfolgt über den Button **Mit dem Monitoring-System synchronisieren**. + +![](/images/import-module/import_sync_monitoring.png) + +!!! info "Hinweis" + Zur Aktivierung der Überwachung muss wie gewohnt ein Refresh der Monitoringkonfiguration erfolgen. \ No newline at end of file diff --git a/de/docs/images/import-module/agent_checks_matches.png b/de/docs/images/import-module/agent_checks_matches.png new file mode 100644 index 0000000..e0dc494 Binary files /dev/null and b/de/docs/images/import-module/agent_checks_matches.png differ diff --git a/de/docs/images/import-module/agent_host_defaults_assignment.png b/de/docs/images/import-module/agent_host_defaults_assignment.png new file mode 100644 index 0000000..874c3bd Binary files /dev/null and b/de/docs/images/import-module/agent_host_defaults_assignment.png differ diff --git a/de/docs/images/import-module/csv_mapping.png b/de/docs/images/import-module/csv_mapping.png new file mode 100644 index 0000000..3ae830e Binary files /dev/null and b/de/docs/images/import-module/csv_mapping.png differ diff --git a/de/docs/images/import-module/csv_settings.png b/de/docs/images/import-module/csv_settings.png new file mode 100644 index 0000000..51f5c75 Binary files /dev/null and b/de/docs/images/import-module/csv_settings.png differ diff --git a/de/docs/images/import-module/ext_systems_conn_settings.png b/de/docs/images/import-module/ext_systems_conn_settings.png new file mode 100644 index 0000000..0918c9b Binary files /dev/null and b/de/docs/images/import-module/ext_systems_conn_settings.png differ diff --git a/de/docs/images/import-module/ext_systems_object_types.png b/de/docs/images/import-module/ext_systems_object_types.png new file mode 100644 index 0000000..465c664 Binary files /dev/null and b/de/docs/images/import-module/ext_systems_object_types.png differ diff --git a/de/docs/images/import-module/host_defaults.png b/de/docs/images/import-module/host_defaults.png new file mode 100644 index 0000000..c275089 Binary files /dev/null and b/de/docs/images/import-module/host_defaults.png differ diff --git a/de/docs/images/import-module/hosts_for_import.png b/de/docs/images/import-module/hosts_for_import.png new file mode 100644 index 0000000..271998d Binary files /dev/null and b/de/docs/images/import-module/hosts_for_import.png differ diff --git a/de/docs/images/import-module/import_module_host_defaults.png b/de/docs/images/import-module/import_module_host_defaults.png new file mode 100644 index 0000000..982d004 Binary files /dev/null and b/de/docs/images/import-module/import_module_host_defaults.png differ diff --git a/de/docs/images/import-module/import_sync_monitoring.png b/de/docs/images/import-module/import_sync_monitoring.png new file mode 100644 index 0000000..fc2659e Binary files /dev/null and b/de/docs/images/import-module/import_sync_monitoring.png differ diff --git a/de/docs/images/import-module/importer_both_source.png b/de/docs/images/import-module/importer_both_source.png new file mode 100644 index 0000000..81816e1 Binary files /dev/null and b/de/docs/images/import-module/importer_both_source.png differ diff --git a/de/docs/images/import-module/importer_cmdb_source.png b/de/docs/images/import-module/importer_cmdb_source.png new file mode 100644 index 0000000..89081cc Binary files /dev/null and b/de/docs/images/import-module/importer_cmdb_source.png differ diff --git a/de/docs/images/import-module/importer_ext_mon_source.png b/de/docs/images/import-module/importer_ext_mon_source.png new file mode 100644 index 0000000..7ec1fa6 Binary files /dev/null and b/de/docs/images/import-module/importer_ext_mon_source.png differ diff --git a/de/docs/images/import-module/servicetemplategroup_matches.png b/de/docs/images/import-module/servicetemplategroup_matches.png new file mode 100644 index 0000000..a28a9b2 Binary files /dev/null and b/de/docs/images/import-module/servicetemplategroup_matches.png differ diff --git a/de/docs/images/import-module/start_import.png b/de/docs/images/import-module/start_import.png new file mode 100644 index 0000000..b3408d4 Binary files /dev/null and b/de/docs/images/import-module/start_import.png differ diff --git a/de/mkdocs.yml b/de/mkdocs.yml index 3a84510..a2ce1ab 100644 --- a/de/mkdocs.yml +++ b/de/mkdocs.yml @@ -72,6 +72,7 @@ nav: - 'Verteiltes Monitoring und Satelliten': 'configuration/distribute-module.md' - 'SNMP Traps': 'configuration/snmp-trap-module.md' - 'Import / Export': 'configuration/import_export' + - 'Import Modul': 'configuration/import-module.md' - 'Development': - 'API': 'development/api.md' - 'Datenbankschema': 'development/database-schema.md' diff --git a/en/docs/configuration/import-module.md b/en/docs/configuration/import-module.md new file mode 100644 index 0000000..cee1127 --- /dev/null +++ b/en/docs/configuration/import-module.md @@ -0,0 +1,141 @@ +# Import Module EE + +The Import Module is one of the most comprehensive and complex modules in openITCOCKPIT. The module can be used to import hosts from other systems. This can be a classic CSV import or an import from a configuration management database (CMDB) such as i-doit or iTop. The module is also used to import new openITCOCKPIT agents in push mode. For all importers, it also enables the rule-based assignment of service checks. It supports various methods, including status transfer from other monitoring systems. + +## Module installation + +Navigate to `Administration -> System tools -> Package Manager` and install the *ImportModule* + +## Host Defaults + +As a first step, at least one standard definition must be created under *Host Defaults*. The host default settings are used to define the host template, container, satellite system and assigned services parameters. + +Navigate to `Administration -> Object Import -> Host Defaults` and create a new definition using the **New** button. + +![](/images/import-module/host_defaults.png) + +Selecting a container defines the container into which the new hosts are to be imported. The host template can be used to define which template is to be used as the basis for newly imported hosts. By selecting further shared containers, it is also possible to create specific views directly. Finally, the last detail is to select whether the new hosts are to be created on the master system or a satellite. + +The optional sections can then be used to define the rules for automatic service assignment. + +![](/images/import-module/servicetemplategroup_matches.png) + +The image shows an example of the assignment of service template groups where one of the attributes Hostname, Description, Address or Software is compared with a regular expression. If the regular expression is found, the selected service template group is assigned. + +## Importer + +The actual data import is realised via the importers. There are different types of importers. + +- **CSV** + - Enables the import of CSV files +- **openITCOCKPIT Agent** + - In addition to the option of adding a host via wizards, the openITCOCKPIT Agent can also be the data source for an import. +- **CMDB** + - An import from iTop and i-doit can be selected in the CMDBs area +- **External monitoring Systems** + - In addition to classic CMDBs, other monitoring systems, such as Icinga2, can also be used as data sources. The special feature here is that not only the hosts, but also the status information from the external monitoring system is determined and displayed. +- **CMDB + External monitoring System** + - A combination of methods is also possible, whereby the import is based on the information from the CMDB and is compared with the information from the external monitoring system. In this case, not only hosts are imported, but also the status information from the external monitoring system. + +### CSV Import + +After defining a host default settings template, importers for CSV files can be created directly. + +Navigate to `Administration -> Object Import -> Importers`. + +![](/images/import-module/csv_settings.png) + +The correct attributes in the mapping and the selection of a host default settings template are particularly important so that the assignments can be made correctly. + +![](/images/import-module/csv_mapping.png) + +A working CSV file for the import could look like this: + +``` +hostname;address;description;software +srvweb04.itsm.love;127.10.10.1;Web server 1;Linux-local,nginx +srvweb05.itsm.love;127.10.10.2;Web server 2;Linux-local,nginx +srvmysqldb01.itsm.love;127.0.0.1;MySQL DB Server;Linux-local,mysql +``` + +### openITCOCKPIT Agent + +A special host default setting is required to import openITCOCKPIT agents. The assignment is made via the agent checks. + +Navigate to `Administration -> Object import -> Host Defaults`. + +![](/images/import-module/agent_checks_matches.png) + +All other parameters behave in the same way as other host default settings and are therefore not described here. + +Navigate to `Administration -> Object Import -> Importers`. + +The importer settings are similar to those of a CSV importer. It is important to select the openITCOCKPIT Agent as the data source and to select the correct template for the host default assignments. + +![](/images/import-module/agent_host_defaults_assignment.png) + +### CMDB + +Before a CMDB can be used as a data source, it must first be created as an external system. + +The CMDB-specific connection data must be specified. + +Navigate to `Administration -> Object import -> External Systems`. + +![](/images/import-module/ext_systems_conn_settings.png) + +You also need to define which object types from the CMDB are to be included in the import. + +![](/images/import-module/ext_systems_object_types.png) + +Once the CMDB has been set up as an external system, the importer can be created as usual. Select the corresponding CMDB (i-doit, iTop, ...) in combination with the external system to be queried as the data source. + +Navigate to `Administration -> Object import -> Importers`. + +![](/images/import-module/importer_cmdb_source.png) + +!!! info "Hint" + By importing the hosts, they are also extended with asset information from the CMDB. + +### Externes Monitoring System + +As with the CMDB, the external monitoring system must first be created before creating an importer. + +Navigate to `Administration -> Object import -> External Monitoring`. + +Once the system has been created, the importer can be created. + +Navigate to `Administration -> Object import -> Importers`. + +![](/images/import-module/importer_ext_mon_source.png) + +### CMDB + Externes Monitoring System + +The combination requires a defined external monitoring system and an external system. The creation takes place according to the points External monitoring system and CMDB. + +Navigate to `Administration -> Object import -> Importers`. + +The importer can now be created with both data sources. + +![](/images/import-module/importer_both_source.png) + +## Import der Daten + +Once all preparations have been made, the import can now be carried out. + +Navigate to `Administration -> Object import -> Imported Hosts`. + +The desired importer can be selected and executed via the **Start import** button. + +![](/images/import-module/start_import.png) + +If the connection is successful, all systems to be imported are listed and you can start the import by clicking the **Start data import** button. + +![](/images/import-module/hosts_for_import.png) + +The next step provides an overview of all hosts, the assigned services and other information. The transfer to the monitoring is done via the **Synchronize with monitoring** button. + +![](/images/import-module/import_sync_monitoring.png) + +!!! info "Hint" + To activate monitoring, the monitoring configuration must be refreshed as usual. \ No newline at end of file diff --git a/en/mkdocs.yml b/en/mkdocs.yml index a65961b..0526f5f 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -72,6 +72,7 @@ nav: - 'Distribute monitoring and satellites': 'configuration/distribute-module.md' - 'SNMP Traps': 'configuration/snmp-trap-module.md' - 'Import/Export': 'configuration/import_export.md' + - 'Import-Module': 'configuration/import-module.md' - 'Development': - 'API': 'development/api.md' - 'Database schema': 'development/database-schema.md'