使用 KubernetesPodOperator

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

本页介绍如何使用 KubernetesPodOperator 将 Kubernetes pod 从 Cloud Composer 部署到作为 Cloud Composer 环境一部分的 Google Kubernetes Engine 集群。

KubernetesPodOperator 会在您环境的集群中启动 Kubernetes pod。相比之下，Google Kubernetes Engine Operator 在指定集群中运行 Kubernetes pod，该集群可以是与您的环境无关的独立集群。您还可以使用 Google Kubernetes Engine Operator 来创建和删除集群。

如果您需要以下内容，KubernetesPodOperator 是一个好的选项：

• 无法通过公共 PyPI 代码库获得的自定义 Python 依赖项。
• 无法通过现有 Cloud Composer 工作器映像获得的二进制依赖项。

注意： 如需详细了解如何安装托管在私有软件包代码库中的软件包，或要了解用于管理依赖项的其他选项，请参见安装 Python 依赖项。

准备工作

• 如果使用的是 CNCF Kubernetes Provider 版本 5.0.0，请按照“CNCF Kubernetes Provider”部分中记录的说明操作。

• Cloud Composer 2 不提供 Pod 亲和性配置。如果您想使用 Pod 亲和性，请改用 GKE Operator 在其他集群中启动 Pod。

Cloud Composer 2 中的 KubernetesPodOperator 简介

本部分介绍 KubernetesPodOperator 在 Cloud Composer 2 中的工作原理。

资源使用情况

在 Cloud Composer 2 中，您的环境的集群会自动扩缩。使用 KubernetesPodOperator 运行的额外工作负载会独立于您的环境进行扩缩。

您的环境不受资源需求增加的影响，但环境的集群会根据资源需求进行扩缩。

您在环境的集群中运行的额外工作负载的价格遵循 Cloud Composer 2 价格模式并使用 Cloud Composer 计算 SKU。

Cloud Composer 2 使用 Autopilot 集群，其中引入了计算类的概念：

• Cloud Composer 仅支持 general-purpose 计算类。

• 默认情况下，如果未选择任何类，则在您使用 KubernetesPodOperator 创建 Pod 时，系统会假定 general-purpose 类。

• 每个类都与特定的属性和资源限制相关联，您可以在 Autopilot 文档中了解它们。例如，在 general-purpose 类中运行的 Pod 最多可使用 110 GiB 的内存。

访问项目的资源

Cloud Composer 2 使用启用了适用于 GKE 的工作负载身份联合的 GKE 集群。在 composer-user-workloads 命名空间中运行的 Pod 无需额外配置即可访问项目中的资源。 Google Cloud 您环境的服务账号用于访问这些资源。

如果您想使用自定义命名空间，则必须将与此命名空间关联的 Kubernetes 服务账号映射到服务账号，以便为对 Google API 和其他服务的请求启用服务身份授权。 Google Cloud 如果您在环境集群的自定义命名空间中运行 Pod，则系统不会在 Kubernetes 和Google Cloud 服务账号之间创建 IAM 绑定，并且这些 Pod 无法访问您的 Google Cloud 项目的资源。

如果您使用自定义命名空间，并且希望您的 Pod 能够访问Google Cloud 资源，请按照适用于 GKE 的工作负载身份联合中的指南操作，为自定义命名空间设置绑定：

1. 在您的环境集群中创建单独的命名空间。
2. 在自定义命名空间 Kubernetes 服务账号和您环境的服务账号之间创建绑定。
3. 将您的环境的服务账号注释添加到 Kubernetes 服务账号。
4. 使用 KubernetesPodOperator 时，请在 namespace 和 service_account_name 参数中指定命名空间和 Kubernetes 服务账号。

注意： GKE 元数据服务器需要几秒钟的时间才能开始接受新创建的 Pod 发出的请求。因此，尝试在 Pod 生命周期的前几秒内使用适用于 GKE 的工作负载身份联合进行身份验证可能会失败。重试调用会解决问题。如需详细了解此限制，请参阅 适用于 GKE 的工作负载身份联合的限制。

最少的配置工作量

如需创建 KubernetesPodOperator，只有要使用的 Pod 的 name、image 和 task_id 参数是必需的。/home/airflow/composer_kube_config 包含用于向 GKE 进行身份验证的凭据。

