Recursos personalizados

Proceso de creación y actualización

Cada vez que cambia el campo spec en cualquiera de los recursos personalizados admitidos, se inicia el siguiente flujo de trabajo en Atlas Kubernetes Operator:

1. El operador de Atlas Kubernetes recibe un evento sobre el recurso personalizado modificado.

2. Atlas Kubernetes Operator actualiza el campo status.conditions para reflejar que el recurso no está listo:

   conditions:
   - lastTransitionTime: "2021-03-13T16:26:17Z"
     status: "False"
     type: Ready

3. Para conectarse a la API de administración de Atlas, Atlas Kubernetes Operator lee el ID de la organización y ClavesAPI de una de las siguientes ubicaciones:

   • spec.connectionSecretRef.name (si se especifica en el AtlasProject recurso personalizado).

     De forma predeterminada, Atlas Kubernetes Operator mantiene los secretos de conexión en el mismo espacio de nombrescomo el AtlasProject recurso personalizado. Para almacenar secretos en otro espacio de nombres, especifique el spec.connectionSecretRef.namespace parámetro.

   • global Secreto del operador de Atlas Kubernetes <operator-deployment-name>-api-key (si no se spec.connectionSecretRef.name especifica).

4. Para crear o actualizar recursos en Atlas, Atlas Kubernetes Operator utiliza la información de conexión para realizar llamadas API a Atlas.

   Nota

   A veces, Atlas Kubernetes Operator realiza varias llamadas API en Atlas durante la reconciliación de un recurso personalizado. Por ejemplo, AtlasProject tiene una configuración de lista de acceso IP para llamar a la correspondiente API.

5. Si ocurre algún error durante la conciliación, status.conditions se actualiza para reflejar el error.

   Ejemplo

   - lastTransitionTime: "2021-03-15T14:26:44Z"
      message: 'POST https://cloud.mongodb.com/api/atlas/v1.0/groups/604a47de73cd8cag77239021/accessList:
         400 (request "INVALID_IP_ADDRESS_OR_CIDR_NOTATION") The address 192.0.2.1dfdfd5
         must be in valid IP address or CIDR notation.'
      reason: ProjectIPAccessListNotCreatedInAtlas
      status: "False"
      type: IPAccessListReady

6. Si la actualización se realiza correctamente, status.conditions refleja que el recurso está listo:

   conditions:
   - lastTransitionTime: "2021-03-13T16:26:17Z"
     status: "True"
     type: Ready

Eliminar proceso

A partir de la versión de Atlas Kubernetes 2.0 Operator, al eliminar un recurso personalizado de Kubernetes, el objeto permanece en Atlas de forma predeterminada, pero Atlas Kubernetes Operator ya no lo controla. Puede revertir esta configuración predeterminada para toda la implementación o anularla para un recurso personalizado específico con una anotación para que Atlas Kubernetes Operator pueda eliminar el objeto correspondiente de Atlas. Si la anula con una anotación, se inicia el siguiente flujo de trabajo:

1. El operador de Atlas Kubernetes recibe un evento sobre el recurso personalizado eliminado.

2. Para conectarse a la API de administración de Atlas, Atlas Kubernetes Operator lee el ID de la organización y las claves de API de una de las siguientes ubicaciones:

   • spec.connectionSecretRef.name (si se especifica en el AtlasProject recurso personalizado).

     De forma predeterminada, Atlas Kubernetes Operator guarda los secretos de conexión en el mismo espacio de nombres que el AtlasProject recurso personalizado. Para almacenar los secretos en otro espacio de nombres, especifique el spec.connectionSecretRef.namespace parámetro.

   • global Secreto del operador de Atlas Kubernetes <operator-deployment-name>-api-key (si no se spec.connectionSecretRef.name especifica).

3. Para borrar el recurso de Atlas, Atlas Kubernetes Operator usa la información de conexión para hacer llamadas API a Atlas.

   Nota

   El operador de Kubernetes de Atlas elimina cualquier objeto relacionado creado en Kubernetes. Por ejemplo, si AtlasDatabaseUser elimina, el operador de Kubernetes de Atlas elimina los secretos de conexión relacionados.

Utilice anotaciones para omitir o anular los valores predeterminados

Puede utilizar anotaciones para modificar el nuevo comportamiento predeterminado de Atlas Kubernetes Operator.

• Si agrega la anotación mongodb.com/atlas-resource-policy: "delete" al metadata ​​de un recurso personalizado, Atlas Kubernetes Operator elimina el objeto correspondiente en Atlas cuando usted elimina el recurso Atlas Kubernetes Operator.

  Ejemplo

  apiVersion: atlas.mongodb.com/v1
  kind: AtlasProject
  metadata:
    name: my-project
    annotations:
      mongodb.com/atlas-resource-policy: "delete"

• Si ha revertido el nuevo comportamiento de eliminación al valor predeterminado utilizado antes de Atlas Kubernetes Operator 2.0, puede agregar la mongodb.com/atlas-resource-policy: "keep" anotación al de un recurso personalizado metadata para que Atlas Kubernetes Operator no elimine el recurso cuando elimine el recurso Atlas Kubernetes Operator.

• Si agregas la anotación mongodb.com/atlas-reconciliation-policy: "skip" a los metadata de un recurso personalizado, el Atlas Kubernetes Operator no inicia la reconciliación para el recurso. Esta anotación permite que se pause la sincronización con la especificación hasta que se remueva la anotación. Puede usar esta anotación para realizar cambios manuales en un recurso personalizado y evitar que el Atlas Kubernetes Operator deshaga esos cambios durante una sincronización. Cuando se remueve esta anotación, el Atlas Kubernetes Operator reconcilia el recurso y lo sincroniza con la especificación.

• Si agrega la anotación mongodb.com/atlas-resource-version-policy: "allow" al metadata ​​de un recurso personalizado, Atlas Kubernetes Operator le permite usar un recurso incluso si su etiqueta de versión no coincide con la versión de Atlas Kubernetes Operator que está utilizando. Si la versión de su recurso es una versión principal posterior a la de Atlas Kubernetes Operator, es posible que las funciones más recientes no funcionen. Las pequeñas discrepancias de versión son compatibles con versiones anteriores.