Stack FerretDB — basis data dokumen yang disusun sebagai modul
Contoh ini mengompilasi sebuah stack kecil yang nyata — sebuah basis data dokumen yang mengekspos
protokol wire MongoDB — menjadi manifest Kubernetes yang disintesis dari satu
Aggregate yang ditulis oleh Developer.
Basis data dokumen ini bukan satu komponen tunggal. Ia adalah sebuah modul: sub-agregat yang dapat digunakan ulang dan menyusun dua komponen ber-workload tunggal —
- sebuah proxy yang berbicara dengan protokol wire MongoDB dan tidak menyimpan state lokal, dan
- sebuah backend, PostgreSQL 17 dengan ekstensi DocumentDB, yang menyimpan data secara persisten pada sebuah volume.
Modul ini menghubungkan edge internalnya sendiri dari proxy ke backend dan mengekspor
proxy sebagai endpoint publiknya mongo. 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 basis data dokumen (core/ferretdb). |
manifest-helm-synth.yaml | Memetakan tipe proxy dan backend ke Recipes helm sintesisnya. |
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. Kapabilitas multi-workload — basis data dokumen yang sebenarnya adalah proxy ditambah backend penyimpanan — dikemas sebagai sub-agregat yang menyusun dua komponen ber-workload tunggal, bukan sebagai satu komponen monolitik. Modul ini diimpor berdasarkan nama dan digunakan ulang di mana pun basis data dokumen dibutuhkan.
- Edge internal di dalam modul. Proxy mendeklarasikan penggunaan backend;
host, port, user, dan database dari
providesRecipe backend dialirkan ke proxy dan disusun menjadi koneksi PostgreSQL-nya. Compiler merutekan string tersebut tanpa menafsirkannya. - Endpoint publik. Modul mengekspor proxy-nya sebagai
mongo, nama publik yang stabil yang dihubungkan oleh konsumen basis data dokumen — terlepas dari nama komponen internal modul. - Penentuan ukuran komponen internal oleh operator. Release merujuk komponen internal modul berdasarkan ID yang dicakup modul (
database.backend,database.proxy) untuk mengatur komputasi, tanpa Aggregate milik developer menyatakan ulang ukuran fisik. - Kredensial bersama. Proxy mendelegasikan autentikasi ke backend PostgreSQL-nya, sehingga keduanya berbagi satu kata sandi. Contoh ini menggunakan default pengembangan inline bersama, sehingga stack berjalan secara mandiri tanpa secret eksternal.
- String koneksi tanpa kata sandi. URL koneksi PostgreSQL milik proxy
dirender tanpa kata sandi yang disematkan; kata sandi diberikan secara terpisah melalui
variabel lingkungan libpq standar
PGPASSWORD, yang digabungkan oleh driver ke dalam koneksi. Hal ini menjaga kredensial tetap berada di luar string koneksi dalam manifest yang dirender. - Image yang dapat direproduksi. Baik proxy maupun backend menetapkan tag image 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 ferretdb-stackKemudian ia mencetak perintah yang dijalankan berikutnya. Perintah pertama berpindah ke folder baru:
cd ferretdb-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 `ferretdb-stack`, panggil alat `scaffold` sekali dengan `example` diatur ke `ferretdb-stack` dan tanpa `dir`: alat ini menulis contoh ke dalam folder `ferretdb-stack` yang baru. Lalu panggil alat `build` dengan `workspace_root` diatur ke `ferretdb-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 `ferretdb-stack/dist/`.Seperti apa stack yang tersusun
Proxy dirender sebagai Deployment stateless ditambah Service ClusterIP pada port wire. Lingkungan kontainernya membawa koneksi yang disusun dari edge backend — nama Service in-cluster, user, dan database milik backend, tanpa kata sandi di URL — dan mempertahankan listener debug FerretDB pada alamat loopback pod, yang tidak dapat dijangkau oleh pod lain:
env: - name: FERRETDB_LISTEN_ADDR value: :27017 - name: FERRETDB_DEBUG_ADDR value: 127.0.0.1:8088 - name: FERRETDB_POSTGRESQL_URL value: postgres://postgres@database-zdbackend-default:5432/postgres - name: PGPASSWORD value: apppassKedua probe tidak membutuhkan listener tersebut. Probe readiness menjalankan ferretdb ping
di dalam kontainer, yang melakukan ping ke port wire sehingga sekaligus membuktikan koneksi
backend; probe liveness hanya memeriksa bahwa port wire menerima
koneksi, sehingga gangguan backend mengeluarkan proxy dari Service-nya tanpa
me-restart-nya:
livenessProbe: tcpSocket: port: 27017readinessProbe: exec: command: - /ferretdb - pingBackend dirender sebagai StatefulSet dengan volume persisten yang di-mount pada
/var/lib/postgresql/data, ditambah Service ClusterIP dan Service headless.