Terraform Best Practices
Terraform consultingTwitter @antonbabenkoTerraform Weekly
Українська (Ukrainian)
Українська (Ukrainian)
  • Ласкаво просимо
  • Ключові концепції
  • Структура коду
  • Приклади структури коду
    • Terragrunt
    • Terraform
      • Малорозмірна структура із Terraform
      • Середня інфраструктура з Terraform
      • Велика структура Terraform
  • Умови найменувань
  • Стиль коду
  • FAQ (Часті запитання)
  • Посилання
  • Написання конфігурацій Terraform
  • Workshop
Powered by GitBook
On this page
  • Документація
  • Автоматично згенерована документація
  • terraform-docs
  • Ресурси
Export as PDF

Стиль коду

PreviousУмови найменуваньNextFAQ (Часті запитання)

Last updated 3 years ago

  • Приклади та модулі Terraform повинні містити документацію, яка пояснює функції та як їх використовувати.

  • Усі посилання у файлах README.md мають бути абсолютними, щоб веб-сайт Terraform Registry відображав їх правильно.

  • Документація може включати схеми, створені за допомогою і креслення, створені за допомогою .

  • Використовуйте щоб переконатися, що код валідний, правильно відформатований і автоматично задокументований, перш ніж запушати його на git і надати для подальшого код рев'ю.

Документація

Автоматично згенерована документація

- це фреймворк для керування та підтримки багатомовних pre-commit хуків. Він написаний на Python і є потужним інструментом для автоматичного виконання завдань на машині розробника до того, як код буде передано в репозиторій git. Зазвичай він використовується для запуску лінтерів і форматування коду (дивіться ).

З конфігураціями Terraform pre-commit можна використовувати для форматування та перевірки коду, а також для оновлення документації.

Перегляньте , щоб ознайомитися з ним та існуючими репозиторіями (наприклад, ), де це вже використовується.

terraform-docs

- це інструмент, який створює документацію з модулів Terraform у різних вихідних форматах. Ви можете запускати його вручну (без pre-commit хуків, або ж використовувати , щоб документація оновлювалася автоматично).

@todo: Document module versions, release, GH actions

Ресурси

  1. Блог пост від :

mermaid
cloudcraft.co
Terraform pre-commit hooks
pre-commit
підтримувані хуки
pre-commit-terraform repository
terraform-aws-vpc
terraform-docs
pre-commit-terraform hooks
pre-commit framework homepage
Collection of git hooks for Terraform to be used with pre-commit framework
Dean Wilson
pre-commit hooks and terraform - a safety net for your repositories