NATS — jedna encja Aggregate, dwa cele, opcjonalne uwierzytelnianie
Ten przykład kompiluje pojedynczy serwer komunikatów NATS (pub-sub, request-reply, kolejkowanie) z jednej encji Aggregate utworzonej przez programistę do dwóch realizacji:
- Docker Compose do lokalnego programowania oraz
- syntetyzowana encja helm Recipe uruchamiająca oficjalny obraz upstream
natsbezpośrednio w Kubernetes (bez zewnętrznego chartu).
Syntetyzowana encja helm Recipe to preferowana ścieżka dla Kubernetes: zależy wyłącznie od tagu oficjalnego obrazu zamiast od chartu zewnętrznego dostawcy, a wyrenderowany zestaw zasobów jest dokładnie tym, co deklaruje workload.
Ten sam plik aggregate.yaml steruje obiema. Dla każdej realizacji zmienia się tylko warstwa Recipe wybrana przez
Manifest. Druga encja Aggregate, aggregate-auth.yaml,
pokazuje ten sam serwer z dołączonym poświadczeniem hasła typu inject-value dla
ścieżki Compose; aggregate-helm-synth-auth.yaml dołącza poświadczenie referencyjne
dla syntetyzowanej ścieżki helm.
Pliki
| Plik | Rola |
|---|---|
aggregate.yaml | Intencja programisty: jeden komponent bus typu core/messaging/nats, bez poświadczenia — serwer działa bez uwierzytelniania. |
aggregate-auth.yaml | Ten sam serwer z poświadczeniem hasła typu inject-value dołączonym do opcjonalnego slotu password komponentu (ścieżka Compose). |
aggregate-helm-synth-auth.yaml | Ten sam serwer z poświadczeniem referencyjnym dołączonym dla syntetyzowanej ścieżki helm — wartość jest materializowana jako Secret Kubernetes, do którego odwołuje się Deployment. |
manifest-compose.yaml | Mapuje typ NATS na encję Recipe dla Compose (compose/nats), a poświadczenie na dotenv-secret. |
manifest-helm-synth.yaml | Mapuje typ NATS na syntetyzowaną encję helm Recipe (helm/nats), a poświadczenie na k8s-secret-from-parameter. |
release-compose.yaml / release-helm-synth.yaml | Rekordy operatora dla obu realizacji, bez uwierzytelniania. |
release-compose-auth.yaml / release-helm-synth-auth.yaml | Rekordy operatora włączające uwierzytelnianie. |
Co demonstruje
- Jedna powierzchnia tworzenia, wiele celów. Pojedyncza encja Aggregate jest źródłem prawdy o tym, czym jest stos. Każda encja Manifest mówi, jak go zrealizować.
- Bezstanowy serwer komunikatów. W tym oszczędnym kształcie NATS trasuje tematy w
pamięci z wyłączonym magazynem plikowym JetStream, więc komponent ma typ
server. W Kubernetes syntetyzowana encja Recipe renderuje jednoreplikowy Deployment bez trwałego wolumenu; usługa Compose udostępnia serwer do lokalnego programowania. - Synteza encji Workload (Kubernetes). Syntetyzowana encja helm Recipe deklaruje
Workload — Deployment oraz usługę ClusterIP uruchamiające oficjalny obraz
nats— który provider helm tłumaczy na manifesty Kubernetes bez zewnętrznego chartu. Wyrenderowany zestaw zasobów jest dokładnie tym, co deklaruje Workload. Ponieważ zarówno encja Recipe dla Compose, jak i syntetyzowana encja helm Recipe noszą nazwęnats, encje Manifests odwołują się do nich w zakresie providera jakocompose/natsihelm/nats. - Opcjonalne uwierzytelnianie, w obu przypadkach deterministyczne. Uwierzytelnianie NATS jest domyślnie wyłączone. Gdy nie dołączono poświadczenia, żadna z realizacji nie włącza uwierzytelniania, a render jest identyczny bajt w bajt między uruchomieniami. Gdy poświadczenie jest dołączone, wstrzyknięta wartość włącza uwierzytelnianie użytkownik/hasło w obu realizacjach.
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:
aggrega scaffold --example nats-messagingNastępnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:
cd nats-messagingKompilacja
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:
# Local development (Docker Compose), no authenticationaggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), no authenticationaggrega build --release release-helm-synth.yaml --auto-pull
# The same realizations with authentication enabledaggrega build --release release-compose-auth.yaml --auto-pullaggrega build --release release-helm-synth-auth.yaml --auto-pullWyrenderowane artefakty trafiają do dist/.
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 `nats-messaging`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `nats-messaging` i bez `dir`: zapisuje ono przykład w nowym folderze `nats-messaging`. Następnie wywołaj narzędzie `build` raz dla każdego pliku Release, w tej kolejności — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml` i `release-helm-synth-auth.yaml` — za każdym razem z `workspace_root` ustawionym na `nats-messaging`, `release` ustawionym na ten plik, `auto_pull` ustawionym na true i `write` ustawionym na true. Podaj, które pliki zapisała każda kompilacja; znajdują się w `nats-messaging/dist/`.Uwaga o dostarczaniu poświadczeń
Na ścieżce Compose poświadczenie jest sekretem typu inject-value
(aggregate-auth.yaml): jego wartość jest dostarczana kanałem środowiskowym komponentu,
a serwer jest uruchamiany z flagami uwierzytelniania użytkownik/hasło.
Syntetyzowana ścieżka helm używa poświadczenia referencyjnego
(aggregate-helm-synth-auth.yaml): wartość jest materializowana jako Secret
Kubernetes, Deployment odwołuje się do niego przez env secretKeyRef, a
serwer jest uruchamiany z flagami --user/--pass odczytującymi tę zmienną
środowiskową. Hasło w postaci jawnej nigdy więc nie pojawia się w manifeście
Deployment — tylko w Secret.
Wartość origin w uwierzytelnionych Aggregates jest symbolem zastępczym do celów deweloperskich;
w każdym rzeczywistym wdrożeniu należy dostarczyć prawdziwą wartość ze źródła poświadczeń.