Segredos
Esta página explica uma única ideia, como uma credencial chega ao componente que dela precisa, e não é um espaço de trabalho executável. Plataforma avançada — uma plataforma Kubernetes com várias fronteiras mostra ambos os modelos de entrega num espaço de trabalho que se constrói; pode escrevê-lo numa pasta própria com:
aggrega scaffold --example advanced-platformDepois, imprime os próximos comandos a executar:
cd advanced-platformaggrega pull --release release.yamlaggrega build --release release.yamlA lista de verificação da entrega de segredos
Uma credencial passa por seis superfícies antes de chegar a um contentor em execução. Estes são os pontos de contacto a verificar ao ligar uma nova:
| Passo | Superfície | Ação |
|---|---|---|
| 1 | featuresSchema: do Component | Declarar o slot da credencial: o seu nome, se é required, e a sua lista de permissões inject: — os mecanismos de entrega que um anexo pode nomear, [env] ou [env, file] para um slot transparente, [] para um opaco. |
| 2 | schema: da Feature de credenciais | Definir o que um autor fornece: as Features de credenciais da biblioteca padrão têm a etiqueta feature.aggrega.ai/kind: secret e recebem o localizador da credencial como origin e a chave de dados como key. |
| 3 | Aggregate features: | Pedir a credencial, sob a mesma palavra-chave features: que qualquer outra Feature: o seu type, os seus values e, apenas num slot transparente, um bloco inject: que indica como a aplicação a lê. |
| 4 | FeatureRecipe | Realizá-la para o destino: escrever o valor onde o componente o lê, renderizar um recurso que o contém ou renderizar um que o obtém de um repositório de segredos. |
| 5 | mappings.features.type do Manifest | Associar a Feature de credenciais à sua FeatureRecipe, no mesmo nível que qualquer outra Feature. |
| 6 | Recipe | Lê-la, num slot opaco: a Recipe do componente lê o localizador que a credencial publica, .features.<slot>.provides.name, e entrega-o ao mecanismo próprio do produto, como o existingSecret de um chart. |
Um slot transparente usa as cinco primeiras; um slot opaco usa todas as seis, que é o caso habitual da infraestrutura empacotada, como o chart de um fornecedor.
Slots transparentes e opacos
Um slot transparente permite ao programador indicar como a aplicação lê a credencial. Um slot opaco deixa a entrega à Recipe, e um anexo que escreva nele um bloco inject: interrompe a compilação. No exemplo, core/datastore/mariadb declara um de cada, e o Aggregate preenche ambos, a partir de aggregate.yaml sem os seus comentários:
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 é opaco: core/secret-value entrega o valor sob a chave que o anexo nomeia, onde a Recipe da base de dados o lê. user_password é transparente: core/secret-provided publica o valor como value, e o próprio bloco inject: do anexo entrega-o em MARIADB_PASSWORD. Um bloco inject: que nomeie um mecanismo que o slot não lista interrompe a compilação, tal como um que nomeie uma chave que nada publica nem lê.
Para um slot opaco preenchido por uma credencial referenciável, a Recipe do componente lê o localizador publicado em vez de derivar um nome, existingSecret: "{{ .features.root_password.provides.name }}", pelo que o Secret que uma FeatureRecipe emite e a referência a ele são uma única cadeia. MariaDB (chart da Bitnami) — um único Secret de credenciais com várias chaves constrói esse fluxo sobre o chart de um fornecedor.
Realizar uma credencial: um recurso ou um pipeline de dois passos
As realizações Kubernetes da biblioteca padrão renderizam o recurso da credencial a partir de um pequeno chart ao lado da FeatureRecipe: helm/k8s-secret-from-parameter um Secret que contém o valor fornecido por um autor, e helm/k8s-external-secret um ExternalSecret que o External Secrets Operator reconcilia a partir de um repositório de segredos. Features de credenciais descreve cada uma.
Uma FeatureRecipe pode, em vez disso, realizar uma credencial com um pipeline: de dois passos, cada um deles um plugin. O primeiro, o recuperador, escreve o recurso específico do repositório — um ExternalSecret, por exemplo — nomeando a entrada do repositório que os valores do anexo indicam. O segundo, o injetor, aplica um patch à carga de trabalho renderizada do componente para montar o Secret resultante no seu contentor, nas variáveis ou ficheiros que o bloco inject: do anexo nomeia, que o passo lê em .inject. Mudar para outro repositório de segredos substitui o recuperador; o injetor mantém-se. Um passo devolve os recursos que adiciona como efeitos secundários e as suas alterações aos documentos renderizados como patches; o contrato dos plugins Wasm é a forma de ambos.
A credencial própria de uma Feature
Uma Feature pode precisar de uma credencial própria: um proxy de guardrails que se autentica junto de um serviço a montante, um expedidor de registos com um token de ingestão. A Feature declara o slot no seu próprio featuresSchema, exatamente como faz um Component, e a FeatureRecipe associada a ela lê o que preenche esse slot quando renderiza a carga de trabalho da Feature.
Os anexos não se aninham. A credencial é anexada ao lado da Feature, no mesmo componente, sob o nome que o slot da Feature declara; o nome do slot é o que liga as duas. A Feature de guarda e o componente abaixo são entidades próprias do espaço de trabalho; core/referenced-secret pertence à biblioteca padrão.
# 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-keyA FeatureRecipe da guarda renderiza uma carga de trabalho cujo contentor referencia o slot, attachments: { GUARD_API_KEY: { from: guard_api_key, as: env } }, pelo que a referência chega ao contentor da guarda e a nenhum outro. A Recipe do componente anfitrião não pode referenciar o slot, porque este pertence à Feature: uma carga de trabalho que tente alcançá-lo interrompe a compilação, nomeando o slot. Uma entrada de carga de trabalho que nomeie um slot que nada preenche também a interrompe, uma vez que não há nenhum localizador publicado a resolver.
O mesmo vale para as ligações que uma Feature estabelece: uma ligação no próprio bloco uses: da Feature não tem anexos, pelo que uma credencial de que uma ligação dessas precise é um slot que a Feature declara, preenchido ao lado da Feature.
A credencial própria de uma ligação
Um gateway que alcança dois modelos pode apresentar uma chave diferente a cada um, ou uma chave a um e nenhuma ao outro. Um slot no gateway contém uma única credencial para o componente inteiro, pelo que a credencial vai, em vez disso, na ligação: o socket do gateway declara o slot que cada ligação que passa por ele pode preencher, e cada ligação preenche-o, ou não, por conta própria.
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-keyA Recipe do gateway lê o anexo a partir da sua ligação, em .context.uses.gpt.features.credential, pelo que um gateway que alcança vários modelos lê a chave própria de cada modelo; core/gateway/litellm entrega cada uma como uma variável própria, que a entrada da ligação na sua tabela de encaminhamento nomeia. Um anexo sob um nome para o qual o socket não declara nenhum slot interrompe a compilação, nomeando os slots que declara. O Manifest pode realizar a credencial de uma ligação de forma diferente das restantes, pela chave <connection>.credential no seu nível por instância. Credenciais nas ligações — uma chave por ligação e uma única chave nas duas extremidades constrói isto; uma Release também pode estabelecer uma ligação dessas e nomear o segredo no infra do anexo, como descreve Features de credenciais.