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

MySQL — один Aggregate, дві цілі

Цей мінімалістичний приклад компілює одну базу даних MySQL із сутностей Aggregate, написаних розробником, для двох цілей:

  • Kubernetes через синтез Workload у провайдері helm (StatefulSet, відрендерений безпосередньо на офіційному образі mysql, без зовнішнього чарту), і
  • Docker Compose для локальної розробки.

Кожну ціль визначає той самий намір розробника. Для кожної цілі змінюється лише шар Recipe, який вибирає Manifest.

Файли

ФайлРоль
aggregate-helm-synth.yamlНамір розробника для базового варіанта Kubernetes: один компонент db типу core/datastore/mysql, його значення і лише обов’язковий обліковий секрет root_password.
aggregate-helm-synth-auth.yamlНамір розробника для повного варіанта Kubernetes: обидва слоти облікових секретів, root_password і user_password.
manifest-helm-synth.yamlЗіставляє тип MySQL із синтезованою сутністю Recipe для helm (helm/mysql), а кожен обліковий секрет — з його FeatureRecipe (env-secret, k8s-secret-from-parameter).
release-helm-synth.yamlЗапис оператора для базового варіанта Kubernetes з операційними розмірами (engine_version, storage).
release-helm-synth-auth.yamlЗапис оператора для повного варіанта Kubernetes.
aggregate.yamlНамір розробника для локальної цілі Compose: той самий компонент db, обидва слоти облікових секретів якого передаються як облікові секрети inject-value.
manifest-compose.yamlЗіставляє тип MySQL із сутністю Recipe для Compose (mysql), а обліковий секрет — з dotenv-secret.
release-compose.yamlЗапис оператора для локальної цілі Compose, зокрема специфічний для провайдера запис infra.overrides, що фіксує точний образ контейнера.

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

  • Одна поверхня написання, багато цілей. Aggregate є джерелом істини щодо того, що являє собою стек. Кожен Manifest визначає, як його реалізувати.
  • Синтез Workload у Kubernetes (рекомендовано). Сутність Recipe helm/mysql оголошує агностичний щодо можливостей Workload з form: stateful; провайдер helm синтезує StatefulSet, ClusterIP Service, Headless Service (стабільна мережева ідентичність StatefulSet) і volumeClaimTemplate для каталогу даних. Середовище контейнера містить MYSQL_DATABASE, MYSQL_USER, MYSQL_ROOT_PASSWORD і MYSQL_PASSWORD. Набір символів і правила зіставлення передаються як аргументи командного рядка сервера mysqld (--character-set-server, --collation-server), оскільки офіційний образ mysql приймає їх як прапорці сервера, а не як змінні середовища.
  • Синтез Workload у Compose. Сутність Recipe для Compose оголошує агностичний щодо можливостей Workload; провайдер compose синтезує сервіс docker-compose.yaml з образом MySQL, його середовищем, іменованим томом даних і перевіркою стану.
  • Запасний вихід для оператора. Сутність Compose release задає infra.overrides.image, відкритий стовп для специфічних для провайдера фактів, яких не називає власна схема сутності Component, і згенерований сервіс запускає саме це посилання на образ. Див. Provider-specific overrides (перевизначення, специфічні для Provider).
  • Модель облікових секретів із двома слотами. Паролі є вкладеннями у стовпі features: компонента, кожен — сутність Feature з міткою feature.aggrega.ai/kind: secret, окремо від прикладних values. featuresSchema сутності Component оголошує слот Black-Box root_password і прозорий слот user_password.

Передавання облікових секретів у Kubernetes

root_password — слот Black-Box (inject: []): передаванням керує сутність Recipe. Приєднаний обліковий секрет inject-value кладе значення в канал inject компонента, а Recipe зчитує його як .context.inject.env.MYSQL_ROOT_PASSWORD, видаючи звичайну змінну середовища контейнера. Kubernetes Secret для нього не генерується.

user_password — прозорий слот (inject: [env, file]). Повний варіант приєднує обліковий секрет, на який можна посилатися: він матеріалізує Kubernetes Secret і публікує його ідентичність; сутність Recipe посилається на слот через containers.attachments, що синтезатор рендерить як env secretKeyRef. Згенерований Secret і посилання контейнера називають той самий ресурс, оскільки обидва зчитують .features.user_password.provides.name. Залишити user_password неприєднаним (базовий варіант) теж допустимо: Recipe повертається до вбудованого значення для розробки (MYSQL_PASSWORD: apppass), і Secret не генерується, тож мінімальне розгортання все одно рендериться і працює.

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

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

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

Terminal window
aggrega scaffold --example mysql-standalone

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

Terminal window
cd mysql-standalone

Збирання

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

Terminal window
# Kubernetes — synthesized helm StatefulSet (base: root credential only)
aggrega build --release release-helm-synth.yaml --auto-pull
# Kubernetes — synthesized helm StatefulSet (full: both credential slots)
aggrega build --release release-helm-synth-auth.yaml --auto-pull
# Local development (Docker Compose)
aggrega build --release release-compose.yaml --auto-pull

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

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

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

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

Визначення розмірів оператором

Сутності Release для Kubernetes заповнюють стовп операційних розмірів для кожного середовища: тег образу контейнера береться з infra.engine_version (mysql:8.4), а запит і клас сховища volumeClaimTemplate — з infra.storage. Aggregate розробника ніколи не містить цих полів.

Перевизначення, специфічні для Provider

Стовпи розмірів — це іменовані поля: сутність Component оголошує engine_version і storage, тож оператор, задаючи будь-яке з них, заповнює поле, яке Component передбачив. infra.overrides — стовп для того, чого Component не може передбачити: він оголошений як об’єкт, що приймає будь-яку вкладену структуру, і кожна сутність Recipe документує, які ключі вона зчитує.

release-compose.yaml використовує його. Сутність Recipe для Compose зчитує один ключ, image, і коли його задано, контейнер запускає саме це посилання замість того, яке Recipe складає з engine_version:

infra:
engine_version: "8.4"
overrides:
image: "registry.internal.example/library/mysql:8.4"

Відрендерений сервіс містить перевизначення дослівно:

services:
db:
image: registry.internal.example/library/mysql:8.4
[… omitted: the service's environment, labels, volume, network and health check]

Це шлях до збірки тієї самої версії сервера з дзеркала реєстру або із зафіксованим дайджестом — факту розгортання, що належить цільовому середовищу, а не контракту сутності Component. Оскільки набір ключів визначається для кожної Recipe, а не для кожного Component, саме в Recipe слід шукати, які ключі застосовуються: Recipe для Compose тут зчитує image, а Recipe, що не зчитує жодного, так і зазначає.