/ /

Archivo de configuración del clúster

Overview

La mongocli el comando requiere configuraciones de clúster para crear o actualizar un MongoDB Cloud Manager o MongoDB Ops Manager clúster. Las propiedades de configuración pueden proporcionarse a través de un archivo .yaml o .json. Las siguientes secciones describen las Propiedades de configuración que se requieren para crear o actualizar un clúster y proporcionan un archivo de configuración de muestra que puedes copiar y modificar.

Propiedades de configuración

Las siguientes secciones contienen lo siguiente:

Propiedades de configuración de todo el clúster
Propiedades de configuración de miembros del conjunto de réplicas
Propiedades de configuración del clúster fragmentado

Configuraciones a nivel de clúster

El archivo de configuración para crear o actualizar un clúster de MongoDB Cloud Manager o MongoDB Ops Manager debe contener las siguientes configuraciones a nivel de clúster:

Campo	Tipo	Descripción
`name`	string	Nombre del clúster.
`version`	string	Versión del proceso `mongod` para implementar.
`featureCompatibilityVersion`	string	Versión de compatibilidad de características entre versiones de la implementación.
`processes`	Arreglo de objetos	Requerido para conjuntos de réplicas. Una matriz de objetos que contiene la configuración de cada proceso.`mongod` Cada `mongod` tiene configuraciones de los set de réplicas.
`shards`	Arreglo de objetos	Requerido para clústeres fragmentados. Una matriz de objetos que contiene la configuración de cada fragmento.
`config`	Objeto	Requerido para clústeres fragmentados. Objeto que contiene tu set de réplicas del servidor de configuración.
`mongos`	Arreglo de objetos	Requerido para clústeres fragmentados. Una matriz de objetos que contiene la configuración de cada `mongos` instancia.

Configuraciones de set de réplicas

El archivo de configuración para crear o actualizar un MongoDB Cloud Manager o un MongoDB Ops Manager clúster puede contener la siguiente configuración para cada miembro del set de réplicas:

Campo

Tipo

Descripción

¿Requerido?

auditLogDestination

string

Ajuste que permite auditoría y especifica dónde enviar todos los eventos de auditoría. MongoDB CLI acepta los siguientes valores:

syslog
Genera los eventos de auditoría en syslog en formato JSON.
console
Genera los eventos de auditoría en stdout en formato JSON.
file
Envíe los eventos de auditoría al archivo especificado en la configuración auditLogPath en el formato especificado en la configuración auditLogFormat.

Esta configuración corresponde a la opción del archivo de configuración auditLog.destination.

auditLogFilter

string

Configuración que filtra qué eventos son auditados. El filtro limita los resultados para que coincidan con la query que se especifica.

Para obtener más información sobre cómo crear filtros, consulta Configurar filtros de auditoría.

Esta configuración corresponde a la opción del archivo de configuración auditLog.filter.

auditLogFormat

string

Formato del archivo de salida para auditar si auditLogDestination está configurado en file.

MongoDB CLI acepta los siguientes valores:

JSON
Genera los eventos de auditoría en formato JSON en el archivo especificado en la configuración auditLogPath.
BSON
Exportar los eventos de auditoría en formato binario BSON al archivo especificado en la configuración auditLogPath.

Esta configuración corresponde a la opción del archivo de configuración auditLog.format.

auditLogPath

string

Archivo de salida para auditoría si auditLogDestination tiene un valor file de. La auditLogPath opción puede tomar una ruta absoluta o relativa.

Esta configuración corresponde a la opción del archivo de configuración auditLog.path.

bindIp

string

Los nombres de host y/o direcciones IP y/o rutas completas del socket de dominio Unix en las que mongos o mongod deben escuchar las conexiones de los clientes. Puedes adjuntar mongos o mongod a cualquier interfaz. Para enlazar varias direcciones, introduce una lista de valores separados por comas.

Este ajuste corresponde a la opción de archivo de configuración net.bindIp.

bindIpAll

booleano

Indicador que muestra si la instancia mongos o mongod se vincula a todas las direcciones IPv4 (por ejemplo, 0.0.0.0). Si ipv6 está configurado en true, bindIpAll también se conecta a direcciones IPv6 (por ejemplo, :: ). La CLI de MongoDB acepta los siguientes valores: true o false.

Esta configuración corresponde a la opción del archivo de configuración net.bindIpAll.

buildIndexes

booleano

Indicador que indica si se debe indicar a la creación de índices. La CLI de MongoDB acepta los siguientes mongod valores: true falseo.

