Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

Доставка учётных данных — `secretKeyRef` от начала до конца

Одна база данных PostgreSQL, пароль которой предоставляет подсистема учётных данных, показанная для каждого провайдера. Один и тот же слот password в core/datastore/postgres принимает любое семейство учётных данных; семейство, которое подключает разработчик, определяет, как доставляется пароль, а сущность Recipe базы данных читает слот так, как это поддерживает её провайдер.

Создание примера

Этот пример можно собрать командами ниже или поручить сборку вашему ИИ-ассистенту.

Запишите пример в новую папку, названную по его имени:

Terminal window
aggrega scaffold --example credential-secretkeyref

Затем она выводит команды, которые нужно выполнить дальше. Первая переходит в новую папку:

Terminal window
cd credential-secretkeyref

Сборка

В этом примере три релиза. За один запуск собирайте один:

Terminal window
aggrega build --release release-helm.yaml --auto-pull
aggrega build --release release-compose.yaml --auto-pull
aggrega build --release release-negative.yaml --auto-pull # expected to fail (see below)

Каждый релиз разрешает сущности своего каталога через .aggrega-config.yaml этого рабочего пространства, из реестра hub, который тот указывает как реестр по умолчанию, поэтому флаг --catalog не нужен, а --auto-pull во время сборки записывает lock-файл, которого нет в свежем клоне.

С ИИ-ассистентом

ИИ-ассистент, настроенный с инструментами Aggrega, может сделать то же самое: вставьте в него этот промпт.

Используйте только инструменты Aggrega и не создавайте папки самостоятельно. Если в папке рабочей области ещё нет папки `credential-secretkeyref`, вызовите инструмент `scaffold` один раз, задав `example` равным `credential-secretkeyref` и не указывая `dir`: он запишет пример в новую папку `credential-secretkeyref`. Затем вызовите инструмент `build` один раз для каждой сущности Release в следующем порядке — `release-helm.yaml`, `release-compose.yaml` — каждый раз задавая `workspace_root` равным `credential-secretkeyref`, `release` равным этому файлу, `auto_pull` равным true и `write` равным true. Затем так же вызовите инструмент `build`, задав `release` равным `release-negative.yaml`: эта сборка должна быть отклонена, поэтому прочитайте мне отказ. Сообщите мне, какие файлы записала каждая сборка; они находятся в `credential-secretkeyref/dist/`.

Helm — Secret, на который можно сослаться, + secretKeyRef

aggregate-helm.yaml подключает core/referenced-secret к слоту password. Сущность Manifest сопоставляет его с k8s-secret-from-parameter, который создаёт Secret Kubernetes и публикует идентификатор этого Secret как provides {name, key}. Сущность Recipe для postgres в helm ссылается на слот через containers.attachments, что синтезатор отображает в переменную окружения secretKeyRef.

Terminal window
aggrega build --release release-helm.yaml --auto-pull

Сгенерированный Secret (dist/helm/helm/db--password--db-secret-db-password.yaml) и secretKeyRef базы данных (dist/helm/helm/db-statefulset.yaml) называют один и тот же ресурс, потому что оба читают .features.password.provides.name, — нет ни повторного вычисления, ни соглашения, о котором двум сторонам нужно было бы договориться:

db--password--db-secret-db-password.yaml
[… omitted: the apiVersion and the Secret kind]
metadata:
name: db-password
[… omitted: the labels and annotations every rendered document carries]
stringData:
POSTGRES_PASSWORD: "dev-pw-change-me"
# db-statefulset.yaml (container env)
- name: POSTGRES_PASSWORD
valueFrom:
secretKeyRef:
name: db-password # == the Secret's metadata.name
key: POSTGRES_PASSWORD # == the Secret's data key

Compose — учётные данные с внедрением значения

aggregate-compose.yaml подключает core/secret-value. В Compose нет примитива ресурса Secret / secretKeyRef, поэтому сущность Manifest сопоставляет учётные данные с dotenv-secret, который доставляет значение по каналу внедрения под ключом, который подключение называет в values.key, здесь POSTGRES_PASSWORD, а сущность Recipe для postgres в compose читает его под этим ключом.

Terminal window
aggrega build --release release-compose.yaml --auto-pull
# dist/compose/compose/docker-compose.yaml → POSTGRES_PASSWORD: dev-pw-change-me

Негативный пример — заполнение, на которое нельзя сослаться, отклоняется при ссылке

aggregate-negative.yaml подключает к слоту password учётные данные с внедрением значения core/secret-value, а затем выполняет сборку на helm, где сущность Recipe для postgres ссылается на слот через containers.attachments (secretKeyRef). Для secretKeyRef нужен ресурс Secret, на который он указывает, но учётные данные с внедрением значения его не публикуют, — поэтому сборка явно останавливается:

Terminal window
aggrega build --release release-negative.yaml --auto-pull
# [… omitted: the pull's lines, which carry the same halt, and two lint notices]
# [CATALOG_ERROR E0212] instance db
# rendering node "db"
# [… omitted: the cause, "workload attachment slot is not referenceable", naming the Recipe and its path in your catalog, then one line each for the "name" and the "key" the slot's provides does not expose]

Ожидается, что этот релиз завершится ошибкой — остановка и есть урок. Сборка завершается с кодом 1, а не сообщает об успехе, поэтому защитный механизм виден и читателю, и любому скрипту, который её запускает.

Есть два способа исправления. Подключите учётные данные, на которые можно сослаться (core/referenced-secret), как в aggregate-helm.yaml; или сохраните присоединение core/secret-value и сопоставьте его в сущности Manifest с k8s-secret-from-value — реализацией Helm для core/secret-value, которая записывает значение в выпускаемый ею Secret и публикует имя и ключ этого Secret, так что у ссылки есть ресурс, на который она указывает. При привязке к env-secret учётные данные с внедрением значения вместо этого попадают в контейнер по каналу внедрения, а не через ссылку containers.attachments.