Terraform Infrastructure as Code · Pelajaran

Struktur Kode dan Konvensi Penamaan

Terapkan praktik terbaik untuk menata file dan modul Terraform, beserta konvensi penamaan yang konsisten untuk resource dan variabel.

Struktur Kode dan Konvensi Penamaan adalah pelajaran Terraform Infrastructure as Code gratis di CoddyKit. Ini adalah pelajaran 1 dari 4. Kamu bisa membaca pelajaran lengkapnya di bawah secara gratis — lalu praktikkan langsung di browser dengan editor kode bawaan dan tutor AI 24/7. Ini adalah bagian dari jalur belajar Terraform Infrastructure as Code, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Terraform Infrastructure as Code mencakup 4 pelajaran total.

Mengapa Kode Terraform Perlu Disusun?

Sama seperti menata ruang kerja fisik, menyusun kode Terraform membuatnya lebih mudah dipahami, dikelola, dan digunakan untuk berkolaborasi.

Struktur yang baik meningkatkan keterbacaan, mengurangi kesalahan, dan membantu anggota tim baru memahami pekerjaan dengan cepat.

Berkas Terraform Penting

Proyek Terraform biasanya dimulai dengan beberapa berkas utama. Mengatur konfigurasi ke dalam berkas-berkas ini merupakan praktik terbaik yang umum:

main.tf: Menentukan sumber daya dan modul.
variables.tf: Mendeklarasikan semua variabel input.
outputs.tf: Menentukan nilai keluaran dari infrastruktur Anda.
versions.tf: Menentukan versi Terraform dan penyedia.

Menamai Sumber Daya

Penamaan yang konsisten memudahkan identifikasi sumber daya. Ikuti panduan umum berikut untuk nama lokal (misalnya, my_instance dalam resource "aws_instance" "my_instance"):

Gunakan nama yang deskriptif: Apa fungsi sumber daya tersebut?
Gunakan tanda hubung atau garis bawah: Agar mudah dibaca (misalnya, web-server-sg atau web_server_sg).
Hindari nama umum: server kurang informatif daripada app-frontend-server.

Nama lokal sumber daya Terraform harus unik di dalam sebuah modul.

Konvensi untuk Variabel

Variabel membuat konfigurasi Anda fleksibel. Penamaan yang baik sangat penting:

Huruf kecil dengan garis bawah: Ini adalah konvensi yang paling umum (misalnya, instance_type, vpc_id).
Buatlah spesifik: Apa yang dikendalikan variabel ini?
Tambahkan deskripsi: Jelaskan tujuan variabel agar lebih jelas.

Nama variabel yang baik membantu orang lain memahami input yang diharapkan modul Anda.

Menamai Nilai Keluaran

Keluaran menyediakan informasi penting tentang infrastruktur yang Anda terapkan. Penamaan yang konsisten membantu pengguna keluaran:

Huruf kecil dengan garis bawah: Serupa dengan variabel, misalnya web_server_ip.
Deskripsikan nilainya: Informasi apa yang disediakan?
Tambahkan deskripsi: Hal ini penting untuk keluaran modul agar menjelaskan nilai yang dikembalikan.

Contoh: Konfigurasi Sederhana

Berkas main.tf lengkap ini menunjukkan praktik penamaan yang baik untuk sumber daya, variabel, dan keluaran. Anda dapat menjalankan terraform init dan terraform plan dengan berkas ini.

terraform {
  required_providers {
    null = {
      source = "hashicorp/null"
      version = "~> 3.0"
    }
  }
}

resource "null_resource" "example_web_server" {
  # Descriptive resource name
  triggers = {
    always_run = timestamp()
  }
}

variable "app_environment" {
  description = "The application's deployment environment (e.g., dev, prod)."
  type        = string
  default     = "development"
}

output "resource_unique_id" {
  description = "The unique ID of the example null resource."
  value       = null_resource.example_web_server.id
}

Menyusun Modul Terraform

Untuk komponen yang dapat digunakan kembali, modul memiliki struktur yang jelas:

Modul akar: Direktori tingkat teratas yang berisi konfigurasi utama Anda.
Modul anak: Subdirektori yang masing-masing berisi main.tf, variables.tf, outputs.tf, dan sebagainya.
README.md: Penting untuk menjelaskan tujuan, input, dan keluaran modul.

