Update environments

Cloud Composer 1 | Cloud Composer 2

This page explains how an environment can be updated.

About update operations

When you change parameters of your environment, such as specifying new scaling and performance parameters, or installing custom PyPI packages, your environment updates.

After this operation is completed, changes become available in your environment.

For a single Cloud Composer environment, you can start only one update operation at a time. You must wait for an update operation to complete before starting another environment operation.

Caution: Do not upgrade the GKE clusters for your Cloud Composer environments to newer versions. Use the GKE version pre-configured during the environment creation and rely on auto-upgrades performed by the GKE service.

About updating with Terraform

Warning: If you attempt to change a configuration parameter that cannot be updated, Terraform deletes your environment and creates a new one with the new parameter value.

Run terraform plan before terraform apply to see if Terraform creates a new environment instead of updating it.

Before you begin

• Check that your account, the service account of your environment, and the Cloud Composer Service Agent account in your project have required permissions:

  • Your account must have a role that can trigger environment update operations.

  • The service account of your environment must have a role that has enough permissions to perform update operations.

• The gcloud composer environments update command terminates when the operation is finished. You can use the --async flag to avoid waiting for the operation to complete.

View environment details

Console

1. In Google Cloud console, go to the Environments page.

   Go to Environments

2. In the list of environments, click the name of your environment. The Environment details page opens.

gcloud

Run the following gcloud command:

gcloud composer environments describe ENVIRONMENT_NAME \
  --location LOCATION

Replace:

• ENVIRONMENT_NAME with the name of the environment.
• LOCATION with the region where the environment is located.

API

Construct an environments.get API request.

Example:

GET https://composer.googleapis.com/v1/projects/example-project/
locations/us-central1/environments/example-environment

Terraform

Run the terraform state show command for your environment's resource.

The name of your environment's Terraform resource might be different than the name of your environment.

terraform state show google_composer_environment.RESOURCE_NAME

Replace:

• RESOURCE_NAME with the name of your environment's resource.

Update environments

For more information about updating your environment, see other documentation pages about specific update operations. For example:

• Override Airflow configuration options
• Set environment variables
• Install Python dependencies
• Scale environments
• Configure authorized networks

Upgrading the machine type for GKE nodes

You can manually upgrade the machine type for your environment's GKE cluster by deleting the existing default-pool and creating a new default-pool with the desired machine type.

We recommend you to specify a suitable machine type for the type of computing that occurs in your Cloud Composer environment when you create an environment.

If you are running jobs that perform resource-intensive computation, you might want to use GKE Operators.

Caution: The execution of your DAGs might be interrupted during the upgrade. Before upgrading, consider pausing all DAGs and wait for in-progress tasks to finish.

After an upgrade, the previous machine type is still listed in your environment's details. For example, the Environment details page does not reflect the new machine type.

Console

To upgrade the machine type:

1. In Google Cloud console, go to the Environments page.

   Go to Environments

2. In the list of environments, click the name of your environment. The Environment details page opens.

3. Get information about the default node pool:

   1. Go to the Environment configuration tab.

   2. Click the view cluster details link.

   3. On the Clusters page in the Nodes section, click default-pool.

   4. Note all the information for default-pool on the Node pool details page. You use this information to create a new default node pool for your environment.

4. To delete default-pool:

   1. On the Node pool details page, click the back arrow to return to the Clusters page for your environment.

   2. In the Node Pools section, click the trash icon for the default-pool. Then click Delete to confirm the operation.

5. To create the new default-pool:

   Caution: Use the same service account that runs the Cloud Composer environment. If you use a custom service account and rely on access scopes then you must use gcloud CLI to create a new pool with proper scopes. To do so, follow the instructions on the Add and manage node pools page. Specify access scopes using the --scopes parameter.

   1. On the Clusters page, click Add node pool.

   2. For Name, enter default-pool. You must use the default-pool name so that workflows in your environment can run in this pool.

   3. Enter the Size and Nodes settings.

   4. (Only for default Compute Engine service accounts) For Access scopes, select Allow full access to all Cloud APIs.

   5. Click Save.

6. If you notice that workloads are distributed unevenly, scale down the airflow-worker deployment to zero and scale up again.

What's next

• Upgrade environments
• Override Airflow configuration options