Roles Rôle « Backup »

22 octobre 2025 à 16:34

Ce rôle est chargé d’installer le système de sauvegarde sur le serveur et de gérer les configurations de sauvegarde.

Remarque : Prend en charge le nouveau fichier de configuration et l’absence de l’ancien fichier de configuration.

Tags internes

  • packages: Installation et configuration des packages ;

Traitements spécifiques du jeu de tâches

Afin de permettre de filtrer les bases de données lorsque l’on souhaite limiter l’exécution (comme avec les tags), les noms de variable à fournir sont différents de ceux attendus par le rôle « Backup ».

Variable côté jeu de tâches Variable côté rôle
backup_databases backup_mysql
backup_pg_databases backup_pgsql

Les bases de données MySQL spécifiées dans les vhosts sont aussi intégrées. Voir CustomVhostsUsers. Pour ce faire, la variable globale backup_mysql_defaults est à définir avec les options par défaut et une propriété optionnelle backup est acceptée sur les éléments. De même pour les bases de données PostgreSQL, qui nécessitent la variable globale backup_pgsql_defaults.

Propriété / Variable Type Requis Défaut Description
backup_mysql_defaults Objet database_config Oui Configuration par défaut de la sauvegarde
backup_pgsql_defaults Objet pg_database_config Oui Configuration par défaut de la sauvegarde
backup Objet database_config Non Absent configuration de la sauvegarde

Type database_config

Dérivé du type database. La propriété name est ignorée.

Type pg_database_config

Dérivé du type pg_database. La propriété name est ignorée.

Variables à fournir

Variable Type Requis Défaut Description
backup_vhosts Liste d’objets vhost Non Liste vide Sauvegarde séparée de sous-dossier dans le dossier configuré
backup_mysql Liste d’objets database Non Liste vide Sauvegarde d’une base de données MySQL
backup_pgsql Liste d’objets pg_database Non Liste vide Sauvegarde d’une base de données PostgreSQL
backup_app Liste d’objets app Non Liste vide Sauvegarde d’un dossier spécifique
backup_host FQDN Oui Vide Nom dans l’inventaire de l’hôte de sauvegarde
backup_host_name FQDN [’:’ <numéro port>] Non Vide Nom de domaine à utiliser pour accéder à l’hôte au lieu de celui de l’inventaire
backup_host_user Identifiant Oui Vide Nom d’utilisateur dans l’hôte de sauvegarde avec lequel transférer les fichiers
backup_host_dir Chemin Oui Vide Chemin vers l’emplacement de sauvegarde
backup_hosts Liste d’objets bck_host Non Vide Hôtes de sauvegarde supplémentaires
backup_install_mysql Booléen Non Faux Indique si le client mysql en ligne de commande doit être installé
backup_package_server_url Url Oui Vide Adresse du dépôt debian contenant le paquet
backup_package_server_key Url Oui Vide Adresse du fichier de clé du dépôt
backup_disable Boolean Non Faux Ne pas activer le processus de sauvegarde automatiquement
backup_server_name Identifiant Non Vide Nom de serveur à utiliser à la place du nom d’inventaire
force_backup Booléen Non Faux Paramètre pour forcer la génération des clés et des options (extra args)

Type vhost

Propriété Type Requis Défaut Description
name Identifiant Oui Nom de la configuration
path Chemin absolut Oui Chemin vers le dossier contenant les dossiers à sauvegarder
hour Entier de 00 à 23 Oui Heure de la sauvegarde sur deux chiffres
auto Booléen [yes/no] Oui Effectuer la sauvegarde à l’horaire indiqué
available Booléen [yes/no] Non yes La configuration est active
vhosts Liste d’objet vhostover Non Liste vide Surcharge de la configuration par dossier

Type vhostover

Propriété Type Requis Défaut Description
path Segment de chemin Oui Nom du dossier sauvegardé
auto Booléen [yes/no/default] Oui Effectuer la sauvegarde à l’horaire indiqué, default pour hériter la valeur
time Entier de 00 à 23 Oui Heure de la sauvegarde sur deux chiffres

Type database

Propriété Type Requis Défaut Description
name Identifiant Oui Nom de la base de données
sysmaint Booléen [yes/no] Non no Utiliser l’utilisateur de maintenance système
user Texte Si sysmaint=no Nom d’utilisateur pour se connecter à la base de données
password Texte Si sysmaint=no Mot de passe de l’utilisateur de la base de données
hour Entier de 00 à 23 Oui Heure de la sauvegarde sur deux chiffres
auto Booléen [yes/no] Oui Effectuer la sauvegarde à l’horaire indiqué
available Booléen [yes/no] Non yes La configuration est active
host FQDN Non Absent L’hôte de base de données auquel se connecter

Type pg_database

Propriété Type Requis Défaut Description
name Identifiant Oui Nom de la base de données
host FQDN Non localhost L’hôte de base de données auquel se connecter
port Entier 1-65535 Non 5432 L’hôte de base de données auquel se connecter
user Texte Oui Nom d’utilisateur pour se connecter à la base de données
password Texte Oui Mot de passe de l’utilisateur de la base de données
hour Entier de 00 à 23 Oui Heure de la sauvegarde sur deux chiffres
auto Booléen [yes/no] Oui Effectuer la sauvegarde à l’horaire indiqué
available Booléen [yes/no] Non yes La configuration est active

Type app

Propriété Type Requis Défaut Description
name Identifiant Oui Nom de l’application
instance Identifiant Oui Nom de l’instance de l’application
path Chemin absolut Oui Chemin vers le dossier contenant l’instance de l’application
hour Entier de 00 à 23 Oui Heure de la sauvegarde sur deux chiffres
auto Booléen [yes/no] Oui Effectuer la sauvegarde à l’horaire indiqué
available Booléen [yes/no] Non yes La configuration est active

Type bck_host

Propriété Type Requis Défaut Description
host FQDN Oui Vide Nom dans l’inventaire de l’hôte de sauvegarde
name FQDN [’:’ <numéro port>] Non Vide Nom de domaine à utiliser pour accéder à l’hôte au lieu de celui de l’inventaire
user Identifiant Oui Vide Nom d’utilisateur dans l’hôte de sauvegarde avec lequel transférer les fichiers
dir Chemin Oui Vide Chemin vers l’emplacement de sauvegarde