Terraform 速查表

count, for_each, [for( o in var.list: o.id])

# 使用 count 创建多个 EC2 实例
resource "aws_instance" "server" {
  ami = "ami-06ec8443c2a35b0ba"
  instance_type = "t2.micro"
  count = 3  # 创建 3 个资源
}

# 声明一个变量
variable "users" {
  type = list(string)
  default = ["demo-user", "admin1", "john"]
}

# 使用 for_each 创建 IAM 用户
resource "aws_iam_user" "test" {
  for_each = toset(var.users) # 将列表转换为集合
  name = each.key
}

# for 表达式通过转换另一个复杂类型值来创建一个复杂类型值。
variable "names" {
    type = list
    default = ["som", "john", "mary"]
}

output "show_names" {
    # 类似于 Python 的列表推导式
    value = [for n in var.names : upper(n)]
}

output "short_upper_names" {
  # 通过指定条件过滤结果列表：
  value = [for name in var.names : upper(name) if length(name) > 7]
}

Splat(var.list[*].id)

# 启动一个 EC2 实例
resource "aws_instance" "server" {
  ami = "ami-05cafdf7c9f772ad2"
  instance_type = "t2.micro"
  count = 3
}

output "private_addresses"{
  value = aws_instance.server[*].private_ip  # splat 表达式
}

如果两个资源相互依赖，depends_on 指定该依赖关系以强制执行顺序

resource "aws_iam_role_policy" "example" {
    name = "example"
    role = "s3 access"
    policy = jsonencode({
      "Statement" = [{
        "Action" = "s3:*",
        "Effect" = "Allow",
      }],
    })
}

resource "aws_instance" "my_server" {
    ami  = "ami-a255235"
    instance_type = "t2.micro"

    iam_instance_profile = aws_iam_instance_profile.my_server

    depends_on = [
      aws_iam_role_policy.example,
    ]

一组用于控制特定资源行为的元参数

resources "aws_instance" "server" {
  ami           = "ami-a1b3414"
  instance_type = "t2.micro"

  lifecycle {
    create_before_destroy = true
    ignore_changes = [
      # 某些资源具有元数据
      # 在 TF 外部自动修改

      tags
    ]
  }
}

condition ? true_val : false_val

正在使用的提供程序的详细信息。包括访问机制、区域选项、要使用的配置文件等信息。

provider "aws" {
  region = "us-east-1"
}

# 附加的提供程序配置引用为 `aws.west`。
provider "aws" {
  alias  = "west"
  region = "us-west-2"
}

terraform {

  # required_providers 块指定源和版本
  required_providers {
    aws = {
      source  = "hashicorp/aws" # 在哪里找到提供程序
      version = "5.8.0" # 此配置需要哪个版本的提供程序
    }
  }
}

本地值为表达式分配一个名称，因此您可以在模块中多次使用该名称，而不是重复表达式

locals {
  service_name = "forum"
  owner        = "Community Team"
}

# 一旦声明了 local，就可以引用它
locals {
  common_tags = {
    Service = local.service_name
    Owner   = local.owner

output "api_base_url" {
  value = "https://${aws_instance.example.private_dns}:8433/"

  # EC2 实例必须具有加密的根卷。
  precondition {
    condition     = data.aws_ebs_volume.example.encrypted
    error_message = "服务器的根卷未加密。"
  }

  # 输出可以标记为包含敏感信息
  sensitive = true # 输出可以标记为包含敏感信息
}

可以查询的数据源（云提供商、本地列表等）

data "aws_ami" "example" {
  most_recent = true

  owners = ["self"]
  tags = {
    Name   = "app-server"
    Tested = "true"
  }
}

module "myec2" {
  source = "../modules/ec2"

  # 模块输入
  ami_id = var.ami_id
  instance_type = var.instance_type
  servers = var.servers
}

后端定义了 Terraform 存储其状态数据文件的位置。

可用后端：local(默认), remote, azurerm, consul, cos, gcs, http, Kubernetes, oss, pg, s3

terraform {
  backend "remote" {
    organization = "example_corp"

    workspaces {
      name = "my-app-prod"
    }
  }
}

terraform init [选项]

    -upgrade            # 安装最新的模块和提供程序版本
    -reconfigure        # 重新配置后端，忽略任何已保存的配置
    -backend=false      # 禁用后端并使用先前的初始化
    -migrate-state      # 重新配置后端并尝试迁移任何现有状态

生成并审查执行计划

terraform plan [选项]

    -var 'user=john'    # 为配置的根模块中的输入变量设置值
    -var-file=filename  # 从给定文件加载变量值
    -input=true         # 如果未直接设置，则请求输入变量
    -out=path           # 将计划文件写入给定路径。可用作 "apply" 的输入
    -refresh-only       # 验证远程对象的一致性，而不建议执行操作来撤消在 TF 外部所做的更改
    -destroy            # 创建计划以销毁当前管理的所有对象
    -target=resource    # 仅将计划目标限定为给定资源及其依赖项。

terraform plan -refresh-only # 更新状态以匹配在 TF 外部所做的更改。适用于漂移检测

terraform validate      # 验证配置文件是否存在错误

执行对基础架构的更改

terraform apply [选项]

    -auto-approve       # 在应用前跳过计划的交互式批准
    -replace            # 强制替换特定资源实例
    -var 'foo=bar'      # 为配置的根模块中的输入变量设置值
    -var-file=filename  # 从给定文件加载变量值
    -parallelism=n      # 限制并发操作的数量。默认=10

terraform apply -auto-approve var-file=web-dev.tfvars
terraform apply -replace="aws_instance.server"
terraform plan -refresh-only # 更新状态文件以接受手动进行的更改。

销毁（删除）Terraform 管理的基础架构。与 terraform apply -destroy 相同

terraform destroy [选项]

    -auto-approve        # 在销毁前跳过交互式批准
    -target              # 仅将销毁限制为给定资源及其依赖项


terraform destroy -target aws_vpc.my_vpc -auto-approve

杂项

terraform state show aws_instance.my_vm
terraform state pull > my_terraform.tfstate
terraform state mv aws_iam_role.my_ssm_role
terraform state list
terraform state rm aws_instance.my_server

terraform import aws_instance.new_server i-243abc
sudo apt install graphviz
terraform graph | dot -Tpng > graph.png

日志记录

日志级别 = TRACE > DEBUG > INFO > WARN > ERROR

export TF_LOG_CORE=TRACE     # 启用核心日志记录
export TF_LOG_PROVIDER=TRACE # 启用提供程序日志记录
export TF_LOG_PATH=logs.txt  # 持久化日志