kubernetes_min_pod = KubernetesPodOperator(
    # The ID specified for the task.
    task_id="pod-ex-minimum",
    # Name of task you want to run, used to generate Pod ID.
    name="pod-ex-minimum",
    # Entrypoint of the container, if not specified the Docker container's
    # entrypoint is used. The cmds parameter is templated.
    cmds=["echo"],
    # The namespace to run within Kubernetes. In Composer 2 environments
    # after December 2022, the default namespace is
    # `composer-user-workloads`. Always use the
    # `composer-user-workloads` namespace with Composer 3.
    namespace="composer-user-workloads",
    # Docker image specified. Defaults to hub.docker.com, but any fully
    # qualified URLs will point to a custom repository. Supports private
    # gcr.io images if the Composer Environment is under the same
    # project-id as the gcr.io images and the service account that Composer
    # uses has permission to access the Google Container Registry
    # (the default service account has permission)
    image="gcr.io/gcp-runtimes/ubuntu_20_0_4",
    # Specifies path to kubernetes config. The config_file is templated.
    config_file="/home/airflow/composer_kube_config",
    # Identifier of connection that should be used
    kubernetes_conn_id="kubernetes_default",
)

其他配置

此示例展示了您可以在 KubernetesPodOperator 中配置的其他参数。

如需了解详情，请参阅以下资源：

• 如需了解如何使用 Kubernetes Secret 和 ConfigMap，请参阅使用 Kubernetes Secret 和 ConfigMap。

• 如需了解如何将 Jinja 模板与 KubernetesPodOperator 搭配使用，请参阅使用 Jinja 模板。

• 如需了解 KubernetesPodOperator 参数，请参阅 Airflow 文档中的操作器参考文档。

kubernetes_full_pod = KubernetesPodOperator(
    task_id="ex-all-configs",
    name="pi",
    namespace="composer-user-workloads",
    image="perl:5.34.0",
    # Entrypoint of the container, if not specified the Docker container's
    # entrypoint is used. The cmds parameter is templated.
    cmds=["perl"],
    # Arguments to the entrypoint. The Docker image's CMD is used if this
    # is not provided. The arguments parameter is templated.
    arguments=["-Mbignum=bpi", "-wle", "print bpi(2000)"],
    # The secrets to pass to Pod, the Pod will fail to create if the
    # secrets you specify in a Secret object do not exist in Kubernetes.
    secrets=[],
    # Labels to apply to the Pod.
    labels={"pod-label": "label-name"},
    # Timeout to start up the Pod, default is 600.
    startup_timeout_seconds=600,
    # The environment variables to be initialized in the container.
    # The env_vars parameter is templated.
    env_vars={"EXAMPLE_VAR": "/example/value"},
    # If true, logs stdout output of container. Defaults to True.
    get_logs=True,
    # Determines when to pull a fresh image, if 'IfNotPresent' will cause
    # the Kubelet to skip pulling an image if it already exists. If you
    # want to always pull a new image, set it to 'Always'.
    image_pull_policy="Always",
    # Annotations are non-identifying metadata you can attach to the Pod.
    # Can be a large range of data, and can include characters that are not
    # permitted by labels.
    annotations={"key1": "value1"},
    # Optional resource specifications for Pod, this will allow you to
    # set both cpu and memory limits and requirements.
    # Prior to Airflow 2.3 and the cncf providers package 5.0.0
    # resources were passed as a dictionary. This change was made in
    # https://github.com/apache/airflow/pull/27197
    # Additionally, "memory" and "cpu" were previously named
    # "limit_memory" and "limit_cpu"
    # resources={'limit_memory': "250M", 'limit_cpu': "100m"},
    container_resources=k8s_models.V1ResourceRequirements(
        requests={"cpu": "1000m", "memory": "10G", "ephemeral-storage": "10G"},
        limits={"cpu": "1000m", "memory": "10G", "ephemeral-storage": "10G"},
    ),
    # Specifies path to kubernetes config. The config_file is templated.
    config_file="/home/airflow/composer_kube_config",
    # If true, the content of /airflow/xcom/return.json from container will
    # also be pushed to an XCom when the container ends.
    do_xcom_push=False,
    # List of Volume objects to pass to the Pod.
    volumes=[],
    # List of VolumeMount objects to pass to the Pod.
    volume_mounts=[],
    # Identifier of connection that should be used
    kubernetes_conn_id="kubernetes_default",
    # Affinity determines which nodes the Pod can run on based on the
    # config. For more information see:
    # https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
    # Pod affinity with the KubernetesPodOperator
    # is not supported with Composer 2
    # instead, create a cluster and use the GKEStartPodOperator
    # https://cloud.google.com/composer/docs/using-gke-operator
    affinity={},
)

