Terraform kod yapısıyla ilgili sorular, toplulukta açık ara en sık sorulan sorulardır. Herkes bir noktada proje için en iyi kod yapısını da düşündü.

Terraform konfigürasyon yapısını nasıl kurmalıyım?

Bu, birçok çözümün bulunduğu ve genel bir tavsiye vermenin çok zor olduğu sorulardan biridir, o yüzden neyle uğraştığımızı anlamakla başlayalım.

• Projeniz ne kadar karışık?

  • Bağımlı olduğu kaynakların sayısı

  • Terraform sağlayıcılarının sayısı (Mantıksal ayraçlar hakkındaki not için aşağıya gözatınız)

• Altyapınız ne sıklıkla değişiyor?

  • Ayda/yılda/günde bir defadan

  • Sürekli değişen bir yapıya (Her committe güncellenen bir yapı)

• Kod değişikliği başlatıcıları? Yeni bir çıktı üretildiğinde CI aracınızın repoyu güncellemesine izin veriyor musunuz?

  • Altyapı reposunda sadece geliştiriciler kod değişikliği yapabilir.

  • Herkes, altyapı reposunda değişiklik için PR(Pull Request) açabilir (Buna CI aracı ve diğer botlar da dahil.)

• Hangi geliştirme platformunu veya dağıtım servisini kullanıyorsunuz?

  • AWS CodeDeploy, Kubernetes veya OpenShift için farklı farklı yaklaşımlar sergilemeniz gerekebilir.

• Hangi özelliğe göre gruplandırma yapıyorsunuz?

  • Ortam(environment), bölge(region), proje

Terraform konfigürasyonlarının yapılandırılmasına başlarken

Başlarken veya bir örnek kod yazarken tüm kodu main.tf'ye koymak iyi bir fikirdir. Diğer tüm durumlarda, aşağıdaki gibi mantıksal olarak bölünmüş birkaç dosyaya sahip olmak daha iyi olacaktır:

• main.tf - tüm kaynakları oluşturmak için modülleri, yerelleri ve veri kaynaklarını çağıran dosyadır.

• variables.tf - main.tf'de kullanılan değişkenlerin tanımlamalarını içerir.

• outputs.tf - main.tf'de oluşturulan kaynaklardan çıktıları içerir

• versions.tf - Terraform ve sağlayıcılar için sürüm gereksinimlerini içerir

terraform.tfvars kompozisyon dışında hiçbir yerde kullanılmamalıdır.

Terraform yapılandırma yapısı hakkında nasıl düşünülür?

Kod yapısı hakkında genel öneriler

• Daha az sayıda kaynakla çalışmak daha kolay ve hızlıdır

  • terraform plan ve terraform apply, kaynakların durumunu doğrulamak için bulut API istekleri yapar

  • Tüm altyapınız tek bir kompozisyondaysa bu biraz zaman alabilir.

• Patlama çapı (güvenlik ihlali durumunda) daha az kaynakla daha küçüktür

  • Birbiriyle ilgisi olmayan kaynakları ayrı bileşimlere yerleştirerek birbirinden yalıtmak, bir şeyler ters giderse oluşacak sorun riskini azaltır.

• Projenizdi endirekt durum kullanarak başlatın çünkü

  • Dizüstü bilgisayarınız, altyapınızın kaynaklarını barındırmak için için doğru bir yer değil.

  • Git'te bir tfstate dosyasını yönetmek kabustur.

  • Daha sonra altyapı katmanları birden çok yönde (bağımlılık veya kaynak sayısı) büyümeye başladığında, işleri kontrol altında tutmak daha kolay olacaktır.

• Tutarlı bir yapı ve adlandırma kuralı uygulayın:

  • Prosedürel kod gibi, Terraform kodu da insanların okuyabilmesi için yazılmalıdır, bundan altı ay sonra değişiklikler olduğunda tutarlılık yardımcı olacaktır.

  • Kaynakları Terraform durum dosyasında taşımak mümkündür ancak tutarsız yapı ve adlandırmalarınız varsa bunu yapmak daha zor olabilir.

