View Source

Contexte

Cette page a pour but de vous décrire la mise en place du pack linux-by-SSH__shinken :

Le déploiement du pack sur la plateforme (sur le Synchronizer et sur le ou les Pollers),
La configuration des prérequis nécessaires à l’exécution des checks.

L'installation du pack sur l'infrastructure Shinken

En préambule, il faut :

Récupérer la dernière version du pack auprès de l'équipe Shinken ou de votre partenaire,
Transférer le pack sur votre Synchronizer et votre/vos Pollers.

Mise en place du pack avec l'installeur "install.sh" ( sur Poller / Synchronizer )

Commun à tout Poller / Synchronizer

Que ce soit sur un Synchronizer où sur un Pollers :

Désarchiver le pack :

tar --no-same-owner -xf NOM_DU_PACK.tar.xz

Entrée dans le répertoire extrait de l'archive et lancer le "install.sh"
cd NOM_DU_PACK/ ./install.sh

L'installeur dépose les éléments suivants :

Le fichier de configuration de la source "shinken-additional-packs-import" qui servira à importer la définition du pack dans le Synchronizer.
Les fichiers de définitions des éléments du pack, à importer dans le Synchronizer.

Les sondes du pack.

Exemple de mise en place :

=============================================
INSTALL PACK [ linux-by-SSH__shinken ]
=============================================

    -----------------------------
    |   COLLECTOR [ shinken-additional-packs-import ]

        => ADDING Collector cfg file
              - Path : /etc/shinken/sources/shinken-additional-packs-import.cfg
        => CREATING Collector DATA space
              - Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import
              => ADDING Definition File [ definition_shinken-additional-packs-import.cfg ]
                     - Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/definition_shinken-additional-packs-import.cfg
              - Changing owner ( to "shinken" user )
              - Setting rights

    -----------------------------
    |   MONITORING DEFINITION:

        => Installing definition files in source-data folder ( Collector => shinken-additional-packs-import )
              - Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import
              - Changing owner ( to "shinken" user )
              - Setting rights

    -----------------------------
    |   PROBES:

        => Deleting previous probes
        => Installing probes
              - Path : /var/lib/shinken-user/libexec/shinken-additional-packs/shinken-linux_by_ssh
              - Setting owner ( to "shinken" user )
              - Setting rights

Si une version du pack est déjà installée, elle doit être désinstallée avant d’installer la nouvelle version. L’installeur vérifiera automatiquement si l’ancienne version a été correctement supprimée et vous avertira si ce n’est pas le cas.

========================================================
PRE-INSTALLATION CHECKS
========================================================

ERROR: Previous installation detected!

The following files/folders from a previous installation were found:
              - /var/lib/shinken-user/libexec/shinken-additional-packs/linux_by_ssh-shinken
              - /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/linux_by_ssh-shinken
              - /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/linux_by_ssh-shinken
              - /etc/shinken/resource.d/shinken-additional-packs-import/global-data/linux_by_ssh-shinken

Please run './uninstall.sh' before installing the pack.

Installation ABORTED.

WARNING: Uninstallation will remove all installed config files ( .cfg ).
This step is required for installing this new pack version.
All manual changes to the present config files will be lost. This doesn't affect shinken Staging or Production environment.

Sur le Synchronizer

SEULEMENT si le collecteur "shinken-additional-packs-import" n'est pas déja PRÉSENT dans votre Synchronizer ( par exemple : première fois que vous utilisez un installeur de pack Shinken ) :

