Aller au contenu
AggregaAggrega
Selectionner la langue: Français
Cette page a été traduite automatiquement. Lire l’original en anglais.

Un chart conservé dans un dépôt git

Un chart Helm ne doit pas nécessairement provenir d’un registre de charts. Cet exemple en récupère un qui se trouve dans un dépôt git — le chart d’exemple hello-world du projet Helm lui-même — et le construit en manifestes Kubernetes.

L’Aggregate du développeur ne dit rien de tout cela. Il déclare un core/compute/server, et la provenance du packaging de ce serveur est décidée dans la Recipe et liée par le Manifest.

Le bloc 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

Trois coordonnées, et chacune répond à une question différente :

  • url — le dépôt à cloner. https://, ssh:// et git:// sont tous acceptés. Un dépôt privé est atteint via SSH par l’agent SSH, ou via HTTPS avec une entrée pour son hôte dans votre fichier netrc — machine github.com login <user> password <token>. Une information d’identification écrite dans l’URL elle-même est refusée, comme le décrit Authentification.
  • ref — la référence à laquelle lire le dépôt : un tag, une branche ou un commit. C’est ce que les auteurs du dépôt ont nommé, qui n’est pas toujours une simple version — ici, le tag porte aussi le nom du chart.
  • module_subdir — le répertoire du dépôt qui constitue le chart. Le dépôt contient un chart sous ce chemin au lieu d’en être un, et le répertoire fait partie de ce qui rend l’artefact distinct : deux répertoires d’un même dépôt au même commit sont deux artefacts, et non un seul.

Le type de source nomme le transport et l’emplacement, pas le format. Le même type récupère un chart, un module Terraform ou tout autre répertoire de fichiers ; ce que contient le répertoire est l’affaire du fournisseur qui le consomme.

Ce qu’enregistre le lockfile

Seul un commit nomme un contenu qui ne peut pas changer à votre insu. Un tag ou une branche est un nom que le dépôt peut faire pointer vers un autre commit, si bien que aggrega pull résout la référence et enregistre les deux — la référence que vous avez écrite, et le commit vers lequel elle s’est résolue :

# 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

Les deux moitiés méritent leur place. Le commit est ce que récupère le build, si bien que le build est reproductible. La référence est ce par quoi le build recherche l’entrée, et c’est ce qui vous permet de continuer à écrire ref: hello-world-0.1.0 dans la Recipe tout en résolvant vers le commit exact sur lequel se trouvait ce tag lorsque le lockfile a été écrit.

Générer l’exemple

Vous pouvez construire cet exemple avec les commandes ci-dessous, ou le faire construire pour vous par votre assistant IA.

Écrivez l’exemple dans un nouveau dossier qui porte son nom :

Terminal window
aggrega scaffold --example chart-from-git-repository

Elle affiche ensuite les prochaines commandes à exécuter. La première vous place dans le nouveau dossier :

Terminal window
cd chart-from-git-repository

Build

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

Cet exemple contient deux releases, si bien que celle à construire est nommée. Le premier build a besoin d’un lockfile, c’est pourquoi --auto-pull est passé ici ; exécuter une fois au préalable aggrega pull --release release-chart.yaml fait la même chose et permet à chaque build ultérieur de s’exécuter sans flag.

Le Deployment rendu porte les valeurs que la Release a fournies, mappées sur les noms de valeurs propres au 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]

Chaque build affiche un avertissement :

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

C’est exact et mérite d’être lu plutôt que réduit au silence. Le Component core/compute/server offre un réglage de dimensionnement CPU et mémoire ; ce chart-ci n’expose aucune valeur pour lui, si bien que la Recipe n’y mappe rien. Une Recipe sourced mappe ce qu’accepte réellement le chart qu’elle récupère, et le compilateur signale la valeur qui n’a abouti nulle part au lieu de prétendre qu’elle est arrivée.

Avec un assistant IA

Un assistant IA configuré avec les outils d’Aggrega peut faire de même : collez-lui ce prompt.

Utilisez uniquement les outils Aggrega et ne créez vous-même aucun dossier. Si le dossier de l’espace de travail ne contient pas encore de dossier `chart-from-git-repository`, appelez une seule fois l’outil `scaffold` avec `example` défini sur `chart-from-git-repository` et sans `dir` : il écrit l’exemple dans un nouveau dossier `chart-from-git-repository`. Appelez ensuite l’outil `build` avec `workspace_root` défini sur `chart-from-git-repository`, `release` défini sur `release-chart.yaml`, `auto_pull` défini sur true et `write` défini sur true. Indiquez-moi quels fichiers le build a écrits ; ils se trouvent sous `chart-from-git-repository/dist/`.

Quand la référence se déplace

Un tag peut être redirigé dans le dépôt. Lorsque cela arrive, le aggrega pull ordinaire suivant constate que la référence se résout ailleurs que vers le commit qu’il a enregistré, et s’arrête au lieu de l’adopter :

# 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>`

Il nomme les deux commits, si bien que vous pouvez voir exactement ce qui a bougé avant de décider. Le lockfile reste tel quel — l’arrêt intervient avant que quoi que ce soit soit écrit — et adopter le nouveau commit est un acte délibéré :

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

Une référence déplacée est le cas pour lequel existe --upgrade : un pull ordinaire conserve le commit qu’enregistre le lockfile, et seule une mise à niveau adopte l’endroit vers lequel pointe désormais la référence. Un --upgrade nu abandonne chaque épinglage enregistré, si bien qu’il demande d’abord une confirmation. --pin-sources est nécessaire aussi, parce que cette Recipe enregistre également le commit de sa source dans l’entity.lock à côté d’elle : la mise à niveau réécrit cet épinglage vers le nouveau commit, alors que sans le flag le pull s’arrête sur le verrou et nomme aggrega pin. Commitez l’entity.lock réécrit avec la Recipe.

Une modification faite dans cet espace de travail, à l’Aggregate ou à la Release par exemple, est une dérive d’un autre type : le build suivant la signale, et un aggrega pull --release release-chart.yaml ordinaire l’efface.

Épingler un commit dans ref: au lieu d’un tag est l’autre façon d’obtenir la même garantie, au prix d’une coordonnée qu’aucun humain ne peut lire.

La release garde-fou

release-negative.yaml est censée échouer, et elle est là parce qu’un chemin de récupération exercé uniquement sur son chemin nominal ne vous apprend rien sur ses garde-fous. Elle déploie le même Aggregate via manifest-negative.yaml, qui lie une Recipe identique à celle qui fonctionne, sauf pour sa référence — elle nomme un tag que le dépôt ne contient pas :

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]

Le dépôt est accessible et le clonage réussit ; il n’y a simplement aucune référence de ce nom, si bien qu’il n’y a aucun commit à épingler et rien à archiver.

Ce dont cet exemple a besoin du réseau

Contrairement à la plupart des espaces de travail ici, celui-ci clone un vrai dépôt lors de son premier build, si bien que ce build a besoin d’un accès sortant à l’hôte nommé dans url. Une fois que le lockfile et le cache de résolution existent, les builds suivants lisent depuis le cache et s’exécutent sans aucun réseau — aggrega build --release release-chart.yaml --offline reconstruit les mêmes octets.