Guarda y carga instantáneas de entorno

Cloud Composer 1 | Cloud Composer 2

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

Puedes configurar tu entorno para que guarde instantáneas automáticamente. Para obtener más información, consulta Configura instantáneas programadas.

Información acerca de las instantáneas de entorno

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

Puedes usar instantáneas para lo siguiente:

• Restablece tu entorno a un estado anterior. Crea copias de seguridad de tu entorno mediante instantáneas y, luego, carga una de ellas para restablecer el entorno. Por ejemplo, puedes revertir una operación de actualización que instale paquetes de PyPI o anule las opciones de configuración de Airflow, incluso después de que tu entorno se actualice de forma correcta.

• Realizar actualizaciones en paralelo y copiar entornos. Crea una instantánea de un entorno existente, crea uno nuevo que use la misma versión de Cloud Composer o una posterior y, luego, aplica la instantánea a este entorno nuevo. Este procedimiento es similar a la migración. Asegúrate de pausar los DAG antes de tomar la instantánea para evitar ejecuciones duplicadas.

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 sus datos.

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

Cloud Composer no borra instantáneas cuando borras tu entorno.

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

Mientras que la IU de Cloud Storage muestra datos como carpetas para mayor comodidad, los buckets funcionan en una estructura de archivos plana. Esto no cambia la forma en que trabajas para guardar y cargar instantáneas en la consola de Google Cloud, pero puede ser una distinción importante a tener en cuenta cuando realizas operaciones directamente en los archivos del bucket. Para obtener más información, consulta Carpetas.

Consideraciones de seguridad para las instantáneas

Advertencia: La clave fernet de tu entorno se almacena junto con la copia de seguridad de la base de datos de Airflow. Esto significa que la información sensible, como los extras y las contraseñas de conexión de Airflow, se pueden desencriptar desde una instantánea del entorno.

Para mitigar este riesgo de seguridad, puedes almacenar información sensible que usan los DAG de Airflow, como claves o contraseñas, en Secret Manager. Si quieres 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 almacenas instantáneas del entorno en un bucket personalizado, asegúrate de que los permisos de acceso correspondientes estén configurados de forma correcta en tu proyecto. Cuando asignes permisos, asegúrate de que la cuenta de servicio del entorno tenga los permisos suficientes para guardar y cargar instantáneas desde el 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.
• 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.
• Clave de 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 carga instantáneas.

Qué datos se cargan desde las instantáneas

Cloud Composer carga los siguientes datos desde las instantáneas:

• Anulaciones de configuración de Airflow.
• Variables de entorno.

• Paquetes de PyPI personalizados (a menos que decidas omitir la instalación).

  Precaución: Cloud Composer instala los paquetes a medida que se especifican en los requisitos. Por ejemplo, si una instantánea tiene example_package>=1.0 como requisito, se puede instalar una versión diferente del paquete cuando la cargues.

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

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

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

Aunque Cloud Composer almacena cierta información sobre 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 cargas una instantánea:

• Configuración del entorno, como la escala del entorno y los parámetros de rendimiento
• Configuración de red del entorno.
• Contenido del bucket del entorno fuera de las carpetas /dags, /data y /plugins
• Etiquetas de entorno.

Cualquier configuración que hayas aplicado en la infraestructura de Cloud Composer sin usar la API de Cloud Composer podría perderse cuando cargues una instantánea.

Acerca de las operaciones completadas parcialmente

Cuando cargas una instantánea, la operación puede ser exitosa, tener errores o completarse de forma parcial:

• Las operaciones exitosas cargan todos los datos de la instantánea.
• Las operaciones con errores no introducen ningún cambio.
• Las operaciones completadas parcialmente cargan un subconjunto de datos desde la instantánea. Estas operaciones se informan como fallidas, pero el mensaje de error indica qué datos se cargaron correctamente. Por ejemplo, si se instalan los paquetes de PyPI, pero las anulaciones de la opción de configuración de Airflow no se realizaron de forma correcta, el mensaje de error lo indica.

En el caso de una operación que se completó de forma parcial, puedes intentar cargar la misma instantánea otra vez. Cloud Composer omite los pasos que tuvieron éxito en el intento anterior. Por ejemplo, si una operación falló durante el tiempo de espera, pero la base de datos se cargó de forma correcta, el próximo intento no volverá a cargar la base de datos.

Antes de comenzar

• Las instantáneas son compatibles con Cloud Composer 2 versión 2.0.9 y posteriores. Cloud Composer 1 admite el guardado de instantáneas de entorno para versiones >= 1.18.5.

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

• No puedes cargar instantáneas a entornos que están en estado de error. No es posible corregir 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 bien en una posterior. Por ejemplo, no puedes cargar una instantánea de Cloud Composer 2.0.2 a un entorno con Cloud Composer 2.0.1. Como otro ejemplo, 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 de Cloud Composer y, luego, cargas una instantánea desde una versión anterior, tu entorno seguirá conservando su versión actual de Cloud Composer. Por ejemplo, cargar una instantánea de Cloud Composer 2.0.1 a Cloud Composer 2.0.2 no revierte 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 ocupa más de 20 GB, reduce el tamaño de la base de datos de Airflow antes de guardar una instantánea.

