Uso avanzado del comando cyberwatch

Esta documentación explica cómo utilizar los parámetros avanzados del comando cyberwatch mediante variables de entorno.

Todas las variables que siguen pueden modificarse de dos formas diferentes:

  • De forma temporal. Utilizando la variable en la línea de comando. Por ejemplo, para realizar una copia de seguridad en otra carpeta:

     sudo CBW_BACKUP_DIR=/tmp/backups cyberwatch backup save
    
  • O de forma «definitiva» añadiéndolas o editando el archivo de configuración del Socle /etc/cyberwatch/config.env (o definido por ${CBW_CONFIG_FILE})

Variables

CBW_CONFIG_FILE

Por defecto: /etc/cyberwatch/config.env

Permite cambiar el archivo que contiene todos los parámetros del Socle.

CBW_CONFIG_DIR

Por defecto: /etc/cyberwatch

Permite cambiar la carpeta que contiene los archivos de configuración de Cyberwatch.

Modificar este parámetro puede también modificar las variables CBW_CERT_DIR y CBW_SSL_DIR.

CBW_CERT_DIR

Por defecto: ${CBW_CONFIG_DIR}/certs

Permite cambiar la carpeta de almacenamiento de los certificados.

CBW_SSL_DIR

Por defecto: ${CBW_CONFIG_DIR}/ssl

Permite cambiar la carpeta que contiene el certificado presentado por la interfaz web (nginx.crt y nginx.key). Para más información, consulte Modificar el certificado TLS de Cyberwatch.

CBW_NGINX_UID

Por defecto: 101 (0 en la versión 5.31 del socle)

Permite cambiar el UID asignado a la carpeta ${CBW_SSL_DIR} en cada inicio. Debe corresponder al usuario del contenedor nginx. Modificar únicamente en caso de aislamiento de contenedores por namespaces.

CBW_NGINX_GID

Por defecto: 101 (0 en la versión 5.31 del socle)

Permite cambiar el GID asignado a la carpeta ${CBW_SSL_DIR} en cada inicio, en las mismas condiciones que CBW_NGINX_UID.

CERT_WARNING_DAYS

Por defecto: 90

Número de días antes de la expiración de un certificado a partir del cual se muestra una advertencia al iniciar Cyberwatch.

CERT_RENEWAL_DAYS

Por defecto: 45

Número de días antes de la expiración a partir del cual se renueva un certificado: automáticamente al iniciar Cyberwatch para los certificados de los servicios, o con el comando cyberwatch renew-certificates. Para más información, consulte el procedimiento de renovación de los certificados TLS.

CERT_VALIDITY_DAYS

Por defecto: 365

Duración de validez, en días, de los certificados de los servicios generados o renovados por Cyberwatch.

ROOT_CERT_VALIDITY_DAYS

Por defecto: 3650

Duración de validez, en días, de los certificados raíz generados por Cyberwatch.

CBW_BACKUP_DIR

Por defecto: /var/lib/cyberwatch/backups

Permite cambiar la carpeta de almacenamiento de los archivos de copia de seguridad. Para más información sobre las copias de seguridad, consulte Procedimiento de backup y restauración de Cyberwatch.

CBW_SKIP_BACKUP

Por defecto: false

Permite desactivar el mecanismo de copia de seguridad de las bases de datos. Estas copias de seguridad se realizan en cada reinicio del Socle. Para más información sobre las copias de seguridad, consulte Procedimiento de backup y restauración de Cyberwatch.

CBW_REPORT_DIR

Por defecto: /var/lib/cyberwatch/reports

Permite cambiar la carpeta de almacenamiento de los informes generados con el comando cyberwatch report.

CBW_OFFLINE

Por defecto: false

Permite controlar si el Socle está fuera de línea o no. Para más información sobre la administración fuera de línea, consulte Guía de administración fuera de línea.

CBW_DISABLE_ELK

Por defecto: false

Permite desactivar el despliegue de Elasticsearch y Kibana integrados en los nodos master/single. Cuando la variable se define a true, el stack ELK se excluye del despliegue Cyberwatch. El cambio se aplica en el siguiente cyberwatch configure o, únicamente en Docker Swarm, en el siguiente inicio. Para más información, consulta Configurar un Elastic Stack externo.

CBW_NO_PULL

Por defecto: false

Permite desactivar la descarga de las imágenes desde el registro de contenedores. Los comandos cyberwatch start y cyberwatch restart utilizan entonces las imágenes ya presentes en el nodo. Este comportamiento puede modificarse puntualmente, sin editar el archivo de configuración, con las opciones --no-pull y --force-pull disponibles a partir de la versión 5.32 del socle. Por ejemplo, para actualizar una instancia configurada con CBW_NO_PULL="true":

sudo cyberwatch restart --force-pull