Cloud Composer 1 |Cloud Composer 2 |Cloud Composer 3
本页面介绍了如何在 Cloud Composer 中安装自定义插件 环境
通过 Apache Airflow 的插件管理器,您可以编写自定义的内部 Apache Airflow 运算符、钩子、传感器或接口。如需了解详情,请参阅 Airflow 文档中的自定义插件。
自定义插件简介
当您创建环境时,Cloud Composer 会创建一个 Cloud Storage 存储桶,并将该存储桶与您的环境关联。您可以使用环境存储桶中的 plugins
文件夹来安装自定义插件。
准备工作
- 您的账号必须具备允许查看和修改环境的存储桶内容的角色。
- 这种安装方法仅适用于 Airflow 插件。例如,您不能使用此方法来安装常用的 Python 模块或其他库。
- 插件必须遵循 Airflow 插件模板准则。
安装插件
如需在 Cloud Composer 环境中安装自定义插件,请执行以下操作:
将插件代码复制到环境存储桶中的 plugins
文件夹。
如需安装插件,请按照以下所述操作:
控制台
gcloud
使用以下 gcloud
命令:
gcloud composer environments storage plugins import \
--environment ENVIRONMENT_NAME \
--location LOCATION \
--source PATH_TO_LOCAL_FILE \
--destination PATH_IN_SUBFOLDER
替换:
ENVIRONMENT_NAME
替换为环境的名称。LOCATION
替换为环境所在的区域。- 将
PATH_TO_LOCAL_FILE
替换为要上传的文件的路径。 - (可选)将
PATH_IN_SUBFOLDER
替换为子文件夹路径。使用--destination
参数,用于将插件上传到plugins
文件夹中的内容。否则,请省略--destination
参数。
查看插件列表
控制台
在 Google Cloud 控制台中,前往环境页面。
找到您的环境,然后点击 DAG 链接。
转到上一级文件夹,然后导航到
plugins/
文件夹。查看插件文件。
gcloud
使用以下 gcloud
命令:
gcloud composer environments storage plugins list \
--environment ENVIRONMENT_NAME \
--location LOCATION
替换:
ENVIRONMENT_NAME
替换为环境的名称。LOCATION
替换为环境所在的区域。
删除插件
如需从 Cloud Composer 环境中删除插件,请从该环境存储桶内的 plugins
文件夹中删除插件代码。
如需删除插件,请按照以下所述操作:
控制台
gcloud
使用以下 gcloud
命令:
gcloud composer environments storage plugins delete \
--environment ENVIRONMENT_NAME \
--location LOCATION \
PLUGIN_TO_DELETE
下载插件
要下载插件,请选择以下方式之一:
控制台
gcloud
使用以下 gcloud
命令:
gcloud composer environments storage plugins export \
--environment ENVIRONMENT_NAME \
--location LOCATION \
--destination PATH_TO_LOCAL_DESTINATION \
--source PATH_IN_FOLDER
替换:
ENVIRONMENT_NAME
替换为环境的名称。LOCATION
替换为环境所在的区域。- 将
PATH_TO_LOCAL_DESTINATION
替换为下载文件的目标位置。 - (可选)
--source
是一个选项,用于仅下载一个插件。PATH_IN_FOLDER
是文件夹路径。
排查插件问题
插件导致 Airflow 界面出现问题
您可以停用 Web 服务器插件而不删除它们。有关 信息,请参阅停用 Web 服务器插件。
Airflow 界面中未显示新上传的插件
如果您使用 Airflow 界面访问权限控制,则新上传的插件可能不会显示在 Airflow 界面中。如需解决此问题,请让 Airflow 界面管理员配置对新上传的插件的访问权限,或在 Airflow 界面中为自己分配 Admin
角色。