Satu kontrak, tiga realisasi
Sebuah basis data PostgreSQL dan aplikasi yang membacanya, di-deploy dengan tiga cara berbeda dari satu Aggregate yang tidak diubah: PostgreSQL yang berjalan di kluster, PostgreSQL sebagai instans cloud terkelola, dan server PostgreSQL yang sudah ada sebelum Release ini di-deploy.
Pelajarannya adalah apa yang tidak berubah. Aplikasi menyebutkan kunci yang diinginkannya dari basis data dan nama yang akan dipakai untuknya, satu kali saja. Aplikasi tidak pernah mengetahui yang mana dari ketiganya yang menjawab. Compiler pun tidak pernah mengetahuinya: compiler membaca kunci yang dipublikasikan oleh Recipe yang dipilih dan meneruskan string tersebut.
Satu-satunya hal yang berbeda
.-- helm/postgres ---------- a StatefulSet in the cluster /core/datastore/postgres --- terraform/postgres-rds -- an RDS instance in Terraform one Component \ one contract '- helm/postgres-external -- a server that already existsTiga Recipes mengimplementasikan Component yang sama. Masing-masing menerbitkan kunci provides
yang sama — host, port, user, database, protocol, dan kunci-kunci yang menyatakan di mana
sebuah scraper menemukan metrik basis data, yang kosong pada ketiganya. Mana yang dijalankan cukup ditentukan oleh
satu baris dalam Manifest.
Berkas
aggregate.yaml— maksud pengembang, dan dokumen yang sama untuk ketiga deployment: sebuah komponendbbertipecore/datastore/postgres, sebuahappyanguseskomponen tersebut, dan lima kunci yang diminta aplikasi. Tidak ada apa pun di sini yang menyebut target, cloud, atau Recipe.manifest-selfhosted.yaml,manifest-managed.yaml,manifest-external.yaml— pemetaan Ops. Masing-masing memilih realisasinya dalam satu baris: Recipe mana yang diikat oleh tipe komponen PostgreSQL. Pemetaan terkelola juga mengikat Feature backup yang dilampirkan oleh Releases-nya.release-selfhosted.yaml,release-managed.yaml,release-external.yaml— penentuan ukuran oleh operator di setiap Release: penyimpanan dan versi engine untuk yang berjalan di dalam klaster, penyimpanan, HA, dan lampirancore/backupuntuk yang terkelola, dan alamat server yang sudah ada untuk yang dirujuk.release-managed-dns.yaml— Release terkelola sekali lagi, dengan nama DNS yang diberikan operator kepada instans, sehingga aplikasi menerima nama yang dapat di-resolve-nya.catalog/— Component milik aplikasi itu sendiri dan satu-satunya Recipe yang merendernya. Semua yang ada di sisi basis data berasal dari pustaka standar tanpa modifikasi.
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 postgres-three-realizationsKemudian ia mencetak perintah yang dijalankan berikutnya. Perintah pertama berpindah ke folder baru:
cd postgres-three-realizationsBuild
aggrega build --release release-selfhosted.yaml --auto-pullaggrega build --release release-managed.yaml --auto-pullaggrega build --release release-managed-dns.yaml --auto-pullaggrega build --release release-external.yaml --auto-pull--auto-pull menulis lockfile setiap Release pada build pertamanya; build berikutnya tidak memerlukan flag. Masing-masing menulis ke dist/, dan sebuah build menambahkan file-filenya alih-alih membersihkan apa yang ditinggalkan oleh build sebelumnya. Hapus dist/ di antara setiap eksekusi untuk membaca keluaran satu realisasi secara tersendiri:
rm -rf dist && aggrega build --release release-managed.yamlDengan 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 Workspace belum berisi folder `postgres-three-realizations`, panggil alat `scaffold` sekali dengan `example` diatur ke `postgres-three-realizations` dan tanpa `dir`: alat ini menulis contoh ke folder `postgres-three-realizations` yang baru. Kemudian panggil alat `build` sekali untuk setiap Release, dengan urutan ini — `release-selfhosted.yaml`, `release-managed.yaml`, `release-managed-dns.yaml`, dan `release-external.yaml` — setiap kali dengan `workspace_root` diatur ke `postgres-three-realizations`, `release` diatur ke file tersebut, `auto_pull` diatur ke true, dan `write` diatur ke true. Beri tahu saya file apa saja yang ditulis setiap build; file-file itu ada di bawah `postgres-three-realizations/dist/`.Apa yang dirender masing-masing
Self-hosted — deployment menjalankan server
helm/postgres menyintesis basis data di dalam kluster: sebuah StatefulSet, sebuah
Service ClusterIP, dan sebuah Service headless. provides.host adalah nama polos
Service tersebut, sehingga aplikasi menjangkaunya melalui DNS di dalam kluster.
- name: DB_HOST value: db-defaultManaged — penyedia cloud menjalankan server
terraform/postgres-rds menghasilkan sebuah aws_db_instance sebagai Terraform HCL, dan ukuran ha serta lampiran core/backup dari operator dipetakan ke pengaturan native instans tersebut: retention_days: 14 milik lampiran menjadi backup_retention_period = 14 milik instans. Aplikasi tetap dirender ke Kubernetes: kedua sisi deployment ini bertemu pada kontrak yang dipublikasikan basis data, bukan pada target bersama.
- name: DB_HOST value: ${module.db.address}Nilai itu bukan hostname, dan tidak ada apa pun dalam build ini yang mengubahnya menjadi hostname. Alamat sebuah instans RDS belum ada sampai instans tersebut dibuat, sehingga tidak ada yang dapat dicari oleh compiler yang berjalan secara ahead-of-time. Yang dipublikasikan Recipe adalah referensi Terraform ke sebuah output dari modul milik basis data itu sendiri; compiler menyalurkannya melintasi edge tanpa diubah, Recipe aplikasi menerimanya apa adanya, dan referensi itu dirender ke dalam manifest Kubernetes sebagai karakter literal yang ditunjukkan di atas. Teks itulah yang diberikan kepada container.
DB_PORT berbeda: nilainya dirender sebagai "5432", karena Recipe menetapkan
port instans dari Release dan memublikasikan nilai yang sama itu, yang sudah diketahui
sebelum apa pun ada.
Wiring native antara dua komponen adalah sesuatu yang dilakukan target di dalam outputnya
sendiri, sehingga tidak ada yang perlu dilakukan di sini. Kedua ujung edge ini dirender melalui
target yang berbeda — basis data ke Terraform HCL, aplikasi ke manifest
Kubernetes — dan referensi Terraform hanya bermakna di dalam
konfigurasi Terraform. Saat melintasi batas itu, nilai yang dipublikasikan dikirimkan sebagai
teks seperti string lainnya. Konsumen yang dirender di Terraform sebagai Recipe source:,
dalam konfigurasi root yang sama dengan basis data, menerima
referensi yang sama sebagai salah satu argumen modulnya, dan di sana Terraform me-resolve-nya.
Ini adalah aturan umum, bukan kasus khusus untuk RDS: apa pun yang bergantung pada keadaan sistem yang sedang berjalan dinyatakan sebagai penunjuk deterministik yang di-resolve oleh runtime, tidak pernah sebagai nilai yang diambil oleh compiler. Bagian compiler adalah mengirimkan penunjuk itu tanpa diubah. Membuatnya dapat di-resolve di tempat tujuannya adalah tugas penulis Recipe: publikasikan alamat yang dapat digunakan sisi konsumen, atau berikan kedua komponen Recipes yang dirender ke target yang sama.
Memberi instans nama yang dapat di-resolve oleh aplikasi
terraform/postgres-rds menerima yang pertama dari keduanya sebagai opsi yang ditetapkan operator. release-managed-dns.yaml adalah Release terkelola dengan satu tambahan, yaitu nama DNS yang diberikan operator kepada instans:
db: infra: overrides: host: db.internal.example.netRecipe memublikasikan nama itu sebagai host sebagai pengganti referensi Terraform,
dan aplikasi menerimanya:
- name: DB_HOST value: db.internal.example.net| variabel | release-managed.yaml | release-managed-dns.yaml |
|---|---|---|
DB_HOST | ${module.db.address} | db.internal.example.net |
DB_PORT | 5432 | 5432 |
Itulah satu-satunya baris output yang berubah. Recipe tidak menghasilkan record DNS maupun alias untuk nama tersebut, dan build tidak mencarinya: compiler menyalurkannya persis seperti menyalurkan referensi tadi. Mengarahkan db.internal.example.net ke instans setelah instans itu ada — sebuah record di zona DNS milik operator sendiri, yang diarahkan ke alamat instans — adalah tugas operator, di luar Release. Key ini adalah key yang sama yang dibaca oleh realisasi referenced di bawah untuk alamat yang sama; Recipe ini menerimanya sebagai nama polos atau literal IP, dan nilai yang membawa skema, path, user, atau port menghentikan build, karena port adalah infra.port milik Release dan konsumen menyusun koneksinya dari keduanya.
Konsumen yang dirender ke dalam konfigurasi Terraform yang sama dengan basis data
juga menerima nama itu, dan bersamaan dengan itu kehilangan urutan yang diberikan referensi:
Terraform memproses sebuah modul setelah modul yang direferensikannya, dan sebuah nama tidak mereferensikan
apa pun. Menempatkan konsumen itu dalam boundary tersendiri yang berbagi
directory: dengan basis data dan membawa syncWave: yang lebih akhir akan memulihkan urutannya.
External — tidak ada pihak dalam deployment ini yang menjalankan server
helm/postgres-external tidak menyediakan apa pun. Seluruh outputnya adalah satu
Service yang memetakan nama di dalam kluster ke alamat yang disediakan Release:
[… omitted: the Service's apiVersion, kind and metadata — its name, db, and the labels and annotations every rendered document carries]spec: type: ExternalName externalName: postgres.data.example.net ports: - port: 5432Tidak ada StatefulSet, tidak ada volume, tidak ada container — siklus hidup server sepenuhnya berada di luar deployment ini. Alamatnya berasal dari Release:
db: infra: overrides: host: postgres.data.example.net- name: DB_HOST value: postgres.data.example.netMereferensikan sebuah server tidak sama dengan mengambil alihnya. Recipe ini menjangkau server yang tetap dimiliki pihak eksternal; tidak ada apa pun di sini yang membawanya ke bawah pengelolaan deployment, dan tidak ada apa pun di sini yang akan mengubahnya.
Jika alamat dihilangkan, build berhenti dan menyatakannya. Server yang direferensikan memiliki alamat atau tidak memiliki apa pun, sehingga Recipe menolak alih-alih menghasilkan Service yang menjadi alias bagi nama kosong:
[… omitted: what resolving the lockfile prints, the same halt among it, then [CATALOG_ERROR E0033], the Recipe's assertion external_host_supplied, its template position and source, and "error calling fail:"]assertion failed: the Manifest selects the referenced realization ofPostgreSQL, which addresses a server it does not provision, but no address wassupplied: set infra.overrides.host on this component in the Release to the DNSname or IP literal the existing server answers onPerbandingan yang menjadi intinya
Lingkungan aplikasi yang telah dirender, ketiganya berdampingan:
| variabel | dikelola sendiri | terkelola | eksternal |
|---|---|---|---|
POOL_SIZE | 10 | 10 | 10 |
DB_HOST | db-default | ${module.db.address} | postgres.data.example.net |
DB_NAME | appdb | appdb | appdb |
DB_PORT | 5432 | 5432 | 5432 |
DB_PROTOCOL | postgres | postgres | postgres |
DB_USER | appuser | appuser | appuser |
Variabel yang sama, urutan yang sama, setiap kali. Hanya string di balik salah satunya yang berubah. Recipe aplikasi tidak menyebutkan satu pun variabel DB_: Recipe tersebut mengeluarkan apa pun yang di-resolve oleh edge uses, itulah sebabnya satu Recipe dirender tanpa perubahan terhadap ketiga database.
Dan kompiler tidak mengetahui apa sebenarnya string-string tersebut. db-default adalah
nama Service Kubernetes, ${module.db.address} adalah referensi
Terraform, postgres.data.example.net adalah nama DNS — bagi kompiler, ketiganya adalah
tiga string yang dipublikasikan oleh sebuah Recipe di bawah kunci host dan diminta oleh sebuah edge untuk
dikirimkan sebagai DB_HOST. Kompiler tidak memeriksa apakah salah satunya dapat dirutekan, atau
apakah sebuah port berupa angka, atau apakah komponen bernama db adalah database. Kompiler
mencocokkan edge berdasarkan label yang dibawa oleh Component, membaca kunci yang dideklarasikan
oleh kontrak, lalu memindahkan teksnya.
Di mana batasnya
Masing-masing dari ketiga deployment dipilih oleh sebuah pemetaan Ops, dan dokumen developer tidak tersentuh oleh pilihan tersebut. Itulah pemisahan yang ingin dikonkretkan oleh seluruh contoh ini:
- pengembang menyatakan apa yang dibutuhkan aplikasi dari basis data;
- Ops menyatakan terdiri dari apa sebuah database — satu Recipe per realisasi;
- operator menyatakan realisasi mana yang didapat deployment ini, dan menentukan ukurannya.
Tambahkan realisasi keempat besok — cloud yang berbeda, operator yang berbeda, sebuah layanan Compose untuk pekerjaan lokal — dan itu hanyalah satu Recipe lagi yang memublikasikan kunci yang sama, ditambah satu baris Manifest. aggregate.yaml di direktori ini tidak berubah.