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

Yönetilen bir veritabanı ve onu okuyan servis, Terraform ve CloudFormation üzerinde

Bir Aggregate, bir PostgreSQL veritabanını ve onu okuyan sunucuyu içerir. Aynı Aggregate, AWS’ye karşı üç biçimde derlenir: veritabanının terraform-aws-modules projesinin yayımlanmış RDS modülüyle sağlandığı ve sunucunun Fargate üzerinde bir Amazon ECS servisi olarak çalıştırıldığı tek bir Terraform kök yapılandırması olarak; ikisini birden içeren tek bir CloudFormation yığını olarak; ve veritabanının birinde, sunucunun diğerinde olduğu iki CloudFormation yığını olarak.

Her hedefte sunucu, veritabanının adresini o hedefin kendisinin çözümlediği biçimde alır: kök yapılandırmada bir modül çıktısı referansı, tek bir yığın içinde bir Fn::GetAtt, iki yığın arasında bir Fn::ImportValue. Derleyici bunların hiçbirini değerlendirmez. Adres, örnek oluşturulana kadar var olmaz; bu nedenle derleme bir referansı olduğu gibi aktarır ve hedef bunu dağıtım sırasında çözümler.

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: orders_admin rolünün sahibi olduğu orders adlı mantıksal bir veritabanına sahip, core/datastore/postgres türünde bir db bileşeni ve onu kullanan, core/compute/server türünde bir api bileşeni. İçindeki hiçbir anahtar veya değer AWS ile ilgili değildir.
  • manifest-terraform.yaml — veritabanını terraform/postgres-rds-terraform-aws-modules Recipe’ine, sunucuyu terraform/server-ecs’e, core/backup Feature’ını ise terraform/backup-native’e bağlar.
  • manifest-cloudformation.yaml — veritabanını cloudformation/postgres-rds’e, sunucuyu cloudformation/server-ecs’e, core/backup Feature’ını ise cloudformation/backup-native’e bağlar.
  • release-terraform.yaml — iki bileşen tek bir sınır içinde, Terraform Manifest’i üzerinden derlenir.
  • release-one-stack.yaml — iki bileşen tek bir sınır içinde, CloudFormation Manifest’i üzerinden derlenir; böylece ikisi tek bir yığında birleşir.
  • release-two-stacks.yaml — aynı niyet iki sınıra bölünür; böylece sunucunun veritabanına olan başvurusu bir yığın sınırını aşar.
  • .aggrega-config.yaml — standart kütüphane kataloğunun çözümlendiği hub kayıt defterini adlandırır.

Bu örneğin kullandığı varlıkların tümü o katalogda bulunur. Release dosyalarının yanına hiçbir şey kopyalanmaz.

Sunucunun istedikleri

Sunucu, database adını verdiği bir soket üzerinde tek bir kenar bildirir ve veritabanının yayımladığı girdilerden dördünü, kendi yapılandırmasının okuduğu ortam değişkeni adları altında ister:

api:
type: core/compute/server
uses:
database:
db:
target: db
inject:
env:
- in: DB_HOST
from: host
- in: DB_PORT
from: port
- in: DB_USER
from: user
- in: DB_NAME
from: database

core/compute/server kendine ait bir soket bildirmez, bu nedenle database geçici (ad-hoc) bir sokettir: kenar ne bir seçici ne de bir inject izin listesi taşır ve her from: anahtarı yine de veritabanının yayımladığı bir anahtar olmalıdır — bu sözleşme için bkz. adhoc-uses-socket. Aggregate hiçbir zaman bir adres, bir port numarası ya da bir bulut sağlayıcısı adlandırmaz ve aşağıdaki üç derlemenin tümü için aynı dosyadır.

Operatörün sağladıkları

Her Release, infra.overrides altında, operatörün zaten çalıştırdığı ve Recipes’in okuduğu şeyleri adlandırır: RDS DB alt ağ grubu ve veritabanının güvenlik grupları; ECS kümesi, görevlerin bağlandığı alt ağlar ve güvenlik grupları ve ECS’nin imajı çekip günlükleri yazarken kullandığı yürütme rolü. Sunucunun imajı infra.image’dır. Her iki sunucu Recipe’i de imajı, kümeyi, alt ağları, güvenlik gruplarını ve yürütme rolünü gerektirir; Terraform veritabanı Recipe’i ise alt ağ grubunu gerektirir: bunlardan biri eksik olan bir derleme, sizin yerinize bir ağ ya da rol seçmek yerine anahtarı adlandırarak durur.

Bu değerlerin her biri yer tutucudur: 123456789012, AWS belgelerinin örneklerde kullandığı hesap numarasıdır; example-cluster, example-private-db-subnets, subnet-… ve sg-… kimlikleri, rol ve registry.example.com/orders-api:1.0.0 ise kendi hesabınızdaki kaynakları temsil eder. Derleme bunları hiçbir zaman sorgulamadığı için kabul eder; plan oluşturmadan ya da dağıtım yapmadan önce bunları değiştirin.

