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

Entrega de credenciais — `secretKeyRef` de ponta a ponta

Uma única base de dados PostgreSQL cuja palavra-passe é fornecida pelo subsistema de credenciais, mostrado por fornecedor. O mesmo slot password em core/datastore/postgres aceita qualquer uma das duas famílias de credenciais; a família que o programador anexa decide como a palavra-passe é entregue, e a Recipe da base de dados lê o slot da forma que o seu fornecedor suporta.

Gerar o exemplo

É possível compilar este exemplo com os comandos abaixo, ou pedir ao assistente de IA que o compile.

Escreva o exemplo numa nova pasta com o nome dele:

Terminal window
aggrega scaffold --example credential-secretkeyref

Depois, imprime os próximos comandos a executar. O primeiro entra na nova pasta:

Terminal window
cd credential-secretkeyref

Compilação

Este exemplo tem três releases. Compile-se 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)

Cada release resolve as suas entidades de catálogo através do .aggrega-config.yaml deste espaço de trabalho, a partir do registo do hub que este nomeia como predefinido, pelo que não é necessária nenhuma flag --catalog, e --auto-pull escreve durante a compilação 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-lhe este prompt.

Utilize apenas as ferramentas do Aggrega e não crie nenhuma pasta por si. Se a pasta da área de trabalho ainda não contiver uma pasta `credential-secretkeyref`, chame uma vez a ferramenta `scaffold` com `example` definido como `credential-secretkeyref` e sem `dir`: esta escreve o exemplo numa nova pasta `credential-secretkeyref`. Em seguida, chame a ferramenta `build` uma vez para cada Release, por esta ordem — `release-helm.yaml`, `release-compose.yaml` — de cada vez com `workspace_root` definido como `credential-secretkeyref`, `release` definido como esse ficheiro, `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`: este build destina-se a ser recusado, por isso leia-me a recusa. Indique-me que ficheiros cada build escreveu; encontram-se em `credential-secretkeyref/dist/`.

Helm — um Secret referenciável + secretKeyRef

aggregate-helm.yaml anexa core/referenced-secret ao slot password. O Manifest mapeia-o 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 através 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 da base 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 sobre a qual os dois lados tenham de 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 anexa core/secret-value. O Compose não tem nenhuma primitiva de recurso Secret / secretKeyRef, pelo que o Manifest mapeia a credencial para dotenv-secret, que entrega o valor pelo pipe de injeção sob a chave que o anexo nomeia em values.key, aqui POSTGRES_PASSWORD, e a Recipe de compose do postgres lê-o 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 anexa a credencial de valor injetado core/secret-value ao slot password e depois compila em helm, onde a Recipe do postgres referencia o slot através de containers.attachments (um secretKeyRef). Um secretKeyRef precisa de um recurso Secret para onde apontar, mas uma credencial de valor injetado não publica nenhum — pelo que a compilação é interrompida 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. A compilação termina com 1 em vez de reportar sucesso, pelo que a salvaguarda fica visível para quem lê e para qualquer script que a execute.

Há duas correções. Anexar uma credencial referenciável (core/referenced-secret), como em aggregate-helm.yaml; ou manter o anexo core/secret-value e mapeá-lo no Manifest para k8s-secret-from-value, a realização Helm de core/secret-value que escreve o valor num Secret que emite e publica o nome e a chave desse Secret, para que a referência tenha um recurso para onde apontar. Associada a env-secret, uma credencial de valor injetado chega, em vez disso, ao contentor através do pipe de injeção, nunca através de uma referência containers.attachments.