Terraform Best Practices
Terraform consultingTwitter @antonbabenkoTerraform Weekly
Bosanski (Bosnian)
Bosanski (Bosnian)
  • Dobro došli
  • Ključni koncepti
  • Struktura koda
  • Primjeri organizacije koda
    • Terragrunt
    • Terraform
      • Kreiranje manjih infrastruktura uz pomoc Terraforma
      • Kreiranje infrastrukture srednje velicine uz pomoc Terraforma
      • Kreiranje velike infrastrukture uz pomoc Terraforma
  • Konvencija o imenovanjima
  • Stilovi koda
  • Česta pitanja
  • Reference
  • Pisanje Terraform konfiguracija
  • Vježba
Powered by GitBook
On this page
  • Dokumentacija
  • Automatski generisana dokumentacija
  • terraform-docs
  • Izvori
Export as PDF

Stilovi koda

PreviousKonvencija o imenovanjimaNextČesta pitanja

Last updated 2 years ago

  • Primjeri Terrafrom modula trebaju sadrzavati dokumentovana objasnjenja mogucnosti i kako ih koristiti.

  • Svi linkovi README.md trebaju biti apsulutni da bi ih Terrafrom Registry web stranica prikazivala ispravno

  • Dokumentacija moze ukljucivati dijagrame krierane sa i primjere kreirane uz pomoc .

  • Koristite kako bi osigurali da je kod validan, pravilno formatiran i automatski dokumentovan prije nego bude dostupan na gitu i pregledan od strane ljudi.

Dokumentacija

Automatski generisana dokumentacija

je framework za menadzmen i odrzavanje visejezicnih okidaca prije nego se kod nadje na gitu. Napisan je u Python programskom jeziku i to je mocan alat koji vam omogucava da odradite nesto automatski na racunaru programera prije nego je kod postavljen na git repozitoriji. Koristi se za pokretanje automatskih formatera koda (pogledajte ).

Sa Terraform konfiguracijama pre-commit se moze korisititi da formatira i validira kod kao i da azurira dokumentaciju.

Pogledajte kako bi se poblize upoznali sa tim, takodjer pogledajte i postojeci repozitoriji gdje se to i koristi.

terraform-docs

je alat koji vam omogucava generisanje dokumenatacije iz Terrafrom modula u razlicitim izlaznim formatima. Mozete ga pokrenuti rucno bez upotrebe pre-commit okidaca, ili koristeci da bi se dokumentacija azurirala automatski..

@todo: Document module versions, release, GH actions

Izvori

  1. Blog post - :

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