Repository files navigation

This module allows you to use gcloud, gsutil, any gcloud component, and jq in Terraform. Sometimes, there isn't Terraform GCP support for a particular feature, or you'd like to do something each time Terraform runs (ie: upload a file to a Kubernetes pod) that lacks Terraform support.

This moduledoes not create any resources on GCP itself, rather exposes the GCP SDK to you for usage in null resources & external data resources.

Basic usage of this module is as follows:

module"gcloud" {source="terraform-google-modules/gcloud/google"version="~> 4.0"platform="linux"additional_components=["kubectl","beta"]create_cmd_entrypoint="gcloud"create_cmd_body="version"destroy_cmd_entrypoint="gcloud"destroy_cmd_body="version"}

Functional examples are included in theexamples directory.

Thejq binary is also included in this module so you can use it as well for either of yourcreate_cmd_entrypoint ordestroy_cmd_entrypoint values.

By default, this module assumes you already have gcloud installed in your $PATH.

If you need to run Terraform in environments without a gcloud binary available, you can override this behavior by setting theskip_download variable tofalse.

You can also override the behavior by setting theGCLOUD_TF_DOWNLOAD environment variable.This environment variable will override all other settings.Setting it tonever willnever gcloud download and setting it toalways will always download gcloud.

These sections describe requirements for using this module.

The following dependencies must be available:

• Terraform v0.12
• Terraform Provider for GCP plugin v2.0
• curl

A service account must be created, along with a key, to use this module.The service account must have the proper IAM roles for whatevercommands you're running with this module.

A project is not required to host resources of this module, sincethis module does not create any resources.

However you will likely need a project for your service accountand any resources you'd like to interact with while using this module.

Refer to thecontribution guidelines forinformation on contributing to this module.