7 методов написания читаемого кода Terraform с примерами кода

Под «читабельностью Terraform» подразумевается практика написания кода Terraform таким образом, чтобы его было легко понять и поддерживать. Вот несколько методов, которые вы можете использовать для улучшения читаемости вашего кода Terraform, а также примеры кода:

  1. Использовать описательные имена ресурсов:

    resource "aws_instance" "web_server" {
     # ...
    }
  2. Прокомментируйте свой код:

    # Create a VPC
    resource "aws_vpc" "my_vpc" {
     # ...
    }
  3. Организация ресурсов с помощью модулей:

    module "web_app" {
     source      = "./modules/web_app"
     app_name    = "my_web_app"
     environment = "production"
    }
  4. Использовать переменные для конфигурации:

    variable "region" {
     type    = string
     default = "us-west-2"
    }
    resource "aws_instance" "web_server" {
     # ...
     availability_zone = var.region
    }
  5. Использовать функции Terraform:

    resource "aws_s3_bucket" "my_bucket" {
     # ...
     bucket = "${lower(var.environment)}-my-bucket"
    }
  6. Использовать форматирование Terraform:

    terraform fmt
  7. Следуйте единому руководству по стилю:

    resource "aws_instance" "web_server" {
     # ...
    }