Cómo guardar y cargar instantáneas del entorno

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

En esta página, se explica cómo guardar y cargar el estado de tu entorno usando instantáneas del entorno.

Puedes configurar tu entorno para que guarde instantáneas automáticamente. Para ver más consulta Configura instantáneas programadas.

Acerca de las instantáneas de entorno

Las instantáneas del entorno almacenan el estado de tu entorno. Puedes guardar y cargar instantáneas del entorno a pedido.

Puedes usar instantáneas para lo siguiente:

Cómo se almacenan las instantáneas

Una instantánea del entorno es un conjunto de archivos que describen el estado de tu entorno y almacenan la copia de seguridad de los datos del entorno.

Puedes crear varias instantáneas de tu entorno. Las instantáneas del entorno no son incrementales. Puedes usar cualquier instantánea independientemente de las demás.

Cloud Composer no borra las instantáneas cuando borras en un entorno de nube.

De forma predeterminada, Cloud Composer almacena instantáneas en snapshots/. en el bucket de tu entorno. También puedes especificar una ubicación personalizada cuando creas una instantánea.

Si bien la IU de Cloud Storage muestra los datos como carpetas para mayor comodidad, los buckets funcionan en una estructura de archivos sin formato. Esto no cambia la forma en que trabajas con el guardado y la carga de instantáneas en la consola de Google Cloud, pero tenlo en cuenta cuando realices operaciones directamente en los archivos de tu bucket. Para obtener más información, consulta Espacio de nombres de objetos.

Consideraciones de seguridad para las instantáneas

Para mitigar este riesgo de seguridad, puedes almacenar la información sensible que usan los DAG de Airflow, como claves o contraseñas, en Secret Manager. Para obtener más información, consulta Configura Secret Manager para tu entorno.

Asegúrate de verificar los permisos de seguridad del bucket de tu entorno. Si almacenar instantáneas de entorno en un bucket personalizado, asegúrate de permisos de acceso para ellos estén configurados correctamente en un proyecto final. Cuando asignes permisos, asegúrate de que el servicio de ese entorno tiene suficientes permisos para guardar y cargar instantáneas de la bucket.

Qué datos se guardan en las instantáneas

Cloud Composer guarda los siguientes datos en instantáneas:

  • Anulaciones de configuración de Airflow.
  • Variables de entorno.
  • Es la lista de paquetes personalizados de PyPI, como requisitos.
  • Una copia de seguridad de la base de datos de Airflow, incluidos los estados de las tareas ejecutadas y el historial de ejecuciones de DAG
  • Una copia de seguridad de las carpetas /dags, /data y /plugins del bucket del entorno
  • La clave fernet del entorno.
  • Otra información sobre la configuración del entorno, como la escala y los parámetros de rendimiento del entorno. Cloud Composer no usa esta información cuando se carga. instantáneas.

Qué datos se cargan desde las instantáneas

Cloud Composer carga los siguientes datos desde instantáneas:

  • Anulaciones de configuración de Airflow.
  • Variables de entorno
  • Paquetes personalizados de PyPI (a menos que elijas omitir su instalación)

  • El contenido de la base de datos de Airflow, incluidos los estados de las tareas ejecutadas y el historial de ejecuciones de DAG

  • Contenido de las carpetas /dags, /data y /plugins de la instantánea se cargan en el bucket del entorno.

  • La clave de Fernet de la instantánea se usa para volver a encriptar los datos de la instantánea con la clave de Fernet del entorno. La clave de Fernet del entorno no se modifica.

Aunque Cloud Composer almacena información sobre el la configuración del entorno en instantáneas, no se usa cuando se cargan instantáneas. Los siguientes parámetros de tu entorno no cambian cuando cargar una instantánea:

  • Configuración del entorno, como el escalamiento y el rendimiento parámetros.
  • Configuración de red del entorno.
  • El contenido del bucket del entorno fuera de /dags, /data y /plugins carpetas.
  • Etiquetas de entorno

