Contexte
Ce guide vous
accompagnera dans l’installation ou la mise à jour Shinken Entreprise sur un serveur Linux.
- Une fois le guide d'installation suivi, vous aurez rapidement accès à l'interface de Configuration et de Visualisation de Shinken dans une architecture par défaut, c'est-à-dire sur un serveur simple, sur lequel tous les démons seront activés.
Si vous mettez en place une architecture distribuée, après avoir terminé l'installation de Shinken sur vos différents serveurs, il vous faudra passer à la phase de configuration de vos démons (noms et IP des serveurs, royaume, spare, Tag des Pollers, rétention..).
- En ce qui concerne la procédure de mise à jour, le script "d'update" vous permettra de mettre à jour votre serveur Shinken de manière complète, même si quelques démons sont
- seulement activés. La configuration de votre serveur Shinken ne sera pas modifiée.
| Warning | ||
|---|---|---|
| ||
Lors de l'installation/mise à jour de Shinken Entreprise, le système de gestion de base de données orientée |
documents MongoDB est mis en place |
. Ce système de base de données permettra le bon fonctionnement de l'interface de Configuration et de Visualisation. Utilisé avec une base MongoDB, Graphite, |
quant à lui, |
est un outil |
pour stocker les métriques de vos sondes. Pour ne pas créer de dysfonctionnement, nous vous demandons de ne pas mettre à jour MongoDB / Graphite. Veuillez simplement laisser en place les versions fournies par nos services.
|
Si vous faites une mise à jour de Shinken Entreprise depuis une version antérieure à la 2.6. |
| Panel | ||
|---|---|---|
| ||
|
Installation de Shinken Entreprise
Prérequis
Shinken Entreprise a choisi les distributions produites par Red Hat: Red Hat Enterprise Linux (RHEL) et CentOS (Community enterprise Operating System). Ces distributions Linux, principalement destinées aux serveurs, sont stables, performantes et compatibles avec une très grande majorité des environnements professionnels. La distribution CentOS est elle aussi très performante (basée sur une distribution commerciale RHEL de qualité).
| Info | ||
|---|---|---|
| ||
Lors d'une installation de distribution Redhat Enterprise Linux (commerciale), il faut rattacher votre souscription Redhat à votre système. Voici les commandes à utiliser depuis le serveur: 1/ subscription-manager register et il faut également l'attacher à l'OS en cours: 2/ subscription-manager attach Yum pourra alors être utilisé correctement car l'abonnement sera valide. (et donc Shinken pourra être installé) |
Extraction du package et installation
Installation automatique :
- tar zxvf shinken-enterprise_V02.07.XX-LANGUAGE.tar.gz
- Cela vous créera un répertoire shinken-entreprise contenant le script d’installation et les dépendances nécessaires à l’installation.
| Code Block |
|---|
./install.sh |
| Code Block |
|---|
yum install open-vm-tools |
Vérification du bon fonctionnement
| Code Block |
|---|
shinken-healthcheck |
Votre licence Shinken Enterprise n'est pas installé, c'est normal, dirigez-vous dans la section Clé de licence plus bas sur cette page afin d'installer votre clé.
| Tip |
|---|
L'installation complète fera sur le même serveur :
Pour une installation distribuée, voir la page Architecture Distribuée |
Accès aux interfaces web
Interface Utilisateur (UI) de configuration
Une fois Shinken Enterprise installé, pour accéder à l'UI de configuration, vous devez pointer votre navigateur Web vers l'adresse affichée durant l'installation.
Par défaut, l'interface de configuration est accessible sur le port dédié 7766 (via le protocole HTTP). Par exemple : http://192.168.0.1:7766| Info |
|---|
| L'adresse IP (ou FQDN si votre résolution DNS est opérationnelle) correspond à votre serveur hébergeant le daemon Synchronizer. |
Voir la page Paramétrage de l'interface de Configuration pour plus d'information.
Interface Utilisateur (UI) de visualisation
Une fois Shinken Enterprise installé, pour accéder à l'UI de visualisation, vous devez pointer votre navigateur Web vers l'adresse affichée durant l'installation.
Par défaut, l'interface de configuration est accessible sur le port dédié 7767 (via le protocole HTTP). Par exemple : http://192.168.0.1:7767| Info |
|---|
| L'adresse IP (ou FQDN si votre résolution DNS est opérationnelle) correspond à votre serveur hébergeant le daemon Broker. |
Voir la page Paramétrage de l'interface de Visualisation pour plus d'information.
Intégration du guide d'utilisateur dans le package
Le guide d'utilisateur (en français) est maintenant intégré au package d'installation.
Vous pouvez le retrouver dans : shinken-enterprise_V02.07.XX-LANGUAGE.tar.gz/tools/documentation/ui-visualisation/
Il vous suffira qu'un utilisateur, via son navigateur internet, ouvre le fichier "index.html" afin de pouvoir parcourir le guide d'utilisateur, contenant la documentation liée à l'UI de visualisation.
Installation (Mode avancé)
« Dé-tarez » le package qui vous a été transmis :
--pollernode: active le démon Poller (dédié au lancement des checks)
--reactionnernode: active le démon Reactionner (dédié au lancement des notifications)
--schedulernode: active le démon Scheduler (planificateur des checks)
--arbiternode: active le démon Arbiter (rôle de distribution centrale)
--receivernode: active le démon Receiver (reçoit les checks passifs)
--synchronizernode: active le démon Synchronizer (gère la configuration)
--brokernode: active le démon Broker (export des données pour les interfaces de visualisation)
Une installation Shinken Entreprise peut-être composée de nombreux serveurs pour couvrir plusieurs datacenter/pays, mais chaque serveur inclus dans cette architecture suivra la même procédure d'installation/mise à jour, indépendamment de leur rôle.
Pour mettre en place cette architecture distribuée, il vous faudra passer à la phase de configuration de vos démons ( noms et IP des serveurs, royaume, spare, Tag des Pollers, rétention...).
- Le chapitre Architecture et plus particulièrement la page Architecture Distribuée vous aidera à mieux appréhender les possibilités de Shinken Entreprise en fonction de vos besoins.
REMARQUE: Nous recommandons fortement l'installation des Shinkens sur des machines dédiées, car Shinken entreprise installe tout ce dont il a besoin pour fonctionner et prends soin des mises jours lui-même lors des montés de versions.
| title | Exemple |
|---|
Vous pouvez par exemple installer Shinken Enterprise et activer directement le Scheduler et le Poller en même temps en tapant la commande
| Code Block |
|---|
./install.sh --schedulernode --pollernode |
- Pour vérifier que les démons sélectionnés de Shinken Entreprise sont bien mis à jours, configurés et fonctionnels, lancez la commande :
| Code Block |
|---|
shinken-healthcheck |
Shinken-healthcheck vérifiera alors que Shinken Entreprise est bien configuré et en cours d'exécution (seulement pour les démons installés)
- Après l'installation initiale, si vous souhaitez activer/désactiver des démons, utilisez la commande d'activation détaillée dans le chapitre Activation/Désactivation des démons.
- Lors d'une mise à jour, le script update.sh prends en compte les démons qui sont activés ou non.
Les différents addons sont automatiquement activés lors de l'installation:
- nagvis-shinken-architecture: Activé lors d'une installation d'un Arbiter (plus de détails dans la page de documentation dédiée: Activation et configuration de la fonctionnalité)
- nagvis: Activé lors d'une installation d'un Broker (plus de détails dans la page de documentation dédiée: NagVis)
Mise en place automatique du chiffrement
Vous pouvez mettre en place le Chiffrement des données sensibles de façon automatique au moment de l'installation.
| Tip |
|---|
Si vous n'avez jamais activé le chiffrement des données sensibles, nous vous conseillons de procéder à l’installation sans activer le chiffrement et de découvrir la fonctionnalité par la lecture du chapitre Chiffrement des données sensibles. |
Une clé de chiffrement sera alors générée lors du processus d'installation et la base de données du Synchronizer sera chiffrée.
Pour cela, lancez la commande suivante :
| Code Block |
|---|
./install.sh --activate-encryption <nom de clé> --disable-important-notices-user-input |
- Le paramètre --activate-encryption permet d'activer le chiffrement ; le nom de la clé est optionnel ; il vous sera demandé lors de l'exécution du programme d'installation si vous ne le précisez pas.
- Le paramètre --disable-important-notices-user-input permet de désactiver les prompts vous demandant confirmation avant de continuer le processus.
Il vous est cependant fortement conseillé de lire les informations fournies lors de l'installation.
| Warning |
|---|
La mise en place automatique du chiffrement nécessite dans tout les cas d'effectuer l'export et la sauvegarde de la clé générée lors du processus. Veuillez consulter shinken-protected-fields-keyfile-export pour plus d'informations. |
Shinken-healthcheck vous permettra dé vérifier la bonne configuration des démons et du chiffrement.
Mise à jour de Shinken Entreprise
Prérequis
| Note | ||
|---|---|---|
| ||
Pour mettre à jour d'une version mineure à la majeure suivante, il faut faire attention de bien avoir la dernière itération de cette version. - Par exemple, pour la mise à jour en V02.07.XX, il faut s'assurer d'avoir installé la V02.05.03 (dernière V02.05) avant d'effectuer la mise à jour. - N'hésitez pas à vérifier ce point avec votre revendeur ou Shinken Solutions. |
Extraction et mise à jour
- tar zxvf shinken-enterprise_V02.07.XX-LANGUAGE.tar.gz
- Cela vous créera un répertoire shinken-entreprise contenant le script de mise à jour et les dépendances nécessaires à la mise à jour.
| Code Block |
|---|
./update.sh |
- Il mettra à jour Shinken Entreprise mais n'aura aucune incidence sur le dossier de configuration de /etc/shinken, évitant tout risque d’écrasement d'une configuration que vous auriez définie.
- Au lieu d'écraser votre paramétrage, des fichiers "*.cfg.rpmnew" seront ajoutés. De nouvelles propriétés pourront figurer dans ces fichiers, il est donc conseiller de parcourir ces fichiers et si besoin, récupérer ces nouvelles propriétés pour les intégrer dans votre architecture.
- Avant la mise à jour, une sauvegarde de la configuration et des données utilisateur est effectuée et placée dans /tmp. Ces sauvegardes sont nommées de la manière suivante: "backup-preupdate-version-NUMERO_VERSION".
En cas d'erreur lors de la mise à jour, le script update.sh peut s'interrompre pour que vous puissiez corriger le problème. Les erreurs les plus courantes sont les suivantes :
Vérifiez que celle-ci est démarrée :
Sous CentOS ou RHEL 6
| Code Block |
|---|
service mongod status |
Sous CentOS ou RHEL 7
| Code Block |
|---|
systemctl status mongod |
Redémarrez mongod si le démon est arrêté
Sous CentOS ou RHEL 6
| Code Block |
|---|
service mongod start |
Sous CentOS ou RHEL 7
| Code Block |
|---|
systemctl start mongod |
Le script de mise à jour refuse de s'exécuter avec l'erreur suivante :
| No Format |
|---|
ERROR: Mongodb is already installed but your Mongodb version XX.YY.ZZ is not supported for install/update" |
En cas de doute, n'hésitez pas à contacter votre support.
Ajout du bac à événements
Lors d'une nouvelle installation, le bac à événements est automatiquement mis en place.
Lors d'une mise à jour depuis une version antérieure, avec une architecture complexe, le script de mise à jour ne peut pas toujours déterminer avec certitude sur quels brokers et quelles Web-UI le bac à événements doit être installé.
C'est pourquoi vous devez vous-même effectuer la configuration manuellement.
Il est nécessaire d'ajouter les modules :
event-manager-writersur vos brokersevent-manager-readersur vos WebUI
Veuillez consulter la page du Module Bac à événement pour plus de détail sur l'architecture du module.
Vérification du bon fonctionnement
| Code Block |
|---|
shinken-healthcheck |
Mise à jour des checks via la source cfg-file-shinken
Lors de l'installation de Shinken, nous incluons de nombreux checks (via des modèles du Pack Shinken, Linux, Windows,..).
Ces éléments de ces packs (checks, modèles, commandes) sont disponibles au travers de la source "cfg-file-shinken" :
| Panel |
|---|
|
Lors d'une update, nous vous fournissons également toutes les mises à jour de ces packs, nous vous conseillons donc d'activer la source et de bien regarder les mises à jour possibles, via les éléments qui apparaîtront en "nouveau" et en "différence".
| Info |
|---|
Si vous avez déjà fait des personnalisations sur les éléments de ces packs, soyez vigilant avant d'appliquer les différences. |
Clé de licence Shinken Enterprise
La licence par défaut installée est une licence d'essai. Vous ne pourrez placer en supervision qu'un très faible nombre d'hôtes.
| Panel |
|---|
|
Le service Commercial de Shinken Enterprise a dû vous envoyer une licence nominative vous permettant d'utiliser pleinement le produit.
La licence est un fichier qui a le nom suivant : user.key et cette licence est nominative et limitée dans le temps.
Pour l'installer, rien de plus simple, il suffit de :
- Placer ce fichier sur le serveur hébergeant l'arbiter et sur les serveurs hébergeant le ou les UIs de Visualisation , dans le chemin suivant : /etc/shinken/user.key
- Redémarrez alors Shinken Enterprise via la commande : service shinken restart
Relancez alors la commande shinken-healthcheck le message d'erreur de licence doit avoir disparu et voici un exemple d'information de licence valide :
| Panel |
|---|
|
Si vous n'avez pas de clé de licence ou que celle ci a expiré contactez-nous : contact@shinken-solutions.com
Résolution des problèmes liés à l'installation/mise à jour
Lors de l'installation des dépendances, si une machine n'est pas connectée à internet ou connecté à un repository privé, il arrive que les scripts d'installation ou de mise à jour échouent.
Dans ce cas, des fichiers sont créés dans le "home" de l'utilisateur avec lequel est effectué l'installation/mise à jour. Ces fichiers contiennent plus de détails sur les erreurs rencontrées et peuvent être envoyés à votre contact de support Shinken Entreprise pour la correction du problème.
Pour chaque installation/mise à jour, un dossier est créé dans ~/shinken et nommé de la manière suivante:
- Pour une installation:
| Code Block |
|---|
~/shinken/install-<date>-<version> |
- Pour une mise à jour:
| Code Block |
|---|
~/shinken/update-<date>-<version> |
Ces dossiers contiennent les données suivantes:
- Affichage du script d'installation (installation seulement): shinken.enterprise.install.log
Détails d'installation des paquets: shinken.enterprise.install.detail.log
Nettoyage de la configuration: sanatize.update.log
Affichage du script de mise à jour (mise à jour seulement): shinken.enterprise.update.log
- Backup de la configuration et données utilisateur (mise à jour seulement)
| Panel |
|---|
|
Cas spécifique de la mise à jour d'un cluster Mongo
Dans la version V02.07.00, la base Mongodb est mise à jour. Lorsque Mongodb a été configuré pour fonctionner en tant que cluster, le comportement du script de mise à jour de Shinken Entreprise a été modifié pour prendre en compte cette configuration particulière. Des explication détaillées sont présentes dans la page de documentation dédiée: Mise à jour d'un cluster Mongodb