Enable and disable the Cloud Composer service

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Preview — Cloud Composer 3

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

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:

Enable the 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.

Important: If you disable the BigQuery API, your Cloud Composer environment stops working. This happens because Google Kubernetes Engine depends on BigQuery and Cloud Composer inherits this dependency from the Google Kubernetes Engine API.

Disable the Cloud Composer service

This section describes how to disable the Cloud Composer service in your Google Cloud project.

Before you begin

Warning: You cannot recover environments in your project after you disable the Cloud Composer API. After the API is disabled, you still have access to data stored in your environment's buckets, but the environments themselves are no longer usable.

• 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:

  1. Pause the DAGs.
  2. If required, export the environment's data, such as DAGs from the environment's bucket.
  3. Delete your environment, including the resources that are not deleted automatically.

Disable Cloud Composer API

To disable the Cloud Composer service:

Console

1. In the Google Cloud console, go to the Cloud Composer API page.

   Go to Cloud Composer API

2. Click Manage.

3. 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.

What's next

• Create environments
• Access control