Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Routing na granicach modułów — umieszczanie całych podmodułów w granicach

Ten przykład kompiluje dwie funkcjonalności — warstwę odczytu metryk Thanos nad magazynem obiektów oraz bazę dokumentów obsługującą protokół sieciowy MongoDB — z jednej encji Aggregate napisanej przez dewelopera i umieszcza każdą z nich we własnej granicy na podstawie encji Release.

Obie funkcjonalności są modułami: wielokrotnego użytku podagregatami, z których każdy składa kilka komponentów z pojedynczym obciążeniem i łączy własne wewnętrzne krawędzie. Encja Aggregate nazywa oba moduły i nie mówi nic o tym, gdzie działają. Encja Release umieszcza każdy moduł w całości za pomocą jednego wpisu aggregates: na granicę — operator decyduje, gdzie działa funkcjonalność, bez śledzenia ani powtarzania tego, co jest w jej środku.

Pliki

PlikRola
aggregate.yamlIntencja dewelopera: importuje moduł metryk (core/thanos) i moduł bazy dokumentów (core/ferretdb).
manifest.yamlMapuje każdy typ komponentu wnoszony przez oba moduły na jego encję Recipe synth helm, encję Feature poświadczeń, którą moduł metryk dołącza, na realizację emitującą Secret z każdego z dwóch parametrów kluczy modułu, a encję Feature scrapowania na jej encję FeatureRecipe.
release.yamlZapis operatora: kieruje każdy moduł do własnej granicy, określa rozmiar jednego komponentu jednego modułu i dołącza do niego encję Feature scrapowania.

Co demonstruje

  • Kierowanie całego modułu do granicy. Wpis aggregates: granicy jest kluczowany nazwą modułu w encji Aggregate. Umieszcza on każdy komponent, który moduł zawiera, więc wyemitowane artefakty wszystkich trzech komponentów metryk trafiają do granicy observability, a obu komponentów bazy dokumentów do data.
  • Podstawową formą jest nienazywanie żadnych komponentów. Granica data kieruje moduł bazy dokumentów samym wpisem documents: {}. Każdy komponent w nim zostaje umieszczony i przyjmuje własne wartości domyślne schematu; encja Release potrzebuje tylko nazwy modułu i niczego więcej na jego temat.
  • Konfigurowanie kierowanego komponentu przez jego nazwę lokalną. Wpis routingu może też konfigurować poszczególne komponenty kierowanego modułu, adresowane lokalną nazwą, którą każdy z nich nosi w tym module — query, a nie metrics.query, ponieważ w module jest to jego jedyna nazwa. Nazwanie jednego komponentu nie mówi nic o pozostałych: tutaj query otrzymuje rozmiar i cel scrapowania, a magazyn obiektów i brama magazynu są kierowane z wartościami domyślnymi.
  • Kierowany komponent jest komponentem tej granicy. Dziedziczy kaskadę adnotacji granicy jak każdy inny, dzięki czemu każdy zasób kierowanego modułu otrzymuje wartość aggrega.ai/namespace granicy — również komponenty, o których wpis routingu w ogóle nie wspomina.
  • Routing to umieszczenie, a nie inny rodzaj przynależności. Komponent skierowany bez żadnych ustawień renderuje się tak samo jak ten sam komponent nazwany bezpośrednio w tej granicy z pustym ciałem. Te dwa zapisy to dwa sposoby określenia, gdzie komponent należy, a nie dwa zachowania.

Generowanie przykładu

Ten przykład można zbudować za pomocą poniższych poleceń albo zlecić jego zbudowanie asystentowi AI.

Należy zapisać przykład w nowym folderze nazwanym tak jak on:

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

Następnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:

Terminal window
cd module-boundary-routing

Kompilacja

Ta przestrzeń robocza nie zawiera pliku .aggrega-config.yaml, więc encje biblioteki standardowej są rozwiązywane z rejestru hub, hub.aggrega.ai, i flaga katalogu nie jest potrzebna; --auto-pull zapisuje w trakcie kompilacji plik blokady, którego brakuje w świeżym klonie:

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

Wyrenderowane artefakty trafiają do dist/. Cel Kubernetes renderuje zwykłe manifesty offline — pobieranie chartu nie jest wymagane.

Z asystentem AI

Asystent AI skonfigurowany z narzędziami Aggrega może zrobić to samo: wystarczy wkleić mu ten prompt.

Używaj wyłącznie narzędzi Aggrega i nie twórz samodzielnie żadnego folderu. Jeśli folder obszaru roboczego nie zawiera jeszcze folderu `module-boundary-routing`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `module-boundary-routing` i bez `dir`: zapisuje ono przykład w nowym folderze `module-boundary-routing`. Następnie wywołaj narzędzie `build` z `workspace_root` ustawionym na `module-boundary-routing`, `release` ustawionym na `release.yaml`, `auto_pull` ustawionym na true i `write` ustawionym na true. Podaj, które pliki zapisała kompilacja; znajdują się w `module-boundary-routing/dist/`.

Jak wyglądają umieszczone stosy

Pole directory każdej granicy jest katalogiem głównym artefaktów wszystkiego, co w niej umieszczono, więc komponenty obu modułów rozdzielają się na dysku według granicy, która je skierowała:

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

Nazwy plików zawierają tożsamość każdego komponentu z rozpisanym separatorem modułu, ponieważ kropka nie jest znakiem dopuszczalnym w każdej nazwie zasobu — metrics.store w encji Aggregate to metrics-zdstore w klastrze. Składanie modułu jest jedyną rzeczą, która wprowadza separator do tożsamości, więc komponent nazwany bezpośrednio ma taki sam zapis w obu miejscach.

Każdy zasób ma przestrzeń nazw granicy kierującej i zapisuje, która granica go umieściła. Brama magazynu nie jest nazwana we wpisie routingu, a mimo to dziedziczy oba:

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]

To samo dotyczy czterech obiektów Secret, które encja Feature poświadczeń modułu metryk emituje dla pary kluczy magazynu obiektów i pary, którą przedstawia mu brama magazynu: każdy trafia do observability z tą przestrzenią nazw, obok obciążenia, które go odczytuje.

Encja Feature scrapowania dołączona do kierowanego komponentu query renderuje własny artefakt w tej samej granicy, zawierający ustawienia scrapowania operatora:

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