Стек APISIX — динамічний API-шлюз, скомпонований як модуль
Цей приклад компілює невеликий реальний стек — динамічний API-шлюз — у
синтезовані маніфести Kubernetes з одного Aggregate, створеного розробником.
Шлюз не є одним компонентом. Це модуль: багаторазовий підагрегат, що компонує два компоненти з одним робочим навантаженням кожен —
- шлюз, який термінує клієнтський трафік на своєму проксі-порту і не зберігає локального стану, та
- сховище, etcd, яке зберігає конфігурацію шлюзу і записує її на том.
Модуль сам з’єднує своє внутрішнє ребро від шлюзу до сховища та експортує
шлюз як свою публічну кінцеву точку proxy. Aggregate верхнього рівня імпортує
модуль за назвою і рендерить скомпонований стек; оператор задає розміри внутрішніх
компонентів модуля в сутності Release.
Файли
| Файл | Роль |
|---|---|
aggregate.yaml | Намір розробника: імпортує модуль API-шлюзу (core/apisix) і передає йому ключ Admin API шлюзу з власного параметра. |
manifest-helm-synth.yaml | Зіставляє типи шлюзу та сховища з їхніми Recipes synth helm, а Feature облікових даних, яку модуль приєднує, — з реалізацією, що читає Secret, який уже існує в просторі імен. |
release-helm-synth.yaml | Операторський запис для цілі Kubernetes. Називає Secret, що містить ключ Admin API, і задає розміри внутрішніх компонентів модуля за їхніми ідентифікаторами в межах модуля; усе інше визначають типові значення схеми. |
Що демонструє приклад
- Композиція як модуль. Можливість із кількома робочими навантаженнями — API-шлюз, який насправді є проксі плюс сховищем конфігурації, — упаковано як підагрегат, що компонує два компоненти з одним робочим навантаженням, а не як один монолітний компонент. Модуль імпортують за назвою і повторно використовують усюди, де потрібен шлюз.
- Внутрішнє ребро всередині модуля. Шлюз оголошує використання
сховища; хост і порт із
providesсутності Recipe сховища передаються в шлюз і складаються в його з’єднання з etcd. Компілятор маршрутизує рядки, не інтерпретуючи їх. - Публічна кінцева точка. Модуль експортує свій шлюз як
proxy— стабільну публічну назву, до якої підключається споживач, незалежну від назв внутрішніх компонентів модуля. - Задання розмірів внутрішніх компонентів оператором. Release звертається до внутрішніх
компонентів модуля за їхніми ідентифікаторами в межах модуля (
gateway.store,gateway.gateway), щоб задати обчислювальні ресурси, і Aggregate розробника не мусить повторювати фізичні розміри. - Файл конфігурації, змонтований поряд із файлами, що записуються під час виконання. Шлюз читає свою конфігурацію з файлу в каталозі, у який він також записує під час запуску. Recipe видає цю конфігурацію як ConfigMap і монтує її як окремий файл, тож вона конфігурує шлюз, не приховуючи файлів, які шлюз туди записує.
- Ключ Admin API, прочитаний із Secret. Шлюз керує своїми маршрутами
через Admin API, а його ключ надходить через слот облікових даних шлюзу,
який шлюз вимагає, поки до його сокета models нічого не під’єднано, як тут,
тож типового ключа немає. Модуль приймає ключ як
параметр,
admin_key, і з ним приєднує до слота Feature облікових данихcore/referenced-secret; цей Aggregate оголошує власний параметр і передає його вниз, а Release надає його значення. Manifest зіставляє Feature зk8s-existing-secret, тож значенням є назва Secret, який уже існує в просторі імен: збирання не читає жодного ключа й не рендерить його, а шлюз читає ключ із цього Secret під час запуску. Release, який не надає значення, зупиняє збирання з назвою параметра. - Відтворювані образи. І шлюз, і сховище фіксують явні теги образів, тож відрендерені маніфести посилаються на стабільні образи.
Створення прикладу
Цей приклад можна зібрати командами нижче або доручити збирання вашому ШІ-асистенту.
Запишіть приклад у нову теку, названу за ним:
aggrega scaffold --example apisix-stackПотім вона виводить команди, які слід виконати далі. Перша переходить у нову теку:
cd apisix-stackЗбирання
Цей робочий простір не містить .aggrega-config.yaml, тож сутності стандартної бібліотеки розв’язуються з реєстру hub, hub.aggrega.ai, і прапорець каталогу не потрібен; --auto-pull під час збирання записує lock-файл, якого бракує свіжому клону:
aggrega build --release release-helm-synth.yaml --auto-pullВідрендерені артефакти потрапляють у dist/. Ціль Kubernetes рендерить звичайні
маніфести офлайн — завантаження чарта не потрібне.
Перш ніж застосовувати їх, створіть у цільовому просторі імен Secret, який називає Release, apisix-admin-key,
що містить ваш власний ключ під ключем даних
admin-key. Ключ не має бути порожнім, бо це зупиняє шлюз під час запуску,
і не має бути значенням, яке APISIX читає як число або як true чи false, наприклад
ключем лише з цифр, бо тоді APISIX ніколи не зіставляє його з ключем, який
пред’являє запит.
З ШІ-асистентом
ШІ-асистент, налаштований з інструментами Aggrega, може зробити те саме: вставте йому цей промпт.
Використовуйте лише інструменти Aggrega і не створюйте жодної теки самостійно. Якщо тека робочого простору ще не містить теки `apisix-stack`, викличте один раз інструмент `scaffold`, задавши для `example` значення `apisix-stack` і не задаючи `dir`: він запише приклад у нову теку `apisix-stack`. Потім викличте інструмент `build`, задавши для `workspace_root` значення `apisix-stack`, для `release` — `release-helm-synth.yaml`, для `auto_pull` — true і для `write` — true. Скажіть мені, які файли записала збірка; вони лежать у `apisix-stack/dist/`.Як виглядає скомпонований стек
Шлюз рендериться як Deployment без стану плюс Service типу ClusterIP на проксі-порту. Його конфігурація постачається як ConfigMap, змонтований як окремий файл у каталог conf контейнера; конфігурація містить внутрішньокластерну назву Service сховища, а там, де має бути ключ Admin API, — назву змінної середовища, з якої APISIX читає ключ, коли завантажує файл:
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 передає цю змінну із Secret, тож ключ не з’являється в жодному відрендереному файлі:
env: - name: APISIX_ADMIN_KEY valueFrom: secretKeyRef: name: apisix-admin-key key: admin-keyСховище рендериться як StatefulSet із постійним томом, змонтованим у
/etcd-data, плюс Service типу ClusterIP і headless Service.