Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /

Rota un archivo clave con la API

Puede rotar programáticamente un archivo clave actualizando un proyecto configuración de la automatización.

Para rotar un archivo clave usando la API de Cloud Manager:

  1. Recuperar la configuración actual.

  2. Añade el nuevo archivo de clave que deseas utilizar con el ajuste auth.newKey.

  3. Reemplace toda la configuración utilizando PUT. Debes usar PUT. No uses PATCH.

Cuando todos los agentes de MongoDB utilicen la nueva clave, Cloud Manager reemplazará el valor de auth.key con la nueva clave proporcionada en auth.newKey y removerá auth.newKey de la configuración de automatización.

  • Debe tener acceso al API. Para obtener más información, consulta Configura el acceso a la API.

  • Su clave API debe tener el rol Project Automation Admin o Project Owner.

  • La autenticación debe estar habilitada.

  • Al menos un clúster en el proyecto debe estar configurado con la opción clusterAuthMode configurada en keyFile o sendKeyFile.

  • Todos los clústeres del proyecto deben ejecutar MongoDB versión 4.2 o superior.

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

Tu llave privada de API para tus credenciales de API.

cloud.mongodb.com

string

URL de la instancia de Cloud Manager.

GROUP-ID

string

Identificador único de tu proyecto desde la configuración del proyecto.

CLUSTER-ID

string

Identificador único de tu clúster.

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

    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.

    Compara el campo version del currentAutomationConfig.json con el del archivo de copia de seguridad de Configuración de Automatización, mms-cluster-config-backup.json. El valor version es el último elemento en ambos documentos JSON . Puedes encontrar este archivo en cualquier host que ejecute el MongoDB Agent 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ás trabajando con la versión actual del archivo de configuración de Automatización.

2
  1. Abre currentAutomationConfig.json en tu editor de texto preferido.

  2. Añade el campo auth.newKey. Establece el valor de este campo en el nuevo archivo de clave que deseas que Cloud Manager utilice.

    Nota

    La siguiente configuración de muestra está truncada para facilitar la lectura.

    {
    "auth": {
    "disabled": "false",
    "key": "<your-old-key>",
    "newKey": "<your-new-key>"
    }
    }

Si está actualizando el MongoDB Agent, consulte Actualizar versiones del agente antes de continuar con este procedimiento.

3

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

Ejecute el siguiente comando con la ruta al documento de configuración actualizado y sustituya los marcadores de posición con las Variables de Recursos de la API de Automation Config.

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 la actualización exitosa de la configuración, la API devuelve el código de estado HTTP 200 OK para indicar que la solicitud se ha realizado correctamente.

4

Recupera la configuración de automatización de Cloud Manager y confirma que contenga los cambios. Para recuperar la configuración, emite el siguiente comando, reemplazando los marcadores de posición con las Variables para los Recursos de la API de Configuración de Automatización.

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

Usa el recurso automationStatus para recuperar el estado de implementación. Ejecute el siguiente comando, sustituyendo los marcadores de posición con las Variables para los Recursos de la API de Automatización.

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

Confirma que los valores de todos los campos lastGoalVersionAchieved en el arreglo processes coincidan con el campo goalVersion. Para conocer el estado de la implementación, consulta Obtener el estado de automatización del último plan.

Volver

Actualizar configuración de automatización

En esta página