Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=clean_corrupted_html
Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltruefalse
Panel
titleSommaire

Table of Contents
stylenone
printablefalse

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 Synchroniser 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

L'installation du pack sur l'infrastructure Shinken

Installation de dépendance : VENV__plugins-packs__shinken

En préambule, il faut :

  1. récupérer Récupérer la dernière version du pack contenant le VENV auprès de l'équipe Shinken,
  2. 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

Les checks suivants utilisent un environnement virtuel python, livré par shinken :

  • Certificate Expiration $KEY$ by WinRM


Pour le bon fonctionnement des checks ci-dessus, il est nécessaire d'installer cet environnement python.

L'installation de l'environnement virtuel s'effectue en deux étapes :


Récupérer l'archive tar.xz de l'environnement virtuel

Chaque pack requiert une version minimale de l'environnement virtuel pour fonctionner. Les versions sont rétrocompatibles. Il est donc recommandé de toujours utiliser la dernière version disponible de l'environnement virtuel.

PackEnvironnement Virtuel minimum
windows-by-WinRMV01.00.02


décompresser l'archive tar.xz de l'environnement virtuel sur tous les serveurs Shinken avec un poller ou synchronizer et lancer l'installation

Décompresser l'archive sur les serveurs Shinken

Code Block
themeEmacs
tar -xJf VENV__plugins-packs__shinken__VXX.XX.XX__Linux.tar.xz

Rentrer dans le répertoire créé à la suite de la décompression, et exécuter le script d'installation

Code Block
themeEmacs
cd VENV__plugins-packs__shinken__VXX.XX.XX__Linux
./install-venv.sh

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

Commun à tout Poller / Synchronizer

Que ce soit sur un Synchronizer ou sur un Poller :

  1. Désarchiver le pack :

    Code Block
    languagetext
    themeEmacs
    tar --no-same-owner -xf NOM_DU_PACK.tar.xz
  2. Entrer dans le répertoire extrait de l'archive et lancer le "install.sh"

    Code Block
    languagetext
    themeEmacs
    cd NOM_DU_PACK/
    ./install.sh
  3. 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
languagetext
themeEmacs
========================================================
PRE-INSTALLATION CHECKS
========================================================

No previous installation detected. Proceeding with installation...


