La configuración de automatización de un proyecto determina el estado objetivo de sus procesos y agentes de MongoDB. El MongoDB Agent construye la implementación de acuerdo con los objetivos especificados.
Para actualizar la configuración:
Recuperar la configuración actual.
Puedes usar el endpoint /groups/{ID del grupo}/automationConfig para obtener la configuración completa o el endpoint /groups/{ID del grupo}/automationConfig/noSecrets para obtener la configuración con información confidencial redactada, como contraseñas o valores clave.
Tenga en cuenta el valor del campo
versionen el cuerpo de la respuesta.Haz cambios en una copia de la configuración actual, cambiando solo aquellos elementos que deseas modificar.
Mantén el campo
versionestablecido en el valor que anotaste en el paso anterior.Envía tu nueva configuración usando
PUT, con la configuración actualizada en el cuerpo de la solicitud. Debes usarPUT. No usesPATCH.A partir de MongoDB Ops Manager 8.0.28 y 9.0.2, si otro usuario o proceso publicó un cambio después de que usted recuperó la configuración, MongoDB Ops Manager rechaza la solicitud con un error
409AUTOMATION_CONFIG_CONCURRENT_MODIFICATION. Recuperar la configuración de nuevo, vuelva a aplicar sus cambios y vuelva a enviar la solicitud.Cuando envías actualizaciones, Ops Manager realiza modificaciones internas en los datos y luego guarda la nueva versión de tu configuración.
Importante
Una configuración de automatización podría contener información confidencial, incluidas contraseñas o valores clave. Para actualizar la configuración de automatización de un proyecto sin actualizar ningún campo que contenga información confidencial, utiliza el endpoint /groups/{ID del proyecto}/automationConfig/noSecrets.
Nota
Algunos parámetros no pueden actualizarse a través del endpoint automationConfig. Para obtener más información, consulte:
Para realizar actualizaciones en el MongoDB Agent que no sean hostname, debes hacerlo a través de un endpoint diferente.
Para ver un tutorial sobre cómo actualizar una configuración de automatización, consulte Actualizar la configuración de automatización del proyecto.
Los agentes de MongoDB consultan continuamente de forma periódica a Ops Manager en busca de cambios en la configuración y obtienen actualizaciones de la configuración cuando estas ocurren. Luego, los agentes ajustan los estados de sus procesos en vivo para que coincidan.
Advertencia
Realizar cambios en la configuración de automatización con una solicitud PUT puede provocar tiempo de inactividad del clúster. Prueba los cambios en entornos inferiores antes de aplicarlos a entornos de producción.
A partir de MongoDB Ops Manager 8.0.28 y 9.0.2, MongoDB Ops Manager protege contra modificaciones simultáneas al verificar el campo version en el cuerpo de su solicitud. Si el valor no coincide con la versión de configuración actual, MongoDB Ops Manager rechaza la solicitud con un error 409 AUTOMATION_CONFIG_CONCURRENT_MODIFICATION. Incluya siempre el campo version en el cuerpo de su solicitud. Si lo omite, MongoDB Ops Manager no puede detectar que su copia está desactualizada y la solicitud sobrescribe cualquier cambio publicado después de que usted recuperó la configuración. En versiones anteriores, MongoDB Ops Manager aplica la modificación posterior sin verificar la versión.
Advertencia
Actualizar el nombre de usuario del agente antes de habilitar la autenticación
La configuración de automatización proporciona la única manera de habilitar la autenticación en sus clústeres utilizando la API. Para habilitar la autenticación, primero debes llamar a los siguientes endpoints con "nombre de usuario": "mms-automation":
Después de llamar a estos endpoints, recupere la configuración de automatización nuevamente para que el cuerpo de su solicitud PUT contenga el valor version actual.
Roles necesarios
Este recurso requiere el rol de Project Automation Admin.
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PUT /groups/{PROJECT-ID}/automationConfigSolicitud
Parámetros de ruta
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
PROJECT-ID | string | Requerido | Identificador único del grupo que posee la configuración de automatización. |
Parámetros de query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo
Para revisar estos parámetros, consulta los Parámetros de Configuración de Automatización.
Respuesta
Para revisar estos parámetros, consulta los Parámetros de Configuración de Automatización.
Solicitud de ejemplo
Lo siguiente reemplaza la configuración de automatización con la configuración actualizada guardada en /Users/admin/updated-conf.json. Para ver un ejemplo de un documento de configuración actualizado, consulte Ejemplo de configuración de automatización.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \ --data-binary "@/Users/admin/updated-conf.json"Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
Para revisar un ejemplo de esta configuración, consulta Ejemplo de configuración de automatización.