terraform-cloud-operator

Terraform Cloud Operator v2 for Kubernetes

Kubernetes Operator allows managing Terraform Cloud / Enterprise resources via Kubernetes Custom Resources.

Note From this point forward, the terms Terraform Cloud or TFC can be used interchangeably with Terraform Enterprise or TFE in all documents, provided that the contrary is indicated.

The Operator can manage the following types of resources:

• AgentPool manages Terraform Cloud Agent Pools, Terraform Cloud Agent Tokens and can perform TFC agent scaling
• Module implements API-driven Run Workflows
• Project manages Terraform Cloud Projects
• Workspace manages Terraform Cloud Workspaces

Getting started

To get started see our tutorials on the HashiCorp Developer Portal:

• Terraform Cloud Operator for Kubernetes overview
• Deploy infrastructure with the Terraform Cloud Kubernetes Operator v2
• Manage agent pools with the Terraform Cloud Kubernetes Operator v2
• Terraform Cloud Kubernetes Operator v2 Migration Guide

Documentation

Supported Features

The full list of supported Terraform Cloud features can be found on our Developer portal.

Installation

The Operator provides Helm chart as a first-class method of installation on Kubernetes.

Three simple commands to install the Operator:

$ helm repo add hashicorp https://helm.releases.hashicorp.com
$ helm repo update
$ helm install demo hashicorp/terraform-cloud-operator --wait --version 2.1.0

More detailed information about the installation and available values can be found here.

Usage

General usage documentation can be found here.

Controllers usage guides:

• AgentPool
• Module
• Project
• Workspace

Annotations and Labels used by Terraform Cloud Operator can be found here.

Metrics

The Operator exposes metrics in the Prometheus format for each controller. More information can be found here.

API reference

API reference documentation can be found here.

Frequently Asked Questions

FAQ can be found here.

Examples

YAML manifests examples live here.

Community Contribution

If you come across articles, videos, how-tos, or any other resources that could assist individuals in adopting and utilizing the operator with greater efficiency, kindly inform us by initiating a pull request and placing a link within this designated section.

Your participation matters. Thank you for being a part of our community! 🙌

Troubleshooting

If you encounter any issues with the Operator there are a number of ways how to troubleshoot it:

• check the Operator logs:

  $ kubectl logs -f <POD_NAME>
  

  Logs for a specific CR can be identified with the following pattern:

  {"<KIND>": "<NAMESPACE>/<METADATA.NAME>", "msg": "..."}
  

  For example:

  2023-01-05T12:11:31Z INFO Agent Pool Controller	{"agentpool": "default/this", "msg": "successfully reconcilied agent pool"}
  

• check the CR:

  $ kubectl get agentpool <NAME>
  $ kubectl get module <NAME>
  $ kubectl get project <NAME>
  $ kubectl get workspace <NAME>
  

• check the CR events:

  $ kubectl describe agentpool <NAME>
  $ kubectl describe module <NAME>
  $ kubectl describe project <NAME>
  $ kubectl describe workspace <NAME>
  

If you believe you've found a bug and cannot find an existing issue, feel free to open a new issue! Be sure to include as much information as you can about your environment.

Contributing to the Operator

We appreciate your enthusiasm for participating in the development of the Terraform Cloud Operator. To contribute, please read the contribution guidelines.

Security Reporting

If you think you've found a security vulnerability, we'd love to hear from you.

Follow the instructions in SECURITY.md to make a report.