Docs Menu
Docs Home
/ /

Implementar un clúster a través de la API

Este tutorial manipula el Configuración de automatización de la API de administración de Cloud Manager para implementar un clúster fragmentado propiedad de otro usuario. El tutorial primero crea un nuevo proyecto, luego un nuevo usuario como propietario del proyecto y, finalmente, un clúster fragmentado propiedad del nuevo usuario. Puede crear un script para automatizar estos procedimientos y usarlos en operaciones rutinarias.

Para realizar estos pasos, debe tener acceso suficiente a Cloud Manager. Un usuario con la Project Owner El rol tiene suficiente acceso.

Los procedimientos instalan un clúster con dos fragmentos. Cada fragmento consta de un conjunto de réplicas de tres miembros. El tutorial instala un mongos y tres servidores de configuración. Cada componente del clúster reside en su propio servidor, lo que requiere un total de 10 hosts.

El tutorial instala el Agente MongoDB en cada host.

Aprovisione diez hosts para servir los componentes del clúster fragmentado. Para conocer los requisitos de los hosts, consulte las Notas de producción en el manual de MongoDB.

Cada host debe proporcionar a su agente MongoDB acceso completo a los nombres de host y puertos de los agentes MongoDB en todos los demás hosts. Cada agente ejecuta el comando hostname -f para identificar su nombre de host y puerto e informarlos a Cloud Manager.

Tip

Para garantizar que los agentes puedan comunicarse entre sí, aprovisione los hosts mediante Automation. Esto instala los agentes de MongoDB con acceso correcto a la red. Utilice este tutorial para reinstalar Automations en esas máquinas.

A medida que trabajas con el API, puedes ver ejemplos en la página de ejemplos de GitHub.

Los recursos de la API utilizan una o más de estas variables. Reemplaza estas variables con tus valores deseados antes de llamar a estos recursos API.

Nombre
Tipo
Descripción

PUBLIC-KEY

string

Su clave API pública para sus credenciales de API.

PRIVATE-KEY

string

Su clave API privada para sus credenciales de API.

cloud.mongodb.com

string

URL de su instancia de Cloud Manager.

GROUP-ID

string

Identificador único de su proyecto desde la configuración de su proyecto.

1

Utilice la API de administración de Cloud Manager para enviar un documento de proyectos para crear el nuevo proyecto.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Content-Type: application/json" \
--request POST "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true" \
--data '
{
"name": "{GROUP-NAME}"
}'

La API devuelve un documento que incluye los y del proyecto.agentApiKey id

2

Registre estos valores para utilizarlos en este procedimiento y en otros procedimientos de este tutorial.

3

Utilice el punto final /users para agregar un usuario al nuevo proyecto.

El cuerpo de la solicitud debe contener un documento JSON con la información del usuario.

Establezca el roles.roleName del usuario en GROUP_OWNER y el roles.groupId del usuario en el id del nuevo grupo.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header 'Accept: application/json' \
--header "Content-Type: application/json" \
--request POST "https://cloud.mongodb.com/api/public/v1.0/users?pretty=true" \
--data '
{
"username": "<new_user@example.com>",
"emailAddress": "<new_user@example.com>",
"firstName": "<First>",
"lastName": "<Last>",
"password": "<password>",
"roles": [{
"groupId": "{PROJECT-ID}",
"roleName": "GROUP_OWNER"
}]
}'
1

Para aprender cómo instalar el Agente MongoDB, siga el procedimiento para la plataforma apropiada.

2

Cuando el Agente MongoDB se ejecuta por primera vez, descarga el mms-cluster-config-backup.json archivo, que describe el estado deseado de la configuración de automatización.

En uno de los hosts, navegue a /var/lib/mongodb-mms-automation/ y abra mms-cluster-config-backup.json. Confirme que el campo version del archivo esté configurado como 1. Cloud Manager incrementa automáticamente este campo a medida que se producen cambios.