• Kaynak modüllerini olabildiğince sade tutun.

• Değişken olarak iletilebilecek veya veri kaynakları kullanılarak keşfedilebilecek değerleri sabit kodlamayın.

• Veri kaynaklarını ve terraform_remote_state'i özellikle kompozisyon içindeki altyapı modülleri arasında bir tutkal olarak kullanın

Bu kitapta, örnek projeler karmaşıklığa göre gruplandırılmıştır - küçük ölçekli yapılardan en büyüğene. Bu ayrım kesin çizgilerle ayrılmamıştır, bu nedenle diğer yapılara da göz gezdirmeniz iyi olacaktır.

Altyapı modüllerinin ve kompozisyonlarının yönetimi

Küçük bir altyapıya sahip olmak, az sayıda bağımlılık ve az kaynak olduğu anlamına gelir. Proje büyüdükçe, Terraform konfigürasyonlarının büyümesi ve bağımlılıklarının artmasıyla, farklı altyapı modülleri birbirine bağlama ve bir kompozisyon içindeki değerleri geçirme ihtiyacı ortaya çıkması kaçınılmazdır.

Geliştiricilerin kullandığı en az 5 farklı düzenleme çözümünden söz edebiliriz:

1. Terraform. Çok basit, geliştiricilerin işi halletmek için yalnızca Terraform'u bilmesi gerekiyor.

2. Terragrunt. Tüm altyapıyı düzenlemek ve bağımlılıkları işlemek için kullanılabilen saf düzenleme aracı. Terragrunt, altyapı modülleri ve kompozisyonları ile kendi makinenizde çalışır, böylece kod tekrarını azaltır.

3. Şirket içi scriptler. Genellikle bu, düzenlemeye yönelik bir başlangıç noktası olarak ve Terragrunt'ı keşfetmeden önce olur.

4. Ansible veya benzeri genel amaçlı otomasyon aracı. Genellikle Ansible'dan sonra Terraform benimsendiğinde veya Ansible UI aktif olarak kullanıldığında kullanılır.

5. Crossplane ve Kubernetes'ten ilham alan diğer çözümler. Bazen, Terraform konfigürasyonlarınızın istenen durumunu elde etmek için Kubernetes ekosistemini kullanmak ve bir mutabakat döngüsü özelliği kullanmak mantıklıdır. Daha fazla bilgi için Crossplane vs Terraform videosunu izleyin.

Bunları akılda tutarak, bu kitap bu proje yapılarının ilk ikisini, sadece Terraform ve Terragrunt hakkında bilgi içermektedir.

Bir sonraki bölümde Terraform veya Terragrunt için kod yapısı örneklerine gözatabilirsiniz.

Kaynak: https://github.com/antonbabenko/terraform-best-practices/tree/master/examples/medium-terraform

Bu örnek, aşağıdakileri kullanan orta ölçekli bir altyapı için Terraform konfigürasyonlarının yapılandırılmasına örnek kodları içerir:

• 2 AWS hesabı

• 2 ayrı ortam (tamamen birbirlerinden izole prod ve stage). Her ortam ayrı bir AWS hesabında yaşar

• Her ortam, Terraform Registry kaynaklı hazır altyapı modülünün (alb) farklı bir sürümünü kullanır.

• Her ortam, dahili modüllerin aynı versiyonu kullanır.

