Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

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

В этом примере две возможности — уровень чтения метрик Thanos поверх объектного хранилища и документная база данных, работающая по протоколу MongoDB, — компилируются из одного Aggregate, написанного разработчиком, и каждая размещается в собственной границе из Release.

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

Файлы

ФайлРоль
aggregate.yamlНамерение разработчика: импортирует модуль метрик (core/thanos) и модуль документной базы данных (core/ferretdb).
manifest.yamlСопоставляет каждый тип компонента, который вносят два модуля, с его Recipe synth helm, Feature учётных данных, которую модуль метрик присоединяет, — с реализацией, порождающей Secret из каждого из двух ключевых параметров модуля, а Feature сбора метрик — с её FeatureRecipe.
release.yamlЗапись оператора: направляет каждый модуль в собственную границу, задаёт размер одного компонента одного модуля и присоединяет к нему 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 с этим пространством имён рядом с рабочей нагрузкой, которая его читает.

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