К основному содержанию
правило CX Codex

terraform · microsoft — правило для Claude Code: стиль Terraform

Задаёт соглашения для Terraform-кода: структуру файлов, именование ресурсов и переменных, работу с модулями и выражениями. Применяется к .tf и .tfvars.

MIT ★ 1 627 обновлён 2026-10-25

Установить в GitHub Copilot · Вручную: положить файлы Все способы и платформы ↓
.github/instructions/terraform.instructions.md
Открыть на GitHub

Что делает terraform

Правило охватывает файлы Terraform и каталоги terraform/. Оно задаёт структуру конфигурации: ресурсы и вызовы модулей размещаются в main.tf, переменные — в variables.tf, выходные значения — в outputs.tf. Для одиночного ресурса или источника данных используется имя this, а названия переменных и ресурсов пишутся в snake_case.

Для переменных и выходных значений нужны описания без точки в конце; чувствительные значения помечаются как sensitive = true. В комментариях используются // и /* */, не #. Для необязательных значений правило предлагает coalesce() и try(), а для нескольких однотипных экземпляров — for_each. Пустая строка считается пустым значением в coalesce(), поэтому, если она допустима, нужно выбрать тернарное выражение.

Инструкции рассчитаны на Terraform 1.6+; для Azure указаны AzureRM provider 4.0+ или AzAPI. В Claude Code файл правила размещается по пути .claude/rules/terraform.md.

Какие задачи решает

  • разложить Terraform-конфигурацию по стандартным файлам
  • согласовать имена ресурсов и переменных
  • описать входные переменные и выходные значения
  • выбрать for_each для повторяющихся модулей
  • обработать необязательные значения через try() и coalesce()

Примеры запросов агенту

  • Приведи main.tf и variables.tf к соглашениям Terraform в правиле.
  • Добавь модуль для нескольких конфигураций и используй for_each со стабильными ключами.
  • Проверь, что переменные и outputs имеют описания, а секреты помечены как чувствительные.

Как установить terraform

Вручную: положить файлы

.github/instructions/terraform.instructions.md

Поле applyTo задаёт, к каким файлам применять

По шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать

Вопросы о terraform

Как установить terraform в Claude Code?

Добавь файл правила по пути .claude/rules/terraform.md.

Что делает правило terraform?

Задаёт соглашения по структуре Terraform-файлов, именованию, переменным, outputs, модулям и выражениям.

Как правило предлагает обрабатывать необязательные значения?

Для выбора значения по умолчанию оно предлагает coalesce(), а для безопасного доступа к необязательным атрибутам — try(). Если пустая строка допустима, вместо coalesce() следует использовать тернарное выражение.

Исходный текст

terraform.instructions.md · MIT
---
applyTo: '**/*.tf, **/*.tfvars, **/terraform/**'
description: 'Terraform infrastructure-as-code authoring conventions'
---
# Terraform Instructions

These instructions define conventions for Terraform Infrastructure as Code (IaC) development in this codebase. Terraform files deploy cloud resources declaratively through the HashiCorp Configuration Language (HCL).

> [!NOTE]
> These instructions target Terraform 1.6+ and include features through January 2026. For Azure deployments, use AzureRM provider 4.0+ or AzAPI for latest resource support.

## Project Structure

Organize Terraform files following a modular architecture:

```text
terraform/
├── modules/                      # Reusable modules for specific resource groupings
│   ├── networking/
│   │   ├── main.tf
│   │   ├── variables.tf
│   │   ├── outputs.tf
│   │   └── versions.tf
│   ├── storage/
│   └── compute/
└── README.md
```

## File Organization

Every Terraform configuration follows a consistent file structure:

| File                   | Purpose                                              |
|------------------------|------------------------------------------------------|
| `main.tf`              | Primary resource definitions and module calls        |
| `variables.tf`         | Input variable declarations                          |
| `outputs.tf`           | Output value declarations                            |
| `versions.tf`          | Required providers and Terraform version constraints |
| `backend.tf`           | State backend configuration (root modules only)      |
| `locals.tf`, `data.tf` | Local values and data sources (when numerous)        |

Within each file, order content as: terraform/provider blocks, variables, locals, data sources, resources, module calls, outputs.

## Naming Conventions

File and folder names use `kebab-case` (e.g., `storage-account.tf`, `modules/web-app/`).

Resource names, variable names, local values, and output names use `snake_case` (e.g., `azurerm_storage_account.data_storage`, `resource_group_name`, `local.computed_name`).

### Resource and Data Source Logical Names

Logical names (the label after the resource or data source type) follow these patterns:

* Singleton of a type: use `"this"` (e.g., `azurerm_resource_group.this`, `data.azurerm_client_config.this`). The Terraform community has coalesced around `"this"` as the dominant symbolic name for the sole resource or data source of a given type within a module.
* Multiple instances with distinct purposes: use descriptive names (e.g., `azurerm_storage_account.data`, `azurerm_storage_account.logs`)
* Dynamic instances: use `for_each` with descriptive keys from `each.key`