Esta configuración corresponde a la opción de configuración del conjunto de réplicas buildIndexes.

dbPath

string

Directorio donde la instancia almacena sus datos. No se puede modificar después de la mongod implementación.

Sí

delay

Int

Número de segundos que este miembro debe estar detrás del miembro principal.

Esta configuración corresponde a la opción de configuración del conjunto de réplicas slaveDelay.

directoryPerDB

booleano

Indicador que indica si MongoDB debe usar un directorio independiente para almacenar los datos de cada base de datos. Los directorios se encuentran en el directorio y el nombre de cada subdirectorio corresponde al nombre de la base de storage.dbPath datos.

Por defecto, directoryPerDB es false.

Esta configuración corresponde a la opción de configuración storage.directoryPerDB mongod del set de réplicas.

enableMajorityReadConcern

booleano

Marca que indica si se habilita o no "majority" la preocupación de lectura. Si se habilita, la preocupación de lectura "majority" garantiza que la mayoría de los miembros del conjunto de réplicas hayan confirmado la lectura de datos para operaciones de lectura no asociadas con transacciones multidocumento.

Por defecto, enableMajorityReadConcern es true.

Esta configuración corresponde a la opción de configuración del conjunto de réplicas replication.enableMajorityReadConcern.

hostname

string

Nombre del host que agregar al set de réplicas. Este es el host en el que Ops Manager implementa el proceso mongod.

Sí

inMemory.engineConfig. inMemorySizeGB

float

Cantidad máxima de memoria a asignar para los datos del motor de almacenamiento en memoria, incluyendo índices, oplog si mongod es parte de un set de réplicas, metadatos del set de réplicas o del clúster, etc.

El valor puede tener un rango de 256 MB a 10 TB. Por defecto, el motor de almacenamiento en memoria utiliza el 50% de la RAM física menos 1 GB.

Esto está disponible solo para MongoDB Enterprise.

Esta configuración corresponde a la opción de configuración inMemorySizeGB mongod del set de réplicas.

ipv6

booleano

Indicador que señala si la implementación admite IPv.6 La CLI de MongoDB acepta los siguientes valores: true falseo.

Esta configuración corresponde a la opción del archivo de configuración net.ipv.6

logDestination

string

Destino al que MongoDB envía toda la salida de los registros. MongoDB CLI acepta los siguientes valores: file o syslog. Si especificas file, también debes especificar logPath.

Si no especifica logDestination, MongoDB envía toda la salida de registro a la salida estándar.

Esta configuración corresponde a la opción del archivo de configuración systemLog.destination.

logPath

string

Ubicación y nombre de la entrada de registro para el proceso mongod en el host.

Sí

oplogSizeMB

entero

Tamaño máximo en megabytes para la oplog de replicación.

Esta configuración corresponde a la opción de configuración del set de réplicas replication.oplogSizeMB.

port

entero

Puerto para el miembro del conjunto de réplicas. El proceso mongod debe tener acceso exclusivo al puerto especificado.

Sí

priority

entero

Prioridad del miembro del set de réplicas durante las elecciones. El valor puede ser:

Los miembros sin derecho a voto deben tener una prioridad de 0. Los miembros del set de réplicas con una prioridad de 0 no pueden convertirse en primarios y no pueden activar elecciones.

Sí

tls.CAFile

string

.pem archivo que contiene la cadena de certificados raíz de la Autoridad de Certificación. Especifica el nombre del archivo .pem usando rutas relativas o absolutas.

Esta configuración corresponde a la opción de configuración del mongod conjunto de réplicas net.tls.CAFile.

tls. certificateKeyFile

string

.pem archivo que contiene tanto el certificado TLS como la clave.

tls.certificateKeyFile y tls.certificateSelector son mutuamente excluyentes. Solo puedes especificar uno.

Esta configuración corresponde a net.tls.certificateKeyFile. Opción de configuración de set de réplicas mongod.

tls. certificateKeyFilePassword

string

Contraseña para descifrar el archivo de clave del certificado.

Utiliza la opción tls.certificateKeyFilePassword solo si el archivo de clave de certificado está cifrado. En todos los casos, el mongos o mongod eliminará la contraseña de todos los registros e reportes de salida.

Esta configuración corresponde a la net.tls.certificateKeyFilePassword mongod opción de configuración del set de réplicas.

tls.certificateSelector

string

Propiedad del certificado que el agente de MongoDB utiliza para seleccionar un certificado coincidente del almacén de certificados del sistema operativo que se utilizará para TLS/SSL.

