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

Um chart mantido num repositório git

Um chart Helm não tem de vir de um registo de charts. Este exemplo obtém um que está num repositório git — o chart de exemplo hello-world do próprio projeto Helm — e compila-o em manifestos do Kubernetes.

O Aggregate do programador não diz nada sobre isto. Declara um core/compute/server, e a origem do empacotamento desse servidor é decidida na Recipe e vinculada pelo Manifest.

O bloco source

catalog/recipe/helm/hello-world-git/1.0.0/recipe.yaml
source:
kind: git-repository
url: https://github.com/helm/examples.git
ref: hello-world-0.1.0
module_subdir: charts/hello-world

Três coordenadas, e cada uma responde a uma pergunta diferente:

  • url — o repositório a clonar. https://, ssh:// e git:// são todos aceites. Um repositório privado é alcançado por SSH através do agente SSH, ou por HTTPS com uma entrada para o seu anfitrião no ficheiro netrc do utilizador — machine github.com login <user> password <token>. Uma credencial escrita no próprio URL é recusada, como descreve Autenticação.
  • ref — a referência em que ler o repositório: uma tag, um branch ou um commit. É o que os próprios autores do repositório nomearam, o que nem sempre é uma versão simples — aqui a tag traz também o nome do chart.
  • module_subdir — o diretório dentro do repositório que é o chart. O repositório contém um chart sob este caminho em vez de ser um, e o diretório faz parte do que torna o artefacto distinto: dois diretórios de um repositório no mesmo commit são dois artefactos, não um.

O tipo de source nomeia o transporte e a localização, não o formato. O mesmo tipo obtém um chart, um módulo Terraform ou qualquer outro diretório de ficheiros; o que o diretório contém é assunto do fornecedor que o consome.

O que o lockfile regista

Só um commit nomeia conteúdo que não pode mudar sem aviso. Uma tag ou um branch é um nome que o repositório pode reapontar para outro commit, pelo que aggrega pull resolve a referência e regista ambos — a referência que foi escrita e o commit para o qual foi resolvida:

# release-chart.lock
source_artifacts:
- kind: git-repository
url: https://github.com/helm/examples.git
module_subdir: charts/hello-world
pinned_version: f3dc419e558e6ccebce2ed447384e5d2e11de2f9
digest: sha256:2bee62cfc2efccc61d8e17efeb72f9f77ad7bd87f3ea4e50b1e4219c8d5a2c78
mediatype: application/gzip
referenced_by:
- entity: recipe
uri: helm/hello-world-git:1.0.0
field: spec.source
requested_ref: hello-world-0.1.0

As duas metades justificam o seu lugar. O commit é o que a compilação obtém, pelo que a compilação é reproduzível. A referência é aquilo pelo qual a compilação procura a entrada, e é isso que permite continuar a escrever ref: hello-world-0.1.0 na Recipe e ainda assim resolver para o commit exato em que essa tag estava quando o lockfile foi escrito.

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 chart-from-git-repository

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

Terminal window
cd chart-from-git-repository

Compilação

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

Este exemplo inclui duas releases, pelo que se nomeia a que deve ser compilada. A primeira compilação precisa de um lockfile, e é por isso que --auto-pull é passado aqui; executar aggrega pull --release release-chart.yaml uma vez antes faz o mesmo e permite que cada compilação posterior corra sem flag.

O Deployment renderizado traz os valores que a Release forneceu, mapeados para os nomes de valores próprios do chart:

