Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
Panel
titleSommaire

Table of Contents
stylenone

Description

Shinken Entreprise V02.06.00 introduit un nouveau module permettant d'effectuer une sauvegarde automatique à intervalles réguliers de la base de données du Synchronizer.

  • Cela vous permettra, en cas de mauvaise manipulation, de restaurer facilement une ancienne version.
  • Par défaut, une sauvegarde est effectuée toutes les heures, et les données sont conservées pendant 21 jours. Ces paramètres sont configurables, et il est possible de définir des périodes pendant lesquelles la fréquence de sauvegarde est différente.
  • Cette sauvegarde nécessite à priori 200 Mo de RAM.

Cette fonctionnalité est activée automatiquement à l'installation d'une version 2V02.06.6 XX ( ou ultérieure ) mais aussi lors de la mise à jour depuis une version 2V02.05.5XX.


Warning

Ce module ne remplace pas une sauvegarde complète et régulière !

  • En effet, elle ne sauvegarde que les données de la base MongoDB du Synchronizer en l'état.
  • Les fichiers de configuration, les logs, les SLA, les métriques et les données utilisateur ne sont pas traités par ce module.

Pour la gestion des sauvegardes complètes, veuillez-vous référer à Shinken-backup et Shinken-restore, les commandes de sauvegarde et de restauration.

Info

La page Restaurer une sauvegarde automatique de la base de données du Synchronizer explique comment restaurer l'une de ces sauvegardes.

Activation du module

Le module synchronizer-module-database-backup est un module qui peut être activé seulement sur le démon Synchronizer.

  • L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du démon Synchronizer.
  • Pour ce faire, ouvrer le fichier de configuration du Synchronizer à l'emplacement /etc/shinken/synchronizers/synchronizer-master.cfg , et ajouter le nom de votre module "synchronizer-module-database-backup" .


Exemple: par défaut, nous livrons un module dont le nom est "synchronizer-module-database-backup" :

Code Block
languagebash
define synchronizer {
    [...]
    modules                   Module 1, Module 2, Module 3, synchronizer-module-database-backup
    [...]
}


Pour prendre en compte le changement de configuration, redémarrer le Synchronizer:

Code Block
service shinken-synchronizer restart

Configuration

La configuration du module se trouve par défaut dans le fichier  /etc/shinken/modules/synchronizer-module-database-backup.cfg

  • Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/synchronizers/modules/synchronizer-module-database-backup/synchronizer-module-database-backup-example.cfg

Exemple de fichier de configuration

Code Block
languagejs
#===============================================================================
# Configuration Database Backup
#===============================================================================
# Daemons that can load this module:
# - synchronizer
# This module backup the configuration mongo database
#===============================================================================


define module {

    # Shinken Enterprise. Lines added by import core. Do not remove it, it's used by Shinken Enterprise to update your objects if you re-import them.
    _SE_UUID             core-module-91dad8dedeac11e8a43d484d7eb6be52
    _SE_UUID_HASH        83f1c80c198953bd295e3e0b5b285939
    # End of Shinken Enterprise part

    #======== Module identity =========
    # Module name. Must be unique
    module_name                 synchronizer-module-database-backup

    # Module type (to load module code). Do not edit.
    module_type                 synchronizer_module_database_backup

    #======== Backup Rate =========
    # The default backup rate in minutes
    backup_rate                 60

    #======== Work hours  =========
    # You can use the work hours to define a period of time. During this time period, the rate will be modified. Disable by default
    enable_specific_backup_interval_during_working_hours             0

    # Set the works hours. Format is HH:MM
    #work_hours_start            08:00
    #work_hours_end              18:00
    # The days worked in the week to 0 (monday) to 6 (sunday). If not defined, all the days use this timeperiod
    #days_worked                 0-4

    # Rate to backup during non works hours in minutes
    #backup_interval_during_working_hours         15


    #======== Location and name =========
    backup_directory            /var/shinken-user/backup/synchronizer-module-database-backup
    backup_name                 synchronizer_localhost

    #======== Retention =========
    retention_days              21
}
   

Détails des sections composant le fichier de configuration

Identification du module

Il est possible de définir plusieurs instances de module de type MODULE-NAME. "synchronizer-database-backup"   dans votre architecture Shinken .

  • Chaque instance devra avoir un nom unique.


NomTypeUnitéDéfautCommentaire
Code Block
module_name 
Texte--- synchronizer-module-database-backup

Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir.

Doit être unique.

Code Block
module_type 
Texte--- synchronizer_module_database_backup

Ne peut être modifié.

Fréquence de sauvegarde

Code Block
languagejs
   ... 
  #======== Backup Rate =========
  # The default backup rate in minutes
  backup_rate 60    
  ...

Description du chapitreLe module sauvegarde la base du Synchronizer à intervalle régulier. Vous pouvez spécifier cet intervalle selon vos besoins.