MongoDB CLI acepta una de las siguientes asignaciones clave-valor como argumento de tls.certificateSelector:

Clave	Tipo de valor	Descripción
`subject`	string ASCII	El nombre del sujeto o nombre común en el certificado.
`thumbprint`	cadena hexadecimal	Una secuencia de bytes, expresada en hexadecimal, utilizada para identificar una llave pública mediante su resumen SHA-1. El `thumbprint` a veces se conoce como `fingerprint`.

tls.certificateKeyFile y tls.certificateSelector son mutuamente excluyentes. Solo puedes especificar uno.

Esta configuración corresponde a la opción de configuración del mongod conjunto de réplicas net.tls.certificateSelector.

tls. clusterCertificateSelector

string

Propiedad de certificado que el MongoDB Agent utiliza para seleccionar un certificado coincidente del almacén de certificados del sistema operativo para usar en la autenticación de membresía interna x.509.

MongoDB CLI acepta una de las siguientes asignaciones clave-valor como argumento de tls.clusterCertificateSelector:

Clave	Tipo de valor	Descripción
`subject`	string ASCII	El nombre del sujeto o nombre común en el certificado.
`thumbprint`	cadena hexadecimal	Una secuencia de bytes, expresada en hexadecimal, utilizada para identificar una llave pública mediante su resumen SHA-1. El `thumbprint` a veces se conoce como `fingerprint`.

tls.clusterCertificateSelector y tls.clusterFile son mutuamente excluyentes. Solo puedes especificar uno.

Esta configuración corresponde al net.tls.clustercertificateSelector mongod opción de configuración del set de réplicas.

tls.clusterFile

string

.pem archivo que contiene el archivo de clave-certificado x.509 para autenticación de membresía para el clúster o set de réplicas.

tls.clusterCertificateSelector y tls.clusterFile son mutuamente excluyentes. Solo puedes especificar uno.

Esta configuración corresponde a la opción de configuración del net.tls.clusterFile mongod set de réplicas.

tls.clusterPassword

string

La contraseña para descifrar el archivo de clave de certificado x.509 especificado con tls.clusterFile.

Utiliza la opción tls.clusterPassword solo si el archivo de clave de certificado está cifrado. En todos los casos, el mongos o mongod eliminará la contraseña de todos los registros e reportes de salida.

Este ajuste corresponde a la opción net.tls.clusterPassword Opción de configuración de set de réplicas mongod.

tls.CRLFile

string

El archivo .pem que contiene la Lista de revocación de certificados. Especifique el nombre del archivo .pem utilizando rutas relativas o absolutas.

Esta configuración corresponde a la opción de configuración del set de réplicas net.tls.CRLFile mongod.

tls.disabledProtocols

string

Protocolos o versiones sobre los cuales un servidor de MongoDB ejecutándose con TLS rechaza conexiones entrantes.

Esta configuración corresponde a la opción de configuración del mongod conjunto de réplicas net.tls.disabledProtocols.

tls.FIPSMode

string

Permite o deshabilita el uso del modo FIPS de la librería TLS para el mongos o mongod. Tu sistema debe tener una librería compatible con FIPS para utilizar esta opción.

Esta configuración corresponde a la opción de mongod configuración del conjunto de réplicas net.tls.FIPSMode.

tls.mode

string

Habilita TLS para todas las conexiones de red. MongoDB CLI acepta los siguientes argumentos para esta configuración:

Valor	Descripción
`disabled`	El servidor no usa TLS.
`allowTLS`	Las conexiones entre servidores no utilizan TLS. Para las conexiones entrantes, el servidor acepta tanto TLS como no TLS.
`preferTLS`	Las conexiones entre servidores utilizan TLS. Para las conexiones entrantes, el servidor acepta tanto TLS como conexiones no TLS.
`requireTLS`	El servidor utiliza y acepta únicamente conexiones cifradas mediante TLS.

Esta configuración corresponde a la opción de configuración de set de réplicas net.tls.mode mongod.

tls.PEMKeyFile

string

.pem archivo que contiene tanto el certificado TLS como la clave.

IMPORTANTE: Esta configuración está obsoleta. Utilice tls.certificateKeyFile en su lugar.

Esta configuración corresponde a la opción de mongod configuración del conjunto de réplicas net.ssl.PEMKeyFile.

votes

entero

Número que indica si el miembro del conjunto de réplicas vota en la elección. MongoDB CLI acepta los siguientes valores:

0 si el miembro del conjunto de réplicas no puede votar
1 si el miembro del replica set puede votar

Para obtener más información votes sobre, consulte los votos.