Para agregar o actualizar una implementación, recupere la configuración, realice los cambios necesarios y envíe la configuración actualizada a través de la API a Cloud Manager.

El siguiente procedimiento implementa una configuración de automatización actualizada a través de la API:

1
  1. Utilice el recurso automationConfig para recuperar la configuración. Ejecute el siguiente comando, reemplazando los marcadores de posición con las variables para los recursos de la API de creación de clústeres.

    curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
    --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \
    --output currentAutomationConfig.json
  2. Validar el archivo de configuración de automatización descargado.

    Compare el version campo de con currentAutomationConfig.json el del archivo de copia de seguridad de configuración de automatización. mms-cluster-config-backup.json version El valor es el último elemento en ambos documentos JSON. Puede encontrar este archivo en cualquier host que ejecute el Agente de MongoDB en:

    • Linux y macOS: /var/lib/mongodb-mms-automation/mms-cluster-config-backup.json

    • Windows: %SystemDrive%\MMSAutomation\versions\mms-cluster-config-backup.json

    Si los valores version coinciden, está trabajando con la versión actual del archivo de configuración de automatización.

2

Cree un documento con los siguientes campos. Al crear el documento de configuración, consulte la descripción de una configuración de automatización para obtener explicaciones detalladas de los ajustes. Para ver ejemplos, consulte la página de MongoDB Labs.

1{
2 "options": {
3 "downloadBase": "/var/lib/mongodb-mms-automation",
4 },
5 "mongoDbVersions": [],
6 "monitoringVersions": [],
7 "backupVersions": [],
8 "processes": [],
9 "replicaSets": [],
10 "sharding": []
11}
3

En el campo monitoringVersions.hostname, introduzca el nombre de host del servidor donde Cloud Manager debe instalar la monitorización. Utilice el nombre de dominio completo que devuelve la ejecución de hostname -f en el servidor, como se muestra a continuación:

1"monitoringVersions": [
2 {
3 "hostname": "<server_x.example.com>",
4 "logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log",
5 "logRotate": {
6 "sizeThresholdMB": 1000,
7 "timeThresholdHrs": 24
8 }
9 }
10]

Este ejemplo de configuración también incluye el campo logPath, que indica la ubicación del registro, y logRotate, que indica los umbrales del registro.

4

Este clúster fragmentado tiene 10 instancias de MongoDB, como se describe en la sección "Implementar un clúster mediante la API", cada una ejecutándose en su propio servidor. Por lo tanto, la processes matriz de la configuración de automatización tendrá 10 documentos, uno por cada instancia de MongoDB.

El siguiente ejemplo agrega el primer documento a la processes matriz. Reemplace <process_name_1> con el nombre que elija y <server1.example.com> con el FQDN del host.

Agregue 9 documentos: uno para cada instancia de MongoDB en su clúster fragmentado.

Especifique la args2_6 sintaxis para el processes.<args> campo. El processes.args2_6 objeto acepta la mayoría de las configuraciones y parámetros de MongoDB para las versiones 2.6 y posteriores. Para obtener más información, consulte Configuración y compatibilidad de automatización de MongoDB.

1"processes": [
2 {
3 "version": "4.0.6",
4 "name": "<process_name_1>",
5 "hostname": "<server1.example.com>",
6 "logRotate": {
7 "sizeThresholdMB": 1000,
8 "timeThresholdHrs": 24
9 },
10 "authSchemaVersion": 5,
11 "featureCompatibilityVersion": "4.0",
12 "processType": "mongod",
13 "args2_6": {
14 "net": {
15 "port": 27017
16 },
17 "storage": {
18 "dbPath": "/data/"
19 },
20 "systemLog": {
21 "path": "/data/mongodb.log",
22 "destination": "file"
23 },
24 "replication": {
25 "replSetName": "rs1"
26 }
27 }
28 },
29]
5

Agregue dos documentos del conjunto de réplicas a la matriz replicaSets. Agregue tres miembros a cada documento.

