Context
To prevent data-loss after a crash of one or several servers used in your Shinken architecture, we advise to use the shinken-backup and shinken-restore commands.
These two commands allow to save and restore a part or all of the Shinken configuration on a Shinken server.
Backup command
Utilization
The basic command to use to perform a complete backup of Shinken Enterprise data is the following:
shinken-backup |
A lot of different parameters can alter what is put in the backup archive:
| Option | Short option | Description | Daemon containing data to backup |
|---|---|---|---|
| --help | -h | Displays the command's help | All |
| --sla | -s | Saves SLA data | Broker |
| --user | -u | Saves data of users from the Visualization UI (custom lists, dashboards and hives, ...) | Broker |
| --configuration | -c | Saves configuration data (hosts, checks, templates, users, ...) | Synchronizer |
| --metrology | -m | Saves metrology data (metrics) | Broker |
| --log | -l | Saves logs | All |
| --output-directory [dir] | -od [dir] | Allows to choose where to put the data | |
| --output-name [name] | -on [name] | Allows to choose a name for the backup archive |
Because the shinken-backup command saves the content of /etc/shinken et /etc/shinken-user folders, it can be used when executed from these folders. Also, check that you use this backup tool on the correct server. For example, trying to save SLA data on a Poller server will not save any actual SLA data, because SLA data are stored on the Broker server. |
Saving data in encrypted configurations
Lorsqu'un backup de données de configuration avec des données protégées est effectué, shinken-backup affiche un avertissement si la clé n'a pas été sauvegardée.
Le backup est tout de même effectué mais vous devez effectuer une sauvegarde de la clé en utilisant la commande shinken-protected-fields-keyfile-export avant toute autre opération impliquant un changement de clé.
Le message suivant apparaîtra si vous n'avez pas effectué de sauvegarde de la clé avant la sauegarde de la configuration :
The protected fields key from this backup looks like it has never been saved
Si la sauvegarde de la clé a été effectuée par la suite, vous pouvez ignorer ce message et restaurer la clé selon la la procédure de restoration habituelle.
|
Exemples
Voici un exemple de sauvegarde complete d'un serveur hébergeant l'ensemble des démons :
root@vm-shinken: ~ $ shinken-backup Saving Sla Sla save size: 360M Saving User User save size: 72K Saving Configuration Configuration save size: 8.0M Saving Metrology Metrology save size: 3.9M Saving Logs Logs save size: 2.8M Done : your backup directory is /root/shinken-backups/2017-11-13__17-50-33 |
Exemple de la sauvegarde de la configuration sur un serveur hébergeant le démon Synchronizer :
root@vm-shinken: ~ $ shinken-backup --configuration Saving Configuration Configuration save size: 3.1M Done : your backup directory is /root/shinken-backups/2017-11-10__17-46-11 |
Commande de restauration
Utilisation
shinken-restore DIRECTORY-TO-RESTORE |
Le dossier "DIRECTORY-TO-RESTORE" doit contenir les dossiers de backups comme : configuration/ metrology/ user/ sla/ context/
Les différences options possibles :
| Option | Option court | Description | Démon sur lequel se trouve les données à restaurer |
|---|---|---|---|
| --help | -h | Affiche l'aide de la commande | Tous |
| --sla | -s | Restaure les données SLA | Broker |
| --user | -u | Restaure les données des utilisateurs de l'UI de visualisation (portails, listes, favoris, tableaux de bords..) | Broker |
| --restore-only-user [USER] | Restaure les données de l'UI de visualisation (portails, listes, favoris, tableaux de bords..) pour l'utilisateur spécifié - à utiliser avec l'option -u
| Broker | |
| --configuration | -c | Restaure les données de configuration | Synchronizer |
| --with-key-backup [HASH] | Pour un backup contenant des données protégées, restaure également la clé de chiffrement spécifiée. Il s'agit du résultat de la commande shinken-protected-fields-keyfile-export. | Synchronizer | |
| --metrology | -m | Restaure les données de métrologie | Broker |
| --log | -l | Restaure les logs | Tous |
Cette option ne demande pas le redémarrage de Shinken Restauration d'une base de données de configuration dont les données sensibles sont chiffrées
Shinken-restore mettra en place votre sauvegarde, mais vous demandera de restaurer la clé.
- Le Synchronizer refusera de démarrer tant que la clé n'est pas restaurée.
Le shinken-restore met aussi l'option --with-key-backup qui vous permet de faire la restauration et de placer automatiquement la clef fournie. Vous aurez juste en suivant à redémarrer le Synchronizer.
Si vous avez égaré votre clé, nous vous conseillons de lire la page de la documentation "shinken-protected-fields-keyfile-rescue-from-backup". Cette commande vous permettre de restaurer votre clef via l'intermédiaire du support Shinken.
|
Exemples
Voici un exemple de restauration d'un backup complet Shinken depuis le dossier ~/shinken-backups :
root@vm-shinken: ~/shinken-backups $ shinken-restore 2017-11-09__16-16-53 Stopping Shinken before restoring Restoring from 02.04.01.fr to 02.04.02.fr -Restoring Sla DONE -Restoring User DONE -Restoring Configuration DONE -Restoring Metrology DONE -Restoring Logs DONE Sanatizing your restored data fix_double_link : skip (unecessary) fix_double_sync_keys : skip (unecessary) fix_default_item_se_uuid : skip (unecessary) fix_remove_shinken_core : skip (unecessary) fix_remove_deprecated_check : skip (unecessary) fix_remove_undefined_aix_templates : skip (unecessary) fix_flapping_thresholds : skip (unecessary) fix_business_impact : skip (unecessary) Done. You can restart your shinken with /etc/init.d/shinken start |
Après la restauration des données, des scripts de "Sanatize" sont lancés. Ces scripts permettent, si nécessaire, de réparer certaines incohérences dans vos données. Une fois la restauration terminée, vous devez démarrer Shinken. |
Voici un autre exemple de restauration d'un backup de la configuration de Shinken, lancé depuis le serveur hébergeant l'Arbiter/Synchronizer :
root@vm-shinken: ~/shinken-backups $ shinken-restore --configuration 2017-11-08__10-58-54 Stopping Shinken before restoring Restoring from 02.04.01-release to 02.04.02-release -Restoring Configuration DONE Sanatizing your restored data fix_double_link : executed [OK] fix_double_sync_keys : skip (unecessary) fix_default_item_se_uuid : skip (unecessary) fix_remove_shinken_core : skip (unecessary) fix_remove_deprecated_check : skip (unecessary) fix_remove_undefined_aix_templates : skip (unecessary) fix_flapping_thresholds : skip (unecessary) fix_business_impact : skip (unecessary) Done. You can restart your shinken with /etc/init.d/shinken start |
Voici un dernier exemple de restauration d'un backup des données de l'utilisateur "monutilisateur" de Shinken (portails, listes, favoris, tableaux de bords), lancé depuis le serveur hébergeant le Broker :
root@vm-shinken: ~/shinken-backups $ shinken-restore -u --restore-only-user monutilisateur 2017-12-13__11-44-49/ Restoring from 02.04.01-release to 02.04.03-release -Restoring User Restoring only the user monutilisateur Restore of the user monutilisateur data is OK |