Çoğu DevOps aracı gibi Terraform için de oldukça yeni bir proje diyebiliriz. (2014'de kullanıma açıldı.)

Terraform yetenekli, güçlü ve altyapıyı kod ile kontrol etmenize olanak sağlayan en fazla kullanılan araçlardan biridir. Tamamiyle geliştirici dostu, çok fazla operasyonu yapmaya olanak sağladığı gibi yapılan operasyonlarda entegrasyonu sağlayabilmek için kısıtlayıcı şekilde sadece tek bir yol sunmaz. Oldukça esnek bir araçtır.

Bu kitaptaki bazı bilgiler Terraform'un en iyi uygulama metodları gibi görünmeyebilir. Bunu biliyorum ve kullanıcıların neyin en iyi uygulamalar, neyin konu hakkında başka bir bakış açısı olduğunu ayırt etmesi için bazı yerlerde küçük ipuçları, simgeler ve bağlamlar kullandım.

Bu kitap 2018'de bir Madrid yazında yazılmaya başlandı ve https://www.terraform-best-practices.com/ adresinden ulaşabilirsiniz.

Sözün özü, bu kitap Terraform kullanıcıları için en iyi uygulama metodlarını ve önerileri içermektedir ve içermelidir.

Sponsors

Please contact me if you want to become a sponsor.

Translations

Bu kitabın başka dillere çevirisi için yardım etmek istiyorsanız benle iletişime geçebilirsiniz.

Katkıda Bulunma

Belirli bir konu hakkında ilgileniyorsanız, işini açabilirsiniz veya açık işi işaretleyerek ön plana çıkarabilirsiniz.

Bir konu hakkında yazacak şeyleriniz olduğunu hissediyorsanız ve bunları paylaşmak istiyorsanız, bir taslak hazırlayıp 'Pull Request' açabilirsiniz. (Bu noktada mükemmel bir şekilde yazmayabilirsiniz!)

Authors

Bu kitap Anton Babenko tarafından katkı sağlayanlar ve çevirmenlerin yardımıyla düzenlenmektedir.

Lisans

Bu çalışma Apache 2 Lisans'ı ile lisanslanmıştır. Lisans'ın tüm detaylarını okuyabilirsiniz.

Bu içeriğin yazarları ve katkıda bulunanlar, burada bulunan bilgilerin geçerliliğini garanti edemez. Lütfen burada verilen bilgilerin ücretsiz olarak verildiğini anladığınızdan ve proje ile ilişkili herhangi bir kişi arasında hiçbir tür anlaşma veya sözleşme oluşturulmamış olduğundan emin olabilirsiniz. Yazarlar ve katkıda bulunanlar, bu içerikte yer alan, içerikle ilişkili veya bu içerikten bağlantı verilen bilgilerdeki hata veya eksikliklerden kaynaklanan herhangi bir kayıp, hasar veya kesinti için, bu tür hatalar veya eksikliklerden kaynaklanıp kaynaklanmadığına bakılmaksızın, herhangi bir tarafa herhangi bir sorumluluk kabul etmez ve burada sorumluluk kabul etmez.

Tüm hakları saklıdır © 2018-2023 Anton Babenko.

Terraform Kod Yapıları

Terragrunt kod yapıları

Belgeleme

Otomatik oluşturulan dökümantasyon

çoklu dil destekli pre-commit hooklarını kontrol etmeyi sağlayan bir frameworktur. Python ile yazılmıştır ve kod bir git reposuna işlenmeden önce geliştiricinin makinesinde otomatik olarak bir şeyler yapmak için güçlü bir araçtır. Normalde, linterleri çalıştırmak ve kodu biçimlendirmek için kullanılır ( gözatabilirsiniz).

Terraform konfigürasyonları ile pre-commit, kodu formatlamak, doğrulamak ve belgeleri güncellemek için kullanılabilir.

Kendinizi daha iyi tanımak için reposuna ve bunun zaten kullanıldığı mevcut repolara (örneğin, ) gözatabilirsiniz.

terraform-docs

, Terraform modüllerinden çeşitli çıktı formatlarında dokümantasyon üreten bir araçtır. Belgeleri otomatik olarak güncellemek için manuel olarak çalıştırabilir ( olmadan) veya pre-commit-terraform hooklarını kullanabilirsiniz.

Kaynaklar

3. Blog post by :

Resmi Terraform tüm bakış açılarını ve konfigürasyonları detaylı bir şekilde bulabilirsiniz. Bölümün geri kalanını anlamak için belirtilen dökümanı okumanız yararlı olacaktır.

Bu bölüm kitap içerisinde yer alan anahtar kavramların açıklamalarını içermektedir.

Kaynak (Resource)

aws_vpc, aws_db_instance kaynak örneği olarak verilebilir. Her bir kaynak bir sağlayıcıya(provider) aittir, argüman kabul eder, özelliklerini çıktı olarak oluşturur ve birer yaşam döngüsü vardır. Kaynaklar oluşturulabilir(create), geri alınabilir(retrieve), güncellenebilir(update) veya silinebilir(delete).

Kaynak Modülü (Resource module)

Kaynak modülü, birlikte ortak eylemi gerçekleştiren bağlı kaynakların topluluğudur (Örnepin, , VPN, sunet, NAT gateway gibi kaynaklar oluşturur). Bu durum kaynak modülünün içinde veya daha üst seviye bir yapıda (Altyapı Modülü) tanımlanan sağlayıcıdan sağlayıcıya göre değişiklik gösterebilir.

Altyapı Modülü (Infrastructure module)

Kaynak moullerinin bir araya gelmesiyle altyapı modülü oluşur. Bunlar mantıksal olarak birbiriyle bağlantılı olmayabilir ama var olan projede veya kurulumda aynı amaca hizmet eder.Altyapı modülünde sağlayıcı(provider) için gerekli konfigürasyonlar belirlenir. Bu konfigürasyonlar kaynak modülüne ve kaynaklara geçecektir. Altyapı modülü genellikle her mantıksal ayraç (AWS Region, Google Project) için bir özellikle limitlenmektedir.

Örneğin, modülü üzerinde çalışan altyapısını yönetmek için ve gibi çeşitli kaynak modüllerine ihtiyaç duyar.

Bir başka örnek ise modülü ve ün birtakım modülleri Docker kaynaklarının derlenmesi(build), ortak bir alana gönderilmesi (push) ve Docker imagelarının deploy edilmesi için kullanılır. Hepsi bir arada.

Kompozisyon (Composition)

Kompozisyon çeşitli mantıksal olarak birbirlerinden ayrılan(AWS Regions, AWS Accounts) altyapı modüllerinin bir araya gelmesinden oluşur. Genellikle Kompozisyonlar bir organizasyondaki veya projedeki tüm altyapıyı tanımlamak için kullanılır.

Bir kompozisyon altyapı modüllerinden oluşur ki altyapı modülü de çeşitli kaynak modülleri ve kişisel olarak oluşturulan kaynaklardan oluşur.

Veri Kaynağı (Data source)

Veri kaynakları sadece okuma (read-only) modunda hizmet vermektedir ve sağlayıcının konfigürasyonlarına bağımlıdır. Veri kaynakları bir kaynak modülü veya altyapı modülü içerisinde kullanılabilir.

Veri kaynağı terraform_remote_state üst seviye modülleri ve kompozisyonları bir arada tutmak için tutkal vazifesi görür.

Endirekt Durum (Remote state)

Sağlayıcı, Hükümcü vb.(Provider, provisioner, etc)

Sağlayıcı, hükümcü ve diğer birtakım terimler resmi dökümantasyonda çok güzel açıklanmış durumda ve bunları papağan gibi tekrarlamanın alemi yok. Bana göre bunları bilmenin iyi terraform modülleri yazmakla da çok alakası yok.

Neden bu kadar zor?

Moleküller arası (kaynak modülleri ve altyapı modülleri) verilere erişim, modüllerin çıktıları ve veri kaynakları kullanılarak gerçekleştirilir.

Yukarıda açıklanan kavramlar kabaca aşağıdaki şekilde görülebilir.

Farkında olmam ve kullanmayı düşünmem gereken araçlar nelerdir?

• - Yönetim aracı

• - Statik kod analiz aracı

• - Versiyon yönetimi

• - Pull Request otomasyonu

• - pre-commit'lerde kullanılabilecek git hooklarının birleşimi olan bir framework.

• - Pull requestlerde Terraform için bulut maliyet tahminleri. Terragrunt, Atlantis ve pre-commit-terraform ile de çalışır.

Modüllerle bağımlılık cehennemine (dependency hell) çözümler nelerdir?

Kaynak ve altyapı modüllerinin sürümleri belirtilmelidir. Sağlayıcılar, modüllerin dışında, ancak yalnızca bileşimde yapılandırılmalıdır. Sağlayıcıların sürümü ve Terraform da kilitlenebilir.

Ana bağımlılık yönetimi aracı yoktur, ancak bağımlılık belirtimlerini daha az sorunlu hale getirmek için bazı ipuçları vardır. Örneğin, , bağımlılık güncellemelerini otomatikleştirmek için kullanılabilir. Dependabot, bağımlılıklarınızı güvenli ve güncel tutmak için çekme istekleri oluşturur. Dependabot, Terraform konfigürasyonlarını destekler.

Kaynaklar arasındaki açık bağımlılıkları belirtmek için locals kullanın

Terraform konfigürasyonlarında doğrudan bağımlılık olmasa bile bazı kaynakların daha önce silinmesi gerektiğine dair Terraform'a bir ipucu vermenin yararlı yolu.

Terraform 0.12 - Zorunlu Zorunlu(Requiered) vs. Opsiyonel(Optional) Argümanlar

1. var.website boş bir map değilse, zorunlu argüman index_document ayarlanmalıdır.

2. İsteğe bağlı argüman error_document göz ardı edilebilir

Kaynak:

Bu örnek, büyük boyutlu bir altyapı için Terraform konfigürasyonları yapılandırılmasına yönelik örnek kodları içerir.

• 2 AWS hesabı

• 2 bölge

• 2 ayrı ortam (tamamen birbirlerinden izole prod ve stage). Her ortam ayrı bir AWS hesabında bulunur ve kaynakları 2 bölge arasında dağıtır

• Her ortam, Terraform Registry kaynaklı hazır altyapı modülünün (alb) farklı bir sürümünü kullanır.

• Her ortam, dahili modüllerin aynı versiyonu kullanır.

https://twitter.com/antonbabenko/lists/terraform-experts - Terraform'u aktif olarak kullanan insanların bulunduğu bir liste.

https://github.com/shuaibiyy/awesome-terraform - HashiCorp'un Terraform'ındaki kaynakların derlenmiş listesi.

http://bit.ly/terraform-youtube - Anton Babenko'nun "Your Weekly Dose of Terraform" YouTube kanalı. İncelemeler, röportajlar, Soru-Cevap, canlı kodlama ve bazı Terraform korsanlığı içeren canlı yayınlar.

https://weekly.tf - Terraform Haftalık haber bülteni. Anton Babenko tarafından Terraform dünyasından çeşitli haberler (projeler, duyurular, tartışmalar).

Genel Kurallar

1. Her yerde - (tire) yerine _ (alt çizgi) kullanın (kaynak adlarında, veri kaynağı adlarında, değişken adlarında, çıktılarda vb.).

2. Küçük harf ve rakam kullanmayı tercih edin (UTF-8 desteklense de).

Kaynak ve veri kaynağı parametreleri

1. Kaynak adında kaynak türünü tekrar etmeyin (kısmen veya tamamen değil):

`resource "aws_route_table" "public" {}`

`resource "aws_route_table" "public_route_table" {}`

`resource "aws_route_table" "public_aws_route_table" {}`

1. Daha fazla açıklayıcı ve genel ad yoksa veya kaynak modülü bu türde tek bir kaynak oluşturuyorsa (örneğin, AWS VPC modülünde aws_nat_gateway türünde tek bir kaynak varsa ve typeaws_route_table türünde birden çok kaynak varsa) kaynak adı bu şekilde adlandırılmalıdır: aws_nat_gateway bu şekilde adlandırılmalı ve aws_route_table daha açıklayıcı adlara sahip olmalıdır - private, public, database gibi).

