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.
  1. 1.
    Gunakan _ (garis bawah) daripada - (tanda hubung) dimana saja (nama sumber daya, nama sumber data, nama variabel, keluaran, dan lain-lain)
  2. 2.
    Pilihlah penggunaan huruf kecil dan angka (walaupun ada dukungan UTF-8)

Argumen sumber daya dan sumber data

  1. 1.
    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" {}
  2. 2.
    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 tipe aws_nat_gateway dan beberapa sumber daya dengan tipe aws_route_table. Maka dari itu sumber daya aws_nat_gateway sebaiknya dinamakan this dan aws_route_table diberi nama yang lebih deskriptif seperti privat, publik, database.
  3. 3.
    Selalu gunakan kata benda tunggal sebagai nama.
  4. 4.
    Gunakan - pada nilai argumen dan ditempat-tempat lain dimana nilai akan dipaparkan ke orang lain (Contoh di dalam nama DNS sebuah RDS).
  5. 5.
    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.
  6. 6.
    Letakan argumen tags (jika sumber daya mendukung hal tersebut) sebagai argumen terakhir, diikuti oleh depends_on dan lifecycle jika diperlukan. Semua argumen tersebut sebaiknya dipisahkan oleh satu baris kosong.
  7. 7.
    Ketika menggunakan argumen count / for_each sebagai pernyataan bersyarat, pilihlah nilai boolean dibandingkan length atau ekspresi lainnya

Contoh kode resource

Penggunaan count / for_each

main.tf
1
resource "aws_route_table" "public" {
2
count = 2
3
4
vpc_id = "vpc-12345678"
5
# ... sisa argumen sengaja dihilangkan
6
}
7
8
resource "aws_route_table" "private" {
9
for_each = toset(["one", "two"])
10
11
vpc_id = "vpc-12345678"
12
# ... sisa argumen sengaja dihilangkan
13
}
Copied!
main.tf
1
resource "aws_route_table" "public" {
2
vpc_id = "vpc-12345678"
3
count = 2
4
5
# ... sisa argumen sengaja dihilangkan
6
}
Copied!

Penempatan tags

main.tf
1
resource "aws_nat_gateway" "this" {
2
count = 2
3
4
allocation_id = "..."
5
subnet_id = "..."
6
7
tags = {
8
Name = "..."
9
}
10
11
depends_on = [aws_internet_gateway.this]
12
13
lifecycle {
14
create_before_destroy = true
15
}
16
}
Copied!
main.tf
1
resource "aws_nat_gateway" "this" {
2
count = 2
3
4
tags = "..."
5
6
depends_on = [aws_internet_gateway.this]
7
8
lifecycle {
9
create_before_destroy = true
10
}
11
12
allocation_id = "..."
13
subnet_id = "..."
14
}
Copied!

Pernyataan bersyarat count

outputs.tf
1
resource "aws_nat_gateway" "that" { # Best
2
count = var.create_public_subnets ? 1 : 0
3
}
4
5
resource "aws_nat_gateway" "this" { # Good
6
count = length(var.public_subnets) > 0 ? 1 : 0
7
}
Copied!

Variabel

  1. 1.
    Hindari membuat ulang secara mandiri (don't reinvent the wheel) pada modul sumber daya: gunakan name, description, dan nilai default untuk variabel seperti yang didefinisikan pada bagian "Referensi Argumen" untuk sumber daya yang Anda kerjakan.
  2. 2.
    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.
  3. 3.
    Gunakan bentuk jamak pada nama variabel dengan tipe list(...) atau map(...).
  4. 4.
    Urutkan nama atribut di dalam blok variabel seperti berikut: description, type, default, validation
  5. 5.
    Selalu sertakan description disemua variabel walaupun menurut Anda hal tersebut sudah jelas (Anda akan membutuhkannya dimasa yang akan datang).
  6. 6.
    Pilihlah tipe-tipe sederhana (number, string, list(...), map(...), any) daripada tipe yang lebih spesifik seperti object() kecuali Anda memerlukan batasan ketat pada setiap atributnya.
  7. 7.
    Gunakan tipe spesifik seperti map(map(string)) jika seluruh elemen dari map memiliki tipe yang sama (Contoh string) atau bisa dikonversikan menjadi tipe tersebut (Contoh tipe number bisa dikonversi menjadi string).
  8. 8.
    Gunakan tipe any untuk menonaktifkan validasi tipe mulai dari level tertentu atau ketika perlu mendukung berbagai tipe.
  9. 9.
    Nilai {} bisa bertipe map atau bisa juga bertipe object. Gunakan tomap(...) untuk konversi menjadi map karena tidak ada cara untuk mengubah menjadi object.

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).
  1. 1.
    Nama keluaran sebaiknya menjelaskan properti yang dimiliki dan tidak terlalu menggunakan bentuk bebas yang biasa kita inginkan.
  2. 2.
    Struktur yang baik untuk nama keluaran berbentuk {name}_{type}_{attribute}, dimana:
    1. 1.
      {name} adalah nama sumber daya atau sumber data tanpa awalan penyedia. Sebagai contoh {name} untuk aws_subnet adalah subnet, {name} untuk aws_vpc adalah vpc.
    2. 2.
      {type} adalah tipe dari sumber daya
    3. 3.
      {attribute} adalah atribut dari nilai keluaran
    4. 4.
      Lihat contoh
  3. 3.
    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.
  4. 4.
    Jika nilai kembalian adalah sebuah daftar maka gunakan bentuk jamak sebagai nama. Lihat contoh.
  5. 5.
    Selalu sertakan description untuk semua keluaran walaupun hal itu dirasa sudah jelas.
  6. 6.
    Hindari argumen sensitive kecuali Anda mengontrol penuh penggunaan keluaran tersebut diseluruh tempat pada seluruh modul.

Contoh kode output

Kembalikan paling banyak satu ID dari security group::
outputs.tf
1
output "security_group_id" {
2
description = "The ID of the security group"
3
value = try(aws_security_group.this[0].id, aws_security_group.name_prefix[0].id, "")
4
}
Copied!
Ketika bekerja dengan banyak sumber daya berjenis sama, this sebaiknya diabaikan dari nama keluaran:
outputs.tf
1
output "this_security_group_id" {
2
description = "The ID of the security group"
3
value = element(concat(coalescelist(aws_security_group.this.*.id, aws_security_group.web.*.id), [""]), 0)
4
}
Copied!

Gunakan bentuk jamak jika mengembalikan nilai yang berupa daftar

outputs.tf
1
output "rds_cluster_instance_endpoints" {
2
description = "A list of all cluster instance endpoints"
3
value = aws_rds_cluster_instance.this.*.endpoint
4
}
Copied!