Cualquier configuración que hayas aplicado a la infraestructura de Cloud Composer sin usar la API de Cloud Composer se pueden perder cuando cargas instantánea.

Información acerca de las operaciones parcialmente completadas

Cuando cargas un resumen, la operación puede ser exitosa, fallar o completarse parcialmente:

  • Las operaciones correctas cargan todos los datos de la instantánea.
  • Las operaciones con errores no producen cambios.
  • Las operaciones que se completaron de forma parcial cargan un subconjunto de datos de la instantánea. Tales operaciones se informan como fallidas, pero el mensaje de error indica qué los datos se cargaron correctamente. Por ejemplo, si los paquetes de PyPI están instalados, pero las anulaciones de opciones de configuración de Airflow no se realizaron correctamente, el mensaje de error lo indica.

Para una operación completada parcialmente, puedes intentar cargar la misma instantánea de nuevo. Cloud Composer omite los pasos que se completaron correctamente en el intento anterior. Por ejemplo, si una operación falló en un tiempo de espera, pero la base de datos se cargó correctamente, el siguiente intento no vuelve a cargarla.

Antes de comenzar

  • En Cloud Composer 1 solo puedes guardar instantáneas, pero no cargarlas. Puedes cargar instantáneas desde un entorno de Cloud Composer 1 a Cloud Composer 2 entornos de prueba.
  • Las instantáneas son compatibles con la versión 2.0.9 y posteriores de Cloud Composer 2. Cloud Composer 1 admite el guardado de instantáneas del entorno para versiones 1.18.5 o posteriores.

  • Las instantáneas no crean un entorno. Si quieres cargar una instantánea de un entorno a otro, primero debes crear un entorno nuevo y, luego, cargar la instantánea en él.

  • No puedes cargar instantáneas en entornos que tengan el estado de error. Sí no es posible arreglar esos entornos cargando una instantánea. Aún puedes cargar una instantánea existente en un entorno nuevo.

  • Solo puedes cargar instantáneas en la misma versión de Cloud Composer o Airflow o una posterior. Por ejemplo, no puedes cargar una instantánea de Cloud Composer 2.0.2 en un entorno con Cloud Composer 2.0.1. Otro ejemplo es que no puedes cargar una instantánea de Airflow 2.2.3 a Airflow 2.1.4.

  • Las instantáneas no cambian la versión de Cloud Composer. Si actualizas tu entorno a una versión posterior Cloud Composer y, luego, cargarás una instantánea de una versión anterior su entorno seguirá manteniendo su versión actual Cloud Composer Por ejemplo, cargar una instantánea desde Cloud Composer 2.0.1 a Cloud Composer 2.0.2 no revertir el entorno a Cloud Composer 2.0.1.

  • El tamaño máximo de la base de datos de Airflow que admite instantáneas es de 20 GB. Si la base de datos de tu entorno toma más de 20 GB, Reduce el tamaño de la base de datos de Airflow antes de guardar una instantánea.

  • La cantidad total de objetos en las carpetas /dags, /plugins y /data en el bucket del entorno debe ser menor que 100,000 para crear instantáneas.

  • Si usas el mecanismo XCom para transferir archivos, asegúrate de [usarlo de acuerdo con los lineamientos de Airflow][ext-airflow-xcom-backend]. Transferir archivos grandes o una gran cantidad de archivos con XCom afecta el rendimiento de la base de datos de Airflow y puede generar fallas cuando se cargan instantáneas o se actualiza el entorno. Considera usar alternativas como Cloud Storage para transferir grandes volúmenes de datos.

  • La longitud máxima del nombre de un objeto en el bucket del entorno no debe ser más largos que los 1,024 símbolos. De lo contrario, no se pueden crear instantáneas.

  • Si guardas instantáneas en una ubicación fuera del bucket de tu entorno, la cuenta de servicio de tu entorno debe tener permisos de lectura y escritura para la ubicación especificada. Por ejemplo, el rol de administrador de objetos de almacenamiento tiene esos permisos. Tú puedes aplicarla a un proyecto o a un bucket específico.

  • La creación y el almacenamiento de instantáneas generan costos adicionales, que se relacionan con Cloud Storage. Para obtener más información, consulta Precios.

