A 15 de setembro de 2026, todos os ambientes do Cloud Composer 1 e do Cloud Composer 2 versão 2.0.x vão atingir o fim da vida útil planeado e não vai poder usá-los. Recomendamos que planeie a migração para o Cloud Composer 3.
Esta página descreve como instalar plug-ins personalizados no seu ambiente do Cloud Composer.
O gestor de plug-ins do Apache Airflow permite-lhe escrever operadores, hooks, sensores ou interfaces do Apache Airflow personalizados.
Para mais informações, consulte os plug-ins personalizados
na documentação do Airflow.
Acerca dos plug-ins personalizados
Quando cria um ambiente, o Cloud Composer
cria um contentor do Cloud Storage e associa este contentor ao seu ambiente. Use a pasta plugins no contentor do seu ambiente para instalar plug-ins personalizados.
Antes de começar
A sua conta tem de ter uma função que permita ver e modificar o conteúdo do contentor do seu ambiente.
Este método de instalação aplica-se apenas a plug-ins do Airflow. Por exemplo, não pode usar este método para instalar módulos Python comuns ou outras bibliotecas.
LOCATION com a região onde o ambiente está localizado.
PATH_TO_LOCAL_FILE com o caminho do ficheiro a carregar.
(Opcional) PATH_IN_SUBFOLDER com o caminho da subpasta. Use o argumento --destination para carregar um plugin para uma subpasta na pasta plugins. Caso contrário, omita o argumento --destination.
Veja a lista de plug-ins
Consola
Na Google Cloud consola, aceda à página Ambientes.
LOCATION com a região onde o ambiente está localizado.
PATH_TO_LOCAL_DESTINATION com o destino do ficheiro transferido.
(Opcional) --source é uma opção para transferir apenas um plugin.
PATH_IN_FOLDER é o caminho da pasta.
Desative os plug-ins do servidor Web
No Cloud Composer 3, se tiver problemas com a IU do Airflow, pode
desativar os plug-ins do servidor Web sem ter de os remover do
contentor do ambiente.
gcloud
Os seguintes argumentos da CLI gcloud desativam e ativam os plug-ins do servidor Web:
--no-support-web-server-plugins: desative os plug-ins do servidor Web
--support-web-server-plugins: ative os plug-ins do servidor Web
Para desativar os plug-ins do servidor Web, execute o seguinte comando da CLI gcloud:
Um plugin carregado recentemente não está visível na IU do Airflow
Se usar o controlo de acesso da IU do Airflow, o plug-in carregado recentemente pode não estar visível na IU do Airflow. Para resolver este problema, peça ao administrador da IU do Airflow para configurar o acesso ao plug-in carregado recentemente ou atribua a si próprio a função Admin na IU do Airflow.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-29 UTC."],[[["\u003cp\u003eCloud Composer allows you to install custom Airflow plugins by uploading them to the \u003ccode\u003eplugins\u003c/code\u003e folder in your environment's Cloud Storage bucket, enabling the use of custom operators, hooks, sensors, or interfaces.\u003c/p\u003e\n"],["\u003cp\u003ePlugins are installed by copying the plugin code to the \u003ccode\u003eplugins\u003c/code\u003e folder of your environment's bucket, accessible through both the Google Cloud console and the \u003ccode\u003egcloud\u003c/code\u003e command-line tool.\u003c/p\u003e\n"],["\u003cp\u003eYou can view, delete, and download installed plugins using the Google Cloud console or the \u003ccode\u003egcloud\u003c/code\u003e command-line tool by navigating the \u003ccode\u003eplugins\u003c/code\u003e folder in your environment's Cloud Storage bucket.\u003c/p\u003e\n"],["\u003cp\u003eWeb server plugins can be disabled or enabled in Cloud Composer 3 environments using the \u003ccode\u003e--no-support-web-server-plugins\u003c/code\u003e or \u003ccode\u003e--support-web-server-plugins\u003c/code\u003e flags with the \u003ccode\u003egcloud\u003c/code\u003e command, or with the API request via \u003ccode\u003eweb_server_plugins_mode\u003c/code\u003e to prevent issues with the Airflow UI.\u003c/p\u003e\n"],["\u003cp\u003eWhen you upload a new plugin, it is not reloaded by default, and in certain cases, it may not immediately be visible in the Airflow UI due to Airflow UI Access Control, requiring admin configuration for visibility.\u003c/p\u003e\n"]]],[],null,["# Install custom plugins\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\n**Cloud Composer 3** \\| [Cloud Composer 2](/composer/docs/composer-2/install-plugins \"View this page for Cloud Composer 2\") \\| [Cloud Composer 1](/composer/docs/composer-1/install-plugins \"View this page for Cloud Composer 1\")\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nThis page describes how to install custom plugins in your Cloud Composer\nenvironment.\n\nApache Airflow's plugin manager allows you to write custom in-house\nApache Airflow operators, hooks, sensors, or interfaces.\nFor more information, see [custom plugins](https://airflow.apache.org/docs/apache-airflow/stable/authoring-and-scheduling/plugins.html)\nin the Airflow documentation.\n\nAbout custom plugins\n--------------------\n\nWhen you create an environment, Cloud Composer\n[creates a Cloud Storage bucket](/composer/docs/composer-3/cloud-storage) and associates this\nbucket with your environment. You use the `plugins` folder in your\nenvironment's bucket to install custom plugins.\n\nBefore you begin\n----------------\n\n- Your account [must have a role](/composer/docs/composer-3/access-control#user-account) that allows viewing and modifying your environment's bucket contents.\n- This installation method applies only to [Airflow plugins](https://airflow.apache.org/docs/apache-airflow/stable/authoring-and-scheduling/plugins.html). For example, you cannot use this method to install common Python modules or other libraries.\n- Plugins must conform to the [Airflow plugins template](https://airflow.apache.org/docs/apache-airflow/stable/authoring-and-scheduling/plugins.html#example) guidelines.\n\nInstall a plugin\n----------------\n\nTo install a custom plugin into your Cloud Composer environment,\ncopy the plugin code to the `plugins` folder in your environment's bucket.\n| **Note:** After the plugins are loaded, they are never reloaded, except the UI plugins in the web server. You might need to restart the web server or the scheduler processes manually. Otherwise, a scheduler only restarts after the [`[scheduler]num_runs`](https://airflow.apache.org/docs/apache-airflow/stable/configurations-ref.html#num-runs), which is set to 5000 by default.\n\nTo install a plugin: \n\n### Console\n\n1. In the Google Cloud console, go to the **Environments** page.\n\n [Go to Environments](https://console.cloud.google.com/composer/environments)\n2. Find your environment and follow the **DAGs** link.\n\n3. Go one folder level up, then navigate to the `plugins/` folder.\n\n4. Upload your plugin files. For more information about uploading objects,\n see [Uploading objects](/storage/docs/uploading-objects).\n\n### gcloud\n\nUse the following `gcloud` command: \n\n gcloud composer environments storage plugins import \\\n --environment \u003cvar translate=\"no\"\u003eENVIRONMENT_NAME\u003c/var\u003e \\\n --location \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e \\\n --source \u003cvar translate=\"no\"\u003ePATH_TO_LOCAL_FILE\u003c/var\u003e \\\n --destination \u003cvar translate=\"no\"\u003ePATH_IN_SUBFOLDER\u003c/var\u003e\n\nReplace:\n\n- `ENVIRONMENT_NAME` with the name of the environment.\n- `LOCATION` with the region where the environment is located.\n- `PATH_TO_LOCAL_FILE` with the path of the file to upload.\n- (Optional) `PATH_IN_SUBFOLDER` with the subfolder path. Use the `--destination` argument to upload a plugin to a subfolder in the `plugins` folder. Otherwise, omit the `--destination` argument.\n\nView the list of plugins\n------------------------\n\n### Console\n\n1. In the Google Cloud console, go to the **Environments** page.\n\n [Go to Environments](https://console.cloud.google.com/composer/environments)\n2. Find your environment and follow the **DAGs** link.\n\n3. Go one folder level up, then navigate to the `plugins/` folder.\n\n4. View the plugin files.\n\n### gcloud\n\nUse the following `gcloud` command: \n\n gcloud composer environments storage plugins list \\\n --environment \u003cvar translate=\"no\"\u003eENVIRONMENT_NAME\u003c/var\u003e \\\n --location \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e\n\nReplace:\n\n- `ENVIRONMENT_NAME` with the name of the environment.\n- `LOCATION` with the region where the environment is located.\n\nDelete a plugin\n---------------\n\nTo delete a plugin from your Cloud Composer environment,\ndelete the plugin code from the `plugins` folder in the environment's bucket.\n| **Note:** You can [disable web server plugins](#disable-webserver-plugins) without deleting them.\n\nTo delete a plugin: \n\n### Console\n\n1. In the Google Cloud console, go to the **Environments** page.\n\n [Go to Environments](https://console.cloud.google.com/composer/environments)\n2. Find your environment and follow the **DAGs** link.\n\n3. Go one folder level up, then navigate to the `plugins/` folder.\n\n4. Delete the plugin files. For more information about deleting objects,\n see [Deleting objects](/storage/docs/deleting-objects).\n\n### gcloud\n\nUse the following `gcloud` command: \n\n gcloud composer environments storage plugins delete \\\n --environment \u003cvar translate=\"no\"\u003eENVIRONMENT_NAME\u003c/var\u003e \\\n --location \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e \\\n \u003cvar translate=\"no\"\u003ePLUGIN_TO_DELETE\u003c/var\u003e\n\nDownload plugins\n----------------\n\nTo download plugins, choose an option: \n\n### Console\n\n1. In the Google Cloud console, go to the **Environments** page.\n\n [Go to Environments](https://console.cloud.google.com/composer/environments)\n2. Find your environment and follow the **DAGs** link.\n\n3. Go one folder level up, then navigate to the `plugins/` folder.\n\n4. Download the plugin files. For more information about deleting objects,\n see [Downloading objects](/storage/docs/downloading-objects).\n\n### gcloud\n\nUse the following `gcloud` command: \n\n gcloud composer environments storage plugins export \\\n --environment \u003cvar translate=\"no\"\u003eENVIRONMENT_NAME\u003c/var\u003e \\\n --location \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e \\\n --destination \u003cvar translate=\"no\"\u003ePATH_TO_LOCAL_DESTINATION\u003c/var\u003e \\\n --source \u003cvar translate=\"no\"\u003ePATH_IN_FOLDER\u003c/var\u003e\n\nReplace:\n\n- `ENVIRONMENT_NAME` with the name of the environment.\n- `LOCATION` with the region where the environment is located.\n- `PATH_TO_LOCAL_DESTINATION` with the destination for downloaded file.\n- (Optional) `--source` is an option to download only one plugin. `PATH_IN_FOLDER` is the folder path.\n\nDisable web server plugins\n--------------------------\n\nIn Cloud Composer 3, if you experience problems with Airflow UI, you can\ndisable web server plugins without having to remove them from the\nenvironment's bucket.\n**Note:** You can also disable web server plugins when you [create an environment](/composer/docs/composer-3/create-environments). \n\n### gcloud\n\nThe following Google Cloud CLI arguments disable and enable web server\nplugins:\n\n- `--no-support-web-server-plugins`: disable web server plugins\n- `--support-web-server-plugins`: enable web server plugins\n\nTo disable web server plugins, run the following\nGoogle Cloud CLI command: \n\n gcloud beta composer environments update \u003cvar translate=\"no\"\u003eENVIRONMENT_NAME\u003c/var\u003e \\\n --location \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e \\\n --no-support-web-server-plugins\n\nTo enable web server plugins, run the following\nGoogle Cloud CLI command: \n\n gcloud beta composer environments update \u003cvar translate=\"no\"\u003eENVIRONMENT_NAME\u003c/var\u003e \\\n --location \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e \\\n --support-web-server-plugins\n\nReplace the following:\n\n- `ENVIRONMENT_NAME`: the name of the environment\n- `LOCATION`: the region where the environment is located\n\n### API\n\n1. Create an [`environments.patch`](/composer/docs/reference/rest/v1beta1/projects.locations.environments/patch) API request.\n\n2. In this request:\n\n 1. In the `updateMask` parameter, specify\n the `config.software_config.web_server_plugins_mode` mask.\n\n 2. In the request body, in the `web_server_plugins_mode` field:\n\n - Specify `PLUGINS_DISABLED` to disable web server plugins.\n - Specify `PLUGINS_ENABLED` to enable web server plugins.\n\nExample (disable plugins): \n\n // PATCH https://composer.googleapis.com/v1beta1/projects/example-project/\n // locations/us-central1/environments/example-environment?updateMask=\n // config.software_config.web_server_plugins_mode\n\n \"config\": {\n \"softwareConfig\": {\n \"web_server_plugins_mode\": \"PLUGINS_DISABLED\"\n }\n }\n\nExample (enable plugins): \n\n // PATCH https://composer.googleapis.com/v1beta1/projects/example-project/\n // locations/us-central1/environments/example-environment?updateMask=\n // config.software_config.web_server_plugins_mode\n\n \"config\": {\n \"softwareConfig\": {\n \"web_server_plugins_mode\": \"PLUGINS_ENABLED\"\n }\n }\n\nTroubleshoot plugin issues\n--------------------------\n\n### Plugins cause problems with Airflow UI\n\nYou can disable web server plugins without deleting them. For more\ninformation, see [Disable web server plugins](#disable-webserver-plugins).\n\n### A newly-uploaded plugin is not visible in Airflow UI\n\nIf you use [Airflow UI Access Control](/composer/docs/composer-3/airflow-rbac) then the newly\nuploaded plugin might not be visible in Airflow UI. To address this issue, ask\nAirflow UI Administrator to configure access to the newly uploaded plugin or\nassign yourself the `Admin` role in Airflow UI.\n\nWhat's next\n-----------\n\n- [Data stored in Cloud Storage](/composer/docs/composer-3/cloud-storage)\n- [Manage DAGs](/composer/docs/composer-3/manage-dags)"]]
