Kod Yapısı ve Adlandırma Kuralları
Terraform dosyalarınızı ve modüllerinizi düzenlemek için en iyi uygulamaları benimseyin; kaynaklar ve değişkenler için tutarlı adlandırma kuralları kullanın.
Kod Yapısı ve Adlandırma Kuralları, CoddyKit'te ücretsiz bir DevOps Bootcamp dersidir. Bu, 4 dersinin 1. dersidir. Aşağıdan dersin tamamını ücretsiz okuyabilir, sonra tarayıcıda yerleşik kod editörü ve 7/24 yapay zeka koçu ile uygulamalı olarak pratik yapabilirsin. Bu, DevOps Bootcamp öğrenme yolunun bir parçasıdır ve ilerlemeniz web ve CoddyKit uygulaması arasında senkronize olur. DevOps Bootcamp kursu toplamda 4 dersten oluşur.
Terraform Kodunu Neden Yapılandırmalısınız?
Fiziksel çalışma alanınızı düzenlemeye benzer şekilde Terraform kodunuzu yapılandırmak, kodu anlamayı, yönetmeyi ve ekip arkadaşlarınızla üzerinde çalışmayı kolaylaştırır.
İyi bir yapı okunabilirliği artırır, hataları azaltır ve yeni ekip üyelerinin hızlıca işe alışmasına yardımcı olur.
Temel Terraform Dosyaları
Terraform projeleri genellikle birkaç temel dosyayla başlar. Yapılandırmanızı bu dosyalara ayırmak yaygın bir en iyi uygulamadır:
main.tf: Kaynakları ve modülleri tanımlar.variables.tf: Tüm giriş değişkenlerini bildirir.outputs.tf: Altyapınızdan döndürülen çıkış değerlerini tanımlar.versions.tf: Terraform ve sağlayıcı sürümlerini belirtir.
Kaynaklarınızı Adlandırma
Tutarlı adlandırma, kaynakları kolayca tanımlamanızı sağlar. Yerel ad için (örneğin resource "aws_instance" "my_instance" içindeki my_instance) şu genel yönergeleri izleyin:
- Açıklayıcı adlar kullanın: Kaynak ne yapıyor?
- Tire veya alt çizgi kullanın: Okunabilirlik için (örneğin
web-server-sgveyaweb_server_sg). - Genel adlardan kaçının:
server,app-frontend-serverkadar açıklayıcı değildir.
Terraform yerel kaynak adları bir modül içinde benzersiz olmalıdır.
Değişkenler İçin Adlandırma Kuralları
Değişkenler yapılandırmalarınızı esnek hâle getirir. Değişkenleri iyi adlandırmak önemlidir:
- Küçük harf ve alt çizgi kullanın: Bu, en yaygın kuraldır (örneğin
instance_type,vpc_id). - Belirli olun: Bu değişken neyi denetliyor?
- Açıklamalar ekleyin: Anlaşılır olması için değişkenin amacını açıklayın.
İyi değişken adları, başkalarının modülünüzün hangi girdileri beklediğini anlamasına yardımcı olur.
Çıkış Değerlerini Adlandırma
Çıkışlar, dağıtılmış altyapınızla ilgili önemli bilgileri dışa sunar. Bunları tutarlı şekilde adlandırmak, bu bilgileri kullananlara yardımcı olur:
- Küçük harf ve alt çizgi kullanın: Değişkenlere benzer şekilde, örneğin
web_server_ip. - Değeri açıklayın: Hangi bilgiyi sağlar?
- Açıklamalar ekleyin: Modül çıktılarının ne döndürdüğünü açıklamak için gereklidir.
Örnek: Basit Yapılandırma
Bu eksiksiz main.tf dosyası, bir kaynak, değişken ve çıkış için iyi adlandırma uygulamalarını gösterir. Bu dosyayla terraform init ve terraform plan komutlarını çalıştırabilirsiniz.
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
}Terraform Modüllerini Yapılandırma
Yeniden kullanılabilir bileşenler için modüllerin kendine ait ve anlaşılır bir yapısı vardır:
- Kök modül: Ana yapılandırmanızı içeren en üst düzey dizin.
- Alt modüller: Her biri kendi
main.tf,variables.tf,outputs.tfvb. dosyalarını içeren alt dizinler. - README.md: Modülün amacını, girdilerini ve çıktılarını açıklamak için gereklidir.
Bu yapı, modülleri kendi içinde bütün ve yeniden kullanımı kolay hâle getirir.
Proje Klasörlerini Düzenleme
Özellikle büyük kurulumlarda, yalnızca dosyaları değil proje klasörlerini nasıl düzenlediğiniz de çok önemlidir:
- Ortamları ayırın: Her birinin kendi yapılandırmasına sahip olduğu
dev,stagingveprodiçin özel klasörler oluşturun. - Ortak modüller klasörü: Özel yeniden kullanılabilir modülleriniz için bir
modulesdizini oluşturun. - Sağlayıcılar için kök klasör: En üst düzey klasör genellikle sağlayıcıları ve durum arka ucunu tanımlar.
Bu, yapılandırma sapmasını önler ve ortamlar arasındaki yönetilebilirliği artırır.
Proje Klasörü Örneği
Tipik bir çok ortamlı Terraform projesi, net bir ayrım ve yeniden kullanılabilirlik sağlayacak şekilde şöyle görünebilir:
.
├── 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.mdAnlayışınızı Kontrol Edin
Örnek sayısını belirten bir Terraform giriş değişkenini adlandırmak için aşağıdakilerden hangisi en iyi uygulamadır?
Tekrar: Yapı ve Adlandırma
İyi yapılandırılmış ve tutarlı şekilde adlandırılmış Terraform kodunun okunabilirlik, sürdürülebilirlik ve ekip çalışması için hayati önem taşıdığını öğrendik.
- Dosyaları
main.tf,variables.tfveoutputs.tfolarak düzenleyin. - Kaynaklar, değişkenler ve çıktılar için açıklayıcı, küçük harf ve alt çizgi içeren adlar kullanın.
- Yeniden kullanılabilirlik ve ortamların ayrılması için modülleri ve proje klasörlerini yapılandırın.
Bu uygulamalar, etkili IaC yönetiminin temelini oluşturur!
Sıkça Sorulan Sorular
“Kod Yapısı ve Adlandırma Kuralları” dersi ücretsiz mi?
Evet — “Kod Yapısı ve Adlandırma Kuralları” dersin tüm metni burada web'de ücretsiz olarak okunabilir. Etkileşimli olarak pratik yapmak (yerleşik kod editörü ve 7/24 yapay zeka koçu) ve DevOps Bootcamp kursunun geri kalanını açmak için CoddyKit PRO'ya yükselt. DevOps Bootcamp kursu toplamda 4 dersten oluşur.
“Kod Yapısı ve Adlandırma Kuralları” dersinde ne öğreneceğim?
Terraform dosyalarınızı ve modüllerinizi düzenlemek için en iyi uygulamaları benimseyin; kaynaklar ve değişkenler için tutarlı adlandırma kuralları kullanın. DevOps Bootcamp ile uygulamalı kodu tarayıcıda doğrudan çalıştırarak pratik yaparsın ve 7/24 yapay zeka koçu dersi çalışırken sorularını yanıtlar.
DevOps Bootcamp öğrenmeye başlamak için deneyim gerekli mi?
Önceden deneyim gerekmez. CoddyKit'te DevOps Bootcamp, başlangıçtan ileri seviyeye kadar yapılandırıldığı için buradan başlayabilir veya başından başlayıp kendi hızında ilerleme yapabilirsin. Bu, 4 dersinin 1. dersidir.
“Kod Yapısı ve Adlandırma Kuralları” dersi ne kadar sürer?
Çoğu CoddyKit dersi yaklaşık 5–10 dakika sürer. Her biri kısa ve etkileşimli olduğu için sabit ilerleme yaparsın ve web ile uygulama arasında tam olarak bıraktığın yerden devam edebilirsin.
Bu DevOps Bootcamp dersinde kod yazıp çalıştırabilir miyim?
Evet. Her DevOps Bootcamp dersi yerleşik bir kod editörü içerir, bu sayede tarayıcıda gerçek kod yazıp çalıştırabilir ve anlık yapay zeka geri bildirimi alırsın — yerel kurulum gerekli değildir.
Bu kursun tüm dersleri
- Kod Yapısı ve Adlandırma Kuralları
- Git ile Sürüm Denetimi
- Ekip İş Birliği ve İş Akışları
- Belgelendirme ve Kendi Kendine Hizmet İş Akışları