使用 Jinja 模板

Airflow 支持在 DAG 中使用 Jinja 模板。

您必须在操作节点 (operator) 中声明所需的 Airflow 参数（task_id、name 和 image）。如以下示例所示，您可以搭配使用 Jinja 和所有其他参数生成模板，包括 cmds、arguments、env_vars 和 config_file。

示例中的 env_vars 参数是通过名为 my_value 的 Airflow 变量设置的。示例 DAG 会从 Airflow 中的 vars 模板变量获取其值。Airflow 提供了更多可用于访问不同类型信息的变量。例如，您可以使用 conf 模板变量来访问 Airflow 配置选项的值。如需了解详情以及 Airflow 中可用变量的列表，请参阅 Airflow 文档中的模板参考文档。

如果不更改 DAG 或创建 env_vars 变量，示例中的 ex-kube-templates 任务会因变量不存在而失败。在 Airflow 界面中或使用 Google Cloud CLI 创建此变量：

Airflow 界面

1. 转到 Airflow 界面。

2. 在工具栏中，依次选择 Admin > Variables。

3. 在 List Variable 页面上，点击 Add a new record。

4. 在 Add Variable 页面上，输入以下信息：

   • Key：my_value
   • Val：example_value

5. 点击保存。

gcloud

输入以下命令：

gcloud composer environments run ENVIRONMENT \
    --location LOCATION \
    variables set -- \
    my_value example_value

您需要进行如下替换：

• ENVIRONMENT 替换为环境的名称。
• LOCATION 替换为环境所在的区域。

以下示例演示了如何将 Jinja 模板与 KubernetesPodOperator 搭配使用：

kubernetes_template_ex = KubernetesPodOperator(
    task_id="ex-kube-templates",
    name="ex-kube-templates",
    namespace="composer-user-workloads",
    image="bash",
    # All parameters below can be templated with Jinja. For more information
    # and the list of variables available in Airflow, see
    # the Airflow templates reference:
    # https://airflow.apache.org/docs/apache-airflow/stable/templates-ref.html
    # Entrypoint of the container, if not specified the Docker container's
    # entrypoint is used. The cmds parameter is templated.
    cmds=["echo"],
    # DS in Jinja is the execution date as YYYY-MM-DD, this Docker image
    # will echo the execution date. Arguments to the entrypoint. The Docker
    # image's CMD is used if this is not provided. The arguments parameter
    # is templated.
    arguments=["{{ ds }}"],
    # The var template variable allows you to access variables defined in
    # Airflow UI. In this case we are getting the value of my_value and
    # setting the environment variable `MY_VALUE`. The pod will fail if
    # `my_value` is not set in the Airflow UI. The env_vars parameter
    # is templated.
    env_vars={"MY_VALUE": "{{ var.value.my_value }}"},
    # Specifies path to Kubernetes config. The config_file is templated.
    config_file="/home/airflow/composer_kube_config",
    # Identifier of connection that should be used
    kubernetes_conn_id="kubernetes_default",
)

使用 Kubernetes Secret 和 ConfigMap

Kubernetes Secret 是包含敏感数据的对象。Kubernetes ConfigMap 是包含键值对形式的非机密数据的对象。

在 Cloud Composer 2 中，您可以使用 Google Cloud CLI、API 或 Terraform 创建 Secret 和 ConfigMap，然后从 KubernetesPodOperator 访问它们。

YAML 配置文件简介