```hcl
resource "azurerm_storage_account" "this" {
  // resource parameters here
}

data "azurerm_client_config" "this" {}
```

## Variables and Outputs

### Variable Declarations

Variable conventions:

* Every variable includes a `description` without trailing periods
* Boolean variables start with `should_` or `is_` (e.g., `should_enable_https`, `is_production`)
* Sensitive variables include `sensitive = true`
* Required variables omit the `default` attribute; optional variables include sensible defaults
* Use `null` for optional defaults instead of empty strings
* Avoid adding `validation` blocks unless explicitly requested

```hcl
variable "storage_account_tier" {
  description = "Performance tier for the storage account"
  type        = string
  default     = "Standard"
  sensitive   = false  // Set true for secrets
}
```

### Output Declarations

Every output includes a meaningful `description` without trailing periods. Sensitive outputs include `sensitive = true`. Conditional resources require conditional output expressions.

```hcl
output "storage_account_id" {
  description = "Resource ID of the deployed storage account"
  value       = var.should_deploy ? azurerm_storage_account.this[0].id : null
  sensitive   = true  // Set true for secrets
}
```

## Comment Style

Use `//` for single-line and `/* */` for multi-line comments. Do not use `#` for comments in this codebase.

Section headers use visual separators for organization:

```hcl
// =====================================================
// Networking Resources
// =====================================================
```

## Module Conventions

Child modules in `modules/{name}/` inherit providers and state from the calling root module.

### Module Calls

Use `count = var.condition ? 1 : 0` for conditional module deployment. Prefer `for_each` over `count` for multiple instances with stable resource addresses:

```hcl
module "workload" {
  source   = "../../modules/workload"
  for_each = var.workload_configurations

  name                = each.key
  resource_group_name = azurerm_resource_group.this.name
  configuration       = each.value
}
```

## Expression Functions

### coalesce()

Returns the first non-null and non-empty value. Prefer over ternary operators for default value selection:

```hcl
location = coalesce(var.override_location, var.primary_location, "eastus")
```

Note: `coalesce()` treats empty strings as falsy. Use ternary when empty string is a valid value.

### try()

Returns the value of an expression or a fallback when the expression fails. Prefer over ternary operators for optional attribute access:

```hcl
endpoint = try(var.network.private_endpoint.ip, null)
database_id = try(module.database[0].id, null)
subnet_id = try(each.value.subnet_id, var.default_subnet_id)
```

### Combining coalesce() and try()

Combine these functions for complex optional configuration patterns:

```hcl
// try() inside coalesce(): safe attribute access with simple fallback
nsg_name = coalesce(try(var.network_security_group.name, null), "${var.subnet_name}-nsg")

// coalesce() inside try(): computed default that might fail (Azure Verified Modules pattern)
nsg_name = try(coalesce(var.new_nsg.name, "${var.subnet_name}-nsg"), "${var.subnet_name}-nsg")
```

### When to Use Ternary Operators

Ternary operators remain appropriate for boolean conditions (`var.is_production ? "Premium" : "Standard"`), conditional counts (`count = var.enable_feature ? 1 : 0`), and complex multi-factor logic.

## Data Sources and Deferred Lookups

Use standard Terraform data source syntax for existing resource lookups (e.g., `data "azurerm_resource_group"`, `data "azurerm_client_config"`). Apply the same logical-name convention as resources: a singleton data source uses `"this"`, while multiple data sources of the same type use descriptive names or `for_each` keys.

### Deferred Data Resources

Use `terraform_data` for values computed at apply time or CI compatibility:

```hcl
resource "terraform_data" "deployment_timestamp" {
  triggers_replace = [var.storage_account_name]
  input            = timestamp()

  provisioner "local-exec" {
    command = "az storage account show --name ${var.storage_account_name} --query id -o tsv"
  }
}
```

## Resource Naming

