hashicorp/hcp-terraform-operator

Kubernetes Operator for Terraform Cloud

镜像概述和主要用途

该Kubernetes Operator旨在通过Kubernetes自定义资源（CR）实现对Terraform Cloud资源的声明式管理。它作为Kubernetes与Terraform Cloud之间的桥梁，允许用户直接通过Kubernetes API定义、部署和维护Terraform Cloud资源（如工作区、运行、变量等），简化多云环境下基础设施即代码（IaC）的管理流程。

核心功能和特性

• 自定义资源定义（CRD）支持：提供TerraformWorkspace、TerraformRun、TerraformVariable等CRD，映射Terraform Cloud核心资源
• 声明式管理：通过Kubernetes API以声明式方式定义Terraform Cloud资源，支持版本控制和审计
• 状态同步：自动同步Kubernetes CR状态与Terraform Cloud实际资源状态，确保配置与运行时一致
• Kubernetes RBAC集成：复用Kubernetes RBAC权限模型，实现对Terraform Cloud资源操作的细粒度权限控制
• 事件与日志：记录资源创建、更新、删除等操作事件及执行日志，便于审计和问题排查
• 依赖管理：支持定义Terraform Cloud资源间的依赖关系，确保按序执行

使用场景和适用范围

• Kubernetes环境下的IaC管理：在Kubernetes集群中统一管理Terraform Cloud配置，避免跨平台切换
• 多云资源编排：通过Terraform Cloud管理多云资源（AWS、Azure、GCP等），并通过Kubernetes进行声明式控制
• CI/CD流水线集成：作为CI/CD流程的一部分，通过Kubernetes CR触发Terraform Cloud运行，实现基础设施自动化部署
• 团队协作与权限隔离：结合Kubernetes命名空间和RBAC，实现不同团队对Terraform Cloud资源的隔离管理

使用方法和配置说明

部署步骤

1. 安装CRD

bash
kubectl apply -f https://raw.githubusercontent.com/[operator-repo]/main/config/crd/bases/terraformcloud.example.com_terraformworkspaces.yaml
kubectl apply -f https://raw.githubusercontent.com/[operator-repo]/main/config/crd/bases/terraformcloud.example.com_terraformruns.yaml

2. 部署Operator

bash
# 创建命名空间
kubectl create namespace terraform-operator

# 配置Terraform Cloud访问令牌（需替换为实际令牌）
kubectl create secret generic terraform-cloud-token -n terraform-operator \
  --from-literal=token=your-terraform-cloud-api-token

# 部署Operator（示例使用默认配置）
kubectl apply -f https://raw.githubusercontent.com/[operator-repo]/main/config/manager/manager.yaml -n terraform-operator

自定义资源示例

创建Terraform Workspace

yaml
apiVersion: terraformcloud.example.com/v1alpha1
kind: TerraformWorkspace
metadata:
  name: example-workspace
  namespace: terraform-operator
spec:
  name: example-workspace
  organization: my-terraform-org
  description: "Example workspace managed by Kubernetes Operator"
  terraformVersion: "1.6.0"
  workingDirectory: "path/to/terraform/code"
  tags: ["k8s-managed", "example"]

触发Terraform Run

yaml
apiVersion: terraformcloud.example.com/v1alpha1
kind: TerraformRun
metadata:
  name: example-run
  namespace: terraform-operator
spec:
  workspaceRef: example-workspace
  runType: planAndApply
  message: "Triggered by Kubernetes Operator"
  variables:
    - name: instance_count
      value: "3"
      sensitive: false

配置参数说明

环境变量（Operator部署时配置）

TerraformWorkspace CRD spec字段

TerraformRun CRD spec字段