使用 Google Cloud CLI 和 API 创建 Kubernetes Secret 或 ConfigMap 时，您需要提供 YAML 格式的文件。此文件必须采用与 Kubernetes Secret 和 ConfigMap 相同的格式。Kubernetes 文档提供了许多 ConfigMap 和 Secret 的代码示例。首先，您可以查看使用 Secret 安全地分发凭据页面和 ConfigMap。

与 Kubernetes Secret 中相同，在 Secret 中定义值时，请使用 base64 表示法。

注意： 采用 base64 编码的值不会以任何方式加密，而只是经过了混淆处理。您可以从其 Base64 表示法恢复原始值。

如需对值进行编码，您可以使用以下命令（这是获取 base64 编码值的众多方法之一）：

echo "postgresql+psycopg2://root:example-password@127.0.0.1:3306/example-db" -n | base64

输出：

cG9zdGdyZXNxbCtwc3ljb3BnMjovL3Jvb3Q6ZXhhbXBsZS1wYXNzd29yZEAxMjcuMC4wLjE6MzMwNi9leGFtcGxlLWRiIC1uCg==

以下两个 YAML 文件示例将在本指南后面的示例中使用。Kubernetes Secret 的 YAML 配置文件示例：

apiVersion: v1
kind: Secret
metadata:
  name: airflow-secrets
data:
  sql_alchemy_conn: cG9zdGdyZXNxbCtwc3ljb3BnMjovL3Jvb3Q6ZXhhbXBsZS1wYXNzd29yZEAxMjcuMC4wLjE6MzMwNi9leGFtcGxlLWRiIC1uCg==

另一个示例演示了如何包含文件。与上一个示例一样，先编码文件内容 (cat ./key.json | base64)，然后在 YAML 文件中提供此值：

apiVersion: v1
kind: Secret
metadata:
  name: service-account
data:
  service-account.json: |
    ewogICJ0eXBl...mdzZXJ2aWNlYWNjb3VudC5jb20iCn0K

ConfigMap 的 YAML 配置文件示例。您无需在 ConfigMap 中使用 base64 表示法：

apiVersion: v1
kind: ConfigMap
metadata:
  name: example-configmap
data:
  example_key: example_value

管理 Kubernetes Secret

在 Cloud Composer 2 中，您可以使用 Google Cloud CLI 和 kubectl 创建 Secret：

1. 获取有关环境集群的信息：

   1. 运行以下命令：

      gcloud composer environments describe ENVIRONMENT \
          --location LOCATION \
          --format="value(config.gkeCluster)"
      

      替换：

      • 将 ENVIRONMENT 替换为您的环境名称。
      • 将 LOCATION 替换为 Cloud Composer 环境所在的区域。

      此命令的输出使用以下格式：projects/<your-project-id>/locations/<location-of-composer-env>/clusters/<your-cluster-id>。

   2. 为了获取 GKE 集群 ID，请复制 /clusters/ 后面的输出内容（以 -gke 结尾）。

2. 使用以下命令连接到您的 GKE 集群：

   gcloud container clusters get-credentials CLUSTER_ID \
     --project PROJECT \
     --region LOCATION
   

   替换以下内容：

   • CLUSTER_ID：环境的集群 ID。
   • PROJECT_ID：项目 ID。
   • LOCATION：环境所在的区域。

3. 创建 Kubernetes Secret：

   注意： 如需了解用于修改和删除 Secret 的命令，请参阅使用 kubectl 管理 Secret。

   以下命令演示了创建 Kubernetes Secret 的两种不同方法。--from-literal 方法使用键值对。--from-file 方法使用文件内容。

   • 如需通过提供键值对来创建 Kubernetes Secret，请运行以下命令。此示例创建了一个名为 airflow-secrets 的 Secret，其中包含一个值为 test_value 的 sql_alchemy_conn 字段。

     kubectl create secret generic airflow-secrets \
       --from-literal sql_alchemy_conn=test_value -n composer-user-workloads
     

   • 如需通过提供文件内容创建 Kubernetes Secret，请运行以下命令。此示例创建一个名为 service-account 的 Secret，其中包含一个 service-account.json 字段，其值取自本地 ./key.json 文件的内容。

     kubectl create secret generic service-account \
       --from-file service-account.json=./key.json -n composer-user-workloads
     

在 DAG 中使用 Kubernetes Secret

