Tugas yang dijalankan sesuai permintaan: satu Aggregate, empat target
Sebuah tugas yang membawa core/manual-trigger, di-deploy tanpa dijalankan di Kubernetes, Docker Compose, Terraform, dan CloudFormation, di samping tugas yang tidak membawa apa pun, beserta perintah yang memulai sebuah eksekusi di setiap target.
Sebagian pekerjaan berjalan hingga selesai hanya ketika seseorang memintanya: perbaikan data sekali jalan, cadangan atas permintaan. core/manual-trigger adalah Feature untuk itu. Jika dilampirkan ke core/compute/task tanpa jadwal, Feature ini men-deploy tugas tanpa menjalankannya, dan setiap eksekusi dimulai oleh seseorang secara manual, dengan perintah milik target itu sendiri.
Workspace ini membangun satu Aggregate untuk empat target — Kubernetes melalui Helm, Docker Compose, Terraform, dan CloudFormation — dan menunjukkan, pada masing-masing, apa yang diubah lampiran pada keluaran yang di-render serta perintah yang memulai sebuah eksekusi. Tugas kedua tidak membawa lampiran, sehingga perbedaannya terlihat dalam build yang sama. Dua Releases lainnya diharapkan berhenti, dan halaman ini mengutip apa yang dicetak masing-masing.
Apa yang dibangunnya
| instans | Component katalog | lampiran | apa yang memulai eksekusi |
|---|---|---|---|
data-fix | core/compute/task | core/manual-trigger | seseorang, secara manual, di setiap target |
report | core/compute/task | tidak ada | jadwalnya, atau, di Docker Compose, dimulainya stack |
Lampiran berada di Aggregate, di samping tugas yang diubahnya: berjalan sesuai permintaan adalah bagian dari hakikat data-fix, sehingga developer yang menuliskannya, dan Feature tersebut tidak menerima nilai apa pun maupun infra. Release tidak menulis apa pun untuknya.
Jadwal report adalah sebuah parameter, report_schedule, yang dideklarasikan Aggregate dengan nilai default kosong dan dibaca ke dalam nilai schedule tugas:
spec: parameters: report_schedule: type: string default: "" [… omitted: the parameter's description]
components: [… omitted: data-fix with its attachment, and the comment above each task] report: type: core/compute/task values: schedule: "{{ .parameters.report_schedule }}"Ini adalah parameter karena keempat target berbeda perlakuan terhadap tugas tanpa lampiran. Kubernetes menjalankannya sesuai jadwal sebagai CronJob, atau sekali saat deploy jika tanpa jadwal. Docker Compose tidak memiliki penjadwal, sehingga menjalankan tugas sekali setiap kali stack dimulai dan menolak jadwal. Di AWS tidak ada yang menjalankan tugas Amazon ECS ketika Terraform atau CloudFormation menerapkan perubahan, sehingga tugas di sana memerlukan jadwal atau lampiran, dan ditolak jika tidak ada keduanya. Jadi Releases Kubernetes, Terraform, dan CloudFormation memenuhi report_schedule, dan Release Docker Compose membiarkannya kosong.
data-fix di-build dengan cara yang sama di keempat target, tanpa jadwal dan tanpa parameter.
Enam Releases
| Release | Manifest | report_schedule | build |
|---|---|---|---|
release-helm.yaml | manifest-helm.yaml | 30 2 * * 1-5 | selesai |
release-compose.yaml | manifest-compose.yaml | kosong | selesai |
release-terraform.yaml | manifest-terraform.yaml | 30 2 * * 1-5 | selesai |
release-cloudformation.yaml | manifest-cloudformation.yaml | 30 2 * * 1-5 | selesai |
release-compose-scheduled.yaml | manifest-compose.yaml | 30 2 * * 1-5 | dihentikan |
release-terraform-unscheduled.yaml | manifest-terraform.yaml | kosong | dihentikan |
Setiap Manifest memetakan core/compute/task ke Recipe targetnya dan mengikat core/manual-trigger ke FeatureRecipe targetnya: helm/task dan helm/manual-trigger, compose/task dan compose/manual-trigger, terraform/task-ecs dan terraform/manual-trigger, serta cloudformation/task-ecs dan cloudformation/manual-trigger. Manifest yang tidak mengikat FeatureRecipe untuk lampiran tersebut menghentikan build dengan menyebutkannya.
Setiap Release menyebutkan image yang dijalankan setiap tugas di bawah infra.image, karena core/compute/task tidak mengemas perangkat lunak apa pun. Releases AWS juga menyebutkan, di bawah infra.overrides, cluster, subnet, security group, dan execution role yang digunakan setiap tugas, dan, jika report memiliki jadwal, role yang digunakan jadwal untuk memulai setiap eksekusi. Setiap nilai khusus akun di sana adalah placeholder.
Membuat contoh
Anda dapat mem-build contoh ini dengan perintah di bawah, atau meminta asisten AI Anda mem-build-nya untuk Anda.
Tulis contoh ke folder baru yang dinamai sesuai contoh itu:
aggrega scaffold --example task-run-on-demandKemudian ia mencetak perintah yang dijalankan berikutnya. Perintah pertama berpindah ke folder baru:
cd task-run-on-demandBuild
Workspace membaca katalog pustaka standar dari registry hub yang disebutkan .aggrega-config.yaml. Setiap Recipe di sini di-render dari katalog saja, sehingga setiap build berjalan offline setelah lockfile di-resolve.
aggrega build --release release-helm.yaml --auto-pull # one ReleaseDi checkout repositori dokumentasi, yang memuat skrip pembantu build bersama yang tidak disertakan oleh salinan yang ditulis aggrega scaffold --example, ./check.sh mem-build keenam Releases dan memeriksa setiap hasilnya. Skrip ini mencetak satu baris per Release dan keluar dengan 0 hanya jika masing-masing berakhir seperti yang dijelaskan halaman ini:
RELEASE EXIT EXPECTED VERDICT----------------------------------------------------------------------------------------------------release-helm.yaml 0 complete OK: completed, the files the README showsrelease-compose.yaml 0 complete OK: completed, the files the README showsrelease-terraform.yaml 0 complete OK: completed, the files the README showsrelease-cloudformation.yaml 0 complete OK: completed, the files the README showsrelease-compose-scheduled.yaml 1 halt OK: halted with the expected refusalrelease-terraform-unscheduled.yaml 1 halt OK: halted with the expected refusal
check: every build ended as expected.Dengan asisten AI
Asisten AI yang disiapkan dengan tool Aggrega dapat melakukan hal yang sama: tempelkan prompt ini ke asisten tersebut.
Gunakan hanya alat Aggrega, dan jangan membuat folder sendiri. Jika folder ruang kerja belum berisi folder `task-run-on-demand`, panggil alat `scaffold` sekali dengan `example` diatur ke `task-run-on-demand` dan tanpa `dir`: alat ini menulis contoh ke folder `task-run-on-demand` yang baru. Lalu panggil alat `build` dengan `workspace_root` diatur ke `task-run-on-demand`, `release` diatur ke `release-helm.yaml`, `auto_pull` diatur ke true, dan `write` diatur ke true. Beri tahu saya file mana yang ditulis oleh build; file tersebut berada di bawah `task-run-on-demand/dist/`.Kubernetes
release-helm.yaml menulis dua file, satu CronJob per tugas, dan tidak ada yang lain. data-fix adalah CronJob yang dibiarkan ditangguhkan, dengan jadwal yang tidak pernah ditulis developer:
apiVersion: batch/v1kind: CronJobmetadata: name: data-fix [… omitted: the labels and annotations the build writes on every resource]spec: schedule: 0 0 30 2 * suspend: true jobTemplate: spec: template: [… omitted: the pod template's metadata, the same labels again] spec: containers: - name: main image: registry.example.com/orders-data-fix:2.0.1 [… omitted: the container's CPU and memory requests and limits] restartPolicy: NeverCronJob memerlukan jadwal, dan 0 0 30 2 * menyebut 30 Februari, tanggal yang tidak ada di tahun mana pun: saat ditangguhkan, CronJob tidak memulai eksekusi apa pun, dan saat dilanjutkan, CronJob tetap tidak memiliki waktu untuk memulainya. Tanpa lampiran, tugas tanpa jadwal akan menjadi Job, yang berjalan segera setelah di-deploy.
report adalah CronJob dengan jadwal yang dipenuhi Release, dan tidak ditangguhkan:
[… omitted: apiVersion, kind and metadata, as in data-fix-cronjob.yaml under report's name]spec: schedule: 30 2 * * 1-5 jobTemplate: [… omitted: the job template, as in data-fix-cronjob.yaml with report's image]Eksekusi data-fix adalah Job yang dibuat dari CronJob-nya, dengan nama pilihan Anda:
kubectl create job data-fix-run-1 --from=cronjob/data-fixPerintah yang sama, jika diberi --from=cronjob/report, memulai eksekusi tambahan report di antara eksekusi terjadwalnya.
Docker Compose
release-compose.yaml menulis satu file Compose. Setiap tugas adalah service yang tidak dimulai lagi oleh Compose ketika keluar; data-fix juga membawa profile manual, dan report tidak membawa profile apa pun:
services: data-fix: image: registry.example.com/orders-data-fix:2.0.1 [… omitted: the labels the build writes on every service, and the service's network] restart: "no" [… omitted: the CPU and memory limits and reservations] profiles: - manual report: image: registry.example.com/orders-report:1.4.2 [… omitted: the labels and the network, as on data-fix] restart: "no" [… omitted: the CPU and memory limits and reservations, as on data-fix][… omitted: the network the services join]Compose memulai service yang membawa profile hanya ketika profile tersebut diaktifkan atau service-nya disebutkan di baris perintah, sehingga docker compose up menjalankan report sekali dan membiarkan data-fix berhenti. Eksekusi data-fix dimulai dengan menyebutkan service-nya, dan --rm menghapus kontainernya setelah eksekusi selesai:
docker compose -f dist/compose/docker-compose.yaml run --rm data-fixTerraform
release-terraform.yaml menulis konfigurasi root dengan satu blok module per tugas, dan modul setiap tugas di sampingnya. Kedua blok berbeda pada jadwalnya:
# 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 "data-fix" { source = "./modules/data-fix"
assign_public_ip = false cluster = "arn:aws:ecs:eu-west-1:123456789012:cluster/example-cluster" cpu = "256" environment = {} execution_role_arn = "arn:aws:iam::123456789012:role/example-ecs-task-execution" image = "registry.example.com/orders-data-fix:2.0.1" memory = "512" name = "data-fix" security_groups = ["sg-0fedcba9876543210"] subnet_ids = ["subnet-0123456789abcdef0"]}
module "report" { source = "./modules/report"
assign_public_ip = false cluster = "arn:aws:ecs:eu-west-1:123456789012:cluster/example-cluster" cpu = "256" environment = {} execution_role_arn = "arn:aws:iam::123456789012:role/example-ecs-task-execution" image = "registry.example.com/orders-report:1.4.2" memory = "512" name = "report" schedule_expression = "cron(30 2 ? * 2,3,4,5,6 *)" schedule_expression_timezone = "UTC" scheduler_role_arn = "arn:aws:iam::123456789012:role/example-scheduler" security_groups = ["sg-0fedcba9876543210"] subnet_ids = ["subnet-0123456789abcdef0"]}Modul mendeklarasikan jadwal EventBridge Scheduler hanya selama diberi ekspresi, sehingga definisi tugas data-fix berdiri sendiri:
[… omitted: the provider requirement, the Region lookup, the task definition and the comments on each]resource "aws_scheduler_schedule" "this" { count = var.schedule_expression == null ? 0 : 1[… omitted: the rest of the schedule]Recipe menulis jadwal report dalam bentuk milik EventBridge Scheduler sendiri: 30 2 * * 1-5 menjadi cron(30 2 ? * 2,3,4,5,6 *), dengan hari dalam seminggu dinomori mulai dari Minggu sebagai 1, dalam UTC karena Release tidak menyebutkan zona waktu.
CloudFormation
release-cloudformation.yaml menulis satu template stack. Template ini berisi definisi tugas untuk setiap tugas dan jadwal hanya untuk report:
{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "DataFixTaskDefinition": { [… omitted: the provenance metadata the build writes on every resource] "Properties": { "ContainerDefinitions": [ { "Essential": true, "Image": "registry.example.com/orders-data-fix:2.0.1", "Name": "main" } ], "Cpu": "256", "ExecutionRoleArn": "arn:aws:iam::123456789012:role/example-ecs-task-execution", "Family": "data-fix", "Memory": "512", "NetworkMode": "awsvpc", "RequiresCompatibilities": [ "FARGATE" ] }, "Type": "AWS::ECS::TaskDefinition" }, "ReportSchedule": { [… omitted: the provenance metadata] "Properties": { "FlexibleTimeWindow": { "Mode": "OFF" }, "ScheduleExpression": "cron(30 2 ? * 2,3,4,5,6 *)", "ScheduleExpressionTimezone": "UTC", "Target": { "Arn": "arn:aws:ecs:eu-west-1:123456789012:cluster/example-cluster", "EcsParameters": { [… omitted: the launch type, the network configuration and the task count each run starts with] "TaskDefinitionArn": { "Ref": "ReportTaskDefinition" } }, "RoleArn": "arn:aws:iam::123456789012:role/example-scheduler" } }, "Type": "AWS::Scheduler::Schedule" }, "ReportTaskDefinition": { [… omitted: the same shape as DataFixTaskDefinition, with report's image and family] } }}Tidak ada apa pun di stack yang merujuk DataFixTaskDefinition, sehingga tidak ada yang memulainya.
Memulai eksekusi di Amazon ECS
Di kedua target AWS, eksekusi data-fix dimulai dengan operasi Amazon ECS RunTask, dengan diberi family definisi tugas sebagaimana di-render serta konfigurasi cluster dan jaringan yang disebutkan Release di bawah infra.overrides:
aws ecs run-task \ --cluster arn:aws:ecs:eu-west-1:123456789012:cluster/example-cluster \ --task-definition data-fix \ --launch-type FARGATE \ --network-configuration 'awsvpcConfiguration={subnets=[subnet-0123456789abcdef0],securityGroups=[sg-0fedcba9876543210],assignPublicIp=DISABLED}'Jika disebut hanya dengan family-nya, definisi tugas di-resolve ke revisi aktif terbarunya.
Yang tidak dilakukan build
Build menulis file lalu berhenti. Build tidak memulai eksekusi apa pun, di target mana pun: tidak menjangkau cluster apa pun, tidak memulai stack Compose apa pun, dan tidak memanggil API AWS apa pun, dan lampiran hanya mengubah isi file. Build juga tidak menulis skrip apa pun: setiap perintah di halaman ini adalah milik target itu sendiri, dijalankan oleh siapa pun yang mengoperasikannya, dan tidak ada yang berada di dist/. Realisasi lampiran tidak menambahkan file sendiri di target mana pun; perubahan yang dibuat masing-masing ada di keluaran tugas itu sendiri, seperti ditunjukkan di atas.
Dua Releases yang berhenti
release-compose-scheduled.yaml memenuhi report_schedule di Docker Compose, dan juga melampirkan core/manual-trigger ke report. Di Kubernetes dan AWS, tugas dengan jadwal berjalan sesuai jadwal itu, baik ada lampiran maupun tidak; di Docker Compose, yang tidak memiliki penjadwal, tugas dengan jadwal tidak memiliki realisasi, dilampirkan atau tidak. aggrega build --release release-compose-scheduled.yaml --auto-pull berhenti:
[… omitted: what resolving the lockfile prints, the same halt among it][CATALOG_ERROR E0033] Recipe/FeatureRecipe assertions caused by: Recipe "task" instance "report" assertion "schedule_refused": [… omitted: the template position and the assertion's own source]: error calling fail: assertion failed: the component "report" is scheduled "30 2 * * 1-5", and Docker Compose has no scheduler: nothing in a compose file starts a service at a time, so the run would happen at none of the times written. Map core/compute/task to helm/task in the Manifest, which runs it on its schedule as a Kubernetes CronJob; or remove the schedule from the component in the Aggregate to run it once at each docker compose up, or attach core/manual-trigger to it there to start each run with docker compose run --rmrelease-terraform-unscheduled.yaml membiarkan report_schedule kosong di Terraform, sehingga report tidak memiliki jadwal maupun lampiran, dan tidak ada apa pun di AWS yang akan pernah memulainya. Inilah kasus yang menjadi alasan core/manual-trigger ada, dan aggrega build --release release-terraform-unscheduled.yaml --auto-pull berhenti dengan menyebutkannya:
[… omitted: what resolving the lockfile prints, the same halt among it][CATALOG_ERROR E0033] Recipe/FeatureRecipe assertions caused by: Recipe "task-ecs" instance "report" assertion "schedule_translates": [… omitted: the template position and the assertion's own source]: error calling fail: assertion failed: the component "report" has no schedule and carries no core/manual-trigger attachment, so it runs once, and nothing on AWS starts a run that happens once: neither Terraform nor CloudFormation runs an Amazon ECS task when it applies, so the run would never happen. Give the component a schedule in the Aggregate; attach core/manual-trigger to it there to deploy its task definition alone, for the operator to start each run with aws ecs run-task; or map core/compute/task to helm/task in the Manifest, which runs it once on KubernetesDi sini jadwal mencapai tugas melalui parameter yang dipenuhi Release, sehingga memberi komponen sebuah jadwal berarti memenuhi report_schedule, seperti yang dilakukan release-terraform.yaml.