Terraform Best Practices
Terraform consultingTwitter @antonbabenkoTerraform Weekly
Bahasa Indonesia (Indonesian)
Bahasa Indonesia (Indonesian)
  • Selamat Datang
  • Konsep Dasar
  • Struktur Kode
  • Contoh-Contoh Struktur Kode
    • Terragrunt
    • Terraform
      • Penggunaan Terraform Untuk Infrastruktur Skala Kecil
      • Penggunaan Terraform Untuk Infrastruktur Skala Sedang
      • Penggunaan Terraform Untuk Infrastruktur Skala Besar
  • Kaidah Penamaan
  • Penataan Kode
  • Tanja Umum
  • Referensi
  • Menulis Konfigurasi Terraform
  • Lokakarya
Powered by GitBook
On this page
  • Dokumentasi
  • Dokumentasi secara otomatis
  • terraform-docs
  • Sumber daya
Export as PDF

Penataan Kode

PreviousKaidah PenamaanNextTanja Umum

Last updated 3 years ago

  • Contoh dan modul Terraform sebaiknya disertai dengan dokumentasi yang menjelaskan fitur-fitur dan cara penggunaannya.

  • Semua tautan pada berkas README.md sebaiknya menggunakan tautan absolut sehingga tautan akan ditampilkan dengan benar pada halaman Terraform Registry.

  • Dokumentasi bisa diisi dengan diagram yang dibuat menggunakan dan cetak biru buatan .

  • Gunakan untuk memastikan kode valid, diformat dengan benar, dan terdokumentasi secara otomatis sebelum dikirim ke git dan ditinjau oleh orang lain.

Dokumentasi

Dokumentasi secara otomatis

merupakan kerangka kerja untuk mengelola dan memelihara kait pre-commit multi bahasa. Pre-commit ditulis dalam bahasa Python dan merupakan alat ampuh untuk melakukan sesuatu secara otomatis pada mesin pengembang sebelum kode disimpan pada repositori git. Umumnya alat ini digunakan untuk menjalankan linter dan memformat kode (Lihat ).

Kita bisa menggunakan pre-commit untuk memformat dan memvalidasi konfigurasi Terraform dan juga untuk memperbarui dokumentasi.

Periksa untuk membiasakan diri Anda akan penggunaan pre-commit untuk Terraform. Beberapa repositori seperti sudah menggunakan pre-commit.

terraform-docs

merupakan alat untuk menciptakan dokumentasi modul Terraform dalam berbagai format keluaran. Kita dapat menjalankan terraform-docs secara manual (tanpa kait pre-commit) atau via untuk memperbarui dokumentasi secara otomatis.

@todo: Dokumentasikan versi modul, rilis, dan GH actions

Sumber daya

  1. Tulisan blog oleh :

mermaid
cloudcraft.co
kait-kait pre-commit Terraform
pre-commit
kait yang didukung
repository pre-commit-terraform
terraform-aws-vpc
terraform-docs
kait pre-commit-terraform
halaman depan kerangka kerja pre-commit
Kumpulan kait-kait git untuk Terraform menggunakan kerangka kerja pre-commit
Dean Wilson
pre-commit hooks and terraform - a safety net for your repositories