Grafana — satu Aggregate, dua target, kredensial admin opsional
Contoh ini mengompilasi satu server dasbor dan visualisasi Grafana dari satu Aggregate yang ditulis oleh Developer ke dua realisasi:
- Docker Compose untuk pengembangan lokal, dan
- Recipe helm tersintesis yang menjalankan image upstream resmi
grafana/grafanalangsung di Kubernetes (tanpa chart eksternal).
Recipe helm tersintesis adalah jalur Kubernetes: Recipe ini hanya bergantung pada tag image resmi, bukan chart pihak ketiga, dan kumpulan resource yang dirender persis sama dengan yang dideklarasikan workload.
aggregate.yaml yang sama menggerakkan keduanya. Hanya lapisan Recipe yang dipilih oleh
Manifest yang berubah per realisasi. Dua Aggregates lainnya menunjukkan server yang sama
dengan kredensial kata sandi admin opsional terpasang: aggregate-auth.yaml untuk
jalur Compose (kredensial inject-value yang dimunculkan sebagai variabel
lingkungan), dan aggregate-helm-synth-auth.yaml untuk jalur helm tersintesis
(kredensial yang dapat dirujuk dan diwujudkan sebagai Secret Kubernetes).
Server Grafana yang dikemas berlisensi AGPL-3.0.
Berkas
| Berkas | Peran |
|---|---|
aggregate.yaml | Maksud Developer: satu komponen dashboards bertipe core/observability/grafana, tanpa kredensial — akun admin menggunakan kata sandi pengembangan deterministik dari Recipe. |
aggregate-auth.yaml | Server yang sama dengan kredensial kata sandi admin yang dipasang pada slot opsional admin_password milik komponen (jalur Compose). |
aggregate-helm-synth-auth.yaml | Server yang sama dengan kredensial yang dapat dirujuk, dipasang untuk jalur helm tersintesis — nilainya diwujudkan sebagai Secret Kubernetes yang dirujuk oleh Deployment. |
manifest-compose.yaml | Memetakan tipe Grafana ke Recipe Compose (compose/grafana) dan kredensial ke dotenv-secret. |
manifest-helm-synth.yaml | Memetakan tipe Grafana ke Recipe helm tersintesis (helm/grafana) dan kredensial ke k8s-secret-from-parameter. |
release-compose.yaml / release-helm-synth.yaml | Catatan operator untuk kedua realisasi, tanpa kredensial terpasang. |
release-compose-auth.yaml / release-helm-synth-auth.yaml | Catatan operator yang mengaktifkan autentikasi. |
Apa yang didemonstrasikan
- Satu permukaan penulisan, banyak target. Satu Aggregate menjadi sumber kebenaran tentang apa stack tersebut. Setiap Manifest menyatakan bagaimana merealisasikannya.
- Server yang didukung volume persisten. Grafana menyimpan statusnya — pengguna,
dasbor tersimpan, preferensi — di disk, sehingga komponen mendeklarasikan volume
data yang ukurannya diambil dari
infra.storage. Di Kubernetes, Recipe helm tersintesis merender sebuah Deployment dengan PersistentVolumeClaim yang di-mount di/var/lib/grafana; di Compose, service me-mount volume bernama pada path yang sama. - Sintesis Workload (Kubernetes). Recipe helm tersintesis mendeklarasikan sebuah
Workload — Deployment beserta Service ClusterIP yang menjalankan image resmi
grafana/grafana— yang diterjemahkan oleh provider helm menjadi manifest Kubernetes tanpa chart eksternal. Kumpulan resource yang dirender persis sama dengan yang dideklarasikan Workload. Karena Recipe Compose dan Recipe helm tersintesis sama-sama bernamagrafana, Manifests merujuk keduanya dengan cakupan provider sebagaicompose/grafanadanhelm/grafana. - Kata sandi admin deterministik. Akun admin Grafana selalu
ada. Komponen ini menyalurkan kata sandi melalui slot kredensial opsional
admin_password: jika tidak ada kredensial yang dipasang (Aggregate dasar), Recipe menetapkan kata sandi pengembangan deterministik, sehingga hasil render identik byte demi byte di setiap eksekusi; jika kredensial dipasang, nilai yang diinjeksikan menjadi kata sandi admin. Di Compose, nilai itu muncul sebagai variabel lingkunganGF_SECURITY_ADMIN_PASSWORD; di Kubernetes, jalur helm tersintesis mewujudkannya sebagai Secret yang dirujuk Deployment melalui envsecretKeyRef, sehingga teks polosnya tidak pernah muncul di manifest Deployment.
Tidak dimodelkan di sini
Grafana di-deploy secara mandiri. Menghubungkan sumber metrik atau log — misalnya server Prometheus — ke Grafana sebagai datasource yang diprovisikan tidak dimodelkan: komponen ini tidak mendeklarasikan socket uses.
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 grafana-dashboardsKemudian ia mencetak perintah yang dijalankan berikutnya. Perintah pertama berpindah ke folder baru:
cd grafana-dashboardsBuild
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:
# Local development (Docker Compose), development admin passwordaggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), development admin passwordaggrega build --release release-helm-synth.yaml --auto-pull
# The same realizations with authentication enabledaggrega build --release release-compose-auth.yaml --auto-pullaggrega build --release release-helm-synth-auth.yaml --auto-pullArtefak yang dirender ditempatkan di bawah dist/.
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 `grafana-dashboards`, panggil alat `scaffold` sekali dengan `example` diatur ke `grafana-dashboards` dan tanpa `dir`: alat ini menulis contoh ke dalam folder `grafana-dashboards` yang baru. Lalu panggil alat `build` sekali untuk setiap Release, dengan urutan ini — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml`, `release-helm-synth-auth.yaml` — setiap kali dengan `workspace_root` diatur ke `grafana-dashboards`, `release` diatur ke file tersebut, `auto_pull` diatur ke true, dan `write` diatur ke true. Beri tahu saya file mana yang ditulis oleh setiap build; file tersebut berada di bawah `grafana-dashboards/dist/`.Catatan pengiriman kredensial
Pada jalur Compose, kredensial berupa secret inject-value
(aggregate-auth.yaml): nilainya dikirim melalui pipa lingkungan komponen
dan menjadi variabel lingkungan service GF_SECURITY_ADMIN_PASSWORD.
Jalur helm tersintesis menggunakan kredensial yang dapat dirujuk
(aggregate-helm-synth-auth.yaml): nilainya diwujudkan sebagai Secret
Kubernetes, dan Deployment merujuknya melalui env secretKeyRef yang terikat ke
GF_SECURITY_ADMIN_PASSWORD. Karena itu, kata sandi teks polos tidak pernah muncul di
manifest Deployment — hanya di Secret.
Nilai origin dalam Aggregates yang terautentikasi adalah placeholder pengembangan;
berikan nilai sebenarnya melalui sumber kredensial Anda untuk deployment nyata apa pun.
Menjalankannya (Compose)
aggrega build --release release-compose.yaml --auto-pulldocker compose -f dist/app/compose/docker-compose.yaml up -dBuka http://localhost:3000 — UI web Grafana — dan masuk sebagai admin dengan
kata sandi pengembangan. Hentikan dengan
docker compose -f dist/app/compose/docker-compose.yaml down.