2. Mutlaka tekli isimler kullanın.

3. - Çizgiyi parametre değerlerinin girildiği değişkenlerde kullanabilirsiniz.

4. 'count' veya 'for_each' kullanan bir parametre veya veri kaynağı bloğu ilk parametre olmalıdır ve yeni bir satırla ayrılarak en üstte konumlanmalıdır.

5. Mümkün olduğunca son parametrede depends_on, lifecycle gibi etiketleri(tags) kullanmaya çalışın.

6. 'count' veya 'for_each' kullanırken mümkün olduğunca boolean değerleri tercih edin. Length veya başka karşılaştırmaları ikinci plana atmanız iyi olacaktır.

'Kaynak(Resource)' kod örneği

count/for_each kullanımı

resource "aws_route_table" "public" {
  count = 2

  vpc_id = "vpc-12345678"
  # ... remaining arguments omitted
}

resource "aws_route_table" "private" {
  for_each = toset(["one", "two"])

  vpc_id = "vpc-12345678"
  # ... remaining arguments omitted
}

resource "aws_route_table" "public" {
  vpc_id = "vpc-12345678"
  count  = 2

  # ... remaining arguments omitted
}

Etiketlerin Kullanımı (tags)

resource "aws_nat_gateway" "this" {
  count = 2

  allocation_id = "..."
  subnet_id     = "..."

  tags = {
    Name = "..."
  }

  depends_on = [aws_internet_gateway.this]

  lifecycle {
    create_before_destroy = true
  }
}   

