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

Redis — um Aggregate, dois destinos, autenticação opcional

Este exemplo enxuto compila um único cache em memória Redis (protocolo de rede do Redis) a partir de um único Aggregate escrito pelo desenvolvedor para duas realizações:

  • Docker Compose para o desenvolvimento local, e
  • a Recipe helm sintetizada que executa a imagem upstream oficial redis diretamente no Kubernetes (sem chart externo).

A Recipe helm sintetizada é o caminho do Kubernetes: ela depende apenas de uma tag de imagem oficial em vez de um chart de terceiros, e o seu conjunto de recursos renderizado é exatamente o que a carga de trabalho declara.

O mesmo aggregate.yaml conduz ambas. Só muda por realização a camada de Recipe selecionada pelo Manifest. Um segundo Aggregate, aggregate-auth.yaml, mostra o mesmo cache com uma credencial de senha opcional vinculada para o caminho do Compose; aggregate-helm-synth-auth.yaml vincula uma credencial referenciável para o caminho helm sintetizado.

As Recipes do Redis do catálogo que este exemplo mapeia, compose/redis e helm/redis, declaram a licença AGPL-3.0. O exemplo valkey-cache implanta o Valkey, que fala o mesmo protocolo de rede; a sua Recipe helm/valkey declara BSD-3-Clause.

Arquivos

ArquivoPapel
aggregate.yamlIntenção do desenvolvedor: um componente cache do tipo core/datastore/redis, sem credencial — o cache é executado sem autenticação.
aggregate-auth.yamlO mesmo cache com uma credencial de senha vinculada ao slot opcional password do componente (caminho do Compose).
aggregate-helm-synth-auth.yamlO mesmo cache com uma credencial referenciável vinculada para o caminho helm sintetizado — o valor é materializado como um Secret do Kubernetes que o Deployment referencia.
manifest-compose.yamlMapeia o tipo Redis para a Recipe do Compose (compose/redis) e a credencial para dotenv-secret.
manifest-helm-synth.yamlMapeia o tipo Redis para a Recipe helm sintetizada (helm/redis) e a credencial para k8s-secret-from-parameter.
release-compose.yaml / release-helm-synth.yamlDocumentos do operador para as duas realizações, sem autenticação.
release-compose-auth.yaml / release-helm-synth-auth.yamlDocumentos do operador que habilitam a autenticação.

O que ele demonstra

  • Uma única superfície de autoria, muitos destinos. Um único Aggregate é a fonte da verdade sobre o que o stack é. Cada Manifest diz como realizá-lo.
  • Um datastore no papel de cache. Aqui o Redis é usado como cache em memória e não armazena nada de forma durável, então o componente é tipado como um simples server em vez de um stateful-server. No Kubernetes, a Recipe sintetizada renderiza um Deployment, não um StatefulSet, e não solicita nenhum volume persistente; no Compose, o serviço não declara nenhum volume de dados.
  • Síntese de Workload (Kubernetes). A Recipe helm sintetizada declara um Workload — um Deployment mais um Service ClusterIP que executa a imagem oficial redis — que o provedor helm traduz em manifestos do Kubernetes sem nenhum chart externo. O conjunto de recursos renderizado é exatamente o que o Workload declara. Como o nome redis é usado tanto por uma Recipe do Compose quanto por uma helm sintetizada, os Manifests as referenciam com escopo de provedor como compose/redis e helm/redis.
  • Autenticação opcional por meio de um slot de credencial. O componente declara um slot opcional password no seu featuresSchema. Quando nenhuma credencial está vinculada (o Aggregate base), a Recipe renderiza o cache com a autenticação desabilitada — de forma idêntica byte a byte a uma Recipe sem slot. Quando uma credencial está vinculada, ambos os destinos iniciam o Redis com --requirepass, então o servidor exige a senha: no Compose (aggregate-auth.yaml) o valor é passado ao servidor como esse argumento; no caminho sintetizado do Kubernetes (aggregate-helm-synth-auth.yaml) ele é materializado como um Secret que o Deployment referencia.

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 redis-cache

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

Terminal window
cd redis-cache

Build

Este workspace não traz nenhum .aggrega-config.yaml, então as entidades da biblioteca padrão são resolvidas a partir do registro do hub, hub.aggrega.ai, e nenhuma flag de catálogo é necessária; --auto-pull escreve durante o build o lockfile que falta a um clone novo:

Terminal window
# Local development (Docker Compose), no authentication
aggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), no authentication
aggrega build --release release-helm-synth.yaml --auto-pull
# The same realizations with authentication enabled
aggrega build --release release-compose-auth.yaml --auto-pull
aggrega build --release release-helm-synth-auth.yaml --auto-pull

Os artefatos renderizados ficam em dist/.

Com um assistente de IA

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

Use apenas as ferramentas do Aggrega e não crie nenhuma pasta por conta própria. Se a pasta Workspace ainda não contiver uma pasta `redis-cache`, chame uma vez a ferramenta `scaffold` com `example` definido como `redis-cache` e sem `dir`: ela grava o exemplo em uma nova pasta `redis-cache`. Em seguida, chame a ferramenta `build` uma vez para cada Release, nesta ordem — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml` e `release-helm-synth-auth.yaml` — cada vez com `workspace_root` definido como `redis-cache`, `release` definido como esse arquivo, `auto_pull` definido como true e `write` definido como true. Diga-me quais arquivos cada build gravou; eles ficam em `redis-cache/dist/`.

Nota sobre a entrega da credencial

No caminho do Compose, a credencial é um segredo inject-value (aggregate-auth.yaml): o seu valor é entregue no pipe de ambiente do componente sob a variável que o seu values.key nomeia, REDIS_PASSWORD, e a Recipe o repassa ao servidor como --requirepass. A imagem oficial redis não lê nenhuma variável de senha, então o valor é passado como argumento e aparece no comando do serviço. Uma vinculação cujo valor não chega à Recipe sob nenhuma variável que ela lê interrompe o build, nomeando o slot, em vez de deixar o cache aberto.

O caminho helm sintetizado usa uma credencial referenciável (aggregate-helm-synth-auth.yaml): o valor é materializado como um Secret do Kubernetes, o Deployment o referencia por meio de um secretKeyRef de ambiente, e o Redis é iniciado com --requirepass lendo essa variável de ambiente. Por isso, a senha em texto puro nunca aparece no manifesto do Deployment — apenas no Secret. É isso que de fato habilita a autenticação na imagem oficial redis, que por si só não lê uma senha do ambiente.

O valor origin nos Aggregates autenticados é um espaço reservado de desenvolvimento; forneça um valor real por meio da sua fonte de credenciais em qualquer implantação real.