========================================================
INSTALL PACK [ windows-by-WinRM__shinken v02.02.00 ]
========================================================

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

        => Collector cfg file already AVAILABLE

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

  • Désarchiver le pack :

    Code Block
    languagetext
    themeEmacs
    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"

    Code Block
    languagetext
    themeEmacs
    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
    languagetext
    themeEmacs
    ======================================================== INSTALL PACK [ windows-by-WinRM__shinken v01.00.00 ] ======================================================== ----------------------------- | 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
    Path 
    rights -----------------------------
    : /etc/shinken/sources/shinken-additional-packs-import.cfg
    
        
    |
       
    MONITORING DEFINITION:
     => Collector DATA space already AVAILABLE
        
    =>
     
    Installing
     
    definitions
     
    file
     
    in
     
    source-data
     
    folder
     
    (
     
    Collector
     
    => shinken-additional-packs-import )
     
    - Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import
    
            => Definition File already AVAILABLE [ definition_shinken-
    Setting owner ( to "shinken" user )
    additional-packs-import.cfg ]
                  - 
    Setting
    Path 
    rights
    : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/definition_shinken-additional-packs-import.cfg
    
           
    =>
     
    Installing global data definitions file in SHINKEN directory (
    => 
    resource.d
    Applying 
    )
    permissions
                  - Path : /etc/shinken
    /resource.d/
    -user/source-data/source-data-shinken-additional-packs-import
    /
    
                  - Setting owner ( to "shinken" user )
                  - Setting rights
    
        -----------------------------
        |   MONITORING 
    PROBES
    DEFINITION:
    
            =>
    Deleting previous probes
     Installing definitions file in source-data folder ( Collector => shinken-additional-packs-import )
                  - Path : /
    var/lib
    etc/shinken-user/
    libexec/
    source-data/source-data-shinken-additional-packs
    /windows-by-WinRM__shinken
    -import
            
    =>
     
    Installing probes
         - Setting owner ( to "shinken" user )
                  - 
    Path : /var/lib/shinken-user/libexec/shinken-additional-packs/windows-by-WinRM__shinken - Setting owner ( to "shinken" user ) - Setting rights

    En suivant, spécifiquement sur le Synchronizer

    Si le collecteur "shinken-additional-packs-import" n'est pas présent dans votre Synchronizer ( par exemple : lors de la première utilisation d'un installeur de pack Shinken ) :
    Ajouter le nom de la nouvelle source au Synchronizer en modifiant le paramètre sourcesdu fichier  /etc/shinken/synchronizers/synchronizer-master.cfg.
    Code Block
    languagetext
    themeEmacs
    define synchronizer {
        [...]
        sources                   Source 1, Source 2, Source 3, shinken-additional-packs-import
        [...]
    }

    et en suivant, redémarrez le Synchronizer pour que le collecteur soit pris en compte :

    Code Block
    languagetext
    themeEmacs
    service shinken-synchronizer restart
    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
    iconfalse

     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
    languagetext
    themeEmacs
    ========================================================
    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/windows-by-WinRM__shinken
                  - /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/windows-by-WinRM__shinken
                  - /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/windows-by-WinRM__shinken
                  - /etc/shinken/resource.d/shinken-additional-packs-import/global-data/windows-by-WinRM__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

    1. 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
      languagetext
      themeEmacs
      cat /etc/shinken/synchronizers/synchronizer-master.cfg
      Code Block
      languagejs
      themeConfluence
      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
      languagetext
      themeEmacs
      service-shinken-synchronizer restart
      Note
      iconfalse

      Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante :

      Code Block
      languagetext
      themeEmacs
      service shinken-synchronizer restart
    2. Activer le collecteur "shinken-additional-packs-import" si ce n'est pas déja fait.

      Panel

      Image Added

    3. Lancer l'import du collecteur "shinken-additional-packs-import" :

      Panel

      Image Added


      • 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 ).

    4. 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
      languagetext
      themeEmacs
      service-shinken-synchronizer restart
      Note
      iconfalse

      Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante :

      Code Block
      languagetext
      themeEmacs
      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 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
    languagetext
    themeEmacs
    rm -rf /var/lib/shinken-user/libexec/shinken-additional-packs/windows-by-WinRM__shinken
    rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/windows-by-WinRM__shinken
    rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/windows-by-WinRM__shinken
    rm -rf /etc/shinken/resource.d/shinken-additional-packs-import/global-data/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
    languagetext
    themeEmacs
    tar -xjfv --no-same-owner PACK__shinken__NOM-DU-PACK__VERSION__linux.tar.xz -C ./
    • Pour Windows ( Rôle de Poller )
    Lancer l'import du collecteur "shinken-additional-packs-import":
    Panel

    Image Removed

    • Ensuite, certaines nouveautés ou différences liées à l'évolution du pack peuvent nécessiter une validation.

    Ou manuellement ( si ne vous voulez pas utiliser l'install.sh )

    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
    languagetext
    themeEmacs
    rmtar -rf /var/lib/shinken-user/libexec/shinken-additional-packs/windows-by-WinRM__shinken
    Extraire le pack
    xvzf PACK__shinken__NOM-DU-PACK__VERSION__windows.tar.gz -C ./

    Entrer dans le répertoire créé :

    Code Block
    languagetext
    themeEmacs
    cd NOM_DU_PACK/
    Les sondes ( mises en place )

    On place les sondes

    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__NON-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 de la création du pack )

    :

    Code Block
    languagetext
    themeEmacs
    tar -xjfv --no-same-owner PACK__shinken__NON-DU-PACK__VERSION__linux.tar.xz -C ./
    • Pour Windows ( Rôle de Poller ) :
    Code Block
    languagetext
    themeEmacs
    tar -xvzf PACK__shinken__NOM-DU-PACK__VERSION__windows.tar.gz -C ./

    Entrez dans le répertoire créér :

    Code Block
    languagetext
    themeEmacs
    cd NOM_DU_PACK/
    Les sondes ( mises en place )

    On place les sondes :

    Code Block
    languagetext
    themeEmacs
    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

    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
          languagetext
          themeEmacs
          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

    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.
      • 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 :

          Code Block
          languagetext
          themeEmacs
          shinken_collectorpack_dataglobaldata_path="/etc/shinken-user/source-data/source-data-/resource.d/shinken-additional-packs-import"
          mkdir --parents $shinken_pack_globaldata_path
          cp -r "./monitoring-definitions/packs/* global-data" "$shinken_collectorpack_dataglobaldata_path"
          chown -R shinken:shinken "$shinken_collectorpack_dataglobaldata_path
          chmod -R 744 $shinken_collector_data_path
          Ensuite, les données globales
          "
          chmod -R 744 "$shinken_pack_globaldata_path"
    • Redémarrer le Synchronizer

      Section
      Code Block
      languagetext
      themeEmacs
      service-shinken-synchronizer restart
      Note
      iconfalse

      Pour les versions de shinken strictement inférieures à V02.08.02-RC018.05, il faudra utiliser la commande suivante :

      Code Block
      languagetext
      themeEmacs
      service shinken-synchronizer restart
    • shinken_pack_globaldata_path="/etc/shinken/resource.d/

      Activer le collecteur  "

      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"

      :

      Panel

      Image Added

    • Lancer l'import du collecteur "shinken-additional-packs-import",

      Panel

      Image Added


      • 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.

      Section
      Redémarrer shinken
      Code Block
      languagetext
      themeEmacs
      service
      -shinken-synchronizer restart

      Lancer l'import du collecteur "shinken-additional-packs-import",

      Panel

      Image Removed

      • 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 ).

      Note
      iconfalse

      Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante :

      Code Block
      languagetext
      themeEmacs
      service shinken-synchronizer restart

    Le dossier extrait lors de la décompression du pack peut également être supprimé à l’aide de Vous pouvez également supprimer le dossier qui a été créé suite à la décompression du pack en utilisant la commande suivante :

    Code Block
    languagetext
    themeEmacs
    rm -rf ./PACK__windows-by-WinRM__shinken__V02.00.00__Linux
    Info

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

    Si vous avez déjà installé une version précédente de ce pack, il vous faudra du pack a déjà été installée, il est recommandé de supprimer les anciens dossiers dans lesquels le pack était présent ( afin d'éviter de garder d'ancien fichier en cas d'évolution pour éviter de conserver des fichiers obsolètes, notamment en cas de modification de la structure du pack ).Pour supprimer ces dossiers, utilisez la commande suivante .

    Utiliser les commandes suivantes pour effectuer cette suppression :

    Code Block
    languagetext
    themeEmacs
    rm -rf /var/lib/shinken-user/libexec/shinken-additional-packs/windows-by-WinRM__shinken
    rm -rf /etc/shinken-user/sources/source-data/source-data-shinken-additional-packs-import.cfg/packs/windows-by-WinRM__shinken
    rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/windows-by-WinRM__shinken
    rm -rf /var/libetc/shinken-user/libexecresource.d/shinken-additional-packs-import/windows-by-WinRM__shinken

    Installation des dépendances sur le Poller

    Sur un Poller Linux

    Pour les connexions NTLM

    L'authentification NTLM nécessite l'installation de la librairie suivante :

    Code Block
    gssntlmssp

    Sur un Poller Windows

    global-data/windows-by-WinRM__shinken

    Désinstaller

    Desinstaller

    le pack avec "uninstall.sh"

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

    Code Block
    languagetext
    themeEmacs
    cd PACK__windows-by-WinRM__shinken__VX.X.X-RCXXX__Linux
    ./uninstall.sh

    Ce mécanisme va seulement enlever supprime uniquement les fichiers mis en place lors de l'installation installés ( 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 Les éléments déjà absorbés dans le Synchronizer ne sont pas affectés.


    Code Block
    languagetext
    themeEmacs
    ==========================================================
    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 :  Vous devrez retirer les éléments importés dans le Synchronizer ( modèles d'hôtes, checks, ... ) devront être supprimés via les actions de massesmasse.

    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 des serveurs Windows.

    Cette méthode utilise une connexion via login utilisateur / password mot de passe pour accéder aux ressources à collecter et nécessite une configuration sur l'hôte le serveur Windows supervisé ( voir la page NEW_PAGE - SPAC-27 - Configuration de WinRM sur poste Windows supervisé ). 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 Erreurs du pack windows-by-WinRM__shinken