此示例展示了使用 Kubernetes Secret 的两种方法：作为环境变量，以及由 pod 装载的卷。

第一个 Secret airflow-secrets 设置为名为 SQL_CONN 的 Kubernetes 环境变量（而不是 Airflow 或 Cloud Composer 环境变量）。

第二个 Secret service-account 将包含服务账号令牌的文件 service-account.json 装载到 /var/secrets/google。

Secret 对象如下所示：

secret_env = Secret(
    # Expose the secret as environment variable.
    deploy_type="env",
    # The name of the environment variable, since deploy_type is `env` rather
    # than `volume`.
    deploy_target="SQL_CONN",
    # Name of the Kubernetes Secret
    secret="airflow-secrets",
    # Key of a secret stored in this Secret object
    key="sql_alchemy_conn",
)
secret_volume = Secret(
    deploy_type="volume",
    # Path where we mount the secret as volume
    deploy_target="/var/secrets/google",
    # Name of Kubernetes Secret
    secret="service-account",
    # Key in the form of service account file name
    key="service-account.json",
)

第一个 Kubernetes Secret 的名称在 secret_env 变量中定义。此 Secret 名为 airflow-secrets。deploy_type 参数指定它必须公开为环境变量。环境变量的名称为 SQL_CONN，如 deploy_target 参数中所指定。最后，将 SQL_CONN 环境变量的值设置为 sql_alchemy_conn 键的值。

第二个 Kubernetes Secret 的名称在 secret_volume 变量中定义。此 Secret 名为 service-account。它显示为卷，如 deploy_type 参数中所指定。要装载的文件的路径 deploy_target 是 /var/secrets/google。最后，存储在 deploy_target 中的 Secret 的 key 为 service-account.json。

操作节点配置类似于如下所示：

kubernetes_secret_vars_ex = KubernetesPodOperator(
    task_id="ex-kube-secrets",
    name="ex-kube-secrets",
    namespace="composer-user-workloads",
    image="gcr.io/gcp-runtimes/ubuntu_20_0_4",
    startup_timeout_seconds=300,
    # The secrets to pass to Pod, the Pod will fail to create if the
    # secrets you specify in a Secret object do not exist in Kubernetes.
    secrets=[secret_env, secret_volume],
    # Entrypoint of the container, if not specified the Docker container's
    # entrypoint is used. The cmds parameter is templated.
    cmds=["echo"],
    # env_vars allows you to specify environment variables for your
    # container to use. The env_vars parameter is templated.
    env_vars={
        "EXAMPLE_VAR": "/example/value",
        "GOOGLE_APPLICATION_CREDENTIALS": "/var/secrets/google/service-account.json",
    },
    # Specifies path to kubernetes config. The config_file is templated.
    config_file="/home/airflow/composer_kube_config",
    # Identifier of connection that should be used
    kubernetes_conn_id="kubernetes_default",
)

CNCF Kubernetes 提供商的相关信息

KubernetesPodOperator 在 apache-airflow-providers-cncf-kubernetes 提供程序中实现。

如需查看 CNCF Kubernetes 提供商的详细版本说明，请访问 CNCF Kubernetes 提供商网站。

版本 6.0.0

在 CNCF Kubernetes Provider 软件包的 6.0.0 版中，KubernetesPodOperator 中默认使用 kubernetes_default 连接。

如果您在版本 5.0.0 中指定了自定义连接，运营商仍会使用此自定义连接。如需改回使用 kubernetes_default 连接，您可能需要相应地调整 DAG。

版本 5.0.0

与版本 4.4.0 相比，此版本引入了一些向后不兼容的更改。其中最重要的更改与 kubernetes_default 连接有关，该连接在版本 5.0.0 中未使用。

重要提示： 如果您要从使用 4.4.0 或更低版本提供程序的 Cloud Composer 版本升级到使用 5.0.0 版本提供程序的 Cloud Composer 版本，则必须调整使用 KubernetesPodOperator 的 DAG。

• 需要修改 kubernetes_default 连接。Kubernetes 配置路径必须设置为 /home/airflow/composer_kube_config（如以下图所示）。或者，您也可以将 config_file 添加到 KubernetesPodOperator 配置中（如以下代码示例所示）。

