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

Стек Keycloak — сервер ідентифікації з базою даних, скомпонований як модуль

Цей приклад компілює невеликий реальний стек — сервер ідентифікації з базою даних — у синтезовані маніфести Kubernetes з одного Aggregate, написаного розробником.

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

  • сервер, який обслуговує консоль облікового запису та ендпоінти токенів на своєму HTTP- порту й не зберігає локального стану, і
  • бекенд, PostgreSQL, який зберігає realms, клієнтів і користувачів сервера та зберігає їх на томі.

Модуль сам прокладає внутрішнє ребро від сервера до бекенда й експортує сервер як свій публічний ендпоінт http. Сутність Aggregate верхнього рівня імпортує модуль за назвою та рендерить скомпонований стек; оператор задає розміри внутрішніх компонентів модуля в сутності Release.

Файли

ФайлРоль
aggregate.yamlНамір розробника: імпортує модуль сервера ідентифікації (core/keycloak).
manifest-helm-synth.yamlЗіставляє типи сервера й бекенда з їхніми синтетичними helm-сутностями Recipes, а Feature облікових даних, яку модуль приєднує, — з реалізацією, що створює Secret з параметрів облікових даних модуля.
release-helm-synth.yamlЗапис оператора для цілі Kubernetes. Задає розміри внутрішніх компонентів модуля за їхніми ідентифікаторами в межах модуля; усе, що залишено на значення за замовчуванням зі схеми, рендериться самодостатньо.

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

  • Композиція як модуль. Можливість із кількома робочими навантаженнями — сервер ідентифікації, який насправді є сервером плюс базою даних конфігурації, — упакована як підагрегат, що компонує два компоненти з одним робочим навантаженням, а не як один монолітний компонент. Модуль імпортується за назвою й повторно використовується всюди, де потрібен сервер ідентифікації.
  • Внутрішнє ребро всередині модуля. Сервер оголошує використання бекенда; хост, порт, користувач і база даних із provides сутності Recipe бекенда передаються в сервер і компонуються в його підключення до бази даних. Компілятор маршрутизує рядки, не інтерпретуючи їх.
  • Публічний ендпоінт. Модуль експортує свій сервер як http — стабільну публічну назву, до якої підключається споживач, незалежну від назв внутрішніх компонентів модуля.
  • Задання розмірів внутрішніх компонентів оператором. Сутність Release звертається до внутрішніх компонентів модуля за їхніми ідентифікаторами в межах модуля (server.backend, server.server), щоб задати обчислювальні ресурси, без повторення фізичних розмірів у сутності Aggregate розробника.
  • Схема, що мігрує сама. Під час запуску сервер створює й мігрує власну схему в бекенді, тож він стартує з готовою схемою без окремого кроку міграції.
  • Спільні облікові дані, передані за посиланням. Сервер автентифікується у своєму бекенді PostgreSQL, тож обидва мають один спільний пароль. Модуль приймає його як параметр db_password і двічі приєднує з ним Feature облікових даних core/referenced-secret: до власного слота облікових даних бекенда та як credential підключення сервера до бекенда — підключення, на якому сервер його пред’являє. Кожне робоче навантаження читає пароль із Secret, а не містить його безпосередньо; пароль початкового облікового запису адміністратора — це другий параметр, admin_password. Оскільки модуль приєднує цю Feature, сутність Manifest її зіставляє. Цей приклад залишає обидва параметри зі значеннями модуля за замовчуванням для розробки й зіставляє Feature з k8s-secret-from-parameter, що створює Secret з кожним значенням, тож стек працює самодостатньо. Для Release з реальним трафіком Aggregate оголошує власні параметри й передає їх униз через aggregates.server.parameters, Release їх заповнює, а Manifest зіставляє Feature з k8s-existing-secret, що читає кожен параметр як назву Secret, який уже існує в просторі імен.
  • Відтворювані образи. І сервер, і бекенд фіксують явні теги образів, тож відрендерені маніфести посилаються на стабільні образи.

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

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

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

Terminal window
aggrega scaffold --example keycloak-stack

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

Terminal window
cd keycloak-stack

Збирання

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

Terminal window
aggrega build --release release-helm-synth.yaml --auto-pull

Відрендерені артефакти потрапляють у dist/. Ціль Kubernetes рендерить звичайні маніфести офлайн — завантаження чарта не потрібне.

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

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

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

Як виглядає скомпонований стек

Сервер рендериться як Deployment без стану плюс Service типу ClusterIP на HTTP-порту. Його контейнер містить підключення, скомпоноване з ребра до бекенда, — назву Service бекенда в кластері, користувача й базу даних, — а також самодостатні налаштування HTTP, увімкнені ендпоінти здоров’я, що обслуговуються на порту керування, і початковий обліковий запис адміністратора; обидва паролі читаються з 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: admin

Контейнер оголошує порт керування, 9000, поряд із HTTP-портом, і Deployment перевіряє сервер саме там: startup-проба на /health/started стримує інші, поки сервер завантажується, readiness-проба на /health/ready не пропускає трафік, доки він не відповідає, а liveness-проба на /health/live перезапускає його, якщо він зупиняється. Service і далі переспрямовує лише HTTP-порт.

Бекенд рендериться як StatefulSet з постійним томом, змонтованим у /var/lib/postgresql/data, плюс Service типу ClusterIP і headless Service. Його POSTGRES_PASSWORD читає той самий пароль бази даних із власного Secret server-zdbackend-password. Три Secrets створюються поряд із робочими навантаженнями — по одному на кожні облікові дані, які приєднує модуль, — і кожен містить значення модуля за замовчуванням для розробки.