Stos Keycloak — serwer tożsamości oparty na bazie danych, złożony jako moduł
Ten przykład kompiluje mały, rzeczywisty stos — serwer tożsamości oparty na
bazie danych — do syntetyzowanych manifestów Kubernetes z jednej encji
Aggregate napisanej przez programistę.
Serwer tożsamości nie jest pojedynczym komponentem. Jest modułem: wielokrotnie używalnym podagregatem, który składa dwa komponenty z pojedynczym obciążeniem —
- serwer, który obsługuje konsolę konta i punkty końcowe tokenów na swoim porcie HTTP i nie przechowuje lokalnego stanu, oraz
- backend, PostgreSQL, który przechowuje obszary (realms), klientów i użytkowników serwera i utrwala je na wolumenie.
Moduł łączy własną wewnętrzną krawędź od serwera do backendu i
eksportuje serwer jako swój publiczny punkt końcowy http. Encja Aggregate najwyższego poziomu
importuje moduł po nazwie i renderuje złożony stos; operator określa rozmiary
wewnętrznych komponentów modułu w encji Release.
Pliki
| Plik | Rola |
|---|---|
aggregate.yaml | Intencja programisty: importuje moduł serwera tożsamości (core/keycloak). |
manifest-helm-synth.yaml | Mapuje typy serwera i backendu na ich syntetyczne encje Recipes dla Helm, a encję Feature poświadczeń, którą moduł dołącza, na realizację emitującą Secret z parametrów poświadczeń modułu. |
release-helm-synth.yaml | Rekord operatora dla celu Kubernetes. Określa rozmiary wewnętrznych komponentów modułu według ich identyfikatorów w zakresie modułu; wszystko, co pozostawiono domyślnym wartościom schematu, renderuje się samodzielnie. |
Co demonstruje
- Kompozycja jako moduł. Funkcjonalność obejmująca wiele obciążeń — serwer tożsamości, który w rzeczywistości jest serwerem i bazą danych konfiguracji — jest spakowana jako podagregat składający dwa komponenty z pojedynczym obciążeniem, a nie jako jeden monolityczny komponent. Moduł jest importowany po nazwie i używany ponownie wszędzie tam, gdzie potrzebny jest serwer tożsamości.
- Wewnętrzna krawędź wewnątrz modułu. Serwer deklaruje użycie
backendu; host, port, użytkownik i baza danych z
providesencji Recipe backendu są przekazywane do serwera i składane w jego połączenie z bazą danych. Kompilator przekazuje ciągi znaków, nie interpretując ich. - Publiczny punkt końcowy. Moduł eksportuje swój serwer jako
http, stabilną publiczną nazwę, z którą łączy się konsument — niezależną od wewnętrznych nazw komponentów modułu. - Określanie rozmiarów wewnętrznych komponentów przez operatora. Encja Release adresuje wewnętrzne
komponenty modułu według ich identyfikatorów w zakresie modułu (
server.backend,server.server), aby ustawić zasoby obliczeniowe, bez powtarzania fizycznych rozmiarów w encji Aggregate programisty. - Samomigrujący schemat. Serwer przy uruchomieniu sam tworzy i migruje swój schemat w backendzie, więc startuje z gotowym schematem bez osobnego kroku migracji.
- Wspólne poświadczenie, przekazywane przez referencję. Serwer uwierzytelnia się w swoim
backendzie PostgreSQL, więc oba współdzielą jedno hasło. Moduł przyjmuje je jako
parametr
db_passwordi dwukrotnie dołącza z nim encję Feature poświadczeńcore/referenced-secret: do własnego slotu poświadczeń backendu oraz jakocredentialpołączenia serwera z backendem, czyli połączenia, na którym serwer je przedstawia. Każde obciążenie odczytuje hasło z obiektu Secret, zamiast przenosić je bezpośrednio; hasło konta administratora początkowego to drugi parametr,admin_password. Ponieważ moduł dołącza tę encję Feature, encja Manifest ją mapuje. Ten przykład pozostawia oba parametry z domyślnymi wartościami deweloperskimi modułu i mapuje encję Feature nak8s-secret-from-parameter, która emituje Secret zawierający każdą wartość, dzięki czemu stos działa samodzielnie. W przypadku encji Release obsługującej rzeczywisty ruch encja Aggregate deklaruje własne parametry i przekazuje je w dół przezaggregates.server.parameters, encja Release je wypełnia, a encja Manifest mapuje encję Feature nak8s-existing-secret, która odczytuje każdy parametr jako nazwę obiektu Secret istniejącego już w przestrzeni nazw. - Powtarzalne obrazy. Zarówno serwer, jak i backend przypinają jawne tagi obrazów, więc wyrenderowane manifesty odwołują się do stabilnych obrazów.
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 keycloak-stackNastępnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:
cd keycloak-stackKompilacja
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:
aggrega build --release release-helm-synth.yaml --auto-pullWyrenderowane 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 `keycloak-stack`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `keycloak-stack` i bez `dir`: zapisuje ono przykład w nowym folderze `keycloak-stack`. Następnie wywołaj narzędzie `build` z `workspace_root` ustawionym na `keycloak-stack`, `release` ustawionym na `release-helm-synth.yaml`, `auto_pull` ustawionym na true i `write` ustawionym na true. Podaj, które pliki zapisała kompilacja; znajdują się w `keycloak-stack/dist/`.Jak wygląda złożony stos
Serwer renderuje się jako bezstanowy Deployment oraz Service typu ClusterIP na porcie HTTP. Jego kontener zawiera połączenie złożone z krawędzi backendu — nazwę Service backendu w klastrze, użytkownika i bazę danych — oraz samodzielne ustawienia HTTP, punkty końcowe kondycji włączone i obsługiwane na porcie zarządzania, a także konto administratora początkowego, przy czym oba hasła są odczytywane z obiektów Secret:
env: - name: KC_DB_PASSWORD valueFrom: secretKeyRef: name: server-zdserver-db.credential key: db-password - name: KC_BOOTSTRAP_ADMIN_PASSWORD valueFrom: secretKeyRef: name: server-zdserver-admin-password key: admin-password - name: KC_DB value: postgres - name: KC_DB_URL_HOST value: server-zdbackend-default - name: KC_DB_URL_PORT value: "5432" - name: KC_DB_URL_DATABASE value: keycloak - name: KC_DB_USERNAME value: keycloak - name: KC_HTTP_ENABLED value: "true" - name: KC_HOSTNAME_STRICT value: "false" - name: KC_HEALTH_ENABLED value: "true" - name: KC_HTTP_MANAGEMENT_PORT value: "9000" - name: KC_BOOTSTRAP_ADMIN_USERNAME value: adminKontener deklaruje port zarządzania, 9000, obok portu HTTP, a
Deployment sonduje tam serwer: sonda startowa na /health/started wstrzymuje
pozostałe, dopóki serwer się uruchamia, sonda gotowości na /health/ready
odcina ruch, dopóki serwer nie odpowie, a sonda żywotności na /health/live
restartuje go, jeśli przestanie działać. Service nadal przekazuje tylko port HTTP.
Backend renderuje się jako StatefulSet z trwałym wolumenem zamontowanym w
/var/lib/postgresql/data oraz Service typu ClusterIP i Service typu headless. Jego
POSTGRES_PASSWORD odczytuje to samo hasło bazy danych z własnego obiektu Secret,
server-zdbackend-password. Trzy obiekty Secret są emitowane obok obciążeń,
po jednym na każde poświadczenie dołączane przez moduł, a każdy zawiera deweloperską
wartość domyślną modułu.