Resource names follow [Azure naming conventions](https://learn.microsoft.com/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naming):

* Hyphens allowed: `${var.prefix}-{abbrev}-${var.environment}-${var.instance}`
* No hyphens: `${var.prefix}{abbrev}${var.environment}${var.instance}`
* Length restricted: `substr("${var.prefix}{abbrev}${random_id.suffix.hex}", 0, 24)`

## Provider Configuration

### Required Providers Block

Every module includes a `versions.tf` with required providers:

```hcl
terraform {
  required_version = ">= 1.6.0"

  required_providers {
    azurerm = {
      source  = "hashicorp/azurerm"
      version = ">= 4.0"
    }
    azapi = {
      source  = "azure/azapi"
      version = ">= 2.0"
    }
    random = {
      source  = "hashicorp/random"
      version = ">= 3.6"
    }
  }
}
```

### Provider Features

Root modules configure provider features explicitly:

```hcl
provider "azurerm" {
  features {
    resource_group {
      prevent_deletion_if_contains_resources = true
    }
    key_vault {
      purge_soft_delete_on_destroy = false
    }
  }
}
```

## State Management

### Backend Configuration

Root modules include explicit backend configuration:

```hcl
terraform {
  backend "azurerm" {
    resource_group_name  = "tfstate-rg"
    storage_account_name = "tfstateaccount"
    container_name       = "tfstate"
    key                  = "dev/terraform.tfstate"
  }
}
```

### State Management Practices

State files can be stored locally or in remote backends. Do not commit state files to the repository. When using remote backends, enable state locking and protect sensitive values through backend encryption.

## Validation and Formatting

### Pre-commit Checks

Run `terraform fmt -recursive`, `terraform validate`, and `terraform plan` before commits.

### Linting Tools

Use `terraform fmt` for formatting, `terraform validate` for configuration validation, `tflint` for extended linting, and `checkov` or `tfsec` for security scanning.

## Lifecycle Management

Use lifecycle blocks for resources requiring special handling:

```hcl
resource "azurerm_storage_account" "this" {
  // ...

  lifecycle {
    prevent_destroy       = true   // Protect critical resources
    create_before_destroy = true   // Zero-downtime replacement
    ignore_changes        = [tags] // Ignore external tag changes
  }
}
```

## Documentation Requirements

Every Terraform module includes a README.md documenting module purpose, required and optional inputs, outputs, usage examples, and prerequisites.

© microsoft · MIT · microsoft/hve-core

Похожие правила IDE

Все правила IDE по теме «DevOps и инфраструктура» →

Сначала — terraform от других авторов.

terraform официальный github Правило terraform для GitHub Copilot задаёт стандарты написания манифестов **/*.tf: следит за защитой секретов, структурой модулей и форматированием кода. CX Codex +1 ★ 41 430звёзд репо terraform sanjeed5 Задаёт стандарты написания манифестов Terraform для Cursor: структуру каталогов, именование, блокировки стейта и правила модулей. CX Codex +1 ★ 3 589звёзд репо terraform-generator akin-ozer Скилл terraform-generator для Claude Code пишет конфигурации Terraform: ресурсы, модули, провайдеры, переменные и outputs. Генерирует набор .tf файлов и проверяет их через валидатор, пока конфигурация не пройдёт все проверки. CX Codex +1 713установок terraform-test hashicorp Скилл terraform-test для Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode: пишет .tftest.hcl файлы с утверждениями, запускает тесты инфраструктуры во временных ресурсах. CX Codex +1 9 500установок terraform-infrastructure manutej Скилл terraform-infrastructure учит агента писать код Terraform на HCL: настраивать провайдеров AWS и Azure, собирать модули, валидировать переменные и разделять стейт по окружениям. CX Codex +1 439установок terraform-tasks JosiahSiegel Скилл terraform-tasks для автономной работы с Terraform: генерирует код инфраструктуры, собирает CI/CD-пайплайны, мигрирует ресурсы в state и чинит проблемы версий. CX Codex +1 155установок terraform-best-practices NickCrew Скилл terraform-best-practices внедряет инженерные стандарты Terraform: разбиение на модули, блокировку стейта, разделение сред и валидацию в CI/CD. CX Codex +1 109установок terraform-skill Anton Babenko Диагностирует риски и управляет кодом Terraform и OpenTofu в ассистенте. Помогает при рефакторинге модулей, миграциях стейта и настройке безопасного пайплайна. CX Codex +1 8 200установок

Из того же набора148

Весь набор →
engagement-reporting Скилл engagement-reporting формирует еженедельные отчёты о ходе проекта с опорой на первоисточники и создаёт черновики писем в Outlook. CX Codex +1 ★ 1 627звёзд репо hve-builder Скилл hve-builder помогает создавать и дорабатывать промпты, инструкции, агентов и другие скиллы. Он также проводит проверку качества или механическую валидацию без изменения файлов. CX Codex +1 ★ 1 627звёзд репо bash Правило задаёт единые конвенции для Bash-скриптов: strict mode, структуру с main(), форматирование, обработку ошибок и copyright-заголовки Microsoft. CX Codex +1 ★ 1 627звёзд репо incident-response Скилл incident-response помогает дежурным инженерам и SRE расследовать инциденты в Azure: оценивать критичность, писать диагностические запросы и готовить отчёты о причинах сбоя. CX Codex +1 ★ 1 627звёзд репо adr-byo-template Правило adr-byo-template задаёт контракт для собственных шаблонов ADR: как резолвится конфиг проекта и что должен объявить шаблон, чтобы ADR Creator его принял. CX Codex +1 ★ 1 627звёзд репо pptx Задаёт структуру каталогов, форматы YAML и правила верстки для сборки презентаций PowerPoint с помощью агентов и python-pptx. CX Codex +1 ★ 1 627звёзд репо coaching-patterns Правило coaching-patterns задаёт исследовательский стиль вопросов для планирующих агентов. Оно помогает сначала разобраться в системе и её контексте, а затем переходить к классификации и анализу. CX Codex +1 ★ 1 627звёзд репо BRD Quality Reviewer Субагент BRD Quality Reviewer автоматически проверяет требования в BRD по стандартам ISO/IEC/IEEE 29148 и ISO/IEC 25010 и формирует отчёт с рекомендациями без изменения файлов. CX Codex +1 ★ 1 627звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой