İçeriğe geç
AggregaAggrega
Dil seçin: Türkçe
Bu sayfa makine çevirisiyle çevrilmiştir. İngilizce orijinalini okuyun.

Bildirilen hassasiyet, Terraform'un kendi `sensitive` özelliği olarak işlenir

Bir değerin gizli malzeme taşıdığı bildirimi, bir Component’in şemasında bir kez yazılır. İşleme hedefi kendine ait eşleşen bir temel öğe sunduğunda, bu bildirim ona işlenir. Bu örnek Terraform durumudur: derleme, bildirilen değerin aktığı modül girdisine sensitive = true ekleyen bir geçersiz kılma dosyası ekler ve motor ardından bu değeri, normalde görüntüleyeceği her yerde gizler.

Örnek bilerek küçük tutulmuştur ve her parçası incelenebilir: bir bileşen, üç modül girdisi ve bunlardan tam olarak birini adlandıran işlenmiş bir işaretleme.

Derlemenin ürettikleri

dist/infra/terraform/ altında, sınırın kök yapılandırması:

  • aggrega.modules.tf — store öğesini, source değeri ./modules/store olan ve argümanları modülün çözümlenmiş girdi değişkenleri olan, deterministik anahtar sırasındaki bir module bloğu olarak bildirir. Her terraform sınırı bir tane alır.

dist/infra/terraform/modules/store/ altında, store bileşeninin kendi dosyaları:

  • bayt bayt kopyalanan modül dosyaları — variables.tf ve main.tf, tam olarak modül yazarının yazdığı gibi;
  • aggrega_override.tf.json — aşağıda açıklanan hassasiyet işaretlemesi. Modülün kendi dosyalarının yanında durur, çünkü Terraform bir geçersiz kılmayı kendi dizinindeki yapılandırmayla birleştirir;
  • aggrega.provenance.tf — derlemeyi tanımlayan, # yorumlarından oluşan bir dosya (JSON dosyası yorum taşıyamaz, bu yüzden köken bilgisi kendi dosyasında yer alır).

İşaretleme ve adlandırmadığı iki girdi

example/storage/external-object-store üç values yaprağı bildirir. İkisi herkese açık tanımlayıcılar taşır; biri kimlik bilgisini taşır ve sensitive: true bildirir:

values:
bucket: { type: string, required: true }
access_key_id: { type: string, required: true }
secret_access_key: { type: string, required: true, sensitive: true }

module bloğu üç modül girdisinin tümünü bağlar:

module "store" {
source = "./modules/store"
access_key_id = "AKIAEXAMPLE0001"
bucket = "app-artifacts"
secret_access_key = "example-placeholder-not-a-real-credential"
}

eklenen geçersiz kılma ise tam olarak birini adlandırır:

{
"variable": {
"secret_access_key": {
"sensitive": true
}
}
}

Terraform, adı override olan ya da _override ile biten bir dosyayı aynı dizindeki yapılandırmayla birleştirir; bu nedenle bu dosya, özniteliği modülün mevcut secret_access_key bildirimine ekler ve türünü, açıklamasını ve varsayılan değerini modülün yazdığı gibi bırakır. Dışarıdan alınan her bayt yazıldığı gibi kalır.

Geçersiz kılmanın adlandırmadığı iki girdi, örneğin asıl amacıdır. İşaretleme bildirimi izler, başka hiçbir şeyi değil — ne bir değişkenin adını ne de değerinin biçimini. access_key_id kimlik bilgisi malzemesi değil, bir kimlik bilgisi tanımlayıcısıdır; bu nedenle, gizli bilginin yanında durmasına ve adı öyle görünmesine rağmen hassas olarak bildirilmez ve işaretlenmez. Tek yapraktan sensitive: true öğesini kaldırıp yeniden derleyin: geçersiz kılma dosyası hiç üretilmez.

Çalışırken görmek

