Configuración

La configuración del software se realiza de la misma forma que el resto de componentes del sistema luIDS, tal y como se describe en Proceso de inicialización. Luego, cada componente tiene sus propias secciones particulares como se describirá en Configuración luarchive.

Proceso de inicialización

La configuración de un servicio luIDS puede realizarse de varias formas:

  1. Mediante un fichero de configuración (en formatos yaml o toml)

  2. Mediante parámetros de línea de comandos.

  3. Mediante variables de entorno.

Todas las secciones menos aquellas opciones que están definidas como sólo argumentos pueden configurarse por cualquiera de las tres vías, siguiendo el siguiente proceso de inicialización:

  1. Si se especifica la opción --config se utilizará el fichero definido en dicha opción.

  2. Leerá el resto de opciones de configuración de la línea de comandos.

  3. Leerá las opciones de configuración desde variables de entorno.

  4. Valida y aplica la configuración.

  5. Si se ha pasado el parámetro --dry-run detendrá la ejecución con salida ok si todo ha ido bien.

  6. Inicializará los servidores que se hayan configurado.

En caso de que algunas opciones de configuración diverjan: las variables de entorno tienen prioridad sobre los parámetros de línea de comando y estos a su vez, tienen prioridad sobre un fichero de configuración.

Configuración luarchive

Ejemplos

Ejemplo de /etc/luids/archive/luarchive.toml
[archive.backend]
files      = [ "/etc/luids/archive/backends.json" ]

[archive.service]
files      = [ "/etc/luids/archive/services.json" ]

[service.event.archive]
enable  = true
service = "event"

[service.dnsutil.archive]
enable  = true
service = "dns"

[service.tlsutil.archive]
enable  = true
service = "tls"

Referencia de configuración

Sólo argumentos

Parámetro Tipo Requerido Defecto Descripción

config

string

No

Usa el parámetro como fichero de configuración en lugar de los ficheros definidos por defecto. Admite la configuración en formatos toml y yaml. Para la correcta detección del formato, config deberá incorporar la extensión correspondiente.

debug

boolean

No

false

Habilita el modo debug.

dry-run

boolean

No

false

Chequea y construye las listas del servicio pero no lo inicializa. Puede emplearse para comprobar que la configuración es correcta.

help

boolean

No

false

Muestra la ayuda.

version

boolean

No

false

Muestra la versión de la aplicación.

Sección archive.backend

Parámetro Tipo Requerido Defecto Descripción

files

[]string

No

Listado de ficheros donde se encuentra la configuración de los sistemas de almacenamiento.

dirs

[]string

No

Listado de directorios donde se encuentra la configuración de los sistemas de almacenamiento.

Sección archive.service

Parámetro Tipo Requerido Defecto Descripción

files

[]string

No

Listado de ficheros donde se encuentra la configuración de los servicios de almacenamiento.

dirs

[]string

No

Listado de directorios donde se encuentra la configuración de los servicios de almacenamiento.

Sección service.dnsutil.archive

Parámetro Tipo Requerido Defecto Descripción

enable

boolean

false

Habilita la api dnsutil.archive.

service

string_

Define el identificador del servicio definido en los ficheros de configuración que proporcionará la api.

log

boolean

No

true

Habilita el log del servicio.

Sección service.event.archive

Parámetro Tipo Requerido Defecto Descripción

enable

boolean

false

Habilita la api event.archive.

service

string_

Define el identificador del servicio definido en los ficheros de configuración que proporcionará la api.

log

boolean

No

true

Habilita el log del servicio.

Sección service.tlsutil.archive

Parámetro Tipo Requerido Defecto Descripción

enable

boolean

false

Habilita la api tlsutil.archive.

service

string_

Define el identificador del servicio definido en los ficheros de configuración que proporcionará la api.

log

boolean

No

true

Habilita el log del servicio.

Sección server

Parámetro Tipo Requerido Defecto Descripción

allowed

[]string

No

Incluye el listado como orígenes permitidos para el uso del servicio.

cacert

string

No

Utilizará la cadena como al certificado de la CA del servidor.

certfile

string

No

Utilizará la cadena como trayectoria al certificado del servidor.

clientauth

boolean

No

false

Requiere la autenticación del certificado del cliente en el servicio.

keyfile

boolean

No

Utilizará la cadena como trayectoria al fichero de clave privada del servidor.

listenuri

string

No

tcp://127.0.0.1:58XX

Lanzará un servidor GRPC escuchando en la uri.

Sección health

Parámetro Tipo Requerido Defecto Descripción

allowed

[]string

No

Incluye el listado como orígenes permitidos para el uso del servicio.

listenuri

string

No

Lanzará un servidor http escuchando en la uri con información de métricas y estado.

metrics

boolean

No

false

Habilita el uso de métricas.

Sección log

Parámetro Tipo Requerido Defecto Descripción

format

string

No

text

Define el formato del log.

level

string

No

info

Define el el nivel de log empleado.

A continuación: Definición del servicio