Contexte

Le pack docker-by-SSH__shinken permet de superviser les conteneurs en cours de fonctionnement dans une instance Docker. Les vérifications sont effectués grâce à une connexion SSH.

• Le pack vous permet de vérifier, pour chaque conteneur :
  • l'état ( Status, Uptime, Restart, Health ) de fonctionnement.
  • l'utilisation ( CPU, mémoire ) des ressources.
  • l'image ( Image-age ) utilisée.
• Les commandes de vérifications exectués depuis les serveurs Shinken utilisent une sonde PYTHON présente dans le répertoire des sondes Shinken  /var/lib/shinken-user/libexec/shinken-additional-packs/docker-by-SSH_shinken/   (   ou $DOCKER-BY-SSH__SHINKEN__PLUGINSDIR$ depuis l'interface de configuration  ), après la mise en place du pack.

Pour s'adapter à tous les besoins, le pack se compose de deux grandes familles de modèles d'hôtes :

• Les modèles "all-containers", pour superviser tous les conteneurs d'un coup ( qui permettent de mettre rapidement une instance Docker en supervision, sans connaître le nom des conteneurs ) :
  • docker-by-SSH__all-containers qui permet la supervision de l'ensemble des conteneurs pour une vérification des fonctions principales ( CPU, mémoire, Status, Uptime ).
  • docker-by-SSH__all-containers__advanced qui permet, en complément du modèle docker-by-SSH__all-containers, de relever des indicateurs plus poussés ( Image-age, Restarts ).
  • docker-by-SSH__all-containers __extra qui offre la possibilité de mettre sous surveillance des éléments de configuration spécifiques ( Health ).

• Les modèles "selected-containers", pour superviser les conteneurs un par un ( qui permettent d'orienter les vérifications sur des conteneurs spécifiques ) :
  • docker-by-SSH__selected-containers qui permet la supervision d'un conteneur spécifique pour une vérification des fonctions principales ( CPU, mémoire, Status, Uptime ).
  • docker-by-SSH__selected-containers__advanced qui permet, en complément du modèle docker-by-SSH__selected-containers, de relever des indicateurs plus poussés sur un conteneur spécifique ( Image-age, Restarts ).
  • docker-by-SSH__selected-containers __extra qui offre la possibilité, sur un conteneur spécifique, de mettre sous surveillance des éléments de configuration spécifiques ( Health ).

Ce pack est importé et mis à jour par la source " shinken-additional-packs-import ".

Comment utiliser son pack ?

Mise en place

Pour utiliser les packs externes Shinken, il faut commencer par les installer sur son infrastructure Shinken. Cette action permet :

• D'installer sur les serveurs les sondes nécessaires aux vérifications.
• De faire apparaître sur l'interface de configuration les nouveaux modèles.
• De configurer l'hôtes à superviser ( instance docker ) pour accepter les requêtes de supervision.

Une page dédiée explique comment mettre en place le pack docker-by-SSH ( Page Mise en place du pack docker-by-SSH__shinken ).

Utilisation

Choisir les modèles d'hôtes

Une fois le pack installé, il suffit d'appliquer les modèles nouvellement importés sur les hôtes à superviser :

• En utilisant l'interface de configuration : Créez ou éditez un Hôte, et ajoutez un des modèles ; "docker-by-SSH__all-containers"  par exemple ; grâce au menu déroulant ( voir la page Éditer un Hôte  ).
• En éditant les fichiers de définition d'élément ( .cfg ) : 
  • Dans un fichier de configuration, créez ou éditez votre définition d'hôte en ajoutant, dans la propriété "use", la valeur " docker-by-SSH__all-containers".
  • Le fichier de configuration devra alors être importé avec une source ( voir la page Collecteur de type ( cfg-file-import ) - Import depuis des fichiers au format .cfg  ).

Listes des modèles à utiliser dans le pack

Configurer l'accès aux équipements à superviser

Pour savoir comment configurer l'accès SSH de docker ( voir la page Configuration du Docker supervisé pour le pack docker-by-SSH__shinken ).

Personnaliser son pack

Il est possible de modifier certains éléments (  commandes, checks ou modèles d'hôtes  )

• voir la page Les bonnes pratiques d'utilisation d'un pack livré par Shinken .

Version des scripts livrés