Cómo guardar y cargar instantáneas del entorno

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

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 Cómo configurar 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:

• Restablece tu entorno a un estado anterior. Crea copias de seguridad de tu ambiente con instantáneas y, luego, carga una de ellas para restablecer el ambiente. Por ejemplo, puedes revertir una operación de actualización que instala paquetes de PyPI o anula las opciones de configuración de Airflow, incluso después de que tu entorno se haya actualizado correctamente.

• Realiza actualizaciones en paralelo y copia entornos. Crea una instantánea de un entorno existente, crea un entorno nuevo que use la misma versión de Cloud Composer o una posterior y, luego, aplica la instantánea a este nuevo entorno. Este procedimiento es similar a la migración. Asegúrate de pausar los DAG antes de tomar la instantánea para evitar ejecuciones de DAG 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 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 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.

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 la carga y el guardado de instantáneas en la consola de Google Cloud, pero ten esto 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

Advertencia: La clave de 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 de conexión de Airflow y las contraseñas, se puede desencriptar desde una instantánea del entorno.

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 Cómo configurar 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 estén configurados correctamente en tu proyecto. Cuando asignes permisos, asegúrate de que la cuenta de servicio del entorno tenga suficientes permisos para guardar y cargar instantáneas del 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 carga las instantáneas.

Qué datos se cargan desde las instantáneas

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

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

• Paquetes personalizados de PyPI (a menos que elijas omitir su instalación)

  Precaución: Cloud Composer instala los paquetes como se especifica 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 cargas la instantánea.

• 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 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 cierta información sobre la configuración del entorno en las instantáneas, no se usa cuando se cargan. 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 las herramientas de redes del entorno
• Contenido del bucket del entorno fuera de las carpetas /dags, /data y /plugins
• Etiquetas de entorno

Es posible que se pierda cualquier configuración que hayas aplicado en la infraestructura de Cloud Composer sin usar la API de Cloud Composer cuando cargues una 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 fallidas no introducen ningún cambio.
• Las operaciones que se completaron de forma parcial cargan un subconjunto de datos de la instantánea. Estas operaciones se informan como fallidas, pero el mensaje de error indica qué 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 otra vez. 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 volverá a cargarla.

Antes de comenzar

• Las instantáneas son compatibles con Cloud Composer 2 versión 2.0.9 y versiones posteriores. Cloud Composer 1 admite el guardado de instantáneas de entorno en 1.18.5 y versiones 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. 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 Airflow o una posterior. Por ejemplo, no puedes cargar una instantánea de Airflow 2.9.3 a Airflow 2.7.3.

• Es posible cargar una instantánea de una compilación posterior de Airflow de la misma versión de Airflow a un entorno con una compilación anterior. Por ejemplo, puedes cargar airflow-2.9.3-build.6 en airflow-2.9.3-build.5. Te recomendamos cargar instantáneas en compilaciones anteriores solo si es necesario.

• 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.

• La cantidad total de objetos en las carpetas /dags, /plugins y /data del bucket del entorno debe ser inferior a 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]. La transferencia de archivos grandes o una gran cantidad de archivos con XCom afecta el rendimiento de la base de datos de Airflow y puede provocar 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 superior a 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. Puedes aplicarlo 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.

Cómo guardar una instantánea del entorno

Cloud Composer guarda las instantáneas del entorno en una 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, haz lo siguiente:

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 almacenarla:

   • Para almacenar la instantánea en la carpeta /snapshots del bucket del entorno, selecciona Usar la carpeta de instantáneas en el bucket del 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 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 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 lo siguiente:

gcloud 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 guardará la instantánea en la carpeta /snapshots del bucket de tu entorno.

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

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

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

gcloud 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 con el URI de una carpeta de bucket en la que se guardará la instantánea.

Ejemplo:

// POST https://composer.googleapis.com/v1/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 entornos 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. Dado que 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

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

Considera la siguiente situación. Por ejemplo, se habilita la recuperación y Airflow ejecuta un DAG según un programa entre el momento en que se creó la instantánea y el momento en que se cargó. En este caso, después de cargar la instantánea, Airflow no tiene información sobre la ejecución de DAG que se produjo, por lo que vuelve a ejecutar el DAG para la misma hora y los mismos datos.

Como otro ejemplo, considera un DAG que se ejecuta en 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 recuperación está inhabilitada.

Console

Para cargar una instantánea en tu entorno, haz lo siguiente:

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 Cargar instantánea.

4. En el diálogo Cargar instantánea, haz clic en Explorar.

5. Selecciona una carpeta que almacene la instantánea. En el nombre de la carpeta, se muestra el ID de tu proyecto, la ubicación 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.

6. (Opcional) Para omitir la instalación de paquetes personalizados de PyPI desde la instantánea, selecciona Omitir la instalación de paquetes de PyPI. Si cargas una instantánea de un entorno con paquetes PyPI personalizados instalados, Cloud Composer no instalará estos paquetes personalizados.

7. Haz clic en Cargar y espera a que Cloud Composer cargue la instantánea.

gcloud

El comando gcloud 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.

  En el nombre de la carpeta, se muestra el ID de tu proyecto, la ubicación del entorno y la marca de tiempo en la 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.

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

gcloud 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 con el URI de un bucket, seguido de la ruta de acceso a la instantánea.

Ejemplo:

gcloud 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. En el nombre de la carpeta, se muestra el ID de tu proyecto, la ubicación del entorno y la marca de tiempo en la 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. (Opcional) En el cuerpo de la solicitud, en el campo skipPypiPackagesInstallation, especifica si Cloud Composer debe omitir la instalación de paquetes de PyPI personalizados desde la instantánea. Si cargas una instantánea de un entorno con paquetes PyPI personalizados instalados, Cloud Composer no instalará estos paquetes personalizados.

   Este campo es opcional. Si omites este campo, Cloud Composer instalará los paquetes de PyPI desde la instantánea.

{
  "snapshotPath": "SNAPSHOT_PATH"
}

Reemplaza lo siguiente:

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

Ejemplo:

// POST https://composer.googleapis.com/v1/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 entornos 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. Dado que Terraform solo administra la configuración del entorno de Cloud Composer, no puedes guardar ni cargar instantáneas del entorno desde allí.

¿Qué sigue?

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