resource "aws_nat_gateway" "this" {
  count = 2

  tags = "..."

  depends_on = [aws_internet_gateway.this]

  lifecycle {
    create_before_destroy = true
  }

  allocation_id = "..."
  subnet_id     = "..."
}

count içerisindeki karşılaştırmalar

resource "aws_nat_gateway" "that" {    # Best
  count = var.create_public_subnets ? 1 : 0
}

resource "aws_nat_gateway" "this" {    # Good
  count = length(var.public_subnets) > 0 ? 1 : 0
}

Değişkenler

1. Kaynak modüllerinde tekerleği yeniden icat etmeyin: birlikte çalıştığınız kaynak için "Argüman Referansı" bölümünde tanımlandığı gibi değişkenler için ad, açıklama ve varsayılan değeri kullanın.

2. Değişkenlerde doğrulama desteği oldukça sınırlıdır (örneğin, diğer değişkenlere erişemez veya arama yapamaz). Buna göre plan yapın çünkü çoğu durumda bu özellik işe yaramaz.

3. Tür list(...) veya map(...) olduğunda, değişken adında çoğul formu kullanın.

4. 'Key'leri aşağıdaki sırada olacak şekilde bir değişken bloğunda muhafaza ediniz. Tanım(Description), tip(type), default(Fabrika Ayarı), doğrulama(validation)

