Перейти до вмісту
AggregaAggrega
Обрати мову: Українська
Цю сторінку перекладено машинним способом. Читати оригінал англійською.

Grafana — один Aggregate, дві цілі, необов'язковий обліковий запис адміністратора

Цей приклад компілює один сервер дашбордів і візуалізації Grafana з одного написаного розробником Aggregate у дві реалізації:

  • Docker Compose для локальної розробки та
  • синтезований helm Recipe, що запускає офіційний образ grafana/grafana безпосередньо в Kubernetes (без зовнішнього чарту).

Синтезований helm Recipe — це шлях для Kubernetes: він залежить лише від тегу офіційного образу, а не від стороннього чарту, і набір ресурсів, який він рендерить, точно відповідає тому, що оголошує робоче навантаження.

Той самий aggregate.yaml керує обома. Для кожної реалізації змінюється лише шар Recipe, який вибирає Manifest. Ще два Aggregates показують той самий сервер із приєднаними необов’язковими обліковими даними пароля адміністратора: aggregate-auth.yaml для шляху Compose (облікові дані типу inject-value, що передаються як змінна середовища) і aggregate-helm-synth-auth.yaml для синтезованого шляху helm (облікові дані, на які можна посилатися, матеріалізовані як Kubernetes Secret).

Упакований сервер Grafana має ліцензію AGPL-3.0.

Файли

ФайлРоль
aggregate.yamlНамір розробника: один компонент dashboards типу core/observability/grafana, без облікових даних — обліковий запис адміністратора використовує детермінований пароль для розробки з Recipe.
aggregate-auth.yamlТой самий сервер з обліковими даними пароля адміністратора, приєднаними до необов’язкового слота admin_password компонента (шлях Compose).
aggregate-helm-synth-auth.yamlТой самий сервер з обліковими даними, на які можна посилатися, приєднаними для синтезованого шляху helm — значення матеріалізується як Kubernetes Secret, на який посилається Deployment.
manifest-compose.yamlЗіставляє тип Grafana з Recipe для Compose (compose/grafana), а облікові дані — з dotenv-secret.
manifest-helm-synth.yamlЗіставляє тип Grafana із синтезованим helm Recipe (helm/grafana), а облікові дані — з k8s-secret-from-parameter.
release-compose.yaml / release-helm-synth.yamlЗаписи оператора для двох реалізацій, без приєднаних облікових даних.
release-compose-auth.yaml / release-helm-synth-auth.yamlЗаписи оператора, що вмикають автентифікацію.

Що демонструє приклад

  • Одна поверхня написання, багато цілей. Єдиний Aggregate є джерелом істини щодо того, що являє собою стек. Кожен Manifest визначає, як його реалізувати.
  • Сервер на основі постійного тому. Grafana зберігає свій стан — користувачів, збережені дашборди, налаштування — на диску, тому компонент оголошує том даних, розмір якого задає infra.storage. У Kubernetes синтезований helm Recipe рендерить Deployment з PersistentVolumeClaim, змонтованим у /var/lib/grafana; у Compose сервіс монтує іменований том за тим самим шляхом.
  • Синтез Workload (Kubernetes). Синтезований helm Recipe оголошує Workload — Deployment і ClusterIP Service, що запускають офіційний образ grafana/grafana, — який helm-провайдер перетворює на маніфести Kubernetes без зовнішнього чарту. Набір ресурсів, який рендериться, точно відповідає тому, що оголошує Workload. Оскільки і Recipe для Compose, і синтезований helm Recipe мають назву grafana, Manifests посилаються на них з областю провайдера як compose/grafana і helm/grafana.
  • Детермінований пароль адміністратора. Обліковий запис адміністратора Grafana існує завжди. Цей компонент передає пароль через необов’язковий слот облікових даних admin_password: коли облікові дані не приєднано (базовий Aggregate), Recipe задає детермінований пароль для розробки, тож результат рендерингу побайтово однаковий між запусками; коли облікові дані приєднано, впроваджене значення стає паролем адміністратора. У Compose воно передається як змінна середовища GF_SECURITY_ADMIN_PASSWORD; у Kubernetes синтезований шлях helm матеріалізує його як Secret, на який Deployment посилається через env secretKeyRef, тож відкритий текст ніколи не з’являється в маніфесті Deployment.

Що тут не змодельовано

Grafana розгортається окремо. Підключення джерела метрик або логів — наприклад, сервера Prometheus — до Grafana як підготовленого джерела даних не моделюється: компонент не оголошує сокета uses.

Створення прикладу

Цей приклад можна зібрати командами нижче або доручити збирання вашому ШІ-асистенту.

Запишіть приклад у нову теку, названу за ним:

Terminal window
aggrega scaffold --example grafana-dashboards

Потім вона виводить команди, які слід виконати далі. Перша переходить у нову теку:

Terminal window
cd grafana-dashboards

Збирання

Цей робочий простір не містить .aggrega-config.yaml, тож сутності стандартної бібліотеки розв’язуються з реєстру hub, hub.aggrega.ai, і прапорець каталогу не потрібен; --auto-pull під час збирання записує lock-файл, якого бракує свіжому клону:

Terminal window
# Local development (Docker Compose), development admin password
aggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), development admin password
aggrega build --release release-helm-synth.yaml --auto-pull
# The same realizations with authentication enabled
aggrega build --release release-compose-auth.yaml --auto-pull
aggrega build --release release-helm-synth-auth.yaml --auto-pull

Відрендерені артефакти потрапляють у dist/.

З ШІ-асистентом

ШІ-асистент, налаштований з інструментами Aggrega, може зробити те саме: вставте йому цей промпт.

Використовуйте лише інструменти Aggrega і не створюйте жодної папки самостійно. Якщо в папці робочої області ще немає папки `grafana-dashboards`, один раз викличте інструмент `scaffold` зі значенням `example`, встановленим у `grafana-dashboards`, і без `dir`: він записує приклад у нову папку `grafana-dashboards`. Потім викличте інструмент `build` один раз для кожної сутності Release у такому порядку — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml`, `release-helm-synth-auth.yaml` — щоразу з `workspace_root`, встановленим у `grafana-dashboards`, `release`, встановленим у цей файл, `auto_pull`, встановленим у true, і `write`, встановленим у true. Скажіть мені, які файли записала кожна збірка; вони розташовані в `grafana-dashboards/dist/`.

Примітка щодо доставки облікових даних

На шляху Compose облікові дані є секретом типу inject-value (aggregate-auth.yaml): його значення доставляється через канал середовища компонента і стає змінною середовища сервісу GF_SECURITY_ADMIN_PASSWORD.

Синтезований шлях helm використовує облікові дані, на які можна посилатися (aggregate-helm-synth-auth.yaml): значення матеріалізується як Kubernetes Secret, а Deployment посилається на нього через env secretKeyRef, прив’язаний до GF_SECURITY_ADMIN_PASSWORD. Тому пароль у відкритому вигляді ніколи не з’являється в маніфесті Deployment — лише в Secret.

Значення origin в Aggregates з автентифікацією — це заповнювач для розробки; для будь-якого реального розгортання задайте справжнє значення через ваше джерело облікових даних.

Запуск (Compose)

Terminal window
aggrega build --release release-compose.yaml --auto-pull
docker compose -f dist/app/compose/docker-compose.yaml up -d

Відкрийте http://localhost:3000 — вебінтерфейс Grafana — і увійдіть як admin з паролем для розробки. Зупиніть командою docker compose -f dist/app/compose/docker-compose.yaml down.