checkmk 2: Configuration#

Cette application est hautement personnalisable via des fichiers de configuration et des paramètres d'exécution.

Fichiers de configuration#

Au démarrage, il essaie de charger les fichiers suivants :

• /etc/idoitcmk/config.json (au niveau du système) et
• ~/.idoitcmk/config.json (défini par l'utilisateur)

Les fichiers de configuration sont formatés en JSON (JavaScript Object Notation), un format facilement lisible pour les humains et les robots.

Créer automatiquement un fichier de configuration#

Utilisez la commande init pour créer votre propre fichier de configuration :

1

idoitcmk init

Cette commande vous posera plusieurs questions sur tous les paramètres qui sont mentionnés ci-dessous. Ensuite, un fichier de configuration sera écrit dans ~/.idoitcmk/config.json.

Si vous exécutez cette commande avec des droits de super-utilisateur (root), un fichier de configuration sera écrit dans /etc/idoitcmk/config.json à la place.

Avec cette commande, vous pouvez même mettre à jour vos paramètres de configuration. Avant cela, une sauvegarde sera créée en arrière-plan.

Créer des fichiers de configuration manuellement

Pour bien commencer, imprimez la configuration d'exemple et éditez-la localement :

1
2
3

mkdir ~/.idoitcmk
idoitcmk print-example-config > ~/.idoitcmk/config.json
editor ~/.idoitcmk/config.json

Paramètres disponibles#

Les paramètres de configuration sont séparés par thèmes :

Les thèmes requis sont i-doit et check_mk, sinon le partage d'informations entre eux ne fonctionnera pas. Tous les autres thèmes peuvent être modifiés facultativement.

Pour presque chaque paramètre, il existe une valeur par défaut prédéfinie. Vous pouvez supprimer les paramètres inchangés de vos fichiers de configuration locaux.

Accéder à l'API JSON-RPC d'i-doit#

Configurer comment accéder à l'API JSON-RPC d'i-doit :

Accéder à l'API Web de checkmk et à Livestatus#

Configurer comment accéder à l'API Web de checkmk :

Livestatus ne peut actuellement pas être connecté via TLS.

Configurer la version de Checkmk utilisée#

Configurer la commande de push#

Configurer comment envoyer des données de i-doit à checkmk :

Balisage automatique#

Exemple :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
    "push": {
        "autoTagging": {
            "title": {
                "/^00/": {
                    "tag_agent": "cmk-agent",
                    "tag_criticality": "prod"
                },
                "/mail/": {
                    "tag_system": "mail"
                }
            },
            "hostname": {
                "/^vm/": {
                    "tag_networking": "dmz"
                }
            },
            "fqdn": {
                "/test\\.local$/": {
                    "tag_criticality": "test"
                }
            }
        },
        "autoMatching": "all"
    }
}

Essayez de faire correspondre toutes les expressions :

• Les objets dont les titres (title) commencent par 00 seront vérifiés par un agent et seront balisés comme productifs.
• Les objets dont les titres (title) contiennent mail au milieu seront balisés comme hôtes de messagerie.
• Les objets dont les noms d'hôtes (hostname) commencent par vm seront assignés à la DMZ.
• Les objets dont les noms de domaine complets (fqdn) se terminent par test.local seront balisés comme test.

Configurer la commande pull#

Configurer comment extraire des données de checkmk vers i-doit :

Identifiants#

Dans i-doit, il existe plusieurs attributs qui conviennent en tant qu'identifiants uniques pour les associer à des hôtes dans checkmk:

Exemple:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
    "pull": {
        "identifier": [
            "titre",
            "nom d'hôte",
            "fqdn",
            "adresse de l'hôte",
            "alias",
            "défini par l'utilisateur"
        ],
        "minMatch": 2
    }
}

Attributs#

Dans i-doit, chaque attribut d'objet est lié à une catégorie appelée catégorie. Ces catégories peuvent être modifiées:

Types d'objet#

