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

Eklentiler içeren CloudFormation yığını

Yönetilen bir veritabanı ve onu okuyan uygulama; bir kez geliştirici niyeti olarak yazılır ve AWS CloudFormation yığın şablonlarına derlenir. İki ek kendi kaynaklarını getirir — veritabanı üzerinde bir alarm ve sınır üzerinde bir paylaşılan ayarlar parametresi — bu nedenle bu örnek, bir ekin kaynaklarının derlenen yığında nereye yerleştiğini ve bileşenin kaynaklarıyla birlikte nasıl adlandırıldığını gösterir.

Aynı geliştirici niyeti üç şekilde derlenir: tek bir yığın olarak, aralarında bir başvurunun geçtiği iki yığın olarak ve — bilerek — durdurulan bir derleme olarak.

Bu sayfadaki çıktı blokları, Bu sayfalardaki çıktıyı okumak uyarınca gerçek bir çalıştırmadan kopyalanmıştır.

Dosyalar

  • aggregate.yaml — geliştirici niyeti: core/datastore/mariadb türünde bir payments-db veritabanı ve veritabanını kullandığını bildiren example/compute/db-reader türünde bir reporting-app. Burada AWS’ye dair hiçbir şey yer almaz. Veritabanının features: bloğu, example/storage-alarm’ı ekleyen storage-headroom’u taşır.
  • release-one-stack.yaml — her iki bileşen tek bir sınır içindedir, bu nedenle ikisi de tek bir yığında birleştirilir. Sınır genelinde core/shared-config’i ekler.
  • release-two-stacks.yaml — aynı niyet iki sınıra bölünmüştür, bu nedenle uygulamanın veritabanına yaptığı başvuru bir yığın sınırını aşar.
  • aggregate-name-collision.yaml ile birlikte release-negative-name-collision.yaml — başarısız olması beklenir. Alarmı tek bir bileşene iki kez ekler.
  • manifest.yaml — her bileşen türünü ve eklenen her Feature’ı, onu bu hedefte uygulayan Recipe’ye bağlar.
  • .aggrega-config.yaml — katalog varlıklarının çözümlendiği hub kayıt defterini adlandırır.

Her sürüm, veritabanının root_password yuvasını payments-db girdisinde core/generated-secret ile bağlar. Bu hedefte yönetici parolasının sahibi RDS’dir ve Manifest’in seçtiği veritabanı Recipe’si bunu belirten yönergeyi taşır; bu da bağlamayı Release’te yazılan bir operatör kararı yapar ve Aggregate bu konuda hiçbir şey söylemez.

Her sürüm ayrıca core/backup’ı infra.retention_days: 14 ile payments-db’ye ekler ve Manifest onu cloudformation/backup-native’e bağlar. RDS, aksi belirtilmedikçe örneğin otomatik yedeklerini 7 gün saklar; bu ek her birini 14 gün saklar. FeatureRecipe hiçbir şey işlemez: yedekleme örneğin bir ayarıdır; bu nedenle veritabanı Recipe’i eki okur ve "BackupRetentionPeriod": 14 değerini örneğin kendi Properties alanına yazar.

Bu örneğin kullandığı varlıkların tümü yayımlanmış katalogda bulunur. Sürüm dosyalarının yanına hiçbir şey kopyalanmaz; böylece örnek, kataloğun özel bir anlık görüntüsüne göre değil, kataloğun mevcut hâline göre çözümlenir.

Ö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 cloudformation-rds-stack

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

Terminal window
cd cloudformation-rds-stack

Derleme

Bu örnek üç release içerir; bu nedenle istediğinizin adını verin. Her çalıştırmada bir release derlenir. Her release’in ilk derlemesi, pull’un yazdığı kilit dosyasına ihtiyaç duyar:

Terminal window
aggrega pull --release release-one-stack.yaml
aggrega build --release release-one-stack.yaml

Derleme, <workspace> bu örneğin klasörünü temsil edecek şekilde şunu yazdırır:

Total build time: 4.1s
Build completed: 1 file written to <workspace>/dist

Birleştirilen yığın dist/one-stack/cloudformation/cloudformation-stack.json konumuna yazılır. Bu dizine render edilen her bileşen ve her ekleme, o tek şablona katkıda bulunur — provider, katkıda bulunan her biri için ayrı bir dosya yerine tek bir saf JSON yığını üretir.

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 `cloudformation-rds-stack` klasörü yoksa `scaffold` aracını, `example` değeri `cloudformation-rds-stack` olarak ayarlanmış ve `dir` verilmeden bir kez çağırın: araç örneği yeni bir `cloudformation-rds-stack` klasörüne yazar. Ardından `build` aracını `workspace_root` değeri `cloudformation-rds-stack`, `release` değeri `release-one-stack.yaml`, `auto_pull` değeri true ve `write` değeri true olarak ayarlanmış şekilde çağırın. Derlemenin hangi dosyaları yazdığını bana söyleyin; bunlar `cloudformation-rds-stack/dist/` altındadır.

