Stos APISIX — dynamiczna brama API złożona jako moduł
Ten przykład kompiluje mały, rzeczywisty stos — dynamiczną bramę API — do
syntetyzowanych manifestów Kubernetes z jednej encji Aggregate napisanej przez dewelopera.
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
- magazyn, etcd, który przechowuje konfigurację bramy i utrwala ją na woluminie.
Moduł łączy własną wewnętrzną krawędź od bramy do magazynu 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 rozmiar wewnętrznych
komponentów modułu w encji Release.
Pliki
| Plik | Rola |
|---|---|
aggregate.yaml | Intencja dewelopera: importuje moduł bramy API (core/apisix) i przekazuje mu klucz Admin API bramy z własnego parametru. |
manifest-helm-synth.yaml | Mapuje typy bramy i magazynu na ich encje Recipes synth helm, a encję Feature poświadczeń, którą moduł dołącza, na realizację odczytującą Secret już istniejący w przestrzeni nazw. |
release-helm-synth.yaml | Rekord operatora dla celu Kubernetes. Wskazuje Secret zawierający klucz Admin API i określa rozmiar wewnętrznych komponentów modułu według ich identyfikatorów w zakresie modułu; wszystko inne pozostaje przy wartościach domyślnych schematu. |
Co demonstruje
- Kompozycja jako moduł. Możliwość obejmująca wiele obciążeń — brama API, która w rzeczywistości jest proxy plus magazynem 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, gdzie potrzebna jest brama.
- Wewnętrzna krawędź wewnątrz modułu. Brama deklaruje użycie
magazynu; host i port z
providesencji Recipe magazynu są przekazywane do bramy i składane w jej połączenie z etcd. Kompilator przekazuje te ciągi znaków bez ich interpretowania. - 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 przez operatora rozmiaru wewnętrznych komponentów. Encja Release odwołuje się do wewnętrznych
komponentów modułu przez ich identyfikatory w zakresie modułu (
gateway.store,gateway.gateway), aby ustawić zasoby obliczeniowe, bez powtarzania fizycznych rozmiarów w encji Aggregate dewelopera. - Plik konfiguracyjny montowany obok plików zapisywanych w czasie działania. Brama odczytuje konfigurację z pliku w katalogu, do którego również zapisuje przy uruchomieniu. Encja Recipe emituje tę konfigurację jako ConfigMap i montuje ją jako pojedynczy plik, dzięki czemu konfiguruje bramę bez przesłaniania plików, które brama tam zapisuje.
- Klucz Admin API odczytywany z Secret. Brama administruje swoimi trasami
przez Admin API, a jej klucz trafia przez gniazdo poświadczeń bramy,
którego brama wymaga, dopóki nic nie jest podłączone do jej gniazda modeli,
jak tutaj, więc nie istnieje klucz domyślny. Moduł przyjmuje klucz jako
parametr,
admin_key, i dołącza z nim do gniazda encję Feature poświadczeńcore/referenced-secret; ta encja Aggregate deklaruje własny parametr i przekazuje go w dół, a encja Release go wypełnia. Encja Manifest mapuje encję Feature nak8s-existing-secret, więc wartość jest nazwą Secret, który już istnieje w przestrzeni nazw: kompilacja nie odczytuje żadnego klucza ani go nie renderuje, a brama odczytuje klucz z tego Secret przy uruchomieniu. Encja Release, która nie dostarcza wartości, zatrzymuje kompilację, wskazując parametr. - Powtarzalne obrazy. Zarówno brama, jak i magazyn 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 apisix-stackNastępnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:
cd apisix-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.
Przed ich zastosowaniem należy utworzyć w docelowej przestrzeni nazw Secret wskazany przez encję Release, apisix-admin-key,
zawierający własny klucz pod kluczem danych
admin-key. Klucz nie może być pusty, co zatrzymuje bramę przy uruchomieniu,
ani nie może być wartością, którą APISIX odczytuje jako liczbę lub jako true albo false, taką jak
klucz złożony z samych cyfr, ponieważ APISIX wtedy nigdy nie dopasowuje go do klucza, który
przedstawia żądanie.
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 `apisix-stack`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `apisix-stack` i bez `dir`: zapisze ono przykład w nowym folderze `apisix-stack`. Następnie wywołaj narzędzie `build` z `workspace_root` ustawionym na `apisix-stack`, `release` ustawionym na `release-helm-synth.yaml`, `auto_pull` ustawionym na true i `write` ustawionym na true. Powiedz mi, które pliki zapisało budowanie; znajdują się w `apisix-stack/dist/`.Jak wygląda złożony stos
Brama renderuje się jako bezstanowy Deployment plus Service ClusterIP na porcie proxy. Jej konfiguracja jest dostarczana jako ConfigMap montowany jako pojedynczy plik w katalogu conf kontenera; konfiguracja zawiera wewnątrzklastrową nazwę Service magazynu oraz, w miejscu klucza Admin API, nazwę zmiennej środowiskowej, z której APISIX odczytuje klucz podczas wczytywania pliku:
apisix: node_listen: 9080deployment: role: traditional role_traditional: config_provider: etcd admin: [… omitted: the client range the Admin API accepts] admin_key: - name: admin key: ${{APISIX_ADMIN_KEY}} role: admin admin_listen: ip: 0.0.0.0 port: 9180 etcd: host: - "http://gateway-zdstore-default:2379" prefix: "/apisix" timeout: 30Deployment dostarcza tę zmienną z Secret, więc klucz nie pojawia się w żadnym wyrenderowanym pliku:
env: - name: APISIX_ADMIN_KEY valueFrom: secretKeyRef: name: apisix-admin-key key: admin-keyMagazyn renderuje się jako StatefulSet z trwałym woluminem zamontowanym w
/etcd-data, plus Service ClusterIP i headless Service.