NomTypeUnitéDéfautCommentaire
Code Block
 backup_rate 
Entier
Nombre
minutes
Minutes 60
Définit fréquence à laquelle les sauvegarde de la base de données seront réalisées
Fréquence de sauvegarde  ( en minutes ).



Période de travail

xxxxx

Code Block
languagejs
   ... 
  #======== Work hours =========
  # You can use the work hours to define a period of time. During this time period, the rate will be modified. Disable by default
  enable_specific_backup_interval_during_working_hours 0

  # Set the works hours. Format is HH:MM
  #work_hours_start 08:00
  #work_hours_end 18:00
  # The days worked in the week to 0 (monday) to 6 (sunday). If not defined, all the days use this timeperiod
  #days_worked 0-4

  # Rate to backup during non works hours in minutes
  #backup_interval_during_working_hours 15    
  ...

Il est possible de définir des horaires de travail, durant lesquelles, la fréquence des sauvegardes pourra être modifiée.

Cela permet par exemple de faire des sauvegardes plus fréquentes sur vos heures ouvrées et plus espacées en dehors de vos heures de travail afin de limiter le nombre de sauvegardes alors qu'il n'y a pas de modifications de la base.

Description du chapitre

Mettre tous les paramètres présents dans le chapitre de configuration


NomTypeUnitéDéfautCommentaire
Code Block
XXXX 
XXXXXXXXXXXX Code BlockXXXX
 
TexteXXXXXXXX

La sauvegarde est effectuée par un module nommé synchronizer-module-database-backup chargé dans le Synchronizer.

Le fichier de configuration est le suivant : /etc/shinken/modules/synchronizer-module-database-backup.cfg

Info

Lorsque vous modifiez les paramètres de ce module, vous devez redémarrer le Synchronizer pour les prendre en compte.

Voici les paramètres relatifs à la définition des sauvegardes :

Nom du paramètreDescription

Valeur par défaut

backup_rateFréquence de sauvegarde (en minutes)60
enable_specific_backup_interval_during_working_hours
Booléen--- 0

Permet de spécifier une fréquence de sauvegarde différente durant les "horaires de travail".

  • 0 = Périodes "horaires de travail" non activées
  • 1 = Périodes de travail activées
0
Code Block
days
work_hours_
worked
start
HeureHeure:Minutes 08:00

Jours pendant lesquels les "horaires de travail" sont appliqués. 0=lundi, 6=dimanche

Ils sont spécifiés sous la forme d'un intervalle "jour_de_départ"-"jour_de_fin"

Exemple : 0-4 signifie "du lundi au vendredi"

0-6work_hours_start

Pour chaque jour spécifié dans days_worked, heure de début de la période au format HH:MM (Obligatoire si enable_specific_backup_interval_during_working_hours est à 1)

Aucun
Code Block
work_hours_end
HeureHeure:Minutes 18:00 Pour chaque jour spécifié dans days_worked, heure de fin de la période au format HH:MM (Obligatoire si enable_specific_backup_interval_during_working_hours est à 1)
Aucun
Code Block
days_worked
Nombre
0-4

Jours pendant lesquels les "horaires de travail" sont appliqués. 0=lundi, 6=dimanche
Ils sont spécifiés sous la forme d'un intervalle "jour_de_départ"-"jour_de_fin"

Exemple : 0-4 signifie "du lundi au vendredi"

Code Block
backup_interval_during_working_hours
NombreMinute 15 Fréquence de sauvegarde appliquée durant les horaires de travail (en minutes)
15
Voici les paramètres système du module :

Emplacement et nom des sauvegardes

Code Block
languagejs
   ...  
  #======== Location and name =========
  backup_directory /var/shinken-user/backup/synchronizer-module-database-backup
  backup_name synchronizer_localhost    
  ...

Il est possible de paramétrer le nom et l'emplacement des sauvegardes


NomTypeUnitéDéfautCommentaire
Code Block
backup_directory
Texte---
Nom du paramètreDescriptionValeur par défautbackup_directoryRépertoire où les sauvegardes seront stockées
/var/shinken-user/backup/synchronizer-module-database-backup Répertoire où les sauvegardes seront stockées
Code Block
backup_name
Texte--- synchronizer_localhost Chaîne de caractère qui sera ajoutée à l'horodatage pour former le nom des fichiers de sauvegarde
synchronizer_localhost

Rétention des données

Code Block
languagejs
   ...  
  #======== Retention ========= 
  retention_days 21
  ...

Les sauvegarde sont conservé par défaut 21 jours. Vous pouvez modifier cette valeur afin de gagner de l'espace sur le disque.


NomTypeUnitéDéfautCommentaire
Code Block
 retention_days
NombreJours 21 Nombre de jours durant lesquelles les sauvegardes seront conservées sur le disque