Stack Keycloak — server identitas berbasis database yang disusun sebagai modul
Contoh ini mengompilasi stack kecil yang nyata — sebuah server identitas
berbasis database — menjadi manifest Kubernetes tersintesis dari satu
Aggregate yang ditulis oleh Developer.
Server identitas bukanlah satu komponen tunggal. Ia adalah sebuah modul: sub-aggregate yang dapat digunakan ulang dan menyusun dua komponen dengan satu workload —
- sebuah server yang melayani konsol akun dan endpoint token pada port HTTP-nya dan tidak menyimpan state lokal, dan
- sebuah backend, PostgreSQL, yang menyimpan realm, klien, dan pengguna milik server serta mempersistensikannya pada sebuah volume.
Modul menghubungkan edge internalnya sendiri dari server ke backend dan
mengekspor server sebagai endpoint publiknya http. Aggregate tingkat atas
mengimpor modul berdasarkan nama dan merender stack yang tersusun; operator menentukan ukuran
komponen internal modul di dalam Release.
Berkas
| Berkas | Peran |
|---|---|
aggregate.yaml | Intent Developer: mengimpor modul server identitas (core/keycloak). |
manifest-helm-synth.yaml | Memetakan tipe server dan backend ke Recipes synth helm masing-masing, serta Feature kredensial yang dilampirkan modul ke realisasi yang menghasilkan sebuah Secret dari parameter kredensial modul. |
release-helm-synth.yaml | Catatan operator untuk target Kubernetes. Menentukan ukuran komponen internal modul berdasarkan ID yang dicakup modul; apa pun yang diserahkan ke default skema dirender secara mandiri. |
Apa yang didemonstrasikan
- Komposisi sebagai modul. Sebuah kapabilitas multi-workload — server identitas yang sebenarnya adalah sebuah server ditambah database konfigurasi — dikemas sebagai sub-aggregate yang menyusun dua komponen dengan satu workload, bukan sebagai satu komponen monolitik. Modul diimpor berdasarkan nama dan digunakan ulang di mana pun server identitas dibutuhkan.
- Edge internal di dalam modul. Server mendeklarasikan penggunaan
backend; host, port, user, dan database dari
providesmilik Recipe backend dialirkan ke server dan disusun menjadi koneksi database-nya. Compiler merutekan string tersebut tanpa menafsirkannya. - Endpoint publik. Modul mengekspor server-nya sebagai
http, nama publik yang stabil tempat konsumen terhubung — terpisah dari nama komponen internal modul. - Penentuan ukuran komponen internal oleh operator. Release merujuk komponen internal
modul melalui ID berlingkup modul (
server.backend,server.server) untuk menetapkan compute, tanpa Aggregate milik developer menyatakan ulang ukuran fisik. - Skema yang bermigrasi sendiri. Server menyediakan dan memigrasikan skemanya sendiri saat startup terhadap backend, sehingga ia dimulai dengan skema yang siap tanpa langkah migrasi terpisah.
- Kredensial bersama, diambil melalui referensi. Server melakukan autentikasi ke
backend PostgreSQL-nya, sehingga keduanya berbagi satu kata sandi. Modul menerimanya sebagai
parameter,
db_password, dan melampirkan Feature kredensialcore/referenced-secretdengannya dua kali: ke slot kredensial milik backend sendiri, dan sebagaicredentialdari koneksi server ke backend, yaitu koneksi tempat server menyajikannya. Setiap workload membaca kata sandi dari sebuah Secret alih-alih membawanya secara inline; kata sandi akun admin bootstrap adalah parameter kedua,admin_password. Karena modul melampirkan Feature tersebut, Manifest memetakannya. Contoh ini membiarkan kedua parameter pada nilai default pengembangan milik modul dan memetakan Feature kek8s-secret-from-parameter, yang menghasilkan sebuah Secret yang membawa setiap nilai, sehingga stack berjalan secara mandiri. Untuk Release yang melayani lalu lintas nyata, Aggregate mendeklarasikan parameternya sendiri dan meneruskannya melaluiaggregates.server.parameters, Release memenuhinya, dan Manifest memetakan Feature kek8s-existing-secret, yang membaca setiap parameter sebagai nama sebuah Secret yang sudah ada di namespace. - Image yang dapat direproduksi. Server maupun backend sama-sama menyematkan tag image secara eksplisit, sehingga manifest yang dirender merujuk image yang stabil.
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 keycloak-stackKemudian ia mencetak perintah yang dijalankan berikutnya. Perintah pertama berpindah ke folder baru:
cd keycloak-stackBuild
Workspace ini tidak memuat .aggrega-config.yaml, sehingga entitas pustaka standar di-resolve dari registry hub, hub.aggrega.ai, dan flag katalog tidak diperlukan; --auto-pull menulis lockfile yang tidak dimiliki clone baru selama build:
aggrega build --release release-helm-synth.yaml --auto-pullArtefak yang dirender ditempatkan di bawah dist/. Target Kubernetes merender manifest
biasa secara offline — tidak diperlukan penarikan chart.
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 `keycloak-stack`, panggil alat `scaffold` sekali dengan `example` diatur ke `keycloak-stack` dan tanpa `dir`: alat ini menulis contoh ke folder `keycloak-stack` yang baru. Kemudian panggil alat `build` dengan `workspace_root` diatur ke `keycloak-stack`, `release` diatur ke `release-helm-synth.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 `keycloak-stack/dist/`.Seperti apa stack yang tersusun
Server dirender sebagai Deployment stateless ditambah Service ClusterIP pada port HTTP. Container-nya membawa koneksi yang disusun dari edge backend — nama Service in-cluster milik backend, user, dan database — ditambah pengaturan HTTP mandiri, endpoint kesehatan yang diaktifkan dan dilayani pada port manajemen, serta akun admin bootstrap, dengan kedua kata sandi dibaca dari Secrets:
env: - name: KC_DB_PASSWORD valueFrom: secretKeyRef: name: server-zdserver-db.credential key: db-password - name: KC_BOOTSTRAP_ADMIN_PASSWORD valueFrom: secretKeyRef: name: server-zdserver-admin-password key: admin-password - name: KC_DB value: postgres - name: KC_DB_URL_HOST value: server-zdbackend-default - name: KC_DB_URL_PORT value: "5432" - name: KC_DB_URL_DATABASE value: keycloak - name: KC_DB_USERNAME value: keycloak - name: KC_HTTP_ENABLED value: "true" - name: KC_HOSTNAME_STRICT value: "false" - name: KC_HEALTH_ENABLED value: "true" - name: KC_HTTP_MANAGEMENT_PORT value: "9000" - name: KC_BOOTSTRAP_ADMIN_USERNAME value: adminContainer mendeklarasikan port manajemen, 9000, di samping port HTTP, dan
Deployment memeriksa server di sana: startup probe pada /health/started menahan
probe lainnya selama server melakukan boot, readiness probe pada /health/ready
menjauhkan lalu lintas hingga server merespons, dan liveness probe pada /health/live
me-restart server jika berhenti. Service tetap hanya meneruskan port HTTP.
Backend dirender sebagai StatefulSet dengan persistent volume yang di-mount di
/var/lib/postgresql/data, ditambah Service ClusterIP dan Service headless.
POSTGRES_PASSWORD-nya membaca kata sandi database yang sama dari Secret miliknya sendiri,
server-zdbackend-password. Ketiga Secrets tersebut dihasilkan di samping workload,
satu per kredensial yang dilampirkan modul, masing-masing membawa nilai default
pengembangan milik modul.