Valores de configuración externa para MongoDB autogestionado

Utiliza la directiva de expansión __rest

The __rest expansion directive loads configuration file values from a REST endpoint. __rest supports loading specific values in the configuration file or loading the entire configuration file.

storage:
  dbPath: "/var/lib/mongo"
systemLog:
  destination: file
  path: "/var/log/mongodb/mongod.log"
net:
  bindIp: 192.51.100.24,127.0.0.1
  tls:
    mode: requireTLS
    certificateKeyFile: "/etc/tls/mongod.pem"
    certificateKeyFilePassword:
      __rest: "https://myrestserver.example.net/api/config/myCertKeyFilePassword"
      type: "string"

__rest: "https://myrestserver.example.net/api/config/fullConfig"
type: "yaml"

Utiliza la directiva de expansión __exec

The __exec expansion directive loads configuration file values from a shell or terminal command. __exec supports loading specific values in the configuration file or loading the entire configuration file.

storage:
  dbPath: "/var/lib/mongo"
systemLog:
  destination: file
  path: "/var/log/mongodb/mongod.log"
net:
  bindIp: 192.51.100.24,127.0.0.1
  tls:
    mode: requireTLS
    certificateKeyFile: "/etc/tls/mongod.pem"
    certificateKeyFilePassword:
      __exec: "python /home/myUserName/getPEMPassword.py"
      type: "string"

__exec: "python /home/myUserName/getFullConfig.py"
type: "yaml"

Referencia de las directrices de expansión

__rest

The __rest expansion directive loads configuration file values from a REST endpoint. __rest supports loading specific values in the configuration file or loading the entire configuration file. The mongod then starts using the externally sourced values as part of its configuration.

The __rest expansion directive has the following syntax:

• Para especificar un endpoint de REST para un ajuste o ajustes de archivo de configuración:

  <some configuration file setting>:
    __rest: "<string>"
    type: "string"
    trim: "none|whitespace"
    digest: "<string>"
    digest_key: "<string>"

• Para especificar un endpoint REST para todo el archivo de configuración:

  __rest: "<string>"
  type: "yaml"
  trim: "none|whitespace"

  Si especificas el archivo de configuración completo vía el endpoint REST, la directiva de expansión y sus opciones deben ser los únicos valores especificados en el archivo de configuración.

__rest requiere los siguientes campos:

Campo	Tipo	Descripción
__rest	string	Required The URL against which the mongod issues a GET request to retrieve the externally sourced value. Para los puntos finales que no son localhost (por ejemplo, un REST REST punto final alojado en un servidor remoto), __rest requierehttps:// URL cifradas () donde tanto la máquina host como el servidor remoto admiten 1 TLS.1 o posterior. Si el REST punto final especificado en la URL requiere autenticación, codifique las credenciales en la URL con el formato estándar de 3986 información de usuario RFC. For localhost REST endpoints (e.g. a REST endpoint listening on the host machine), __rest allows unencrypted (http://) URLs. IMPORTANT: The value returned by the specified REST endpoint cannot include any additional expansion directives. The mongod does not perform additional processing on the returned data and will terminate with an error code if the returned data includes additional expansion directives.
type	string	Optional Controls how __rest parses the returned value from the specified URL. Los valores posibles son: string (por defecto) Directs __rest to parse the returned data as a literal string. If specifying string, the entire __rest block and supporting options must be nested under the field for which you are loading externally sourced values. yaml Directs __rest to parse the returned data as a yaml formatted file. If specifying yaml, the __rest block must be the only content in the configuration file. The mongod replaces the configuration file contents with the yaml retrieved from the REST resource.
trim	string	Optional Specify whitespace to direct __rest to trim any leading or trailing whitespace, specifically occurrences of " ", "\r", "\n", "\t", "\v", and "\f". Defaults to none, or no trimming.
digest	string	opcional. La salida HMAC-SHA256 del resultado de la expansión, calculada como HMAC-SHA256(digest_key, message), donde message es el valor de la configuración que se va a recuperar. If specified, you must also specify the digest_key.
digest_key	string	Opcional. La 64representación en cadena hexadecimal de caracteres de la 32clave de byte utilizada para calcular el256 resumen HMAC-SHA del resultado de la expansión. If specified, you must also specify the digest. Por ejemplo, supongamos que el certificateKeyFilePassword es "superSecret123". Para recuperar esta contraseña mediante una solicitud REST o una llamada al servicio exec, debe generar una clave de resumen y usarla para calcular el resumen de su contraseña. Ejecute el siguiente código en su terminal para generar una clave de resumen de 32bytes: openssl rand -hex 32 View output Después de generar una clave de resumen, puede usarla para calcular el resumen de su contraseña: echo -ne "superSecret123" | openssl dgst -sha256 -mac hmac -macopt hexkey:f38d0d5adfcf1a0575f9fa9051c70a2f88b1bb7562513c9efd7686e9c21ad304 View output

Nota

