Usage avancé de la commande cyberwatch

Cette documentation explique comment utiliser les paramètres avancés de la commande cyberwatch à l’aide de variables d’environnement.

Toutes les variables qui suivent peuvent être modifiées de deux façons différentes :

Soit temporairement. En utilisant la variable dans la ligne de commande. Par exemple, pour effectuer une sauvegarde dans un autre dossier :
```
 sudo CBW_BACKUP_DIR=/tmp/backups cyberwatch backup save
```
Soit « définitivement » en les ajoutant ou éditant le fichier de configuration du Socle /etc/cyberwatch/config.env (ou définie par ${CBW_CONFIG_FILE})

Variables

`CBW_CONFIG_FILE`

Par défaut : /etc/cyberwatch/config.env

Permet de changer le fichier qui contient tous les paramètres du Socle.

`CBW_CONFIG_DIR`

Par défaut : /etc/cyberwatch

Permet de changer le dossier qui contient les fichiers de configuration de Cyberwatch.

Modifier ce paramètre peut également modifier les variables CBW_CERT_DIR et CBW_SSL_DIR.

`CBW_CERT_DIR`

Par défaut : ${CBW_CONFIG_DIR}/certs

Permet de changer le dossier de stockage des certificats.

`CBW_SSL_DIR`

Par défaut : ${CBW_CONFIG_DIR}/ssl

Permet de changer le dossier qui contient le certificat présenté par l’interface web (nginx.crt et nginx.key). Pour plus d’information, consulter Modifier le certificat TLS de Cyberwatch.

`CBW_NGINX_UID`

Par défaut : 101 (0 en version 5.31 du socle)

Permet de changer l’UID attribué au dossier ${CBW_SSL_DIR} à chaque démarrage. Il doit correspondre à l’utilisateur du conteneur nginx. À modifier uniquement en cas d’isolation des conteneurs par namespaces.

`CBW_NGINX_GID`

Par défaut : 101 (0 en version 5.31 du socle)

Permet de changer le GID attribué au dossier ${CBW_SSL_DIR} à chaque démarrage, dans les mêmes conditions que CBW_NGINX_UID.

`CERT_WARNING_DAYS`

Par défaut : 90

Nombre de jours avant l’expiration d’un certificat à partir duquel un avertissement s’affiche au démarrage de Cyberwatch.

`CERT_RENEWAL_DAYS`

Par défaut : 45

Nombre de jours avant l’expiration à partir duquel un certificat est renouvelé : automatiquement au démarrage de Cyberwatch pour les certificats des services, ou avec la commande cyberwatch renew-certificates. Pour plus d’information, consulter la procédure de renouvellement des certificats TLS.

`CERT_VALIDITY_DAYS`

Par défaut : 365

Durée de validité, en jours, des certificats des services générés ou renouvelés par Cyberwatch.

`ROOT_CERT_VALIDITY_DAYS`

Par défaut : 3650

Durée de validité, en jours, des certificats racines générés par Cyberwatch.

`CBW_BACKUP_DIR`

Par défaut : /var/lib/cyberwatch/backups

Permet de changer le dossier de stockage des fichiers de sauvegarde. Pour plus d’information sur les sauvegardes, consulter Procédure de backup et restauration de Cyberwatch.

`CBW_SKIP_BACKUP`

Par défaut : false

Permet de désactiver le mécanisme de sauvegarde des bases de données. Ces sauvegardes sont effectuées à chaque redémarrage du Socle. Pour plus d’information sur les sauvegardes, consulter Procédure de backup et restauration de Cyberwatch.

`CBW_REPORT_DIR`

Par défaut : /var/lib/cyberwatch/reports

Permet de changer le dossier de stockage des rapports générés avec la commande cyberwatch report.

`CBW_OFFLINE`

Par défaut : false

Permet de contrôler si le socle est hors ligne ou non. Pour plus d’information sur l’administration hors ligne, consulter Guide d’administration hors ligne.

`CBW_DISABLE_ELK`

Par défaut : false

Permet de désactiver le déploiement d’Elasticsearch et Kibana embarqués sur les nœuds master/single. Lorsque la variable est définie à true, le stack ELK est exclu du déploiement Cyberwatch. Le changement est appliqué au prochain cyberwatch configure ou, sur Docker Swarm uniquement, au prochain démarrage. Pour plus d’information, consulter Configurer un Elastic Stack externe.

`CBW_NO_PULL`

Par défaut : false

Permet de désactiver le téléchargement des images depuis le registre de conteneurs. Les commandes cyberwatch start et cyberwatch restart utilisent alors les images déjà présentes sur le nœud. Ce comportement peut être modifié ponctuellement, sans éditer le fichier de configuration, avec les options --no-pull et --force-pull disponibles à partir de la version 5.32 du socle. Par exemple, pour mettre à jour une instance configurée avec CBW_NO_PULL="true" :

sudo cyberwatch restart --force-pull