Стек FerretDB — документна база даних, складена як модуль
Цей приклад компілює невеликий реальний стек — документну базу даних, що надає
протокол MongoDB wire, — у синтезовані маніфести Kubernetes з одного
Aggregate, написаного розробником.
Документна база даних — це не один компонент. Це модуль: повторно використовуваний підагрегат, що складає два компоненти з одним робочим навантаженням кожен —
- проксі, який працює за протоколом MongoDB wire і не зберігає локального стану, та
- бекенд, PostgreSQL 17 з розширенням DocumentDB, який зберігає дані на томі.
Модуль сам з’єднує своє внутрішнє ребро від проксі до бекенду й експортує
проксі як свою публічну точку доступу mongo. Aggregate верхнього рівня імпортує
модуль за назвою і рендерить складений стек; оператор задає розміри внутрішніх
компонентів модуля в сутності Release.
Файли
| Файл | Роль |
|---|---|
aggregate.yaml | Намір розробника: імпортує модуль документної бази даних (core/ferretdb). |
manifest-helm-synth.yaml | Зіставляє типи проксі та бекенду з їхніми синтезованими helm Recipes. |
release-helm-synth.yaml | Запис оператора для цілі Kubernetes. Задає розміри внутрішніх компонентів модуля за їхніми ідентифікаторами в межах модуля; усе, що залишено на значення за замовчуванням зі схеми, рендериться самодостатньо. |
Що демонструє приклад
- Композиція як модуль. Можливість із кількома робочими навантаженнями — документна база даних, яка насправді є проксі плюс бекенд сховища, — упакована як підагрегат, що складає два компоненти з одним робочим навантаженням кожен, а не як один монолітний компонент. Модуль імпортується за назвою і повторно використовується скрізь, де потрібна документна база даних.
- Внутрішнє ребро всередині модуля. Проксі оголошує використання бекенду;
хост, порт, користувач і база даних з
providesсутності Recipe бекенду передаються до проксі й складаються в його з’єднання з PostgreSQL. Компілятор маршрутизує рядки, не інтерпретуючи їх. - Публічна точка доступу. Модуль експортує свій проксі як
mongo— стабільну публічну назву, до якої під’єднується споживач документної бази даних, — відокремлену від назв внутрішніх компонентів модуля. - Задання розмірів внутрішніх компонентів оператором. Release звертається до внутрішніх компонентів модуля за їхніми ідентифікаторами в межах модуля (
database.backend,database.proxy), щоб задати обчислювальні ресурси, без того щоб Aggregate розробника повторював фізичні розміри. - Спільні облікові дані. Проксі делегує автентифікацію своєму бекенду PostgreSQL, тож вони мають один спільний пароль. У цьому прикладі використано спільне вбудоване значення за замовчуванням для розробки, тож стек працює самодостатньо без зовнішнього секрету.
- Рядок з’єднання без пароля. URL з’єднання проксі з PostgreSQL
рендериться без вбудованого пароля; пароль передається окремо через
стандартну змінну середовища libpq
PGPASSWORD, яку драйвер додає до з’єднання. Так облікові дані не потрапляють у рядок з’єднання у відрендереному маніфесті. - Відтворювані образи. І проксі, і бекенд фіксують явні теги образів, тож відрендерені маніфести посилаються на стабільні образи.
Створення прикладу
Цей приклад можна зібрати командами нижче або доручити збирання вашому ШІ-асистенту.
Запишіть приклад у нову теку, названу за ним:
aggrega scaffold --example ferretdb-stackПотім вона виводить команди, які слід виконати далі. Перша переходить у нову теку:
cd ferretdb-stackЗбирання
Цей робочий простір не містить .aggrega-config.yaml, тож сутності стандартної бібліотеки розв’язуються з реєстру hub, hub.aggrega.ai, і прапорець каталогу не потрібен; --auto-pull під час збирання записує lock-файл, якого бракує свіжому клону:
aggrega build --release release-helm-synth.yaml --auto-pullВідрендерені артефакти потрапляють у dist/. Ціль Kubernetes рендерить звичайні
маніфести офлайн — завантаження чарта не потрібне.
З ШІ-асистентом
ШІ-асистент, налаштований з інструментами Aggrega, може зробити те саме: вставте йому цей промпт.
Використовуйте лише інструменти Aggrega і не створюйте жодної папки самостійно. Якщо в папці робочої області ще немає папки `ferretdb-stack`, один раз викличте інструмент `scaffold` зі значенням `example`, встановленим у `ferretdb-stack`, і без `dir`: він записує приклад у нову папку `ferretdb-stack`. Потім викличте інструмент `build` із `workspace_root`, встановленим у `ferretdb-stack`, `release`, встановленим у `release-helm-synth.yaml`, `auto_pull`, встановленим у true, і `write`, встановленим у true. Скажіть мені, які файли записала збірка; вони розташовані в `ferretdb-stack/dist/`.Як виглядає скомпонований стек
Проксі рендериться як Deployment без стану плюс Service типу ClusterIP на wire-порту. Середовище його контейнера містить з’єднання, складене з ребра бекенду, — назву Service бекенду всередині кластера, користувача й базу даних, без пароля в URL, — і тримає налагоджувальний слухач FerretDB на loopback-адресі пода, де жоден інший под до нього не дістається:
env: - name: FERRETDB_LISTEN_ADDR value: :27017 - name: FERRETDB_DEBUG_ADDR value: 127.0.0.1:8088 - name: FERRETDB_POSTGRESQL_URL value: postgres://postgres@database-zdbackend-default:5432/postgres - name: PGPASSWORD value: apppassЖодній із проб цей слухач не потрібен. Проба готовності виконує ferretdb ping
всередині контейнера, що пінгує wire-порт і тим самим також перевіряє з’єднання
з бекендом; проба життєздатності перевіряє лише, що wire-порт приймає
з’єднання, тож збій бекенду виводить проксі з його Service, не
перезапускаючи його:
livenessProbe: tcpSocket: port: 27017readinessProbe: exec: command: - /ferretdb - pingБекенд рендериться як StatefulSet із постійним томом, змонтованим у
/var/lib/postgresql/data, плюс Service типу ClusterIP і headless Service.