Sí

wiredTiger.engineConfig. cacheSizeGB

float

Tamaño máximo de la caché interna que WiredTiger utiliza para todos los datos.

El valor puede oscilar entre 0.25 GB y 10000 GB. Por defecto, el tamaño de la memoria caché interna de WiredTiger es el mayor de los siguientes:

50 % de (RAM - 1 GB), o
256 MB.

Se debe evitar aumentar el tamaño de la caché interna de WiredTiger por encima de su valor por defecto.

Esta configuración corresponde a la opción de configuración journalCompressor mongod del set de réplicas.

wiredTiger.engineConfig. journalCompressor

string

Tipo de compresión a utilizar para comprimir los datos del journal en WiredTiger.

Los compresores disponibles son:

none
rápido
zlib
zstd (Disponible para clústeres que ejecutan MongoDB 4.2 y versiones posteriores)

Por defecto, WiredTiger utiliza snappy.

Esta configuración corresponde a la opción de configuración journalCompressor mongod del set de réplicas.

wiredTiger.engineConfig. directoryForIndexes

booleano

Indicador que indica si almacena mongod índices y colecciones en subdirectorios separados dentro del directorio de datos (esstorage.dbPath decir,). Específicamente, mongod almacena los índices en un subdirectorio llamado index y los datos de la colección en un subdirectorio collection llamado.

Al utilizar un enlace simbólico, puedes especificar una ubicación diferente para los índices. Específicamente, cuando la instancia mongod no está en ejecución, mueve el subdirectorio index a un nuevo destino y crea un enlace simbólico llamado index en el directorio de datos al nuevo destino.

Por defecto, wiredTiger.engineConfig. directoryForIndexes es false.

Esta configuración corresponde a la opción de configuración directoryForIndexes mongod del set de réplicas.

wiredTiger.engineConfig. maxCacheOverflowFileSizeGB

float

Esta configuración sólo es compatible con los clústeres que ejecutan versiones de MongoDB:

4.0.12 a través de 4.0.x, y
4.2.1 a 4.2.x.

Tamaño máximo (en GB) para el archivo "lookaside (o overflow de caché)" llamado WiredTigerLAS.wt. El archivo ya no existe a partir de la versión 7.0 de MongoDB.

La configuración puede aceptar los siguientes valores:

Valor	Descripción
`0`	Valor predeterminado. Si se establece en `0`, el tamaño del archivo es ilimitado.
número >= 0,1	El tamaño máximo (en GB). Si el archivo `WiredTigerLAS.wt` supera este tamaño, `mongod` sale con una aserción fatal. Puedes borrar el archivo `WiredTigerLAS.wt` y reiniciar `mongod`.

Para cambiar el tamaño máximo durante la ejecución, utilice el parámetro wiredTigerMaxCacheOverflowSizeGB.

Esta configuración corresponde a la maxCacheOverflowSizeGB mongod opción de configuración del conjunto de réplicas.

wiredTiger.collectionConfig. blockCompressor

string

Compresión por defecto para datos de colección. Puede anular esto por colección al crear colecciones.

Los compresores disponibles son:

none
rápido
zlib
zstd (Disponible para clústeres que ejecutan MongoDB 4.2 y versiones posteriores)

Por defecto, el compresor es snappy.

Esta configuración afecta a todas las colecciones recién creadas. Si modifica el valor de esta configuración en una implementación de MongoDB existente, todas las colecciones nuevas usarán el compresor especificado. Las colecciones existentes seguirán usando el compresor especificado al crearse o el compresor predeterminado en ese momento.

Esta configuración corresponde a la opción de configuración blockCompressor mongod del set de réplicas.

wiredTiger.indexConfig. prefixCompression

booleano

Indicador que señala si se debe habilitar o deshabilitar la reducción de prefijo para los datos del índice.

Si true, se habilita la reducción de prefijo para los datos del índice. Si false, la reducción de prefijo está deshabilitada.

Por defecto, wiredTiger.indexConfig.prefixCompression es true.

Esta configuración afecta a todos los índices creados. Si cambia el valor de esta configuración en una implementación existente de MongoDB, todos los nuevos índices utilizarán la reducción de prefijo. Los índices existentes no se ven afectados.

Esta configuración corresponde a la opción de configuración prefixCompression mongod del set de réplicas.

Configuración de fragmentos

El archivo de configuración para crear o actualizar un clúster de MongoDB Cloud Manager o MongoDB Ops Manager puede contener las siguientes configuraciones para cada fragmento:

