File dari sebuah build
Halaman ini menjelaskan satu gagasan, yaitu file mana dari sebuah build yang menyatakan apa, dan bukan ruang kerja yang dapat dijalankan. Aplikasi web dengan PostgreSQL, dibangun selangkah demi selangkah menunjukkannya dalam ruang kerja yang Anda build; tulis ruang kerja itu ke folder Anda sendiri dengan:
aggrega scaffold --example quickstart-webKemudian ia mencetak perintah yang dijalankan berikutnya:
cd quickstart-webcd 1aggrega build --release release.yaml --auto-pullexport QUICKSTART_DB_PASSWORD=choose-a-passworddocker compose -p quickstart-web -f dist/compose/docker-compose.yaml up -d --wait# then open http://127.0.0.1:8080/ in your browserLima jenis file, masing-masing dengan satu penulis
Sebuah build membaca lima jenis file. Masing-masing menyatakan satu hal, dan dalam tim pada umumnya masing-masing memiliki penulisnya sendiri:
- sebuah Component menyatakan apa itu suatu jenis komponen: nilai yang dapat diatur oleh developer, pengaturan infrastruktur yang dapat diatur oleh operator, apa yang dipublikasikannya ke komponen yang terhubung dengannya, dan soket yang digunakannya untuk terhubung. Katalog pustaka standar menyediakan Components yang dibutuhkan sebagian besar aplikasi, seperti
core/datastore/postgresdancore/compute/server, sehingga sebuah ruang kerja biasanya tidak menulis satu pun; - sebuah Aggregate adalah milik developer: komponen apa saja yang dimiliki aplikasi, dan ke mana masing-masing terhubung;
- sebuah Recipe mengubah satu jenis komponen menjadi file untuk satu alat — sebuah layanan Compose, sebuah chart Helm, sebuah modul Terraform;
- sebuah Manifest memilih Recipe mana yang merealisasikan setiap jenis komponen untuk satu target;
- sebuah Release menyebutkan sebuah Aggregate dan sebuah Manifest serta memberikan pengaturan satu lingkungan. Itulah yang Anda build:
aggrega build --release release.yaml.
Pembagian ini merupakan panduan: satu orang boleh menulis kelimanya, dan build menerima yang mana pun selama masing-masing valid.
Aggregate: komponen dan koneksinya
Langkah pertama contoh ini adalah sebuah aplikasi web dan basis datanya. Aggregate-nya, dari 1/aggregate.yaml dengan komentarnya dihilangkan:
spec: components: web: type: core/compute/server features: db_password: type: core/secret-value values: key: PGPASSWORD origin: "${QUICKSTART_DB_PASSWORD}" uses: database: db: target: db inject: env: - in: PGHOST from: host - in: PGPORT from: port - in: PGUSER from: user - in: PGDATABASE from: database
db: type: core/datastore/postgres features: password: type: core/secret-value values: key: POSTGRES_PASSWORD origin: "${QUICKSTART_DB_PASSWORD}"Tidak ada yang menyebutkan port, host, namespace, atau alat di sini. web terhubung ke db melalui soket database-nya, dan daftar inject menyatakan variabel aplikasi mana yang menerima setiap entri yang dipublikasikan basis data: from: menyebutkan entri, in: variabelnya.
Koneksi adalah string yang dialirkan
Recipe basis data memublikasikan host, port, user, dan database untuk dibaca oleh koneksi. Alamat mana yang dipegang host bergantung pada Recipe yang dipilih Manifest: nama layanan jika basis data berjalan di samping aplikasi, string penunjuk yang di-resolve oleh alat provisioning untuk basis data terkelola, atau alamat server yang sudah ada. Build menyalin setiap string yang dipublikasikan ke variabel yang disebutkan Aggregate dan tidak menafsirkannya: build tidak pernah me-resolve alamat atau memeriksa apakah alamat itu dapat dijangkau.
Manifest dan Release
Manifest, dari 1/manifest.yaml, mengikat setiap jenis komponen, dan lampiran kata sandi, ke Recipe yang merealisasikannya di Docker Compose:
spec: mappings: components: type: core/compute/server:1.1.0: compose/server:2.0.0 core/datastore/postgres:1.0.0: compose/postgres:1.0.0 features: type: core/secret-value:1.0.0: compose/dotenv-secret:1.0.0Release, dari 1/release.yaml, menyebutkan Aggregate dan Manifest serta memberikan apa yang hanya diketahui lingkungan, di sini image yang dijalankan aplikasi, port yang didengarkannya, dan port tempat Docker Compose memublikasikannya, pada alamat loopback mesin Anda (digest image dipersingkat):
spec: aggregate: quickstart-web manifest: quickstart-web-compose components: web: infra: image: hub.aggrega.ai/tools/quickstart-web:1.1.0@sha256:… port: 8080 published_port: 8080 db: {}Langkah-langkah berikutnya dalam contoh ini mengembangkannya: cache Redis di samping basis data, lalu komponen yang sama di AWS melalui Terraform, lalu cadangan basis data.
Parameter: satu Aggregate, banyak lingkungan
Nilai yang berbeda antarlingkungan dideklarasikan di Aggregate sebagai parameter bertipe, direferensikan di tempat nilai itu digunakan, dan diberikan oleh setiap Release. Dalam Tugas yang dijalankan sesuai permintaan, Aggregate mendeklarasikan jadwal laporannya:
spec: parameters: report_schedule: type: string default: "" components: report: type: core/compute/task values: schedule: "{{ .parameters.report_schedule }}"dan sebuah Release memenuhinya:
spec: parameters: report_schedule: "30 2 * * 1-5"Build memeriksa setiap nilai yang diberikan Release terhadap tipe parameter sebelum mengisi template. Release tidak pernah menulis sendiri values sebuah komponen: Release memenuhi parameter yang diekspos Aggregate, sehingga Aggregate tetap menjadi satu-satunya tempat yang menyatakan nilai mana yang bervariasi menurut lingkungan. Release juga dapat membaca parameternya dari file tersendiri, parameters: { $import: ./env/prod-values.yaml }.