5. Açık olduğunu düşünseniz bile her zaman tüm değişkenlere açıklama ekleyin (gelecekte buna ihtiyacınız olacak).

6. Her bir anahtar üzerinde katı kısıtlamalarınız olması gerekmedikçe, object() gibi belirli türler yerine basit türleri (number, string, list(...), map(...), herhangi biri) kullanmayı tercih edin.

7. map'in tüm öğeleri aynı türe sahipse (ör. string) veya buna dönüştürülebiliyorsa (ör. number türü stringe dönüştürülebilirse) map(map(string)) gibi belirli türleri kullanın.

8. Belirli bir derinlikten başlayarak veya birden çok türün desteklenmesi gerektiğinde tür doğrulamasını devre dışı bırakmak için 'any' kullanın.

9. {} değeri bazen bir map, bazen de bir objedir. Map'e çevirmek için tomap(...) kullanın çünkü bir obje yapmanın yolu yoktur.

Çıktılar

Çıktıları kapsamı dışında tutarlı ve anlaşılır hale getirin (bir kullanıcı bir modül kullanırken, döndürdüğü değerin türünü ve niteliğini açıkça belirtmelidir).

1. Çıktının adı, içerdiği özelliği tanımlamalı ve normalde istediğinizden daha az serbest biçimli olmalıdır.

2. Çıktı adı için iyi bir yapı {name}_{type}_{attribute}gibi görünür, burada:

   1. {name} bir kaynak veya veri kaynağı olabilir. Tabiki sağlayıcı prefixi olmadan. aws_subnet için {name} 'subnet'dir, foraws_vpc 'vpc'dir.

   2. {type} ise kaynağın tipini belirtmektedir.