Terraform Recipes, anahtarlarını kataloğun terraform yazımıyla okur (subnet_group, subnet_ids, vpc_security_groups, cluster, execution_role_arn); CloudFormation Recipes ise bunları kaynak özelliklerinin kendi adlarıyla okur (DBSubnetGroupName, VPCSecurityGroups, Cluster, Subnets, SecurityGroups, ExecutionRoleArn); bu nedenle aynı operatör değerleri iki hedefte farklı yazılır.

Ö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 aws-rds-and-ecs-service

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

Terminal window
cd aws-rds-and-ecs-service

Derleme

Bu örnek üç release içerir, bu yüzden istediğinizi adıyla belirtin. Her çalıştırmada bir release derlenir. Yeni bir kopyada, her release ilk kez derlenirken --auto-pull geçirin; böylece kilit dosyası derleme sırasında doldurulur. İlk Terraform derlemesi RDS modülünü git deposundan, Recipe’nin kendi sabitlemesinin kaydettiği commit’te getirir:

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

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

Pull complete: release-terraform.lock (entities=11, source_artifacts=1, external_inputs=0)
Total build time: 9.4s
Build completed: 151 files written to <workspace>/dist

Kilit dosyası oluştuktan sonra, yalın komut ona göre derler:

Terminal window
aggrega build --release release-terraform.yaml
Total build time: 5.7s
Build completed: 151 files written to <workspace>/dist

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 `aws-rds-and-ecs-service` klasörü yoksa `scaffold` aracını `example` değeri `aws-rds-and-ecs-service` olarak ayarlanmış ve `dir` olmadan bir kez çağırın: örneği yeni bir `aws-rds-and-ecs-service` klasörüne yazar. Ardından `build` aracını `workspace_root` değeri `aws-rds-and-ecs-service`, `release` değeri `release-terraform.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; dosyalar `aws-rds-and-ecs-service/dist/` altındadır.

Tek bir Terraform kök yapılandırması

Sınırın kök yapılandırması dist/one-root/terraform/aggrega.modules.tf konumuna yazılır ve her bileşenin kendi dosyaları, onun module bloğunun gösterdiği dizinde bulunur: tedarik edilmiş RDS modülü modules/db/ altında, kataloğda kendi Recipe’inin yanında tutulan sunucunun ECS modülü ise modules/api/ altında. Kök yapılandırmanın tamamı:

# Root configuration for this boundary. Each component rendered here is one
# module block below, and the directory that block points at holds that
# component's own files. One configuration means one dependency graph, which is
# what lets a reference or a depends_on reach from one component to another.
module "api" {
source = "./modules/api"
assign_public_ip = false
cluster = "example-cluster"
cpu = "256"
desired_count = 2
environment = {"DB_HOST":"${module.db.db_instance_address}","DB_NAME":"orders","DB_PORT":"5432","DB_USER":"orders_admin"}
execution_role_arn = "arn:aws:iam::123456789012:role/example-ecs-task-execution"
image = "registry.example.com/orders-api:1.0.0"
memory = "512"
name = "api"
port = 8080
security_groups = ["sg-0fedcba9876543210"]
subnet_ids = ["subnet-0123456789abcdef0","subnet-0fedcba9876543210"]
}
module "db" {
source = "./modules/db"
allocated_storage = 50
backup_retention_period = 14
create_db_subnet_group = false
db_name = "orders"
db_subnet_group_name = "example-private-db-subnets"
engine = "postgres"
engine_version = "16"
family = "postgres16"
identifier = "db"
instance_class = "db.t3.small"
manage_master_user_password = true
multi_az = true
port = "5432"
skip_final_snapshot = false
storage_type = "gp3"
username = "orders_admin"
vpc_security_group_ids = ["sg-0123456789abcdef0"]
}

Sunucunun environment argümanı, kenarın istediği dört değeri taşır. DB_HOST, ${module.db.db_instance_address} değeridir: veritabanı Recipe’i, RDS modülünün kendi db_instance_address çıktısına bir referansı, bu aynı kökün module "db" olarak bildirdiği modül çağrısı üzerinden yayımlar; böylece Terraform bunu burada, plan ve apply zamanında değerlendirir ve sunucunun modülü örneğin adresini sıradan bir girdi olarak alır. Diğer üçü, derleyicinin önceden bildiği düz metinlerdir: Release’in yapılandırdığı port ve Aggregate’in yazdığı iki ad.

Bu, sunucunun Recipe’i bir source: Recipe’i olduğu için çalışır: eşlemesi, sunucunun module bloğunun argümanlarına dönüşür; bu da Terraform’un komşunun modülünün bildirildiği bir kapsamda değerlendirdiği tek konumdur. İşleyiş için ve bir tüketici referansı başka bir yere yazdığında neyin ters gittiği için Başka bir bileşenin yayımladığı değeri tüketmek ve Çalışılmış bir çift bölümlerine bakın. Aynı nedenle, modül dizinlerinden birini tek başına değil, bu dizini — aggrega.modules.tf dosyasını içereni — plan edin.

Bu dizinin geçici bir kopyasında tofu init -backend=false, kökü ve tedarik edilmiş modülleri diskten yükler ve yalnızca sağlayıcıları indirir:

Initializing modules...
- api in modules/api
- db in modules/db
- db.db_instance in modules/db/modules/db_instance
- db.db_instance_role_association in modules/db/modules/db_instance_role_association
- db.db_option_group in modules/db/modules/db_option_group
- db.db_parameter_group in modules/db/modules/db_parameter_group
- db.db_subnet_group in modules/db/modules/db_subnet_group
[… omitted: provider installation, whose versions move with the registry, and OpenTofu's closing advice]

ardından tofu validate şunu yazdırır:

Success! The configuration is valid.

Tek bir CloudFormation yığını

Terminal window
aggrega build --release release-one-stack.yaml --auto-pull
Pull complete: release-one-stack.lock (entities=11, source_artifacts=0, external_inputs=0)
Total build time: 6.2s
Build completed: 1 file written to <workspace>/dist

Birleştirilen yığın dist/one-stack/cloudformation/cloudformation-stack.json konumuna yerleşir ve üç kaynak içerir: RDS örneği olan Db; ECS hizmeti olan Api; ve hizmetin çalıştırdığı görev tanımı olan ApiTaskDefinition. ApiTaskDefinition içindeki konteynerin ortamı:

"Environment": [
{
"Name": "DB_HOST",
"Value": {
"Fn::GetAtt": [
"Db",
"Endpoint.Address"
]
}
},
{
"Name": "DB_NAME",
"Value": "orders"
},
{
"Name": "DB_PORT",
"Value": "5432"
},
{
"Name": "DB_USER",
"Value": "orders_admin"
}
],

DB_HOST, veritabanı Recipe’inin db bileşen adından türettiği Db mantıksal kimliğine karşı, örneğin Endpoint.Address özniteliği üzerinde bir Fn::GetAtt’tir. CloudFormation bunu yığını oluştururken çözümler ve sunucunun görev tanımı Db’nin bir özniteliğini okuduğu için önce örneği oluşturur. Bkz. Yığın içi başvurular.

İki CloudFormation yığını

Terminal window
aggrega build --release release-two-stacks.yaml --auto-pull
Pull complete: release-two-stacks.lock (entities=11, source_artifacts=0, external_inputs=0)
Total build time: 6.2s
Build completed: 2 files written to <workspace>/dist

aggregate.yaml içinde hiçbir şey değişmez. Release, veritabanını data sınırına, sunucuyu ise app sınırına yerleştirir; böylece her biri kendi yığınına derlenir ve sunucunun veritabanına giden kenarı bir yığından diğerine geçer. Veritabanının yığını, dist/two-stacks-data/cloudformation/cloudformation-stack.json, kenarın tükettiği her girdiyi Export içeren bir çıktı olarak yayımlar. Yığının Outputs bölümü:

"Outputs": {
"dbXXdatabase": {
"Value": "orders",
"Export": {
"Name": "aggrega--orders-two-stacks--two-stacks-data-zscloudformation--db--database"
}
},
"dbXXhost": {
"Value": {
"Fn::GetAtt": [
"Db",
"Endpoint.Address"
]
},
"Export": {
"Name": "aggrega--orders-two-stacks--two-stacks-data-zscloudformation--db--host"
}
},
"dbXXport": {
"Value": "5432",
"Export": {
"Name": "aggrega--orders-two-stacks--two-stacks-data-zscloudformation--db--port"
}
},
"dbXXprotocol": {
"Value": "postgres"
},
"dbXXuser": {
"Value": "orders_admin",
"Export": {
"Name": "aggrega--orders-two-stacks--two-stacks-data-zscloudformation--db--user"
}
}
},

protocol de yayımlanır, ancak hiçbir kenar onu okumadığı için Export taşımaz. Sunucunun yığını, dist/two-stacks-app/cloudformation/cloudformation-stack.json, dördünün her birini aynı adla geri okur:

"Environment": [
{
"Name": "DB_HOST",
"Value": {"Fn::ImportValue":"aggrega--orders-two-stacks--two-stacks-data-zscloudformation--db--host"}
},
{
"Name": "DB_NAME",
"Value": {"Fn::ImportValue":"aggrega--orders-two-stacks--two-stacks-data-zscloudformation--db--database"}
},
{
"Name": "DB_PORT",
"Value": {"Fn::ImportValue":"aggrega--orders-two-stacks--two-stacks-data-zscloudformation--db--port"}
},
{
"Name": "DB_USER",
"Value": {"Fn::ImportValue":"aggrega--orders-two-stacks--two-stacks-data-zscloudformation--db--user"}
}
],

Her dışa aktarma adı; Release adını, üretici sınırının çıktı dizinini, bileşeni ve girdiyi birleştirir; bu nedenle derleme zamanında sabitlenir ve tüketici, yığınlardan hiçbiri var olmadan önce onu adlandırabilir. Buradaki Release’lerin hiçbiri bir hesap veya bölge bildirmez, dolayısıyla okuma aynı hesap içinde bir Fn::ImportValue olur. Adın nasıl oluşturulduğu ve tüketicinin bunun yerine hesaplar arasında ne zaman okuduğu Yığınlar arası bağlantı bölümünde açıklanır. Bir içe aktarma yalnızca zaten var olan bir dışa aktarmaya karşı çözümlenir; bu nedenle veritabanının yığını sunucununkinden önce oluşturulur; iki yığının sıralanması derlemenin dışında, operatörün işidir.

Parola RDS’in kendisine aittir

Aggregate, veritabanının kullanıcısını adlandırır ve parolası hakkında hiçbir şey söylemez; hiçbir Release de veritabanına bir kimlik bilgisi eklemez. Her iki hedefte de Manifest’in seçtiği Recipe, parolayı RDS’e bırakır: yukarıdaki modül bloğunda manage_master_user_password = true, her yığındaki örnekte ise ManageMasterUserPassword. Tek yığınlı şablonda veritabanının Properties alanı:

"Properties": {
"AllocatedStorage": 50,
"BackupRetentionPeriod": 14,
"DBInstanceClass": "db.t3.small",
"DBName": "orders",
"DBSubnetGroupName": "example-private-db-subnets",
"Engine": "postgres",
"EngineVersion": "16",
"ManageMasterUserPassword": true,
"MasterUsername": "orders_admin",
"MultiAZ": true,
"Port": 5432,
"StorageType": "gp3",
"VPCSecurityGroups": [
"sg-0123456789abcdef0"
]
},

RDS, yönetici parolasını örneği oluştururken üretir ve AWS Secrets Manager’da saklar. Hiçbir derleme girdisi parola taşımaz; bu nedenle üç derlemenin hiçbiri herhangi bir dosyaya parola yazmaz. Sunucu, kullanıcının adını alır, parolasını almaz; parolanın Secrets Manager’dan okunması, sunucunun imajının çalıştırdığı koda bırakılmıştır.

Yedekleme bir ektir

RDS, aksi belirtilmedikçe örneği kendisi yedekler ve her otomatik yedeği 7 gün saklar. Her Release, db girdisinde veritabanına core/backup ekleyerek bunları 14 gün saklar:

db:
features:
backup:
type: core/backup
infra:
retention_days: 14

Her Manifest, Feature’ı kendi hedefi için FeatureRecipe’e, yani terraform/backup-native ya da cloudformation/backup-native’e bağlar ve ikisi de hiçbir şey işlemez: yedekleme örneğin bir ayarıdır; bu nedenle veritabanı Recipe’i eki okur ve saklama süresini örneğin yazıldığı yere yazar — modül bloğunda backup_retention_period = 14, yukarıdaki örneğin Properties alanında ise "BackupRetentionPeriod": 14. Tek yığınlı şablonun tam olarak üç kaynak içermesinin nedeni budur.

Derlemek dağıtmak değildir

Her derleme dist/ altına dosyalar yazar ve durur. Terraform, OpenTofu veya CloudFormation’ı hiçbir zaman çalıştırmaz, AWS’ye karşı kimlik doğrulaması yapmaz ve Releases’in adlandırdığı tanımlayıcıların hiçbirini sorgulamaz. Kök yapılandırmanın planlanması ve uygulanması ile yığınların oluşturulması, yer tutucuları değiştirdikten sonra kendi kimlik bilgilerinizle çıktı üzerinde sizin attığınız adımlardır.

Aynı girdi, aynı çıktı

Değişmemiş girdilerden iki kez derleme yapmak, üç sürümün her biri için bayt düzeyinde aynı çıktıyı üretir. Derleyici hiçbir canlı veriyi çözümlemez; bu nedenle yeniden derlemenin baytları değiştirebilecek keşfedeceği bir şey yoktur. Fark tabanlı bir incelemenin dayandığı özellik budur.

dist/, .aggrega/ ve *.lock dosyaları üretilir ve depoya işlenmez; depoya işlenen dosyalardan yeniden üretilirler.