Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
This page explains how to enable and disable the Cloud Composer service in your Google Cloud project.
For information about services management on Google Cloud, see Enabling and Disabling Services.
For a list of services required by Cloud Composer in VPC Service Controls configurations, see Configure VPC Service Controls.
Enable the Cloud Composer service
This section describes how to enable the Cloud Composer service in your Google Cloud project.
Before you begin
To enable the Cloud Composer service, you must have the correct Identity and Access Management permissions. To learn about the IAM requirements for Service Usage, see Service Usage page for Access Control.
Make sure that billing is enabled in your project.
Enable Cloud Composer API
Console
Enable the Cloud Composer API:
gcloud
Enable the composer.googleapis.com API:
gcloud services enable composer.googleapis.com
API
Use the services.enable method to enable
the composer.googleapis.com API.
Terraform
Use the google_project_service
resource to configure the composer.googleapis.com API.
Disable the Cloud Composer service
This section describes how to disable the Cloud Composer service in your Google Cloud project.
Before you begin
To disable the Cloud Composer service, you must have the correct Identity and Access Management permissions. To learn about the IAM requirements for Service Usage, see the Service Usage page for Access Control.
Make sure that all Cloud Composer environments in your project are deleted. Disabling the API irreversibly deletes tenant project parts of Cloud Composer environments, and these environments become unusable.
To avoid additional charges, complete the following steps for each environment before you disable the Cloud Composer API:
- Pause the DAGs.
- If required, export the environment's data, such as DAGs from the environment's bucket.
- Delete your environment, including the resources that are not deleted automatically.
Disable Cloud Composer API
To disable the Cloud Composer service:
Console
In the Google Cloud console, go to the Cloud Composer API page.
Click Manage.
Click Disable API.
gcloud
Run the gcloud services disable command:
gcloud services disable composer.googleapis.com
API
Use the services.disable method to disable
the composer.googleapis.com API.
Terraform
Remove the configuration for the composer.googleapis.com API. You usually
use the google_project_service
resource to configure Google Cloud services.
Services required by Cloud Composer
This section describes services that are required by Cloud Composer. In some cases, organization or project administrators can restrict what Google services can be used in their projects.
The following services are required by Cloud Composer:
- artifactregistry.googleapis.com
- cloudbuild.googleapis.com
- composer.googleapis.com
- compute.googleapis.com
- container.googleapis.com
- deploymentmanager.googleapis.com
- logging.googleapis.com
- cloudkms.googleapis.com, if you are using Cloud KMS or CMEK keys
- monitoring.googleapis.com
- pubsub.googleapis.com
- storage.googleapis.com
- secretmanager.googleapis.com, if you are using Secret Manager as a secret backend
- cloudresourcemanager.googleapis.com
- servicedirectory.googleapis.com
Google services like Cloud DNS or IAM are already allowed by default in most projects.
In addtion, allow using all services that your DAGs are using, for example:
- bigquery.googleapis.com
- dataflow.googleapis.com
- datacatalog.googleapis.com
You can find the *.googleapis.com names of the services in API pages linked from the API Explorer page.