Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 3.13 KB

README.md

File metadata and controls

75 lines (54 loc) · 3.13 KB
Raw

Terraform Helm Chart

This experimental repository contains software which is still being developed and in the alpha testing stage. It is not ready for production use.

This repository contains the official HashiCorp Helm chart for installing and configuring Terraform on Kubernetes. This chart supports multiple use cases of Terraform on Kubernetes depending on the values provided.

Prerequisites

To use the charts here, Helm must be installed in your Kubernetes cluster. Setting up Kubernetes and Helm and is outside the scope of this README. Please refer to the Kubernetes and Helm documentation.

The versions required are:

  • Helm +3.0.1 - This is the earliest version of Helm tested. It is possible it works with earlier versions but this chart is untested for those versions.
  • Kubernetes 1.15+ - This is the earliest version of Kubernetes tested. It is possible that this chart works with earlier versions but it is untested.

In addition to Helm, you must also have a:

  • Terraform Cloud organization - Create an organization on Terraform Cloud.
  • Terraform Cloud Team API Token - Generate a team API token for the Terraform Cloud organization you want to use. Make sure the team at least has privileges to manage workspaces.

Usage

Before installing the chart, you must create two Kubernetes secrets:

  1. credentials file contents with Terraform Cloud Team API token. See Terraform Cloud Configuration File Syntax for proper format.

    $ kubectl -n $NAMESPACE create secret generic terraformrc --from-file=credentials

  2. Sensitive variables for a workspace.

    $ kubectl -n $NAMESPACE create secret generic workspacesecrets --from-literal=secret_key=abc123

For now, we do not host a chart repository. To use the charts, you must download this repository and unpack it into a directory. Assuming this repository was unpacked into the directory terraform-helm, the chart can then be installed directly:

helm install -n ${RELEASE_NAMESPACE} ${RELEASE_NAME} ./terraform-helm

By default, the Helm chart is disabled. To enable the chart and deploy it successfully, set the variables in the values.yaml.

helm install -n ${RELEASE_NAMESPACE} ${RELEASE_NAME} ./terraform-helm --set="global.enabled=true"

Please see the many options supported in the values.yaml file.

To create a Terraform workspace, you can create a separate Helm chart to deploy the custom resource or examine the example under example/. Helm does not currently support a wait function before deletion, which will cause custom resources to remain behind.

Note that the Helm chart automatically installs all Custom Resource Definitions under the crds/ directory. As a result, any updates to the schema must be manually copied into the directory and removed from the Kubernetes cluster:

kubectl delete crd workspaces.app.terraform.io

If the CRD is not updated correctly, you will not be able to create a Workspace Custom Resource.