Pular para o conteúdo
AggregaAggrega
Selecionar língua: Português (Brasil)
Esta página foi traduzida automaticamente. Leia o original em inglês.

Entrega de credenciais — `secretKeyRef` de ponta a ponta

Um único banco de dados PostgreSQL cuja senha é fornecida pelo subsistema de credenciais, mostrado por provedor. O mesmo slot password em core/datastore/postgres aceita qualquer uma das duas famílias de credenciais; a família que o desenvolvedor vincula decide como a senha é entregue, e a Recipe do banco de dados lê o slot da forma que o seu provedor suporta.

Gerar o exemplo

Você pode fazer o build deste exemplo com os comandos abaixo, ou pedir ao seu assistente de IA que faça o build por você.

Escreva o exemplo em uma nova pasta com o nome dele:

Terminal window
aggrega scaffold --example credential-secretkeyref

Em seguida ele imprime os próximos comandos a executar. O primeiro entra na pasta nova:

Terminal window
cd credential-secretkeyref

Build

Este exemplo tem três releases. Faça o build de uma por execução:

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)

Toda release resolve as suas entidades de catálogo por meio do .aggrega-config.yaml deste espaço de trabalho, a partir do registro do hub que ele nomeia como padrão, então nenhuma flag --catalog é necessária, e --auto-pull escreve durante o build o lockfile que falta a um clone novo.

Com um assistente de IA

Um assistente de IA configurado com as ferramentas do Aggrega pode fazer o mesmo: cole este prompt nele.

Use somente as ferramentas do Aggrega e não crie nenhuma pasta por conta própria. Se a pasta do espaço de trabalho ainda não contém uma pasta `credential-secretkeyref`, chame uma vez a ferramenta `scaffold` com `example` definido como `credential-secretkeyref` e sem `dir`: ela grava o exemplo em uma nova pasta `credential-secretkeyref`. Em seguida, chame a ferramenta `build` uma vez para cada Release, nesta ordem — `release-helm.yaml`, `release-compose.yaml` — cada vez com `workspace_root` definido como `credential-secretkeyref`, `release` definido como esse arquivo, `auto_pull` definido como true e `write` definido como true. Em seguida, chame a ferramenta `build` da mesma forma com `release` definido como `release-negative.yaml`: esse build deve ser recusado, então leia para mim a recusa. Diga-me quais arquivos cada build gravou; eles ficam em `credential-secretkeyref/dist/`.

Helm — um Secret referenciável + secretKeyRef

aggregate-helm.yaml vincula core/referenced-secret ao slot password. O Manifest o mapeia para k8s-secret-from-parameter, que materializa um Secret do Kubernetes e publica a identidade do Secret como provides {name, key}. A Recipe de helm do postgres referencia o slot por meio de containers.attachments, que o sintetizador renderiza como um secretKeyRef de env.

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

O Secret gerado (dist/helm/helm/db--password--db-secret-db-password.yaml) e o secretKeyRef do banco de dados (dist/helm/helm/db-statefulset.yaml) nomeiam o mesmo recurso, porque ambos leem .features.password.provides.name — não há nenhuma nova derivação nem nenhuma convenção em que os dois lados precisem concordar:

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 — uma credencial de valor injetado

aggregate-compose.yaml vincula core/secret-value. O Compose não tem nenhuma primitiva de recurso Secret / secretKeyRef, então o Manifest mapeia a credencial para dotenv-secret, que entrega o valor pelo pipe de injeção sob a chave que o vínculo nomeia em values.key, aqui POSTGRES_PASSWORD, e a Recipe de compose do postgres o lê sob essa chave.

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

Negativo — um preenchimento não referenciável rejeitado por uma referência

aggregate-negative.yaml vincula a credencial de valor injetado core/secret-value ao slot password e depois faz o build em helm, onde a Recipe do postgres referencia o slot por meio de containers.attachments (um secretKeyRef). Um secretKeyRef precisa de um recurso Secret para o qual apontar, mas uma credencial de valor injetado não publica nenhum — então o build é interrompido de forma explícita:

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]

Espera-se que esta release falhe — a interrupção é a lição. O build termina com 1 em vez de informar sucesso, então a proteção fica visível para quem lê e para qualquer script que o execute.

Há duas correções. Vincule uma credencial referenciável (core/referenced-secret), como em aggregate-helm.yaml; ou mantenha a vinculação core/secret-value e mapeie-a no Manifest para k8s-secret-from-value, a realização do Helm de core/secret-value que escreve o valor em um Secret que emite e publica o nome e a chave desse Secret, para que a referência tenha um recurso para o qual apontar. Ligada a env-secret, uma credencial de valor injetado chega, em vez disso, ao contêiner pelo pipe de injeção, nunca por uma referência containers.attachments.