Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
En esta página, se muestra cómo usar Secret Manager para almacenar las conexiones y secretos de Airflow de forma segura.
Configura Secret Manager para tu entorno
En esta sección, se explica cómo configurar Secret Manager para que puedas usar secretos con tu entorno de Cloud Composer.
Habilita la API de Secret Manager
Consola
Habilita la API de Secret Manager.
gcloud
Habilita la API de Secret Manager:
gcloud services enable secretmanager.googleapis.com
Configura el control de acceso
Debes configurar el control de acceso para que Airflow pueda acceder a los secretos almacenados en Secret Manager.
Para ello, la cuenta de servicio que accede a los secretos debe tener una función con el permiso secretmanager.versions.access
. Por ejemplo, la función Administrador de accesos a secretos de Secret Manager incluye este permiso.
Puedes otorgar esta función a nivel de Secret, proyecto, organización o carpeta.
Usa una de las siguientes opciones:
Otorga esta función a la cuenta de servicio de tu entorno (recomendado).
Anula la cuenta de servicio con la que Airflow accede a Secret Manager.
- Otorga este rol a una cuenta de servicio.
- Establece el parámetro
gcp_key_path
de la opción de configuraciónbackend_kwargs
de Airflow para que apunte a un archivo JSON con las credenciales de la cuenta de servicio.
Habilita y configura el backend de Secret Manager
Anula la siguiente opción de configuración de Airflow:
Sección Clave Valor secrets
backend
airflow.providers.google.cloud.secrets.secret_manager.CloudSecretManagerBackend
Para agregar una configuración opcional, anula la siguiente opción de configuración de Airflow:
Sección Clave Valor secrets
backend_kwargs
Consulta la siguiente descripción. El valor
backend_kwargs
es la representación JSON del objetobackend_kwargs
con los siguientes campos:connections_prefix
: Es el prefijo del nombre del secreto que se debe leer para obtener conexiones. El valor predeterminado esairflow-connections
.variables_prefix
: Es el prefijo del nombre del secreto que se debe leer para obtener las variables. El valor predeterminado esairflow-variables
.gcp_key_path
: Es la ruta de acceso al archivo JSON de credenciales de Google Cloud (si no se proporciona, se usa la cuenta de servicio predeterminada).gcp_keyfile_dict
: Diccionario JSON de credenciales de Google Cloud. Mutuamente exclusivo congcp_key_path
.sep
: Es el separador que se usa para concatenarconnections_prefix
yconn_id
. El valor predeterminado es-
.project_id
: Es el ID del proyecto de Google Cloud en el que se almacenan los secretos.
Por ejemplo, el valor de
backend_kwargs
puede ser:{"project_id": "<project id>", "connections_prefix":"example-connections", "variables_prefix":"example-variables", "sep":"-"}
Agrega conexiones y variables en Secret Manager
Para crear secretos, sigue los pasos que se describen en Crea secretos y versiones.
Variables
- Debe usar el formato
[variable_prefix][sep][variable_name]
. - El valor predeterminado para
[variable_prefix]
esairflow-variables
. - El separador predeterminado
[sep]
es-
Por ejemplo, si el nombre de la variable es example-var
, el nombre del secreto es airflow-variables-example-var
.
Nombres de las conexiones
- Debe usar el formato
[connection_prefix][sep][connection_name]
. - El valor predeterminado para
[connection_prefix]
esairflow-connections
. - El separador predeterminado
[sep]
es-
Por ejemplo, si el nombre de la conexión es exampleConnection
, el nombre del secreto es airflow-connections-exampleConnection
.
Valores de conexión
Se debe usar la representación de URI. Por ejemplo,
postgresql://login:secret@examplehost:9000
El URI debe estar codificado en formato URL (codificado con porcentaje). Por ejemplo, una contraseña que tiene un símbolo de espacio debe estar codificada como URL de la siguiente manera:
postgresql://login:secret%20password@examplehost:9000
.
Airflow tiene un método conveniente para generar URI de conexión. En la documentación de Airflow, puedes encontrar un ejemplo de cómo codificar una URL compleja con extras de JSON.
Usa Secret Manager con Cloud Composer
Cuando recuperas variables y conexiones, Cloud Composer primero verifica Secret Manager. Si no se encuentra la variable o la conexión solicitadas, Cloud Composer verifica las variables de entorno y la base de datos de Airflow.
Leer variables con plantillas de Jinja
Puedes usar Secret Manager a fin de leer variables con plantillas de Jinja para campos de operador con plantillas (resueltas en el momento de la ejecución).
Para el secreto airflow-variables-secret_filename
:
file_name = '{{var.value.secret_filename}}'
Lee variables con operadores personalizados y devoluciones de llamada
También puedes usar Secret Manager para leer variables en operadores personalizados o métodos de devolución de llamada de operadores. Leer las variables desde los DAG puede tener un impacto negativo en el rendimiento, por lo que debes usar las plantillas de Jinja si deseas usar variables en tus DAG.
Por ejemplo, para el secreto airflow-variables-secret_filename
, haz lo siguiente:
from airflow.models.variable import Variable
file_name = Variable.get('secret_filename')
Leer conexiones
A menos que escribas un operador personalizado, rara vez necesitas acceder directamente a las conexiones. La mayoría de los hooks reciben el nombre de conexión como su parámetro de creación de instancias, y deben recuperar las conexiones del backend del secreto automáticamente cuando se ejecutan las tareas.
Leer las conexiones directamente puede ser útil cuando escribes tu propio hook.
Por ejemplo, para la conexión airflow-connections-exampleConnection
:
from airflow.hooks.base_hook import BaseHook
exampleConnection = BaseHook.get_connection('exampleConnection')
BaseHook.get_connection
muestra un objeto Connection
. Es posible obtener la representación de string de URI de una conexión como esta:
exampleConnectionUri = BaseHook.get_connection('exampleConnection').get_uri()