• 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, la función Administrador de objetos de almacenamiento tiene esos permisos. Puedes aplicarlo a un proyecto o a un bucket específico.

• La creación y el almacenamiento de instantáneas produce costos adicionales relacionados 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 una subcarpeta, relacionada 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 del momento en que se guardó la instantánea. Por ejemplo: /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00

Consola

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 la ubicación en la que deseas almacenar la instantánea:

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

   • Para almacenar la instantánea en la carpeta personalizada, selecciona Usar 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 del 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 del 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
• (Opcional) SNAPSHOTS_FOLDER 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 la carpeta en la que deseas guardar la instantánea.

{
  "snapshotLocation": "SNAPSHOTS_FOLDER"
}

Reemplaza lo siguiente:

• SNAPSHOTS_FOLDER por el URI de una carpeta de bucket en la que se 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 de 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. Debido a que Terraform solo administra la configuración del entorno de Cloud Composer, no puedes guardar ni cargar instantáneas del entorno desde él.

Carga una instantánea del entorno

Advertencia: Después de cargar una instantánea, el historial de ejecución del DAG se restablece al estado de la instantánea. Esto puede generar ejecuciones de DAG duplicadas.

Considera la siguiente situación. Por ejemplo, la actualización está habilitada y Airflow ejecuta un DAG en un programa entre el momento en que se creó la instantánea y en el que se cargó. En este caso, después de cargar la instantánea, Airflow no tiene información sobre la ejecución del DAG que se realizó, por lo que Airflow vuelve a ejecutarlo al mismo tiempo y los mismos datos.

Como otro ejemplo, considere un DAG que se ejecuta según un programa diario. Tomas una instantánea, luego Airflow ejecuta este DAG y, después, cargas la instantánea el mismo día. En este caso, Airflow vuelve a ejecutar el DAG, incluso si la actualización está inhabilitada.

Consola

Para cargar una instantánea en tu entorno de Cloud Composer 2, 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 Load snapshot.

4. En el cuadro de diálogo Load snapshot, haz clic en Browse (Explorar).

5. Selecciona una carpeta que almacene la instantánea. El nombre de la carpeta incluye el ID del proyecto, la ubicación del entorno y la marca de tiempo de cuando se guardó la instantánea. Por ejemplo, /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

6. Para omitir la instalación de paquetes de PyPI personalizados desde la instantánea, selecciona Skip PyPI packages installation (opcional). Si cargas una instantánea de un entorno con paquetes de PyPI personalizados instalados, Cloud Composer no los instala.

7. Haz clic en Load y espera hasta que Cloud Composer cargue la instantánea.

gcloud

El comando gcloud beta composer environments snapshots load carga una instantánea en tu entorno.

• El argumento --snapshot-path especifica una carpeta en la que se encuentra la instantánea.

  El nombre de la carpeta incluye el ID del proyecto, la ubicación del entorno y la marca de tiempo del momento en que se guardó la instantánea. Por ejemplo, gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

• El argumento --skip-pypi-packages-installation omite la instalación de paquetes personalizados de PyPI desde la instantánea (opcional). Si cargas una instantánea de un entorno con paquetes de PyPI personalizados instalados, Cloud Composer no los instala.

gcloud beta composer environments snapshots load \
  DESTINATION_ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-path "SNAPSHOT_PATH"

Reemplaza lo siguiente:

• DESTINATION_ENVIRONMENT_NAME por el nombre del entorno en el que deseas cargar la instantánea
• LOCATION por la región en la que se encuentra el entorno
• SNAPSHOT_PATH por el URI de un bucket, seguido de la ruta a la instantánea.

Ejemplo:

gcloud beta composer environments snapshots load \
  example-environment \
  --location us-central1 \
  --snapshot-path "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00"

API

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

2. En el cuerpo de la solicitud, en el campo snapshotPath, especifica el URI de un bucket, seguido de la ruta de acceso a la instantánea. El nombre de la carpeta muestra el ID del proyecto, la ubicación del entorno y la marca de tiempo del momento en que se guardó la instantánea. Por ejemplo, gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00

3. En el cuerpo de la solicitud, en el campo skipPypiPackagesInstallation, especifica si Cloud Composer debe omitir la instalación de paquetes personalizados de PyPI desde la instantánea (opcional). Si cargas una instantánea de un entorno con paquetes de PyPI personalizados instalados, Cloud Composer no los instala.

   Este campo es opcional. Si omites este campo, Cloud Composer instala paquetes de PyPI a partir de la instantánea.

{
  "snapshotPath": "SNAPSHOT_PATH"
}

Reemplaza lo siguiente:

• SNAPSHOT_PATH por el URI de una carpeta de bucket en la que se almacenará la instantánea.

Ejemplo:

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

{
  "snapshotPath": "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00",
  "skipPypiPackagesInstallation": "False"
}

Terraform

No es posible guardar ni cargar instantáneas de entorno con 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. Debido a que Terraform solo administra la configuración del entorno de Cloud Composer, no puedes guardar ni cargar instantáneas del entorno desde él.

¿Qué sigue?

• Configura instantáneas programadas
• Crea entornos
• Control de acceso