Ejemplo

Esta sección agrega un miembro del conjunto de réplicas al primer documento del conjunto de réplicas:

Importante

Debe incluir "protocolVersion": 1 en el documento raíz para cada conjunto de réplicas.

1"replicaSets": [
2 {
3 "_id": "rs1",
4 "members": [
5 {
6 "_id": 0,
7 "host": "<process_name_1>",
8 "priority": 1,
9 "votes": 1,
10 "secondaryDelaySecs": 0,
11 "hidden": false,
12 "arbiterOnly": false
13 }
14 ],
15 "protocolVersion": 1
16 }
17]

En la matriz sharding, agregue los conjuntos de réplicas a los fragmentos y agregue el nombre del conjunto de réplicas del servidor de configuración, como se muestra a continuación:

1"sharding": [
2 {
3 "shards": [
4 {
5 "tags": [],
6 "_id": "shard1",
7 "rs": "rs1"
8 },
9 {
10 "tags": [],
11 "_id": "shard2",
12 "rs": "rs2"
13 }
14 ],
15 "name": "sharded_cluster_via_api",
16 "configServerReplica": "rs-config",
17 "collections": []
18 }
19]
6

Utilice el recurso automationConfig para enviar la configuración de automatización actualizada.

Emita el siguiente comando con la ruta al documento de configuración actualizado y reemplace los marcadores de posición con las variables para los recursos de la API de creación de clúster.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Content-Type: application/json"
--request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \
--data @currentAutomationConfig.json

Tras una actualización exitosa de la configuración, la API devuelve el código de estado HTTP 200 OK para indicar que la solicitud se realizó correctamente.

7

Recupere la configuración de automatización de Cloud Manager y confirme que contenga los cambios. Para recuperarla, ejecute el siguiente comando, reemplazando los marcadores de posición con las variables para los recursos de la API de creación de clústeres.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true"
8

Utilice el recurso automationStatus para verificar que la actualización de configuración se haya implementado completamente. Ejecute el siguiente comando:

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationStatus?pretty=true"

El curl comando devuelve un objeto JSON que contiene la processes matriz y la clave y el goalVersion valor. La processes matriz contiene un documento por cada servidor que aloja una instancia de MongoDB. La nueva configuración se implementa correctamente cuando todos los lastGoalVersionAchieved campos de la processes matriz son iguales al valor especificado goalVersion para.

Ejemplo

En esta respuesta, processes[2].lastGoalVersionAchieved está detrás de goalVersion. Esto indica que la instancia de MongoDB en server3.example.com se está ejecutando una versión posterior a la de goalVersion. Espere unos segundos y vuelva a ejecutar el comando curl.

1{
2 "goalVersion": 2,
3 "processes": [{
4 "hostname": "server1.example.com",
5 "lastGoalVersionAchieved": 2,
6 "name": "ReplSet_0",
7 "plan": []
8 }, {
9 "hostname": "server2.example.com",
10 "lastGoalVersionAchieved": 2,
11 "name": "ReplSet_1",
12 "plan": []
13 }, {
14 "hostname": "server3.example.com",
15 "lastGoalVersionAchieved": 1,
16 "name": "ReplSet_2",
17 "plan":[]
18 }]
19}

Para ver la nueva configuración en la consola de Cloud Manager:

  1. En MongoDB Cloud Manager, vaya a Processes Página para su proyecto.

    1. Si aún no se muestra, seleccione la organización que contiene su proyecto deseado en el menú Organizations de la barra de navegación.

    2. Si aún no aparece, selecciona el proyecto deseado en el menú Projects de la barra de navegación.

    3. En la barra lateral, haz clic en Processes en la sección Database.

      Se muestra la página Procesos.

  2. Revisa la nueva configuración.

Para que una versión adicional de MongoDB esté disponible en el clúster, consulta Actualizar la versión de MongoDB de una implementación.

Volver

Tutorials

En esta página