Types d'objet utilisés identifiés par leurs constantes :

Titres d'objet#

Les objets utilisés sont identifiés par leurs titres :

Rôles#

Il s'agit d'une liste des rôles i-doit pour les groupes de contacts utilisés dans les affectations de contact :

Types d'objets en liste noire#

Cette liste de types d'objets sera complètement ignorée par défaut :

Vous ne pouvez pas supprimer les types d'objets de cette liste (veuillez signaler un problème si vous le souhaitez quand même). Mais vous pouvez étendre cette liste avec d'autres types d'objets.

Dans l'exemple suivant, tous les objets de type Client seront également ignorés. Pour identifier ce type d'objet, utilisez sa constante au lieu de son titre (anglais ou allemand) :

1
2
3
4
5

{
    "blacklistedObjectTypes": [
        "C__OBJTYPE__CLIENT"
    ]
}

Niveaux de journalisation#

L'outil CLI idoitcmk dispose de différents niveaux de journalisation :

Il existe un paramètre de configuration log.verbosity pour ajuster le niveau de journalisation par défaut. Cette valeur sera utilisée lorsque ni l'option d'exécution -v|--verbose ni -q|--quiet ne sont utilisées. La valeur par défaut actuelle est 31. Cela signifie que tous les messages de journal sauf les messages de débogage sont inclus.

D'un côté, l'option d'exécution -v|--verbose définit temporairement ce paramètre de configuration à 63, ce qui inclut tous les niveaux de journalisation. D'un autre côté, l'option d'exécution -q|--quiet le définit temporairement à 3 (uniquement les erreurs fatales et les erreurs).

Fichiers de configuration supplémentaires#

Optionnellement, vous pouvez passer un ou plusieurs fichiers de configuration au format JSON en utilisant l'option -c ou --config. Répétez l'option pour plus d'un fichier. Par exemple:

1

idoitcmk push --config i-doit-testing.json --config check_mk-testing.json

Paramètres d'exécution#

Vous souhaitez modifier certains paramètres pendant l'exécution ? Vous pouvez le faire avec les options -s et --setting. Séparez les clés imbriquées avec ., par exemple:

1
2
3

idoitcmk push --setting "push.activateChanges=true"

idoitcmk pull -s ['pull.attributes={"C__CATG__ACCESS": true,"C__CATG__APPLICATION": true,"C__CATG__CONTACT": true,"C__CATG__CPU": true,"C__CATG__DRIVE": true,"C__CATG__GRAPHIC": true,"C__CATG__IP": true,"C__CATG__MEMORY": true,"C__CATG__MODEL": true,"C__CATG__OPERATING_SYSTEM": true,"C__CATG__NETWORK_LOG_PORT": true,"C__CATG__NETWORK_PORT": true}']

Répétez l'option pour plus d'un paramètre.

L'ordre des paramètres de configuration est important#

Comme vous l'avez déjà lu, vous avez plusieurs options pour transmettre vos paramètres préférés à cette application. Cette application suit cet ordre :

1. Les paramètres par défaut seront écrasés par
2. Les paramètres système (situés dans /etc/idoitcmk/config.json) seront écrasés par
3. Les paramètres définis par l'utilisateur (situés dans ~/.idoitcmk/config.json) seront écrasés par
4. Les fichiers de configuration supplémentaires (options -c FICHIER ou --config FICHIER) seront écrasés par
5. Les paramètres d'exécution (options -s CLÉ=VALEUR ou --setting CLÉ=VALEUR)

Tester votre configuration#

Avec la commande configtest, vous pouvez effectuer une validation détaillée de vos paramètres de configuration. C'est très utile après avoir créé ou modifié vos paramètres :

1

idoitcmk configtest

Afficher votre configuration#

Si vous avez plusieurs fichiers de configuration et des paramètres d'exécution, il est parfois utile de savoir quels sont vos paramètres compilés :

1

idoitcmk print-config

Cela affichera vos paramètres de configuration actuels au format JSON sur STDOUT.