Terraform Backend 配置

Terraform Backend 配置

Backend 简介

Terraform Backend 是 Terraform 的一个重要概念，用于管理和存储 Terraform 状态信息。Terraform 使用状态文件来跟踪对基础设施资源的管理和更改，并确保当前配置与预期状态保持一致。Terraform Backend 定义了如何存储和访问这个状态文件。

在 Terraform 中，默认情况下，状态文件存储在本地的工作目录中，命名为 terraform.tfstate。然而，在多人协作和生产环境中，直接使用本地状态文件可能会引发一些问题，如冲突和共享状态不便等。这时，Terraform Backend 就派上用场了。

Terraform Backend 允许将状态文件存储在远程位置，而不是本地文件系统。通过这种方式，多个团队成员可以共享和管理相同的状态信息，并且可以更好地适应复杂的协作场景。Terraform 支持多种类型的 Backend，包括 Amazon S3、Azure Blob Storage、Consul、etcd、GCS (Google Cloud Storage) 等。

State

Terraform 可以根据 state 跟踪托管资源，默认文件存储在本地（ local ），可以使用backend{}定义远程的存储（ remote ）。

• terraform.tfstate
• terraform.tfstate.backup

{
  "version": 4,
  "terraform_version": "1.1.9",
  "serial": 5,
  "lineage": "5ef63fd0-168d-9d5d-4ce4-6a4f2dc0e5e8",
  "outputs": {},
  "resources": [
    {
      "module": "module.mydns",
       "mode": "managed",
       "type": "alicloud_dns_record",
       "name": "record",
       “provider”:     "provider[\"registry.terraform.io/hashicorp/alicloud\"]",
"instances": []
},
{

local state存在的问题

• 缺乏灵活性

  • 状态文件存储在本地，不便于团队成员协同；
  • 文件系统损坏，导致状态文件丢失；

• 缺乏安全性

  • state存在敏感数据，缺乏数据的保护；
  • 当多人同时变更时，存在状态不一致导致基础设施风险；

remote backend

配置远程后端允许多人在同一个基础设施上工作

• artifactory
• consul
• gcs
• etcs
• s3
• azurerm
• cos
• oss
• http
• pg
• gitlab

工作原理

• 配置 Backend: 首先，在 Terraform 配置文件中通过 terraform 块配置所需的 Backend。这包括指定使用的 Backend 类型以及连接到 Backend 所需的认证信息和配置参数。不同的 Backend 类型需要不同的配置信息，例如存储桶名称、访问密钥等。
• 初始化 Terraform: 在配置了 Backend 后，通过运行 terraform init 命令来初始化 Terraform。初始化过程将下载所需的提供者插件和配置 Backend，确保 Terraform 可以与 Backend 进行交互。
• 状态文件存储: 在进行 Terraform 操作时（例如 terraform apply 或 terraform destroy），Terraform 会将状态文件上传到配置的 Backend。这将确保状态信息在远程位置进行存储，并供其他团队成员访问和使用。
• 状态锁定: 在多人协作的场景中，当一个用户正在执行 Terraform 操作时，其他用户可能也希望对相同的基础设施资源进行操作。为了避免冲突，Backend 支持状态锁定机制。当一个用户开始执行 Terraform 操作时，Backend 会将状态文件锁定，阻止其他用户对状态文件进行修改，直到操作完成后解锁。
• 状态同步: 多人协作的场景下，团队成员可能会频繁地更改 Terraform 配置并执行操作。每次执行操作后，Terraform 会更新状态文件，并将最新的状态文件保存到 Backend。其他团队成员可以通过 terraform refresh 命令从 Backend 中获取最新的状态信息，并与本地配置进行同步。

Backend 配置阿里云 OSS

OSS Backend是基于阿里云的表格存储服务（Tablestore）和对象存储服务（OSS）实现

工作原理

配置过程

• 创建OSS对象存储 bucket （存储state文件）
• 创建Tablestore 表格存储（存储state的Lock信息）
• 创建backend.tf 配置Terraformbackend

OSS backend

backend中无法使用var变量

terraform {
  backend "oss" {
    access_key          = "xxxxxxxx"
    secret_key          = "xxxxxxxx"
    bucket              = "terraform-data"
    prefix              = "dev/"
    key                 = "terraform.tfstate"
    region              = "cn-beijing"
    tablestore_endpoint = "https://terraform-data.cn-beijing.ots.aliyuncs.com"
    tablestore_table    = "terraform_state"
  }
}

命令行配置backend

# 指定配置文件
terraform init -backend-config=/path/to/terraform/backend/file

# 指定配置参数
terraform init \
    -backend-config="bucket=terraform-data" \
    -backend-config="prefix=dev/" \
    -backend-config="scheme=https"