Стек Kong — API-шлюз із базою даних, скомпонований як модуль
Цей приклад компілює невеликий реальний стек — API-шлюз із базою даних —
у синтезовані маніфести Kubernetes з одного Aggregate, написаного розробником.
Шлюз не є одним компонентом. Це модуль: багаторазовий підагрегат, що компонує два компоненти з одним робочим навантаженням кожен —
- шлюз, який термінує клієнтський трафік на своєму проксі-порту і не зберігає локального стану, та
- бекенд, PostgreSQL, який зберігає конфігурацію шлюзу і зберігає її на томі.
Модуль сам з’єднує своє внутрішнє ребро від шлюзу до бекенду і
експортує шлюз як свою публічну кінцеву точку proxy. Сутність Aggregate верхнього рівня
імпортує модуль за назвою і рендерить скомпонований стек; оператор задає розміри
внутрішніх компонентів модуля в сутності Release.
Файли
| Файл | Роль |
|---|---|
aggregate.yaml | Намір розробника: імпортує модуль API-шлюзу (core/kong). |
manifest-helm-synth.yaml | Зіставляє типи шлюзу і бекенду з їхніми синтезованими helm Recipes. |
release-helm-synth.yaml | Запис оператора для цілі Kubernetes. Задає розміри внутрішніх компонентів модуля за їхніми ідентифікаторами в межах модуля; усе, що залишено на значення за замовчуванням зі схеми, рендериться самодостатньо. |
Що демонструє приклад
- Композиція як модуль. Можливість із кількома робочими навантаженнями — API-шлюз, який насправді є проксі плюс база даних конфігурації, — упакована як підагрегат, що компонує два компоненти з одним робочим навантаженням кожен, а не як один монолітний компонент. Модуль імпортується за назвою і повторно використовується всюди, де потрібен шлюз.
- Внутрішнє ребро всередині модуля. Шлюз оголошує використання
бекенду; хост, порт, користувач і база даних із
providesсутності Recipe бекенду передаються в шлюз і компонуються в його з’єднання з PostgreSQL. Компілятор маршрутизує рядки, не інтерпретуючи їх. - Публічна кінцева точка. Модуль експортує свій шлюз як
proxy— стабільну публічну назву, до якої підключається споживач, незалежну від назв внутрішніх компонентів модуля. - Задання оператором розмірів внутрішніх компонентів. Сутність Release звертається до внутрішніх
компонентів модуля за їхніми ідентифікаторами в межах модуля (
gateway.backend,gateway.gateway), щоб задати обчислювальні ресурси, без того щоб сутність Aggregate розробника повторювала фізичні розміри. - Крок міграцій, що виконується перед обслуговуванням. Шлюз створює схему своєї бази даних через init-контейнер, який виконується до завершення перед запуском основного контейнера шлюзу, тож шлюз працює з готовою схемою. Початкове налаштування ідемпотентне, тому повторний запуск для вже підготовленої бази даних нічого не змінює.
- Спільні облікові дані. Шлюз автентифікується у своєму бекенді PostgreSQL, тож обидва мають один пароль. У цьому прикладі використано спільне вбудоване значення за замовчуванням для розробки, тож стек працює самодостатньо, без зовнішнього секрету.
- Відтворювані образи. І шлюз, і бекенд фіксують явні теги образів, тож відрендерені маніфести посилаються на стабільні образи.
Створення прикладу
Цей приклад можна зібрати командами нижче або доручити збирання вашому ШІ-асистенту.
Запишіть приклад у нову теку, названу за ним:
aggrega scaffold --example kong-stackПотім вона виводить команди, які слід виконати далі. Перша переходить у нову теку:
cd kong-stackЗбирання
Цей робочий простір не містить .aggrega-config.yaml, тож сутності стандартної бібліотеки розв’язуються з реєстру hub, hub.aggrega.ai, і прапорець каталогу не потрібен; --auto-pull під час збирання записує lock-файл, якого бракує свіжому клону:
aggrega build --release release-helm-synth.yaml --auto-pullВідрендерені артефакти потрапляють у dist/. Ціль Kubernetes рендерить звичайні
маніфести офлайн — завантаження чарта не потрібне.
З ШІ-асистентом
ШІ-асистент, налаштований з інструментами Aggrega, може зробити те саме: вставте йому цей промпт.
Використовуйте лише інструменти Aggrega і не створюйте жодної теки самостійно. Якщо тека робочого простору ще не містить теки `kong-stack`, викличте один раз інструмент `scaffold`, задавши для `example` значення `kong-stack`, без `dir`: він запише приклад у нову теку `kong-stack`. Потім викличте інструмент `build`, задавши для `workspace_root` значення `kong-stack`, для `release` — `release-helm-synth.yaml`, для `auto_pull` — true і для `write` — true. Скажіть, які файли записала збірка; вони розташовані в `kong-stack/dist/`.Як виглядає скомпонований стек
Шлюз рендериться як Deployment без стану плюс Service типу ClusterIP на проксі-порту і ConfigMap зі списком дозволених запитів для його Status API. Його Pod містить init-контейнер міграцій, що виконується перед основним контейнером; обидва отримують з’єднання, скомпоноване з ребра бекенду, — назву Service бекенду всередині кластера, користувача і базу даних:
env: - name: KONG_DATABASE value: postgres - name: KONG_PG_HOST value: gateway-zdbackend-default - name: KONG_PG_PORT value: "5432" - name: KONG_PG_USER value: kong - name: KONG_PG_DATABASE value: kong [… omitted: the gateway's own proxy, admin and status listen addresses, and the allowlist file its Status API includes] - name: KONG_PG_PASSWORD value: apppassПроби готовності та життєздатності шлюзу звертаються до Status API Kong —
GET /status/ready і GET /status — на порту контейнера status, тож цей
слухач прив’язаний до адреси Pod. Kong включає список дозволених запитів із
ConfigMap у власний блок server Status API: з будь-якої адреси, крім loopback-адреси Pod,
він відповідає на GET для /status, /status/ready або /metrics, а
відхиляє будь-який інший запит із 403 — серед них POST /status/ready, який
інакше позначив би шлюз як такий, що завершує роботу, і вивів би його з його Service, доки
він не перезапуститься.
Бекенд рендериться як StatefulSet із постійним томом, змонтованим у
/var/lib/postgresql/data, плюс Service типу ClusterIP і headless Service.