Stos Kong — brama API oparta na bazie danych, złożona jako moduł
Ten przykład kompiluje mały, rzeczywisty stos — bramę API opartą na bazie danych —
do syntetyzowanych manifestów Kubernetes z jednej encji Aggregate utworzonej przez programistę.
Brama nie jest pojedynczym komponentem. Jest modułem: wielokrotnego użytku podagregatem, który składa dwa komponenty z pojedynczym obciążeniem —
- bramę, która kończy ruch klientów na swoim porcie proxy i nie przechowuje lokalnego stanu, oraz
- backend, PostgreSQL, który przechowuje konfigurację bramy i utrwala ją na wolumenie.
Moduł łączy własną wewnętrzną krawędź od bramy do backendu i
eksportuje bramę jako swój publiczny punkt końcowy proxy. 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ł bramy API (core/kong). |
manifest-helm-synth.yaml | Mapuje typy bramy i backendu na odpowiadające im syntetyzowane encje Recipes dla Helm. |
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ń — brama API, która w rzeczywistości jest proxy wraz z 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 ponownie używany wszędzie, gdzie potrzebna jest brama.
- Wewnętrzna krawędź w module. Brama deklaruje użycie
backendu; host, port, użytkownik i baza danych z
providesencji Recipe backendu są przekazywane do bramy i składane w jej połączenie z PostgreSQL. Kompilator przekazuje ciągi znaków, nie interpretując ich. - Publiczny punkt końcowy. Moduł eksportuje swoją bramę jako
proxy, 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 (
gateway.backend,gateway.gateway), aby ustawić zasoby obliczeniowe, bez powtarzania fizycznych rozmiarów w encji Aggregate programisty. - Krok migracji uruchamiany przed obsługą ruchu. Brama tworzy schemat swojej bazy danych za pomocą kontenera init, który wykonuje się do końca, zanim uruchomi się główny kontener bramy, dzięki czemu brama działa na gotowym schemacie. Inicjalizacja jest idempotentna, więc ponowne uruchomienie na już przygotowanej bazie danych nic nie zmienia.
- Współdzielone poświadczenie. Brama uwierzytelnia się w swoim backendzie PostgreSQL, więc oba komponenty współdzielą jedno hasło. Ten przykład używa współdzielonej, wpisanej bezpośrednio wartości domyślnej dla środowiska deweloperskiego, więc stos działa samodzielnie, bez zewnętrznego sekretu.
- Powtarzalne obrazy. Zarówno brama, 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 kong-stackNastępnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:
cd kong-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 `kong-stack`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `kong-stack` i bez `dir`: zapisuje ono przykład w nowym folderze `kong-stack`. Następnie wywołaj narzędzie `build` z `workspace_root` ustawionym na `kong-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 `kong-stack/dist/`.Jak wygląda złożony stos
Brama renderuje się jako bezstanowy Deployment wraz z usługą ClusterIP Service na porcie proxy oraz ConfigMap zawierającym listę dozwolonych żądań jej Status API. Jej Pod zawiera kontener init z migracjami, uruchamiany przed głównym kontenerem; oba otrzymują połączenie złożone z krawędzi backendu — nazwę usługi Service backendu w klastrze, użytkownika i bazę danych:
env: - name: KONG_DATABASE value: postgres - name: KONG_PG_HOST value: gateway-zdbackend-default - name: KONG_PG_PORT value: "5432" - name: KONG_PG_USER value: kong - name: KONG_PG_DATABASE value: kong [… omitted: the gateway's own proxy, admin and status listen addresses, and the allowlist file its Status API includes] - name: KONG_PG_PASSWORD value: apppassSondy gotowości i żywotności bramy odpytują Status API Konga —
GET /status/ready i GET /status — na porcie kontenera status, dlatego ten
listener jest powiązany z adresem Poda. Kong dołącza listę dozwolonych żądań z
ConfigMap do bloku serwera samego Status API: z dowolnego adresu poza adresem
loopback Poda odpowiada na GET dla /status, /status/ready lub /metrics, a
każde inne żądanie odrzuca kodem 403 — w tym POST /status/ready, które
w przeciwnym razie oznaczyłoby bramę jako wygaszaną i wyłączyło ją z jej usługi Service aż do
ponownego uruchomienia.
Backend renderuje się jako StatefulSet z trwałym wolumenem zamontowanym w
/var/lib/postgresql/data, wraz z usługą ClusterIP Service i usługą headless Service.