Guarda una instantánea del entorno

Cloud Composer guarda instantáneas del entorno en un subcarpeta, en relación con la carpeta que especifiques. El nombre de la carpeta contiene el ID del proyecto, la ubicación del entorno, el nombre del entorno y la marca de tiempo en la que se guardó la instantánea. Por ejemplo: /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00

Console

Para crear una instantánea de tu entorno, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página Entornos.

    Ir a Entornos

  2. En la lista de entornos, haz clic en el nombre de tu entorno. Se abrirá la página Detalles del entorno.

  3. Haz clic en Guardar instantánea.

  4. En el cuadro de diálogo Guardar instantánea, selecciona dónde almacenar la instantánea:

    • Para almacenar la instantánea en la carpeta /snapshots del entorno bucket, selecciona Usar la carpeta de instantáneas en el bucket de entorno (predeterminado).

    • Para almacenar la instantánea en la carpeta personalizada, selecciona Usa una carpeta personalizada en otro bucket y, luego, especifica una ubicación.

  5. Haz clic en Guardar.

gcloud

El comando gcloud beta composer environments snapshots save guarda una instantánea de tu entorno.

  • El argumento snapshot-location especifica una carpeta en la que se guarda la instantánea. De forma predeterminada, las instantáneas se guardan en la carpeta /snapshots de la en el bucket de tu entorno. Por ejemplo, gs://us-central1-example-916807e1-bucket/snapshots. También puedes especificar cualquier otra carpeta.

Para guardar una instantánea de tu entorno, ejecuta el siguiente comando:

gcloud beta composer environments snapshots save \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-location "SNAPSHOTS_FOLDER"

Reemplaza lo siguiente:

  • ENVIRONMENT_NAME por el nombre del entorno.
  • LOCATION por la región en la que se encuentra el entorno
  • SNAPSHOTS_FOLDER (opcional) con el URI de una carpeta de bucket en la que se almacenará la instantánea Si omites este argumento, Cloud Composer guarda la instantánea en la carpeta /snapshots del bucket de tu entorno.

En el siguiente ejemplo, se usa la ubicación predeterminada:

gcloud beta composer environments snapshots save \
  example-environment \
  --location us-central1

En el siguiente ejemplo, se guarda en una carpeta personalizada:

gcloud beta composer environments snapshots save \
  example-environment \
  --location us-central1 \
  --snapshot-location "gs://example-bucket/environment_snapshots"

API

  1. Realiza una solicitud a la API de environments.saveSnapshot.

  2. En el cuerpo de la solicitud, en el campo snapshotLocation, especifica en la carpeta en la que quieres guardar la instantánea.

{
  "snapshotLocation": "SNAPSHOTS_FOLDER"
}

Reemplaza lo siguiente:

  • SNAPSHOTS_FOLDER por el URI de una carpeta del bucket en la que se realizará guardar la instantánea.

Ejemplo:

// POST https://composer.googleapis.com/v1beta1/projects/example-project/
// locations/us-central1/environments/example-environment:saveSnapshot

{
  "snapshotLocation": "gs://us-central1-example-916807e1-bucket/snapshots"
}

Terraform

No es posible guardar ni cargar instantáneas del entorno desde Terraform.

Guardar y cargar instantáneas son acciones que se realizan en un entorno, y las instantáneas resultantes no forman parte de la definición de un entorno. Desde Terraform solo administra la configuración del entorno de Cloud Composer, no puedes guardar ni cargar instantáneas del entorno desde allí.

Cómo cargar una instantánea del entorno

En Cloud Composer 1, solo puedes guardar instantáneas, pero no cargarlas. Puedes cargar instantáneas desde un entorno de Cloud Composer 1 a Cloud Composer 2 entornos de prueba. Por ejemplo, cuando Migra tus entornos a Cloud Composer 2.

¿Qué sigue?