dist/app/helm/web-deployment-web-hello-world.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: web-hello-world
[… omitted: the chart's own labels, and the labels and annotations every rendered document carries]
spec:
replicas: 2
[… omitted: the selector and the pod template's own labels]
spec:
serviceAccountName: web-hello-world
securityContext: {}
containers:
- name: hello-world
securityContext: {}
image: "nginx:1.27.3"
imagePullPolicy: IfNotPresent
[… omitted: the container port and the two probes]

Cada compilação imprime um aviso:

warning: node "web": .infra key "compute" is read by no template in recipe "hello-world-git" — correct the spelling, or remove the key

Isto é exato e vale a pena lê-lo em vez de o silenciar. O Component core/compute/server oferece um ajuste de dimensionamento de CPU e memória; este chart em particular não expõe valores para ele, pelo que a Recipe não mapeia nada aí. Uma Recipe sourced mapeia o que o chart que obtém realmente aceita, e o compilador reporta o valor que não chegou a lado nenhum em vez de fingir que chegou.

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 do espaço de trabalho ainda não contiver uma pasta `chart-from-git-repository`, chame a ferramenta `scaffold` uma única vez com `example` definido como `chart-from-git-repository` e sem `dir`: esta escreve o exemplo numa nova pasta `chart-from-git-repository`. Em seguida, chame a ferramenta `build` com `workspace_root` definido como `chart-from-git-repository`, `release` definido como `release-chart.yaml`, `auto_pull` definido como true e `write` definido como true. Diga-me que ficheiros a compilação escreveu; encontram-se em `chart-from-git-repository/dist/`.

Quando a referência se move

Uma tag pode ser reapontada no repositório. Quando isso acontece, o aggrega pull comum seguinte encontra a referência a resolver para outro sítio que não o commit que registou, e é interrompido em vez de a adotar:

# aggrega pull --release release-chart.yaml
#
# [E0130]
# lockfile: out of date; it no longer matches what its Release resolves to
# ---
# source-artifact kind=git-repository url=https://github.com/helm/examples.git
# module_subdir=charts/hello-world: reference "hello-world-0.1.0" moved — the
# lockfile pins 03f4a18d3c2b77b7ecd91d0324a95910d4f04152, and it now resolves to
# f3dc419e558e6ccebce2ed447384e5d2e11de2f9; adopt where it now points with
# `aggrega pull --upgrade --release <release>`

Nomeia ambos os commits, para que se possa ver exatamente o que se moveu antes de decidir. O lockfile fica como estava — a interrupção acontece antes de qualquer coisa ser escrita — e adotar o novo commit é um ato deliberado:

Terminal window
aggrega pull --upgrade --pin-sources --release release-chart.yaml

Uma referência movida é o caso para o qual existe --upgrade: um pull comum mantém o commit que o lockfile regista, e só uma atualização adota o ponto para onde a referência aponta agora. Um --upgrade simples descarta todas as fixações registadas, pelo que pede primeiro confirmação. --pin-sources também é necessário, porque esta Recipe regista também o commit da sua source no entity.lock ao lado dela: a atualização reescreve essa fixação para o novo commit, ao passo que, sem a flag, o pull é interrompido no lock e nomeia aggrega pin. O entity.lock reescrito deve ser incluído no commit juntamente com a Recipe.

Uma edição feita neste espaço de trabalho, no Aggregate ou na Release por exemplo, é um desvio de outro tipo: a compilação seguinte reporta-o, e um aggrega pull --release release-chart.yaml comum elimina-o.

Fixar um commit em ref: em vez de uma tag é a outra forma de obter a mesma garantia, à custa de uma coordenada que nenhum humano consegue ler.

A release de salvaguarda

release-negative.yaml foi concebida para falhar, e está aqui porque um caminho de obtenção exercitado apenas no seu caminho feliz não diz nada sobre as suas proteções. Implementa o mesmo Aggregate através de manifest-negative.yaml, que vincula uma Recipe idêntica à que funciona, exceto pela sua referência — nomeia uma tag que o repositório não tem:

Terminal window
aggrega build --release release-negative.yaml --auto-pull
# exits non-zero
# [E0137]
# auto-pull: resolving the source of each Recipe and FeatureRecipe the Release
# uses: resolve: resolve source for recipe
# "helm/hello-world-git-missing-ref:1.0.0": sourceresolver: kind=git-repository
# url=https://github.com/helm/examples.git version=: oci: artifact not found at
# remote source (cause: reference not found)
[… omitted: the rest of that line, a remediation naming the URL and version to check]

O repositório está acessível e o clone é bem-sucedido; simplesmente não existe tal referência nele, pelo que não há nenhum commit a fixar nem nada a arquivar.

O que este exemplo precisa da rede

Ao contrário da maioria dos espaços de trabalho aqui, este clona um repositório real na sua primeira compilação, pelo que essa compilação precisa de acesso de saída ao anfitrião nomeado em url. Assim que o lockfile e a cache de resolução existem, as compilações seguintes leem da cache e correm sem qualquer rede — aggrega build --release release-chart.yaml --offline volta a compilar os mesmos bytes.