Kaidah Penamaan
Kaidah umum
Seharusnya tidak ada alasan untuk menolak mengikuti kaidah berikut :)
Sadarilah bahwa sumber daya awan seringkali memiliki keterbatasan tersendiri dalam pemberian nama. Sebagai contoh beberapa sumber daya tidak bisa menggunakan tanda hubung, atau harus menggunakan aturan penulisan huruf unta (camel case). Kaidah yang dimaksud dalam buku ini dimaksudkan untuk nama sumber daya Terraform itu sendiri.
Gunakan
_
(garis bawah) daripada-
(tanda hubung) dimana saja (nama sumber daya, nama sumber data, nama variabel, keluaran, dan lain-lain)Pilihlah penggunaan huruf kecil dan angka (walaupun ada dukungan UTF-8)
Argumen sumber daya dan sumber data
Hindari mengulang jenis sumber daya pada nama sumber daya (baik itu sebagian atau sepenuhnya):
resource "aws_route_table" "public" {}
resource "aws_route_table" "public_route_table" {}
resource "aws_route_table" "public_aws_route_table" {}
Sumber daya sebaiknya dinamakan
this
jika tidak tersedia nama lain yang lebih deskriptif dan umum, atau jika modul sumber daya menciptakan sumber daya tunggal dari tipe tersebut. Sebagai contoh pada modul AWS VPC terdapat sebuah sumber daya dengan tipeaws_nat_gateway
dan beberapa sumber daya dengan tipeaws_route_table
. Maka dari itu sumber dayaaws_nat_gateway
sebaiknya dinamakanthis
danaws_route_table
diberi nama yang lebih deskriptif sepertiprivat
,publik
,database
.Selalu gunakan kata benda tunggal sebagai nama.
Gunakan
-
pada nilai argumen dan ditempat-tempat lain dimana nilai akan dipaparkan ke orang lain (Contoh di dalam nama DNS sebuah RDS).Letakan argumen
count
/for_each
pada baris pertama di dalam blok sumber daya atau sumber data dan tambahkan baris baru untuk memisahkan dengan argumen lainnya.Letakan argumen
tags
(jika sumber daya mendukung hal tersebut) sebagai argumen terakhir, diikuti olehdepends_on
danlifecycle
jika diperlukan. Semua argumen tersebut sebaiknya dipisahkan oleh satu baris kosong.Ketika menggunakan argumen
count
/for_each
sebagai pernyataan bersyarat, pilihlah nilai boolean dibandingkanlength
atau ekspresi lainnya
Contoh kode resource
Penggunaan count
/ for_each
count
/ for_each
Penempatan tags
tags
Pernyataan bersyarat count
count
Variabel
Hindari membuat ulang secara mandiri (don't reinvent the wheel) pada modul sumber daya: gunakan
name
,description
, dan nilaidefault
untuk variabel seperti yang didefinisikan pada bagian "Referensi Argumen" untuk sumber daya yang Anda kerjakan.Dukungan untuk validasi variabel bersifat terbatas (Contoh tidak bisa mengakses variabel lain atau melakukan pencarian). Buat perencanaan validasi dengan baik karena fitur ini tidak bisa digunakan pada beberapa kasus tertentu.
Gunakan bentuk jamak pada nama variabel dengan tipe
list(...)
ataumap(...)
.Urutkan nama atribut di dalam blok variabel seperti berikut:
description
,type
,default
,validation
Selalu sertakan
description
disemua variabel walaupun menurut Anda hal tersebut sudah jelas (Anda akan membutuhkannya dimasa yang akan datang).Pilihlah tipe-tipe sederhana (
number
,string
,list(...)
,map(...)
,any
) daripada tipe yang lebih spesifik sepertiobject()
kecuali Anda memerlukan batasan ketat pada setiap atributnya.Gunakan tipe spesifik seperti
map(map(string))
jika seluruh elemen darimap
memiliki tipe yang sama (Contohstring
) atau bisa dikonversikan menjadi tipe tersebut (Contoh tipenumber
bisa dikonversi menjadistring
).Gunakan tipe
any
untuk menonaktifkan validasi tipe mulai dari level tertentu atau ketika perlu mendukung berbagai tipe.Nilai
{}
bisa bertipemap
atau bisa juga bertipeobject
. Gunakantomap(...)
untuk konversi menjadi map karena tidak ada cara untuk mengubah menjadiobject
.
Keluaran
Buat keluaran konsisten dan mudah dipahami diluar cakupan mereka (Tipe dan atribut dari nilai yang dikembalikan harus jelas bagi pengguna modul ketika menggunakan modul tersebut).
Nama keluaran sebaiknya menjelaskan properti yang dimiliki dan tidak terlalu menggunakan bentuk bebas yang biasa kita inginkan.
Struktur yang baik untuk nama keluaran berbentuk
{name}_{type}_{attribute}
, dimana:{name}
adalah nama sumber daya atau sumber data tanpa awalan penyedia. Sebagai contoh{name}
untukaws_subnet
adalahsubnet
,{name}
untukaws_vpc
adalahvpc
.{type}
adalah tipe dari sumber daya{attribute}
adalah atribut dari nilai keluaranLihat contoh
Jika keluaran mengembalikan nilai dengan fungsi interpolasi dan banyak sumber daya maka
{name}
dan{type}
sebaiknya dibuat seumum mungkin (this
sebagai prefiks sebaiknya diabaikan saja). Lihat contoh.Jika nilai kembalian adalah sebuah daftar maka gunakan bentuk jamak sebagai nama. Lihat contoh.
Selalu sertakan
description
untuk semua keluaran walaupun hal itu dirasa sudah jelas.Hindari argumen
sensitive
kecuali Anda mengontrol penuh penggunaan keluaran tersebut diseluruh tempat pada seluruh modul.
Contoh kode output
output
Kembalikan paling banyak satu ID dari security group::
Ketika bekerja dengan banyak sumber daya berjenis sama, this
sebaiknya diabaikan dari nama keluaran:
Gunakan bentuk jamak jika mengembalikan nilai yang berupa daftar
Last updated