Campo	Tipo	Descripción	¿Requerido?
`name`	string	Nombre de la partición.	Sí
`processes`	Arreglo de objetos	Un arreglo de objetos que contiene configuraciones para cada proceso de `mongod`. Cada `mongod` tiene configuraciones de miembro del set de réplicas.	Sí

Muestra de archivo de configuración

name: "myCluster"
version: 7.0.0
featureCompatibilityVersion: 7.0
processes:
    - hostname: host0
      dbPath: /data/cluster_2/rs1
      logPath: /data/cluster_2/rs1/mongodb.log
      priority: 1
      votes: 1
      port: 29010
    - hostname: host1
      dbPath: /data/cluster_2/rs2
      logPath: /data/cluster_2/rs2/mongodb.log
      priority: 1
      votes: 1
      port: 29020
    - hostname: host2
      dbPath: /data/cluster_2/rs3
      logPath: /data/cluster_2/rs3/mongodb.log
      priority: 1
      votes: 1
      port: 29030

{
    "name": "myCluster",
    "version": "7.0.0",
    "featureCompatibilityVersion": "7.0",
    "processes": [
     {
        "hostname": "host0",
        "dbPath": "/data/cluster_3/rs1",
        "logPath": "/data/cluster_3/rs1/mongodb.log",
        "priority": 1,
        "votes": 1,
        "port": 30010
     },
     {
        "hostname": "host1",
        "dbPath": "/data/cluster_3/rs2",
        "logPath": "/data/cluster_3/rs2/mongodb.log",
        "priority": 1,
        "votes": 1,
        "port": 30020
     },
     {
        "hostname": "host2",
        "dbPath": "/data/cluster_3/rs3",
        "logPath": "/data/cluster_3/rs3/mongodb.log",
        "priority": 1,
        "votes": 1,
        "port": 30030
     }
   ]
}

{
  "name": "myShardedCluster",
  "version": "7.0.0",
  "featureCompatibilityVersion": "7.0",
  "shards": [
    {
      "name": "myShard_0",
      "processes": [
        {
          "dbPath": "/data/myCluster/myShard_0/27000",
          "hostname": "host0.example",
          "logPath": "/data/myCluster/myShard_0/27000/mongodb.log",
          "port": 27000,
          "votes": 1
        },
        {
          "dbPath": "/data/myCluster/myShard_0/27001",
          "hostname": "host1.example",
          "logPath": "/data/myCluster/myShard_0/27001/mongodb.log",
          "port": 27001,
          "votes": 1
        },
        {
          "dbPath": "/data/myCluster/myShard_0/27002",
          "hostname": "host2.example",
          "logPath": "/data/myCluster/myShard_0/27002/mongodb.log",
          "port": 27002,
          "version": "7.0.0-ent",
          "votes": 1
        }
      ]
    },
    {
      "name": "myShard_1",
      "processes": [
        {
          "dbPath": "/data/myCluster/myShard_1/28000",
          "hostname": "host3.example",
          "logPath": "/data/myCluster/myShard_1/28000/mongodb.log",
          "port": 28000,
          "votes": 1
        },
        {
          "dbPath": "/data/myCluster/myShard_1/28001",
          "hostname": "host4.example",
          "logPath": "/data/myCluster/myShard_1/28001/mongodb.log",
          "port": 28001,
          "votes": 1
        },
        {
          "dbPath": "/data/myCluster/myShard_1/28002",
          "hostname": "host5.example",
          "logPath": "/data/myCluster/myShard_1/28002/mongodb.log",
          "port": 28002,
          "votes": 1
        }
      ]
    }
  ],
  "config": {
    "name": "configRS",
    "processes": [
      {
        "dbPath": "/data/myCluster/configRS/29000",
        "hostname": "host6.example",
        "logPath": "/data/myCluster/configRS/29000/mongodb.log",
        "port": 29000,
        "votes": 1
      },
      {
        "dbPath": "/data/myCluster/configRS/29001",
        "hostname": "host7.example",
        "logPath": "/data/myCluster/configRS/29001/mongodb.log",
        "port": 29001,
        "votes": 1
      },
      {
        "dbPath": "/data/myCluster/configRS/29002",
        "hostname": "host8.example",
        "logPath": "/data/myCluster/configRS/29002/mongodb.log",
        "port": 29002,
        "votes": 1
      }
    ]
  },
  "mongos": [
    {
      "hostname": "host9.example",
      "logPath": "/data/myCluster/mongoses/27015/mongodb.log",
      "port": 27015
    }
  ]
}

Volver

Referencia

Solución de problemas