Repository files navigation

This module makes it easy to create a Cloud Composer Environment. As the module develops, this README should be updated.

The resources/services/activations/deletions that this module will create/trigger are:

• Create a GCP Composer Environment

This module is meant for use with Terraform 1.3+ and tested using Terraform 1.3+. If you find incompatibilities using Terraform >=1.3, please open an issue.

Current version is 4.0. Upgrade guides:

• 3.X -> 4.0.
• 4.X -> 5.0.

Cloud Composer currently has two versions: V2 has greater flexibility in the Airflow core services(scheduler, webserver, worker) and has a more practical and scalable infrastructure. Therefore, we recommend prioritizing theuse ofV2 for new environments.

You can find an overview of the producthereand thelist of major differences. Plans for Cloud Composer V1 end of support is documentedhere.

Simple usage is as follows:

module"composer" {source="terraform-google-modules/composer/google"version="~> 6.1"project_id="<PROJECT ID>"region="us-central1"composer_env_name="composer-env-test"network="test-network"subnetwork="composer-subnet"enable_private_endpoint=false}

Functional examples are included in theexamples directory.

These sections describe requirements for using this module.

The following dependencies must be available:

• Terraform v1.3+
• Terraform Provider for GCP plugin v5.3+

A service account with the following roles must be used to provisionthe resources of this module:

• Project Editor:roles/editor
• Network Admin:roles/compute.networkAdmin
• Instance Admin:roles/compute.instanceAdmin.v1
• Service Account User:roles/iam.serviceAccountUser
• Composer Worker:roles/composer.worker

TheProject Factory module and theIAM module may be used in combination to provision aservice account with the necessary roles applied.

A project with the following APIs enabled must be used to host theresources of this module:

• Cloud Composer API:composer.googleapis.com

TheProject Factory module can be used toprovision a project with the necessary APIs enabled.

Refer to thecontribution guidelines forinformation on contributing to this module.