Encaminhamento de módulos para fronteiras — colocar submódulos inteiros em fronteiras
Este exemplo compila duas capacidades — uma camada de leitura de métricas do Thanos sobre armazenamento de objetos e uma base de dados de documentos que fala o protocolo de rede do MongoDB — a partir de um único Aggregate escrito pelo programador, e coloca cada uma numa fronteira própria a partir da Release.
Ambas as capacidades são módulos: subagregados reutilizáveis que compõem, cada um, vários componentes de carga de trabalho única e ligam as suas próprias arestas internas. O Aggregate nomeia os dois módulos e nada sobre onde são executados. A Release coloca cada módulo inteiro com uma entrada aggregates: por fronteira — o operador decide onde uma capacidade é executada sem acompanhar, nem repetir, o que está dentro dela.
Ficheiros
| Ficheiro | Papel |
|---|---|
aggregate.yaml | Intenção do programador: importa o módulo de métricas (core/thanos) e o módulo de base de dados de documentos (core/ferretdb). |
manifest.yaml | Mapeia cada tipo de componente que os dois módulos contribuem para a sua Recipe helm synth, a Feature de credencial que o módulo de métricas anexa, para a realização que emite um Secret a partir de cada um dos dois parâmetros de chave do módulo, e a Feature de scrape para a sua FeatureRecipe. |
release.yaml | Documento do operador: encaminha cada módulo para a sua própria fronteira, dimensiona um componente de um módulo e anexa-lhe a Feature de scrape. |
O que demonstra
- Encaminhar um módulo inteiro para uma fronteira. A entrada
aggregates:de uma fronteira tem como chave o nome do módulo no Aggregate. Coloca todos os componentes que o módulo contém, pelo que os artefactos emitidos para os três componentes de métricas ficam sob a fronteiraobservabilitye os dois componentes da base de dados de documentos sobdata. - Não nomear nenhum componente é a forma principal. A fronteira
dataencaminha o módulo de base de dados de documentos com um simplesdocuments: {}. Cada componente nele contido é colocado e assume os seus próprios valores predefinidos de esquema; a Release precisa do nome do módulo e de nada mais sobre ele. - Configurar um componente encaminhado pelo seu nome local. Uma entrada de encaminhamento também pode configurar componentes individuais do módulo que encaminha, endereçados pelo nome local que cada um traz dentro desse módulo —
query, e nãometrics.query, porque dentro do módulo é o único nome que tem. Nomear um componente não diz nada sobre os outros: aquiqueryé dimensionado e recebe um destino de scrape, enquanto o armazenamento de objetos e o store gateway são encaminhados com os seus valores predefinidos. - Um componente encaminhado é um componente dessa fronteira. Herda a cascata de anotações da fronteira como qualquer outro, e é isso que dá a cada recurso de um módulo encaminhado o valor
aggrega.ai/namespaceda fronteira — incluindo os componentes que a entrada de encaminhamento nunca menciona. - O encaminhamento é colocação, não um tipo diferente de pertença. Um componente encaminhado sem que nada seja dito sobre ele é renderizado da mesma forma que o mesmo componente nomeado diretamente nessa fronteira com um corpo vazio. As duas grafias são duas maneiras de dizer onde fica um componente, não dois comportamentos.
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:
aggrega scaffold --example module-boundary-routingDepois, imprime os próximos comandos a executar. O primeiro entra na nova pasta:
cd module-boundary-routingCompilação
Este workspace não contém nenhum .aggrega-config.yaml, pelo que as entidades da biblioteca standard são resolvidas a partir do registo do hub, hub.aggrega.ai, e não é necessária nenhuma flag de catálogo; --auto-pull escreve durante a compilação o lockfile que falta a um clone acabado de criar:
aggrega build --release release.yaml --auto-pullOs artefactos renderizados ficam em dist/. O destino Kubernetes renderiza manifestos simples offline — não é necessário nenhum pull de chart.
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 conta própria. Se a pasta da área de trabalho ainda não contiver uma pasta `module-boundary-routing`, chame uma vez a ferramenta `scaffold` com `example` definido como `module-boundary-routing` e sem `dir`: esta escreve o exemplo numa nova pasta `module-boundary-routing`. Em seguida, chame a ferramenta `build` com `workspace_root` definido como `module-boundary-routing`, `release` definido como `release.yaml`, `auto_pull` definido como true e `write` definido como true. Indique quais os ficheiros que a compilação escreveu; encontram-se em `module-boundary-routing/dist/`.Como ficam as stacks colocadas
O directory de cada fronteira é a raiz dos artefactos de tudo o que nela é colocado, pelo que os componentes dos dois módulos se separam no disco pela fronteira que os encaminhou:
dist/observability/helm/ metrics-zdobjstore, metrics-zdstore, metrics-zdquerydist/data/helm/ documents-zdproxy, documents-zdbackendOs nomes de ficheiro trazem a identidade de cada componente com o separador de módulo escrito por extenso, porque um ponto não é um carácter que todos os nomes de recurso possam conter — metrics.store no Aggregate é metrics-zdstore no cluster. Compor um módulo é a única coisa que coloca um separador numa identidade, pelo que um componente que se nomeie diretamente é escrito da mesma forma nos dois lugares.
Cada recurso traz o namespace da fronteira que o encaminha e regista qual fronteira o colocou. O store gateway nunca é nomeado na entrada de encaminhamento e ainda assim herda ambos:
metadata: name: metrics-zdstore namespace: observability [… omitted: the labels every rendered document carries] annotations: aggrega.ai/boundary-path: observability [… omitted: the annotation naming the Recipe that rendered it]O mesmo vale para os quatro Secrets que a Feature de credencial do módulo de métricas emite para o par de chaves do armazenamento de objetos e para aquele que o store gateway lhe apresenta: cada um fica sob observability com esse namespace, ao lado da carga de trabalho que o lê.
A Feature de scrape anexada ao componente encaminhado query renderiza o seu próprio artefacto sob essa mesma fronteira, com as definições de scrape do operador:
apiVersion: monitoring.coreos.com/v1kind: ServiceMonitormetadata: name: metrics-zdquery-scrape [… omitted: the namespace, labels and annotations every rendered document carries]spec: selector: matchLabels: app.kubernetes.io/name: metrics-zdquery endpoints: - port: http interval: 30s path: /metrics