图 1. Airflow 界面，修改 kubernetes_default 连接（点击可放大）

• 按照以下方式使用 KubernetesPodOperator 修改任务的代码：

KubernetesPodOperator(
  # config_file parameter - can be skipped if connection contains this setting
  config_file="/home/airflow/composer_kube_config",
  # definition of connection to be used by the operator
  kubernetes_conn_id='kubernetes_default',
  ...
)

如需详细了解版本 5.0.0，请参阅 CNCF Kubernetes Provider 版本说明。

问题排查

本部分提供了有关排查常见 KubernetesPodOperator 问题的建议：

查看日志

排查问题时，您可以按以下顺序查看日志：

1. Airflow 任务日志：

   1. 在 Google Cloud 控制台中，前往环境页面。

      转到“环境”

   2. 在环境列表中，点击您的环境名称。环境详情页面会打开。

   3. 前往 DAG 标签页。

   4. 点击 DAG 的名称，然后点击 DAG 运行作业以查看详细信息和日志。

2. Airflow 调度器日志：

   1. 前往环境详情页面。

   2. 前往日志标签页。

   3. 检查 Airflow 调度程序日志。

3. Google Cloud 控制台中 GKE 工作负载下的 Pod 日志。这些日志包括 Pod 定义 YAML 文件、Pod 事件和 Pod 详情。

非零返回代码

使用 KubernetesPodOperator（和 GKEStartPodOperator）时，容器入口点的返回代码确定任务是否成功。返回非零代码表示失败。

常见模式是执行一个 shell 脚本作为容器入口点，以将容器内的多个操作分组到一起。

如果您要编写这样的脚本，建议您在脚本的顶部加入 set -e 命令，因而脚本中失败的命令会终止脚本并将故障传播至 Airflow 任务实例。

Pod 超时

KubernetesPodOperator 的默认超时时间为 120 秒，这会导致在较大的映像下载完成之前发生超时。您可以通过在创建 KubernetesPodOperator 时更改 startup_timeout_seconds 参数来增加超时值。

如果某个 pod 超时，您可从 Airflow 界面中查看相应任务专属的日志。例如：

Executing <Task(KubernetesPodOperator): ex-all-configs> on 2018-07-23 19:06:58.133811
Running: ['bash', '-c', u'airflow run kubernetes-pod-example ex-all-configs 2018-07-23T19:06:58.133811 --job_id 726 --raw -sd DAGS_FOLDER/kubernetes_pod_operator_sample.py']
Event: pod-name-9a8e9d06 had an event of type Pending
...
...
Event: pod-name-9a8e9d06 had an event of type Pending
Traceback (most recent call last):
  File "/usr/local/bin/airflow", line 27, in <module>
    args.func(args)
  File "/usr/local/lib/python2.7/site-packages/airflow/bin/cli.py", line 392, in run
    pool=args.pool,
  File "/usr/local/lib/python2.7/site-packages/airflow/utils/db.py", line 50, in wrapper
    result = func(*args, **kwargs)
  File "/usr/local/lib/python2.7/site-packages/airflow/models.py", line 1492, in _run_raw_task
    result = task_copy.execute(context=context)
  File "/usr/local/lib/python2.7/site-packages/airflow/contrib/operators/kubernetes_pod_operator.py", line 123, in execute
    raise AirflowException('Pod Launching failed: {error}'.format(error=ex))
airflow.exceptions.AirflowException: Pod Launching failed: Pod took too long to start

如果 Cloud Composer 服务账号缺少必要的 IAM 权限来执行手头的任务，也会出现 pod 超时。如需验证是否属于这种情况，请使用 GKE 信息中心查看 Pod 级错误，找到特定工作负载的日志；或者使用 Cloud Logging。

无法建立新连接

GKE 集群默认启用自动升级。 如果集群中的某个节点池正在升级，您可能会看到以下错误：

<Task(KubernetesPodOperator): gke-upgrade> Failed to establish a new
connection: [Errno 111] Connection refused

如需检查您的集群是否正在升级，请在 Google Cloud 控制台中前往 Kubernetes 集群页面，然后查看您的环境的集群名称旁是否有加载图标。

后续步骤

• 使用 GKE Operator
• Kubernetes 基础知识