| Scroll Ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Contexte
Cette page a pour objectif de décrire la mise en place du pack windows-by-WinRM__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.
Procédure de mise en place du pack
En préambule, il faut :
- Récupérer la dernière version du pack auprès de l'équipe Shinken,
- Transférer le pack sur le Synchronizer et le ou les Pollers.
En utilisant l'installeur "install.sh" ( sur Poller / Synchronizer )
Commun à tout Poller / Synchronizer
Que ce soit sur un Synchronizer ou sur un Poller :
Désarchiver le pack :
Code Block language text theme Emacs tar --no-same-owner -xf NOM_DU_PACK.tar.xz
Entrer dans le répertoire extrait de l'archive et lancer le "install.sh"
Code Block language text theme Emacs 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 :
| Code Block | ||||
|---|---|---|---|---|
| ||||
========================================================
PRE-INSTALLATION CHECKS
========================================================
No previous installation detected. Proceeding with installation...
========================================================
INSTALL PACK [ windows-by-WinRM__shinken v02.00.00-RC000.07 ]
========================================================
-----------------------------
| COLLECTOR [ shinken-additional-packs-import ]
=> Collector cfg file already AVAILABLE
- Path : /etc/shinken/sources/shinken-additional-packs-import.cfg
=> Collector DATA space already AVAILABLE
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import
=> Definition File already AVAILABLE [ definition_shinken-additional-packs-import.cfg ]
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/definition_shinken-additional-packs-import.cfg
=> Applying permissions
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import
- Setting owner ( to "shinken" user )
- Setting rights
-----------------------------
| MONITORING DEFINITION:
=> Installing definitions file in source-data folder ( Collector => shinken-additional-packs-import )
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import
- Setting owner ( to "shinken" user )
- Setting rights
=> Installing global data definitions file in SHINKEN directory ( => resource.d )
- Path : /etc/shinken/resource.d/shinken-additional-packs-import/
- Setting owner ( to "shinken" user )
- Setting rights
-----------------------------
| PROBES:
=> Installing probes
- Path : /var/lib/shinken-user/libexec/shinken-additional-packs/windows-by-WinRM__shinken
- Setting owner ( to "shinken" user )
- Setting rights
|
| Note | ||
|---|---|---|
| ||
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. |
| Code Block | ||||
|---|---|---|---|---|
| ||||
========================================================
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-SNMP__shinken
- /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/linux-by-SNMP__shinken
- /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/linux-by-SNMP__shinken
- /etc/shinken/resource.d/shinken-additional-packs-import/global-data/linux-by-SNMP__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. |
En suivant, spécifiquement 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.Code Block language text theme Emacs cat /etc/shinken/synchronizers/synchronizer-master.cfg
Code Block language js theme Confluence 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 :
Section Code Block language text theme Emacs service-shinken-synchronizer restart
Note icon false Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante :
Code Block language text theme Emacs service shinken-synchronizer restart
Activer le collecteur "shinken-additional-packs-import" si ce n'est pas déja fait.
Panel Lancer l'import du collecteur "shinken-additional-packs-import":
Panel - 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 ).
- 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.
Section Code Block language text theme Emacs service-shinken-synchronizer restart
Note icon false Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante :
Code Block language text theme Emacs service shinken-synchronizer restart
Ou manuellement (si l'utilisation du script install.sh n’est pas souhaitée) :
Commun à tout Poller / Synchronizer
Si le pack est déjà installé
Il est recommandé de supprimer les anciens dossiers contenant le pack afin de garantir l'utilisation de la dernière version des fichiers livrés.
Pour effectuer cette suppression (si la procédure d'installation manuelle a été suivie telle quelle), la commande suivante peut être utilisée :
| Code Block | ||||
|---|---|---|---|---|
| ||||
rm -rf /var/lib/shinken-user/libexec/shinken-additional-packs/windows-by-WinRM__shinken |
Extraire le pack
Transférer le fichier du pack sur la machine et décompresser le fichier contenant le pack à l'aide de la ligne de commande ci-dessous (remplacer "PACK__shinken__NOM-DU-PACK__VERSION__OS.tar.gz" par le nom exact du pack livré) :
- Pour Linux ( le paramètre --no-same-owner permet de ne pas conserver les attributs d'utilisateurs/roles présent lors de la création du pack ) :
| Code Block | ||||
|---|---|---|---|---|
| ||||
tar -xjfv --no-same-owner PACK__shinken__NOM-DU-PACK__VERSION__linux.tar.xz -C ./ |
- Pour Windows ( Rôle de Poller ) :
| Code Block | ||||
|---|---|---|---|---|
| ||||
tar -xvzf PACK__shinken__NOM-DU-PACK__VERSION__windows.tar.gz -C ./ |
Entrer dans le répertoire créé :
| Code Block | ||||
|---|---|---|---|---|
| ||||
cd NOM_DU_PACK/ |
Les sondes ( mises en place )
On place les sondes :
| Code Block | ||||
|---|---|---|---|---|
| ||||
probe_path="/var/lib/shinken-user/libexec/shinken-additional-packs/windows-by-WinRM__shinken" mkdir --parents $probe_path cp -r ./probes/* $probe_path chown -R shinken:shinken $probe_path chmod -R 750 $probe_path |
Sur le Synchronizer
Ensuite, il est nécessaire de placer les définitions des éléments de supervision du pack au bon endroit.
- Les fichiers de configuration :
Il est recommandé de créer un collecteur de type cfg-file-import, qui permet d'importer des définitions d'éléments Shinken à partir des fichiers .cfg fournis dans le pack.
La procédure de mise en place de ce type de collecteur est disponible dans la documentation à la page : ( Collecteur de type ( cfg-file-import ) - Import depuis des fichiers au format .cfg )
- Dans la suite de cette documentation, ce collecteur sera nommé "shinken-additional-packs-import"
Une fois le collecteur mis en place, le pack peut être déployé à l’emplacement attendu :
En premier, les fichiers de définition des éléments ( modèles d'hôtes, checks, commandes, ... ) du pack :
Code Block language text theme Emacs 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
Code Block language text theme Emacs 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
Code Block language text theme Emacs service shinken-synchronizer restart
Lancer l'import du collecteur "shinken-additional-packs-import",
Panel Ensuite, il peut être nécessaire d’accepter certaines nouveautés ou différences introduites par le pack, selon son évolution.
Le dossier extrait lors de la décompression du pack peut également être supprimé à l’aide de la commande suivante :
| Code Block | ||||
|---|---|---|---|---|
| ||||
rm -rf ./PACK__windows-by-WinRM__shinken__V02.00.00__Linux |
| Info |
|---|
Attention à ne pas supprimer le fichier tar.gz. Connaître la version exacte du pack livré est utile en cas de problème avec celui-ci. |
Si une version précédente du pack a déjà été installée, il est recommandé de supprimer les anciens dossiers pour éviter de conserver des fichiers obsolètes, notamment en cas de modification de la structure du pack.
Utiliser les commandes suivantes pour effectuer cette suppression :
| Code Block | ||||
|---|---|---|---|---|
| ||||
rm /etc/shinken/sources/shinken-additional-packs-import.cfg rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/ rm -rf /var/lib/shinken-user/libexec/shinken-additional-packs/windows-by-WinRM__shinken |
Désinstaller le pack avec "uninstall.sh"
Entrée dans le répertoire extrait de l'archive et lancer le "uninstall.sh"
| Code Block | ||||
|---|---|---|---|---|
| ||||
cd PACK__windows-by-WinRM__shinken__VX.X.X-RCXXX__Linux ./uninstall.sh |
Ce mécanisme supprime uniquement les fichiers installés ( Fichier du collecteur d'import, définition des éléments de supervision, et les sondes proposées ), Les éléments déjà absorbés dans le Synchronizer ne sont pas affectés.
| Code Block | ||||
|---|---|---|---|---|
| ||||
==========================================================
UNINSTALL PACK [ windows-by-WinRM__shinken v02.00.00 ]
==========================================================
-----------------------------
| MONITORING DEFINITION:
=> Deleting pack monitoring definition folder
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/windows-by-WinRM__shinken
=> Deleting pack monitoring definition file
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/windows-by-WinRM__shinken.pack
=> Deleting pack monitoring globaldata folder
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/windows-by-WinRM__shinken
=> Deleting shinken pack globaldata folder
- Path : /etc/shinken/resource.d/shinken-additional-packs-import/global-data/windows-by-WinRM__shinken/
-----------------------------
| PROBES:
=> Deleting probes
- Path : /var/lib/shinken-user/libexec/shinken-additional-packs/windows-by-WinRM__shinken
==========================================================
PACK [ windows-by-WinRM__shinken v01.00.00 ] SUCCESSFULLY UNINSTALLED
========================================================== |
| Info |
|---|
À noter : les éléments importés dans le Synchronizer ( modèles d'hôtes, checks, ... ) devront être supprimés via les actions de masse. |
Pré-requis pour l'exécution des checks
Les accès côté Windows
Les sondes de ce pack utilisent le protocole de communication WinRM ( Windows Remote Management ) de Microsoft, afin de collecter les informations sur les serveurs.
Cette méthode utilise une connexion via login/password pour accéder aux ressources à collecter et nécessite une configuration sur l'hôte supervisé ( voir la page NEW_PAGE - SPAC-27 - Configuration du Windows supervisé pour le pack windows-by-WinRM__shinken ).
Erreurs lors de l'utilisation du pack
Pour toute erreur survenue lors de l'exécution des checks, voir la page NEW_PAGE - SPAC-27 - Erreurs du pack windows-by-WinRM__shinken

