Ús avançat de l’ordre cyberwatch

Aquesta documentació explica com utilitzar els paràmetres avançats de l’ordre cyberwatch per mitjà de variables d’entorn.

Totes les variables següents es poden modificar de dues maneres diferents:

  • De manera temporal, utilitzant la variable a la línia d’ordres. Per exemple, per fer una còpia de seguretat en una altra carpeta:

     sudo CBW_BACKUP_DIR=/tmp/backups cyberwatch backup save
    
  • De manera «definitiva», afegint-les o editant-les al fitxer de configuració de la plataforma base /etc/cyberwatch/config.env (o el que defineixi ${CBW_CONFIG_FILE})

Variables

CBW_CONFIG_FILE

Per defecte: /etc/cyberwatch/config.env

Permet canviar el fitxer que conté tots els paràmetres de la plataforma base.

CBW_CONFIG_DIR

Per defecte: /etc/cyberwatch

Permet canviar la carpeta que conté els fitxers de configuració de Cyberwatch.

Modificar aquest paràmetre també pot modificar les variables CBW_CERT_DIR i CBW_SSL_DIR.

CBW_CERT_DIR

Per defecte: ${CBW_CONFIG_DIR}/certs

Permet canviar la carpeta d’emmagatzematge dels certificats.

CBW_SSL_DIR

Per defecte: ${CBW_CONFIG_DIR}/ssl

Permet canviar la carpeta que conté el certificat que presenta la interfície web (nginx.crt i nginx.key). Per a més informació, consulteu Modificar el certificat TLS de Cyberwatch.

CBW_NGINX_UID

Per defecte: 101 (0 a la versió 5.31 de la plataforma base)

Permet canviar l’UID assignat a la carpeta ${CBW_SSL_DIR} a cada inici. Ha de correspondre a l’usuari del contenidor nginx. Modifiqueu-lo només en cas d’aïllament dels contenidors amb espais de noms.

CBW_NGINX_GID

Per defecte: 101 (0 a la versió 5.31 de la plataforma base)

Permet canviar el GID assignat a la carpeta ${CBW_SSL_DIR} a cada inici, en les mateixes condicions que CBW_NGINX_UID.

CERT_WARNING_DAYS

Per defecte: 90

Nombre de dies abans de la caducitat d’un certificat a partir del qual es mostra un avís en iniciar Cyberwatch.

CERT_RENEWAL_DAYS

Per defecte: 45

Nombre de dies abans de la caducitat a partir del qual es renova un certificat: automàticament en iniciar Cyberwatch per als certificats dels serveis, o amb l’ordre cyberwatch renew-certificates. Per a més informació, consulteu el procediment de renovació dels certificats TLS.

CERT_VALIDITY_DAYS

Per defecte: 365

Durada de validesa, en dies, dels certificats dels serveis que Cyberwatch genera o renova.

ROOT_CERT_VALIDITY_DAYS

Per defecte: 3650

Durada de validesa, en dies, dels certificats arrel que genera Cyberwatch.

CBW_BACKUP_DIR

Per defecte: /var/lib/cyberwatch/backups

Permet canviar la carpeta d’emmagatzematge dels fitxers de còpia de seguretat. Per a més informació sobre les còpies de seguretat, consulteu Procediment de còpia de seguretat i restauració de Cyberwatch.

CBW_SKIP_BACKUP

Per defecte: false

Permet desactivar el mecanisme de còpia de seguretat de les bases de dades. Aquestes còpies de seguretat es fan a cada reinici de la plataforma base. Per a més informació sobre les còpies de seguretat, consulteu Procediment de còpia de seguretat i restauració de Cyberwatch.

CBW_REPORT_DIR

Per defecte: /var/lib/cyberwatch/reports

Permet canviar la carpeta d’emmagatzematge dels informes generats amb l’ordre cyberwatch report.

CBW_OFFLINE

Per defecte: false

Permet controlar si la plataforma base és fora de línia o no. Per a més informació sobre l’administració fora de línia, consulteu Guies d’administració fora de línia.

CBW_DISABLE_ELK

Per defecte: false

Permet desactivar el desplegament d’Elasticsearch i Kibana integrats als nodes master/single. Quan la variable es defineix a true, la pila ELK s’exclou del desplegament de Cyberwatch. El canvi s’aplica en el següent cyberwatch configure o, només a Docker Swarm, en el següent inici. Per a més informació, consulteu Configurar un Elastic Stack extern.

CBW_NO_PULL

Per defecte: false

Permet desactivar la baixada de les imatges des del registre de contenidors. Les ordres cyberwatch start i cyberwatch restart utilitzen aleshores les imatges que ja hi ha al node. Aquest comportament es pot modificar puntualment, sense editar el fitxer de configuració, amb les opcions --no-pull i --force-pull, disponibles a partir de la versió 5.32 de la plataforma base. Per exemple, per actualitzar una instància configurada amb CBW_NO_PULL="true":

sudo cyberwatch restart --force-pull