Секрети
Ця сторінка пояснює одну ідею, а саме як облікові дані потрапляють до компонента, якому вони потрібні, і не є робочим простором, який можна запустити. Розширена платформа — платформа Kubernetes з кількома межами показує обидві моделі доставки в робочому просторі, який ви збираєте самі; запишіть його до власної теки за допомогою:
aggrega scaffold --example advanced-platformПотім вона виводить команди, які слід виконати далі:
cd advanced-platformaggrega pull --release release.yamlaggrega build --release release.yamlКонтрольний список доставки секретів
Облікові дані проходять через шість поверхонь, перш ніж потрапити до запущеного контейнера. Це точки дотику, які слід перевірити під час підключення нових:
| Крок | Інструмент | Дія |
|---|---|---|
| 1 | Component featuresSchema: | Оголосіть слот облікових даних: його ім’я, чи є він required, і його список дозволених значень inject: — механізми доставки, які може назвати прикріплення, [env] або [env, file] для прозорого слота, [] для непрозорого. |
| 2 | Feature облікових даних schema: | Визначте, що надає автор: Features облікових даних зі стандартної бібліотеки мають мітку feature.aggrega.ai/kind: secret і приймають локатор облікових даних як origin, а ключ даних як key. |
| 3 | Aggregate features: | Запитайте облікові дані під тим самим ключовим словом features:, що й будь-яку іншу сутність Feature: їхній type, їхні values і, лише для прозорого слота, блок inject:, що вказує, як застосунок їх зчитує. |
| 4 | FeatureRecipe | Реалізуйте їх для цільового середовища: запишіть значення туди, де компонент його зчитує, відрендерте ресурс, що його містить, або відрендерте ресурс, який отримує його зі сховища секретів. |
| 5 | Manifest mappings.features.type | Прив’яжіть сутність Feature облікових даних до її FeatureRecipe на тому самому рівні, що й будь-яку іншу сутність Feature. |
| 6 | Recipe | Зчитайте їх у непрозорому слоті: сутність Recipe компонента зчитує локатор, який публікують облікові дані, .features.<slot>.provides.name, і передає його власному механізму продукту, наприклад existingSecret чарту. |
Прозорий слот використовує перші п’ять; непрозорий слот використовує всі шість, що є звичайним випадком для пакетованої інфраструктури, як-от чарт постачальника.
Прозорі та непрозорі слоти
Прозорий слот дозволяє розробнику визначити, як застосунок зчитує облікові дані. Непрозорий слот залишає доставку сутності Recipe, а прикріплення, яке записує в нього блок inject:, зупиняє збірку. У прикладі core/datastore/mariadb оголошує по одному слоту кожного виду, а Aggregate заповнює обидва, з aggregate.yaml без коментарів:
db: type: core/datastore/mariadb features: root_password: type: core/secret-value values: key: MARIADB_ROOT_PASSWORD origin: dev-root-pw-change-me user_password: type: core/secret-provided values: origin: dev-app-pw-change-me inject: env: - in: MARIADB_PASSWORD from: valueroot_password непрозорий: core/secret-value доставляє значення під ключем, який називає прикріплення, де його зчитує сутність Recipe бази даних. user_password прозорий: core/secret-provided публікує значення як value, а власний блок inject: прикріплення доставляє його в MARIADB_PASSWORD. Блок inject:, що називає механізм, якого слот не перелічує, зупиняє збірку, так само як і блок, що називає ключ, якого ніщо не публікує й не зчитує.
Для непрозорого слота, заповненого обліковими даними, на які можна посилатися, сутність Recipe компонента зчитує опублікований локатор замість того, щоб виводити ім’я, existingSecret: "{{ .features.root_password.provides.name }}", тож Secret, який створює FeatureRecipe, і посилання на нього є одним рядком. MariaDB (чарт Bitnami) — один багатоключовий Secret облікових даних будує цей потік на чарті постачальника.
Реалізація облікових даних: ресурс або двокроковий конвеєр
Реалізації Kubernetes зі стандартної бібліотеки рендерять ресурс облікових даних із невеликого чарту поруч із FeatureRecipe: helm/k8s-secret-from-parameter рендерить Secret, що містить значення, надане автором, а helm/k8s-external-secret рендерить ExternalSecret, який External Secrets Operator узгоджує зі сховищем секретів. Features облікових даних розглядає кожну з них.
Натомість FeatureRecipe може реалізувати облікові дані за допомогою pipeline: із двох кроків, кожен з яких є плагіном. Перший, отримувач, записує ресурс, специфічний для сховища, — наприклад, ExternalSecret, — який називає запис сховища, заданий значеннями прикріплення. Другий, інжектор, накладає патч на відрендерене робоче навантаження компонента, щоб змонтувати отриманий Secret у його контейнер у змінних або файлах, які називає блок inject: прикріплення і які крок зчитує в .inject. Перехід на інше сховище секретів замінює отримувача; інжектор залишається. Крок повертає ресурси, які він додає, як побічні ефекти, а свої зміни у відрендерених документах — як патчі; контракт плагінів Wasm визначає форму обох.
Власні облікові дані сутності Feature
Сутності Feature можуть знадобитися власні облікові дані: проксі-захист, що автентифікується в зовнішньому сервісі, збирач журналів із токеном прийому. Feature оголошує слот у власній featuresSchema, точно так само, як це робить Component, а прив’язаний до неї FeatureRecipe зчитує те, що заповнює цей слот, коли рендерить робоче навантаження сутності Feature.
Прикріплення не вкладаються одне в одне. Облікові дані прикріплюються поруч із Feature, на тому самому компоненті, під іменем, яке оголошує слот сутності Feature; саме ім’я слота пов’язує їх між собою. Захисна сутність Feature та компонент нижче є власними сутностями робочого простору; core/referenced-secret належить стандартній бібліотеці.
# The Feature declares the slotkind: Featuremetadata: name: local/guardspec: appliesTo: "component.aggrega.ai/type in (server, worker)" featuresSchema: guard_api_key: selector: "feature.aggrega.ai/kind=secret" sensitive: true inject: [env]---# The Aggregate fills it beside the Featurespec: components: finance-agent: type: local/compute/guarded-worker features: ai-guard: type: local/guard guard_api_key: type: core/referenced-secret values: origin: dev-guard-key-change-me key: api-keyFeatureRecipe захисної сутності Feature рендерить робоче навантаження, контейнер якого посилається на слот, attachments: { GUARD_API_KEY: { from: guard_api_key, as: env } }, тож посилання потрапляє в контейнер захисту й у жоден інший. Сутність Recipe компонента-хоста не може посилатися на слот, бо він належить сутності Feature: робоче навантаження, яке звертається до нього, зупиняє збірку й називає слот. Запис робочого навантаження, що називає слот, якого ніщо не заповнює, теж зупиняє збірку, оскільки немає опублікованого локатора, який можна було б розв’язати.
Те саме стосується з’єднань, які створює Feature: з’єднання у власному блоці uses: сутності Feature не має прикріплень, тож облікові дані, потрібні такому з’єднанню, — це слот, який оголошує Feature і який заповнюється поруч із Feature.
Власні облікові дані з’єднання
Шлюз, що звертається до двох моделей, може надавати кожній інший ключ або ключ одній і жодного іншій. Слот на шлюзі містить одні облікові дані для всього компонента, тож натомість облікові дані розміщуються на з’єднанні: сокет шлюзу оголошує слот, який може заповнити кожне з’єднання через нього, і кожне з’єднання заповнює його або ні самостійно.
spec: components: router: type: core/gateway/litellm uses: models: gpt: target: gpt features: credential: # a slot the models socket declares type: core/referenced-secret values: key: api-keyСутність Recipe шлюзу зчитує прикріплення зі свого з’єднання, у .context.uses.gpt.features.credential, тож шлюз, що звертається до кількох моделей, зчитує власний ключ кожної моделі; core/gateway/litellm доставляє кожен як окрему змінну, яку називає запис з’єднання в його таблиці маршрутизації. Прикріплення під іменем, для якого сокет не оголошує слота, зупиняє збірку й називає слоти, які сокет оголошує. Сутність Manifest може реалізувати облікові дані одного з’єднання інакше, ніж решти, за ключем <connection>.credential на своєму рівні для окремих екземплярів. Облікові дані на з’єднаннях — ключ на кожне з’єднання та один ключ на обох кінцях будує це; сутність Release також може підключити таке з’єднання й назвати секрет в infra прикріплення, як описано в Features облікових даних.