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

Маршрутизація меж модулів — розміщення цілих підмодулів у межах

Цей приклад компілює дві можливості — рівень читання метрик Thanos поверх об’єктного сховища та документну базу даних, що підтримує протокол MongoDB, — з одного Aggregate, написаного розробником, і розміщує кожну з них в окремій межі з сутності Release.

Обидві можливості є модулями: багаторазово використовуваними підагрегатами, кожен з яких складається з кількох компонентів з одним робочим навантаженням і сам з’єднує свої внутрішні ребра. Сутність Aggregate називає два модулі й нічого не каже про те, де вони працюють. Сутність Release розміщує кожен модуль цілком одним записом aggregates: на межу — оператор вирішує, де працює можливість, не відстежуючи й не повторюючи того, що є всередині неї.

Файли

ФайлРоль
aggregate.yamlНамір розробника: імпортує модуль метрик (core/thanos) і модуль документної бази даних (core/ferretdb).
manifest.yamlЗіставляє кожен тип компонента, який додають два модулі, з його synth helm Recipe, облікову Feature, яку модуль метрик приєднує, — з реалізацією, що створює Secret з кожного з двох ключових параметрів модуля, а scrape Feature — з її FeatureRecipe.
release.yamlЗапис оператора: спрямовує кожен модуль у власну межу, задає розміри одного компонента одного модуля й приєднує до нього scrape Feature.

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

  • Маршрутизація цілого модуля в межу. Запис aggregates: межі має ключем ім’я модуля в сутності Aggregate. Він розміщує кожен компонент, що міститься в модулі, тож згенеровані артефакти всіх трьох компонентів метрик потрапляють у межу observability, а обидва компоненти документної бази даних — у data.
  • Основна форма — не називати жодного компонента. Межа data спрямовує модуль документної бази даних простим documents: {}. Кожен компонент у ньому розміщується й отримує власні типові значення схеми; сутності Release потрібне лише ім’я модуля і нічого більше про нього.
  • Налаштування спрямованого компонента за його локальним ім’ям. Запис маршрутизації може також налаштовувати окремі компоненти модуля, який він спрямовує, звертаючись до них за локальним ім’ям, яке кожен має всередині цього модуля, — query, а не metrics.query, бо всередині модуля це його єдине ім’я. Називання одного компонента нічого не каже про інші: тут query отримує розміри й ціль збирання метрик, а об’єктне сховище та шлюз сховища спрямовуються з типовими значеннями.
  • Спрямований компонент є компонентом цієї межі. Він успадковує каскад анотацій межі, як і будь-який інший, і саме це дає кожному ресурсу спрямованого модуля значення aggrega.ai/namespace межі — зокрема й компонентам, яких запис маршрутизації ніколи не згадує.
  • Маршрутизація — це розміщення, а не інший вид членства. Компонент, спрямований без жодних уточнень, рендериться так само, як той самий компонент, названий безпосередньо в цій межі з порожнім тілом. Два записи — це два способи сказати, куди належить компонент, а не дві різні поведінки.

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

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

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

Terminal window
aggrega scaffold --example module-boundary-routing

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

Terminal window
cd module-boundary-routing

Збирання

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

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

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

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

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

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

Як виглядають розміщені стеки

directory кожної межі є коренем артефактів для всього, що в ній розміщено, тож компоненти двох модулів розділяються на диску за межею, яка їх спрямувала:

dist/observability/helm/ metrics-zdobjstore, metrics-zdstore, metrics-zdquery
dist/data/helm/ documents-zdproxy, documents-zdbackend

Імена файлів містять ідентичність кожного компонента з виписаним роздільником модуля, бо крапка — не той символ, який може містити будь-яке ім’я ресурсу: metrics.store у сутності Aggregate стає metrics-zdstore у кластері. Лише композиція модуля додає роздільник до ідентичності, тож компонент, названий безпосередньо, записується однаково в обох місцях.

Кожен ресурс має простір імен межі маршрутизації й фіксує, яка межа його розмістила. Шлюз сховища ніколи не називається в записі маршрутизації, але все одно успадковує обидва:

metadata:
name: metrics-zdstore
namespace: observability
[… omitted: the labels every rendered document carries]
annotations:
aggrega.ai/boundary-path: observability
[… omitted: the annotation naming the Recipe that rendered it]

Те саме стосується чотирьох Secret, які облікова Feature модуля метрик створює для пари ключів об’єктного сховища та пари, яку йому пред’являє шлюз сховища: кожен потрапляє в observability з цим простором імен, поруч із робочим навантаженням, яке його читає.

Scrape Feature, приєднана до спрямованого компонента query, рендерить власний артефакт у тій самій межі з налаштуваннями збирання метрик від оператора:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: metrics-zdquery-scrape
[… omitted: the namespace, labels and annotations every rendered document carries]
spec:
selector:
matchLabels:
app.kubernetes.io/name: metrics-zdquery
endpoints:
- port: http
interval: 30s
path: /metrics