main.tf, herkese açık koordinatları ve kimlik bilgisini tek bir kaynağın ayrı özniteliklerinde tutar; böylece bir plan iki yönü aynı anda gösterir. Sınırın kök yapılandırmasını planlayın — aggrega.modules.tf dosyasını içeren dizin; bu dağıtımın değerleri oradadır:

Terminal window
cd dist/infra/terraform
tofu init && tofu plan # or: terraform init && terraform plan
# module.store.terraform_data.reference will be created
+ resource "terraform_data" "reference" {
[… omitted: an id attribute, reported as known only after apply]
+ input = (sensitive value)
[… omitted: an output attribute, reported as known only after apply]
+ triggers_replace = [
+ "app-artifacts",
+ "AKIAEXAMPLE0001",
]
}

Sizin planınız, gösterilen satırların arasında bu iki özniteliği taşır. Bunlar eksik değil, dışarıda bırakıldı olarak işaretlenmiştir; bu nedenle açıklayamadığınız bir satır, bu sayfanın atladığı bir şey değil, gerçek bir farktır.

Kimlik bilgisi gizlenir; yanındaki iki herkese açık değer gizlenmez. aggrega_override.tf.json dosyasını silin ve kimlik bilgisinin tamamen yazdırıldığını görmek için planı yeniden çalıştırın — bu fark, işaretlemenin yaptığı şeyin tamamıdır. İşaretleme modülün kendi variable bloğunda yer alır; bu yüzden modülle birlikte taşınır ve o modül nerede kullanılırsa orada geçerli olur.

Kökte çalıştırın, modules/store/ içinde değil. Bir bileşenin girdileri, bir üst düzeyde yer alan module bloğunun argümanlarıdır; bu nedenle bileşenin kendi dizini, dağıtıldığı haliyle planlayabileceğiniz bir yapılandırma değildir. Motorun orada ne yapacağı modülün kendi variable bloklarına bağlıdır ve iki yanıttan yalnızca biri belirgindir:

  • Bu modül üç girdisinin tümünü default olmadan bildirir; bu yüzden modules/store/ içindeki bir plan başarısız olur — her girdi için bir kez No value for required variable (Gerekli değişken için değer yok), her biri kendi satırını belirtir ve -var / -var-file çözümünü önerir.
  • Girdilerinin tümü varsayılan değer taşıyan bir modül ise orada başarıyla planlanır; kök yapılandırmanın sağladığı değerlerden değil, bu varsayılanlardan. Hiçbir uyarı verilmez. Bilinmesi gereken durum budur, çünkü doğru görünen bir plan kimsenin istemediği bir yapılandırmayı tanımlamaktadır.

İşaretlemenin yapmadıkları

sensitive görüntülemeyi yönetir. Bir değerin plan ve apply çıktısında yazdırılmasını engeller ve Terraform’un bu değeri kendisi hassas olarak işaretlenmemiş bir çıktıya koymasını engeller. Değeri şifrelemez ve değerin nasıl saklandığını değiştirmez: bir apply sonrasında değer, state içinde açık metin olarak bulunur. İşaretleme ne derse desin, state’i kimlik bilgisini taşıyor olarak değerlendirin.

İşaretleme ayrıca işlenmiş bir girdiye yalnızca girdinin kimliği bir bildirimden geliyorsa ulaşır. Bu Recipe bir source: bildirir ve valuesMapping: bildirmez; bu yüzden argüman adları Component’in bildirdiği değer yaprağı yollarıdır ve eşleşme tamdır. valuesMapping: bildiren bir Recipe ise çıktı adlarını hiçbir bildirimin adlandırmadığı bir şablon içinde üretir; bu nedenle böyle bir Recipe aynı değerleri işaretleme olmadan işler — geçersiz kılma dosyası yaklaşık olarak üretilmez, hiç bulunmaz. Hiçbir bildirimin ulaşmadığı bir adı işaretlemek, herkese açık bir girdi hakkında doğru olmayan bir şey ileri sürer ve motorun kendi araçları hiç gizli olmamış bir değeri gizlerdi.

