Секреты
Эта страница объясняет одну идею, а именно как учётные данные попадают в компонент, которому они нужны, и не является запускаемым рабочим пространством. Продвинутая платформа — платформа 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 учётных данных.