• If the configuration file includes the __rest expansion, on Linux/macOS, the read access to the configuration file must be limited to the user running the mongod / mongos process only.

• Para habilitar el análisis de la directiva de expansión __rest, inicie el mongod con la opción --configExpand "rest".

For examples, see Use the __rest Expansion Directive.

__exec

The __exec expansion directive loads configuration file values from the output of a shell or terminal command. __exec supports loading specific values in the configuration file or loading the entire configuration file. The mongod then starts using the externally sourced values as part of its configuration.

The __exec expansion directive has the following syntax:

• Para especificar un comando shell o de terminal para una configuración específica o configuraciones en un archivo de configuración:

  <some configuration file setting>:
    __exec: "<string>"
    type: "string"
    trim: "none|whitespace"

• Para especificar un shell o comando de terminal para todo el archivo de configuración:

  __exec: "<string>"
  type: "yaml"
  trim: "none|whitespace"

  Si se especifica todo el archivo de configuración a través de un comando de terminal o shell, la directiva de expansión y sus opciones deben ser los únicos valores especificados en el archivo de configuración.

__exec requiere los siguientes campos:

Campo	Tipo	Descripción
__exec	string	Required The string which the mongod executes on the terminal or shell to retrieve the externally sourced value. En los hosts Linux y OSX, la ejecución se gestiona mediante POSIX popen(). En los hosts de Windows, la ejecución se gestiona a través de la API de control de procesos. __exec abre una pipe de solo lectura como el mismo usuario que inició mongod o mongos. IMPORTANT: The data returned by executing the specified command cannot include any additional expansion directives. The mongod does not perform additional processing on the returned data and will terminate with an error code if the returned data includes additional expansion directives.
type	string	Optional Controls how __exec parses the value returned by the executed command. Los valores posibles son: string (por defecto ) Directs __exec to parse the returned data as a literal string. If specifying string, the entire __exec block and supporting options must be nested under the field for which you are loading externally sourced values. yaml Directs __exec to parse the returned data as a yaml formatted file. If specifying yaml, the __exec block must be the only content in the configuration file. The mongod replaces the configuration file contents with the yaml retrieved from the executed command.
trim	string	Optional Specify whitespace to direct __exec to trim any leading or trailing whitespace, specifically occurrences of " ", "\r", "\n", "\t", "\v", and "\f". Defaults to none, or no trimming.
digest	string	opcional. La salida HMAC-SHA256 del resultado de la expansión, calculada como HMAC-SHA256(digest_key, message), donde message es el valor de la configuración que se va a recuperar. If specified, you must also specify the digest_key
digest_key	string	Optional. The 64-character hexadecimal string representation of the 32-byte key used to calculate the HMAC-SHA256 digest of the expansion result. If specified, you must also specify the digest Por ejemplo, supongamos que el certificateKeyFilePassword es "superSecret123". Para recuperar esta contraseña mediante una solicitud REST o una llamada al servicio exec, debe generar una clave de resumen y usarla para calcular el resumen de su contraseña. Ejecute el siguiente código en su terminal para generar una clave de resumen de 32bytes: openssl rand -hex 32 View output Después de generar una clave de resumen, puede usarla para calcular el resumen de su contraseña: echo -ne "superSecret123" | openssl dgst -sha256 -mac hmac -macopt hexkey:f38d0d5adfcf1a0575f9fa9051c70a2f88b1bb7562513c9efd7686e9c21ad304 View output

Nota

• If the configuration file includes the __exec expansion, on Linux/macOS, the write access to the configuration file must be limited to the user running the mongod / mongos process only.

• To enable parsing of the __exec expansion directives, start the mongod with the --configExpand "exec" option.

For examples, see Use the __exec Expansion Directive.

Genere el archivo de configuración con los valores resueltos de la directiva de expansión

You can test the final output of a configuration file that specifies one or more expansion directives by starting the mongod with the --outputConfig option. A mongod started with --outputConfig outputs the resolved YAML configuration document to stdout and halts. If any expansion directive specified in the configuration file returns additional expansion directives, the mongod throws an error and terminates.

For example, the following configuration file mongod.conf contains a __rest expansion directive:

storage:
  dbPath: "/var/lib/mongo"
systemLog:
  destination: file
  path: "/var/log/mongodb/mongod.log"
net:
  port:
    __rest: "https://mongoconf.example.net:8080/record/1"
    type: string

La string grabada en la URL especificada es 20128

If the configuration file includes the __rest expansion, on Linux/macOS, the read access to the configuration file must be limited to the user running the mongod / mongos process only.

Inicia el mongod con las opciones --configExpand "rest" y --outputConfig:

mongod -f mongod.conf --configExpand rest --outputConfig

El mongod emite lo siguiente a stdout antes de finalizar:

config: mongod.conf
storage:
  dbPath: "/var/lib/mongo"
systemLog:
  destination: file
  path: "/var/log/mongodb/mongod.log"
net:
  port: 20128
outputConfig: true