Vérifier dans la configuration de votre Synchronizer ( /etc/shinken/synchronizers/synchronizer-master.cfg ) que le collecteur "shinken-additional-packs-import" soit présent dans le champ sources.
cat /etc/shinken/synchronizers/synchronizer-master.cfg
define synchronizer { [...] sources Source 1, Source 2, Source 3, shinken-additional-packs-import [...] }
Si le collecteur "shinken-additional-packs-import" n'est pas présent, l'ajouter dans la liste puis redémarrez le Synchronizer pour que le collecteur soit pris en compte :
service-shinken-synchronizer restart
Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante :
service shinken-synchronizer restart
Activer le collecteur "shinken-additional-packs-import" si ce n'est pas déja fait.
Lancer l'import du collecteur "shinken-additional-packs-import":
- En suivant, vous devrez peut-être accepter ou des nouveautés ou des différences qui seraient liés à ce pack ( en fonction de l'évolution du pack ).
IMPORTANT : si c'est première fois que vous installez le pack, il est nécessaire de faire un dernier redémarrage du Synchronizer.
service-shinken-synchronizer restart
Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante :
service shinken-synchronizer restart

Mise en place du pack manuellement ( si l'utilisation du script install.sh n’est pas souhaitée ) :

Commun à tout Poller / Synchronizer

Si vous avez déjà installé le pack

Nous vous conseillons de supprimer les anciens dossiers dans lesquels le pack était présent, pour être sûr d'avoir la dernière version de tous les fichiers livrés.

Pour supprimer ces dossiers, utilisez la commande suivante ( si vous avez suivi à la lettre la procédure d'installation manuelle ) :

rm -rf /var/lib/shinken-user/libexec/shinken-additional-packs/linux_by_ssh-shinken
rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/linux_by_ssh-shinken
rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/linux_by_ssh-shinken
rm -rf /etc/shinken/resource.d/shinken-additional-packs-import/global-data/linux_by_ssh-shinken

Extraire le pack

Transférer sur votre machine et décompressez le fichier contenant le pack à l'aide de la ligne de commande ci-dessous ( en remplaçant "PACK__shinken__NON-DU-PACK__VERSION__OS.tar.gz" par le nom du pack qui vous est livré.

Pour Linux ( le paramètre --no-same-owner permet de ne pas conserver les attributs d'utilisateurs/roles présent de la création du pack ) :

tar -xjfv --no-same-owner PACK__shinken__NON-DU-PACK__VERSION__linux.tar.xz -C ./

Pour Windows ( Rôle de Poller ) :

tar -xvzf PACK__shinken__NOM-DU-PACK__VERSION__windows.tar.gz -C ./

Entrez dans le répertoire créér :

cd NOM_DU_PACK/

Les sondes ( mises en place )

On place les sondes :

probe_path="/var/lib/shinken-user/libexec/shinken-additional-packs/shinken-linux_by_ssh"
mkdir --parents $probe_path
cp -r ./probes/* $probe_path
chown -R shinken:shinken $probe_path
chmod -R 750 $probe_path

Sur le Synchronizer

Ensuite, plaçons maintenant la définition des éléments de supervision du pack au bon endroit :

Les fichiers de configuration :

Nous vous conseillons de créer un Collecteur de type ( cfg-file-import ) qui permet d'importer des définitions d'éléments Shinken depuis les fichiers de définitions présents dans ce pack.
- Vous trouverez la procédure de mise en place dans la page de documentation suivante ( Collecteur de type ( cfg-file-import ) - Import depuis des fichiers au format .cfg )
- Pour la suite des explications, nous considérerons que ce collecteur s'appelle "shinken-additional-packs-import"

Une fois le collecteur mis en place, nous allons déployer le pack au bon endroit :

En premier, les fichiers de définition des éléments ( modèles d'hôtes, checks, commandes, ... ) du pack :

shinken_collector_data_path="/etc/shinken-user/source-data/source-data-shinken-additional-packs-import"
cp -r ./monitoring-definitions/packs/* $shinken_collector_data_path
chown -R shinken:shinken $shinken_collector_data_path
chmod -R 744 $shinken_collector_data_path

Ensuite, les données globales

shinken_pack_globaldata_path="/etc/shinken/resource.d/shinken-additional-packs-import"
mkdir --parents $shinken_pack_globaldata_path
cp -r "./monitoring-definitions/global-data" "$shinken_pack_globaldata_path"
chown -R shinken:shinken "$shinken_pack_globaldata_path"
chmod -R 744 "$shinken_pack_globaldata_path"

Redémarrer le Synchronizer
service-shinken-synchronizer restart
Pour les versions de shinken strictement inférieures à V02.08.02-RC018.05, il faudra utiliser la commande suivante :
service shinken-synchronizer restart
Activer le collecteur "shinken-additional-packs-import" :
Lancer l'import du collecteur "shinken-additional-packs-import",
- En suivant, vous devrez peut-être accepter les nouveautés / différences qui seraient liés à ce pack ( en fonction de l'évolution du pack ).
IMPORTANT : si c'est première fois que vous installez le pack, il est nécessaire de faire un dernier redémarrage du Synchronizer.
service-shinken-synchronizer restart
Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante :
service shinken-synchronizer restart

Vous pouvez également supprimer le dossier qui a été créé suite à la décompression du pack en utilisant la commande suivante :

rm -rf ./linux_by_ssh

Attention à ne pas supprimer le tar.gz, connaître la version exacte du pack qui vous a été livré vous sera utile en cas de problème avec votre pack.

Si vous avez déjà installé une version précédente de ce pack, il vous faudra supprimer les anciens dossiers dans lesquels le pack était présent ( afin d'éviter de garder d'ancien fichier en cas d'évolution de la structure du pack ).

Pour supprimer ces dossiers, utilisez la commande suivante :

rm -rf /var/lib/shinken-user/libexec/shinken-additional-packs/linux_by_ssh-shinken
rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/linux_by_ssh-shinken
rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/linux_by_ssh-shinken
rm -rf /etc/shinken/resource.d/shinken-additional-packs-import/global-data/linux_by_ssh-shinken

Désinstaller le pack avec "uninstall.sh"

Entrée dans le répertoire extrait de l'archive et lancer le "uninstall.sh"

cd PACK__linux-by-SSH__shinken__VXX.XX.XX-final__Linux
./uninstall.sh

Ce mécanisme va seulement enlever les fichiers mis en place lors de l'installation ( Fichier du collecteur d'import, définition des éléments de supervision, et les sondes proposées ), mais ne touchent pas aux éléments que vous avez absorbés dans le Synchronizer.

=============================================
DELETE PACK [ linux-by-SSH__shinken ]
=============================================

    -----------------------------
    |   COLLECTOR [ shinken-additional-packs-import ]

        => Deleting collector configuration file
              - Path : /etc/shinken/sources/shinken-additional-packs-import.cfg
        => Deleting collector data folder
              - Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import

    -----------------------------
    |   MONITORING DEFINITION:

        => Deleting pack globaldata folder
              - Path : /etc/shinken/resource.d/shinken-additional-packs-import/

    -----------------------------
    |   PROBES:

        => Deleting probes
              - Path : /var/lib/shinken-user/libexec/shinken-additional-packs/shinken-linux_by_ssh

À noter : Vous devrez retirer les éléments importés dans le Synchronizer ( modèles d'hôtes, checks, ... ) via les actions de masses .

Pré-requis pour l'exécution des checks

Pour l'exécution correcte des commandes du pack linux-by-SSH, vous aurez besoin d'une connexion SSH.

Cette section est décrite dans la page Configuration du linux supervisé par le pack linux-by-SSH__shinken

Erreurs lors de l'utilisation du pack

Pour toute erreur survenue lors de l'exécution des checks, voir la page Erreurs du pack linux-by-SSH__shinken