Ne oluşur ve kim katkıda bulundu

Tek yığınlı derleme, dört farklı katkıcıdan dört kaynak bir araya getirir:

KaynakKatkıda bulunan
PaymentsDbveritabanı bileşeninin kendi Recipe’i
PaymentsDbStorageHeadroomo bileşen üzerindeki storage-headroom eki
AppSharedConfigsınır üzerindeki shared-settings eki
ReportingAppuygulama bileşeninin kendi Recipe’i

payments-db üzerindeki backup eki tabloda yer almaz, çünkü kendine ait bir kaynak katkısı yoktur: ayarladığı şey PaymentsDb’nin içine yerleşir.

Her kaynak, geldiği katkıcıyı adlandıran bir köken bloğu taşır; böylece iki yarım, ikisinin de katkıda bulunduğu bir yığın içinde ayırt edilebilir kalır:

"PaymentsDbStorageHeadroom": {
"Metadata": {
"aggrega.ai/provenance": {
"aggrega.ai/aggregate-name": "aggregate",
"aggrega.ai/boundary-path": "app",
[… omitted: a compiler-version entry, which moves with the build]
"aggrega.ai/component-id": "cfr--payments-db--storage-headroom",
"aggrega.ai/environment": "production",
"aggrega.ai/provider": "cloudformation",
[… omitted: a provider-version entry, which moves with the build]
"aggrega.ai/recipe-uri": "storage-alarm:1.0.0"
}
},
[… omitted: the alarm's Properties, printed in full just below]
"Type": "AWS::CloudWatch::Alarm"
},

Bu blokta derlemeler arasında değişen tek satırlar iki sürüm girdisidir; bu yüzden dışarıda bırakılmışlardır. Üçüncü çıkarılan kısım yalnızca alarmın Properties alanıdır ve aşağıda ayrıca gösterilmiştir. Gösterilen her şey, kendi derlemenizin yazdığı şeydir.

Alarm, veritabanının değil ekin kaynağıdır. storage-headroom ekini Aggregate’ten ayırmak tam olarak o kaynağı ve yayımladığı tek çıktıyı kaldırır, PaymentsDb ise bayt bayt olduğu gibi kalır.

Bir ekin kaynak adı, eki taşıyan kapsamı taşır

Bir Feature bir kez yazılır ve birçok kez eklenir; bu nedenle bir FeatureRecipe’in türettiği ad her ek için ayrı olmalıdır. Bu Recipe, ana bileşeni ve ek adını birleştirir: storage-headroom altında taşınan payments-db ana bileşeni PaymentsDbStorageHeadroom adını verir.

Yalnızca ana bileşeni birleştirmek, alarmı izlediği kaynaktan ayrı tutmaya yeterdi; ancak aynı Feature’ın tek bir bileşene iki kez eklenip kendisiyle çakışmasını önlemeye yetmezdi — aşağıdaki başarısız release de tam olarak bununla ilgilidir.

Alarmın kendi özellikleri, ana bileşene onun türetilmiş adıyla başvurur:

"Properties": {
"AlarmDescription": "Free storage below 21474836480 bytes on payments-db",
"ComparisonOperator": "LessThanThreshold",
"Dimensions": [
{
"Name": "DBInstanceIdentifier",
"Value": {
"Ref": "PaymentsDb"
}
}
],
"EvaluationPeriods": 2,
"MetricName": "FreeStorageSpace",
"Namespace": "AWS/RDS",
"Period": 300,
"Statistic": "Minimum",
"Threshold": 21474836480,
"TreatMissingData": "breaching"
},

Veritabanı kaynağı üzerindeki Ref, yığın dağıtıldığında o örneğin tanımlayıcısına çözümlenir. İki yarım da PaymentsDb adını aynı bileşen adından türetir; onları uyumlu kılan budur — burada hiçbir şey aranmaz.

Tek bir ekte neye kim karar verir

Ek, girdilerini bir bileşenin yaptığı gibi böler. Uygulamanın ne kadar boş alana ihtiyaç duyduğu geliştiricinin niyetidir; aggregate.yaml içinde ek üzerinde yazılır — bu, uygulamanın bir özelliğidir. Alarmın nereye bildirim göndereceği ve bir düşüşün alarm tetiklenmeden önce ne kadar sürmesi gerektiği ise operatörün boyutlandırmasıdır ve Release’ten sağlanır:

payments-db:
features:
storage-headroom:
infra:
evaluation_periods: 3
notify_target: "arn:aws:sns:eu-west-1:123456789012:payments-oncall"

Bir Release, Aggregate’in bildirdiği bir ek için infra sağlar, asla values sağlamaz. İki yığınlı release ikisini de ayarlar; tek yığınlı release hiçbirini ayarlamaz ve fark çıktıda okunabilir. Ayarlandığında:

"Properties": {
"AlarmActions": [
"arn:aws:sns:eu-west-1:123456789012:payments-oncall"
],

Ayarlanmadığında alan boş değil yoktur — alarm hiçbir bildirim eylemi olmadan üretilir ve EvaluationPeriods, Feature’ın bildirdiği herhangi bir şeye değil Recipe’in taşıdığı 2 değerine düşer. Hiçbirini sağlamayan bir Release yine de çalışan bir alarm elde eder ve birini sağlamak tam olarak bir alan ekler.

Bir ekin çıktıları kendisi tarafından değil, ana bileşeni tarafından adlandırılır

Yığının iki yarımı farklı kurallarla adlandırılır ve insanları şaşırtan yarım budur.

Bir kaynağın mantıksal kimliği, ekin kendi Recipe’inden gelir — yukarıdaki ad. Bir çıktı, yayımlayan bileşen ile girdi birlikte adlandırılır ve bir ek için yayımlayan bileşen ana bileşendir. Alarm tek bir girdi, alarm-id, yayımlar ve bu şu şekilde ortaya çıkar:

"paymentsXzhdbXXalarmXzhid": {
"Value": {
"Ref": "PaymentsDbStorageHeadroom"
}
},

Kuralı bildiğinizde iki yarım okunabilir hâle gelir: mantıksal kimlik yalnızca harf ve rakam kabul eder, bu yüzden provider bu alfabenin reddettiği şeyi atmak yerine açıkça yazar — Xzh sizin yazdığınız tiredir, XX ise bileşen adının bitip girdi adının başladığı yerdir. Bu ada yalnızca alarm-id yayımlayan payments-db ulaşır, başka hiçbir şey ulaşmaz. Birleştirilmiş yığındaki adlar şemayı eksiksiz açıklar.

Bu, veritabanının kendisi alarm-id yayımlamış olsaydı ulaşacağı çıktı adının aynısıdır. Dolayısıyla ana bileşenin de yayımladığı bir girdi adı, ekinkiyle tek bir çıktı adında buluşurdu — ekin kendine ait gibi okunan girdi adlarının onları ana bileşeninkilerden ayrı tutmasının nedeni budur.

Sınır genelindeki bir ek, sınır için bir kez oluşturulur

core/shared-config, Release’te bir bileşen yerine sınır üzerinde eklenir ve o sınır için bir kez oluşturulur — içindeki her bileşen için bir kez değil. Tek yığınlı derleme iki bileşen ve tam olarak bir AppSharedConfig barındırır:

"AppSharedConfig": {
[… omitted: the provenance Metadata, whose shape is shown above]
"Properties": {
"Description": "Settings shared by every component in the app boundary",
"Name": "/app/shared-config",
"Type": "String",
"Value": "tier=production"
},
"Type": "AWS::SSM::Parameter"
},

İki yığınlı release’i derlediğinizde durum daha belirgin olur: her sınır, o sınırın kendi çözümlenmiş ayarlarını taşıyan kendi ekini alır. O derlemenin yazdığı iki şablonun her birindekinin Properties alanı:

"Properties": {
"Description": "Settings shared by every component in the data boundary",
"Name": "/data/shared-config",
"Type": "String",
"Value": "tier=production-data"
},
"Properties": {
"Description": "Settings shared by every component in the app boundary",
"Name": "/app/shared-config",
"Type": "String",
"Value": "tier=production-app"
},

Release’te eklenir, çünkü taşıdığı şey Aggregate’in bildirdiği herhangi bir şey değil, operatörün kendi düzenlemesidir. Bir sınır eki infra: ayarlar, asla values: ayarlamaz — geliştirici değerlerinin yazıldığı yer Aggregate olarak kalır.

Aynı amacı iki yığına bölmek

Terminal window
aggrega pull --release release-two-stacks.yaml
aggrega build --release release-two-stacks.yaml

aggregate.yaml içinde hiçbir şey değişmez. Uygulama hâlâ veritabanını kullandığını bildirir; ikisinin ayrı ayrı sağlanacağına operatör Release’te karar verir ve bunun sonucunda aralarındaki başvuru bir yığın sınırını aşar.

Tek yığınlı derlemede uygulama, uç noktayı tek şablonun içinde bir başvuru olarak alır:

"Properties": {
"Name": "/reporting/db-host",
"Tier": "Standard",
"Type": "String",
"Value": {
"Fn::GetAtt": [
"PaymentsDb",
"Endpoint.Address"
]
}
},

İki yığınlı derlemede üretici yığın bu değeri bir dışa aktarım olarak yayımlar:

"paymentsXzhdbXXhost": {
"Value": {
"Fn::GetAtt": [
"PaymentsDb",
"Endpoint.Address"
]
},
"Export": {
"Name": "aggrega--cloudformation-two-stacks--two-stacks-data-zscloudformation--payments-db--host"
}
},

ve tüketici yığın onu aynı adla geri okur:

"Properties": {
"Name": "/reporting/db-host",
"Tier": "Standard",
"Type": "String",
"Value": {"Fn::ImportValue":"aggrega--cloudformation-two-stacks--two-stacks-data-zscloudformation--payments-db--host"}
},

Yalnızca host bir Export taşır, çünkü bir kenarın gerçekte tükettiği giriş odur; veritabanının yayımladığı diğer girişler düz çıktılar olarak ortaya çıkar. Bileşen kapsamlı alarm, ana bileşenini izleyerek üretici yığına geçer ve her sınır kendi sınır genelindeki eklentisini korur.

İçsel işlevlerin hiçbiri derleme zamanında değerlendirilmez. Uç nokta, yığın dağıtılana kadar var olmaz; bu yüzden derleyici başvuruyu olduğu gibi aktarır ve onu CloudFormation çözümler — uygulamanın hiçbir zaman bir adres belirtmemesinin nedeni budur.

Dışa aktarım adının nasıl oluşturulduğu ve tüketicinin doğrudan hesaplar arası okuma yerine ne zaman Fn::ImportValue üzerinden okuduğu için bkz. Yığınlar arası bağlantı.

Duran derleme

Terminal window
aggrega pull --release release-negative-name-collision.yaml
aggrega build --release release-negative-name-collision.yaml

aggregate-name-collision.yaml, alarmı tek bir bileşene iki ek adı altında iki kez ekler. Her ekin kaynak adı kendi ek adını içerir; bu nedenle iki alarm iki ayrı kaynaktır ve orada çakışmaz. Çıktıları ise çakışır: her biri alarm-id yayımlar, bir çıktı ana bileşenin ve girdinin adıyla adlandırılır ve ana bileşen her ikisi için de aynıdır.

[… omitted: the pull's lines, which report the same collision while writing the lockfile]
[TRANSLATION_ERROR E0038]
dispatch groups whose contributors derive one name more than once in one key space
caused by (2):
[TRANSLATION_ERROR] release-negative-name-collision.yaml
derived name collision: one name is derived more than once in one key space ("paymentsXzhdbXXalarmXzhid", key space "output-logical-ids", derived by component "payments-db", carrying attachment "storage-headroom", provider "cloudformation", dispatch path "name-collision/cloudformation")
---
[TRANSLATION_ERROR] release-negative-name-collision.yaml
derived name collision: one name is derived more than once in one key space ("paymentsXzhdbXXalarmXzhid", key space "output-logical-ids", derived by component "payments-db", carrying attachment "storage-headroom-strict", provider "cloudformation", dispatch path "name-collision/cloudformation")

Buradan okunacak dört şey var ve her biri bilinçli olarak böyledir.

  • Her iki uç da adlandırılır. Her girdi, bileşeni ve taşıdığı ek adını verir; böylece ikisi de yazdığınız dosyalarda aranabilir. Bir çakışmada katkıda bulunanlardan birinin adını amaçlanan ad yapan hiçbir şey yoktur; bu nedenle yalnızca ilki değil, ikisi de raporlanır.
  • Anahtar uzayı adlandırılır. output-logical-ids, yığının iki ad uzayından hangisine ulaşıldığını ve — kaynak ad uzayı bu durmada yer almadığı için — kaynak adlarının sorunsuz olduğunu size söyler.
  • Hiçbir şey üretilmez. Derleme, iki alarmdan birinin sessizce çıktısız kaldığı bir yığın yazmak yerine durur.
  • Kaynakları farklı adlandırmak bu sorunu çözmez. Çıktı adı ana bileşenden ve girdiden oluşturulur; bu nedenle farklı olması gereken girdidir — ya iki yerine tek bir ek ya da yayımlanan girdi adları o ekin kendi adları olarak okunan bir Feature.

Aynı girdi, aynı çıktı

Değişmemiş girdilerden iki kez derleme yapmak, bayt düzeyinde özdeş şablonlar üretir. Derleyici canlı veri çözümlemez — hiçbir zaman AWS’yi çağırmaz, hiçbir zaman bir hesap kimliği aramaz ve hiçbir zaman CloudFormation çalıştırmaz — bu nedenle yeniden derlemenin baytları değiştirebilecek keşfedeceği hiçbir şey yoktur. Fark tabanlı bir incelemenin dayandığı özellik budur.

dist/ ve *.lock dosyaları üretilir ve commit edilmez; bunlar commit edilen dosyalardan yeniden üretilir.