Dengan demikian, modul tetap mandiri dan mudah digunakan kembali.

Mengatur Folder Proyek

Selain berkas, cara Anda mengatur folder proyek juga sangat penting, terutama untuk pengaturan yang lebih besar:

Pisahkan lingkungan: Sediakan folder khusus untuk dev, staging, dan prod, masing-masing dengan konfigurasinya sendiri.
Folder modul bersama: Sediakan direktori modules untuk modul khusus yang dapat digunakan kembali.
Folder akar untuk penyedia: Folder tingkat teratas biasanya mendefinisikan penyedia dan backend status.

Hal ini mencegah perbedaan konfigurasi dan meningkatkan kemudahan pengelolaan di berbagai lingkungan.

Contoh Folder Proyek

Proyek Terraform multi-lingkungan biasanya dapat terlihat seperti berikut, dengan pemisahan dan penggunaan kembali yang jelas:

.
├── modules/
│   ├── vpc/
│   │   ├── main.tf
│   │   ├── variables.tf
│   │   └── outputs.tf
│   └── ec2-instance/
│       ├── main.tf
│       └── variables.tf
├── environments/
│   ├── dev/
│   │   └── main.tf
│   ├── staging/
│   │   └── main.tf
│   └── prod/
│       └── main.tf
└── README.md

Uji Pemahaman Anda

Manakah dari pilihan berikut yang merupakan praktik terbaik untuk menamai variabel input Terraform yang menentukan jumlah instans?

Rangkuman: Struktur dan Penamaan

Kita telah mempelajari bahwa kode Terraform yang tersusun baik dan memiliki penamaan konsisten sangat penting untuk keterbacaan, kemudahan pemeliharaan, dan kolaborasi tim.

Atur berkas ke dalam main.tf, variables.tf, dan outputs.tf.
Gunakan nama deskriptif dengan huruf kecil dan garis bawah untuk sumber daya, variabel, dan keluaran.
Susun modul dan folder proyek agar dapat digunakan kembali serta memisahkan lingkungan.

Praktik-praktik ini menjadi dasar bagi pengelolaan IaC yang efektif!

Pertanyaan yang Sering Diajukan

Apakah pelajaran “Struktur Kode dan Konvensi Penamaan” gratis?

Ya — teks lengkap “Struktur Kode dan Konvensi Penamaan” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Terraform Infrastructure as Code, upgrade ke CoddyKit PRO. Kursus Terraform Infrastructure as Code mencakup 4 pelajaran total.

Apa yang akan aku pelajari di “Struktur Kode dan Konvensi Penamaan”?

Terapkan praktik terbaik untuk menata file dan modul Terraform, beserta konvensi penamaan yang konsisten untuk resource dan variabel. Kamu berlatih Terraform Infrastructure as Code dengan kode praktik yang langsung kamu jalankan di browser, dan tutor AI 24/7 menjawab pertanyaanmu saat kamu mengerjakan pelajaran ini.

Apakah aku perlu pengalaman untuk memulai Terraform Infrastructure as Code?

Tidak diperlukan pengalaman sebelumnya. Terraform Infrastructure as Code di CoddyKit dirancang untuk pemula hingga pelajar tingkat lanjut, jadi kamu bisa memulai di sini atau dari awal dan belajar sesuai kecepatan kamu sendiri. Ini adalah pelajaran 1 dari 4.

Berapa lama pelajaran “Struktur Kode dan Konvensi Penamaan” memakan waktu?

Sebagian besar pelajaran CoddyKit memakan waktu sekitar 5–10 menit. Setiap pelajaran ringkas dan interaktif, jadi kamu membuat kemajuan stabil dan melanjutkan dari tempat kamu tinggalkan di web dan aplikasi.

Bisakah aku menulis dan menjalankan kode dalam pelajaran Terraform Infrastructure as Code ini?

Ya. Setiap pelajaran Terraform Infrastructure as Code menyertakan editor kode bawaan, jadi kamu menulis dan menjalankan kode nyata langsung di browser dan mendapatkan umpan balik AI instan — tidak diperlukan penyiapan lokal.

Semua pelajaran dalam kursus ini

Struktur Kode dan Konvensi Penamaan
Kontrol Versi dengan Git
Kolaborasi Tim dan Alur Kerja
Dokumentasi dan Alur Kerja Layanan Mandiri

← Kembali ke Terraform Infrastructure as Code