Terraform Best Practices
Terraform consultingTwitter @antonbabenkoTerraform Weekly
Português (Brazilian Portuguese)
Português (Brazilian Portuguese)
  • Seja Bem-Vindo(a)
  • Conceitos chave
  • Estrutura do código
  • Exemplos de estrutura de códigos
    • Terragrunt
    • Terraform
      • Infraestrutura pequena com o Terraform
      • Infraestrutura média com o Terraform
      • Infraestrutura grande com o Terraform
  • Convenções de nomenclatura
  • Estilo de código
  • FAQ
  • Referências
  • Escrevendo configurações do Terraform
  • Workshop
Powered by GitBook
On this page
  • Documentação
  • Documentação gerada automaticamente
  • terraform-docs
  • Recursos
Export as PDF

Estilo de código

PreviousConvenções de nomenclaturaNextFAQ

Last updated 3 years ago

  • Os módulos de exemplos e do Terraform devem conter documentação explicando os recursos e como usá-los.

  • Todos os links nos arquivos README.md devem ser absolutos para que o site do Terraform Registry os mostre corretamente.

  • A documentação pode incluir diagramas criados com e plantas criadas com o .

  • Utilize o para garantir que o código seja válido, formatado corretamente e documentado automaticamente antes de ser enviado para o git e revisado por humanos.

Documentação

Documentação gerada automaticamente

O é um framework para gerenciar e manter hooks pré-commit multi-idioma. Ele é escrito em Python e é uma ferramente poderosa para fazer algo automaticamente na máquina de um desenvolvedor antes que o código seja enviado para o repositório git. Normalmente, ele é usado para executar linters e formatar código (veja ).

Com as configurações do Terraform, o pre-commit pode ser usado para formatar e validar o código, bem como para atualizar a documentação.

Confirma o repositório para se familiarizar com ele e os repositórios existentes (por exemplo, ) onde ele já é utilizado.

terraform-docs

O é uma ferramente que faz a geração de documentação a partir de módulos Terraform em vários formatos de saída (output). Você pode executá-lo manualmente (sem ganchos — pre-commit hooks — de pré-commit) ou usar o para atualizar a documentação automaticamente.

@todo: Document module versions, release, GH actions

Recursos

  1. Blog post by :

mermaid
cloudcraft.co
Terraform pre-commit hooks
pre-commit
supported hooks
pre-commit-terraform
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