Kimlik bilgisinin burada neden bir modül girdisi olduğu

Yönetilen bir bulut veritabanı genellikle diğer durumdur: sağlayıcı ana parolayı kendisi üretir ve döndürür; bu yüzden modülün bir kimlik bilgisi girdisine ihtiyacı yoktur ve işaretlenecek bir şey yoktur. Bu bucket dağıtımın dışında işletilir; bu yüzden görev devredilecek böyle bir sağlayıcı yoktur — dağıtım bir erişim anahtarı tutar ve onu iletmek zorundadır. Bu modülün bir kimlik bilgisi değişkeni bildirmesinin ve standart kütüphanedeki yönetilen veritabanı modüllerinin bildirmemesinin nedeni budur.

Modül bu değişkeni Terraform’un sensitive özniteliği olmadan bildirir; örneği anlaşılır kılan da budur: okuyucunun işleme zamanında uygulandığını gördüğü öznitelik modülden değil, Component’in bildiriminden gelmiştir.

Dosyalar

  • aggregate.yaml — geliştirici niyeti: example/storage/external-object-store türünde tek bir store bileşeni; bucket doğrudan adlandırılmış ve erişim anahtarının her iki yarısı da türlendirilmiş parameters olarak açılmıştır.
  • release.yaml — bu ortam için o parametreleri karşılar ve operatörün endpoint değerini ayarlar. Buradaki değerler yer tutuculardır, herhangi bir gerçek hizmetin kimlik bilgileri değildir.
  • manifest.yaml — bileşen türünü, modülünü yerel olarak kaynaklayan Terraform Recipe’i terraform/external-object-store ile bağlar.
  • .aggrega-config.yaml — katalog varlıklarının çözümlendiği hub kayıt defterini adlandırır.

Kimlik bilgisinin her iki yarısı da yazılmış değerler değil parameters olarak tanımlanmıştır, çünkü bunlar bir operatörün sağladığı ve ortama göre değişen değerlerdir. Bir Release values: bildiremez; bu yüzden tam olarak bunun için yüzey türlendirilmiş bir parametredir: geliştirici değişim noktasını bildirir, Release onu karşılar.

Örneği oluşturun

Bu örneği aşağıdaki komutlarla derleyebilir ya da yapay zekâ asistanınıza sizin için derletebilirsiniz.

Örneği, adını taşıyan yeni bir klasöre yazın:

Terminal window
aggrega scaffold --example terraform-declared-sensitivity

Ardından sırada çalıştırılacak komutları yazdırır. İlki yeni klasöre geçer:

Terminal window
cd terraform-declared-sensitivity

Derleme

Terminal window
aggrega build --release release.yaml --auto-pull

--auto-pull, yeni bir klonda bulunmayan lockfile’ı derleme sırasında yazar.

Bir yapay zekâ asistanıyla

Aggrega araçlarıyla kurulmuş bir yapay zekâ asistanı da aynısını yapabilir: bu istemi ona yapıştırın.

Yalnızca Aggrega araçlarını kullanın ve kendiniz hiçbir klasör oluşturmayın. Çalışma alanı klasöründe henüz bir `terraform-declared-sensitivity` klasörü yoksa `scaffold` aracını `example` değeri `terraform-declared-sensitivity` olarak ayarlanmış ve `dir` olmadan bir kez çağırın: örneği yeni bir `terraform-declared-sensitivity` klasörüne yazar. Ardından `build` aracını `workspace_root` değeri `terraform-declared-sensitivity`, `release` değeri `release.yaml`, `auto_pull` değeri true ve `write` değeri true olacak şekilde çağırın. Derlemenin hangi dosyaları yazdığını bana söyleyin; bunlar `terraform-declared-sensitivity/dist/` altındadır.