Ir al contenido
AggregaAggrega
Seleccionar idioma: Español
Esta página se tradujo automáticamente. Lee el original en inglés.

Un chart alojado en un repositorio git

Un chart de Helm no tiene por qué venir de un registro de charts. Este ejemplo obtiene uno que vive en un repositorio git — el chart de ejemplo hello-world del propio proyecto Helm — y lo compila en manifiestos de Kubernetes.

El Aggregate del desarrollador no dice nada de esto. Declara un core/compute/server, y de dónde viene el empaquetado de ese servidor se decide en la Recipe y lo enlaza el Manifest.

El bloque 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

Tres coordenadas, y cada una responde a una pregunta distinta:

  • url — el repositorio que se clona. https://, ssh:// y git:// se aceptan todos. A un repositorio privado se llega por SSH a través del agente SSH, o por HTTPS con una entrada para su host en tu archivo netrc — machine github.com login <user> password <token>. Una credencial escrita en la propia URL se rechaza, como describe Autenticación.
  • ref — la referencia en la que leer el repositorio: un tag, una rama o un commit. Es lo que hayan nombrado los propios autores del repositorio, que no siempre es una versión simple — aquí el tag lleva también el nombre del chart.
  • module_subdir — el directorio dentro del repositorio que es el chart. El repositorio contiene un chart bajo esta ruta en lugar de ser uno, y el directorio forma parte de lo que distingue al artefacto: dos directorios de un mismo repositorio en un mismo commit son dos artefactos, no uno.

El tipo de source nombra el transporte y la ubicación, no el formato. El mismo tipo obtiene un chart, un módulo de Terraform o cualquier otro directorio de archivos; lo que contiene el directorio es asunto del proveedor que lo consume.

Qué registra el lockfile

Solo un commit nombra un contenido que no puede cambiar sin que lo sepas. Un tag o una rama es un nombre que el repositorio puede volver a apuntar a otro commit, así que aggrega pull resuelve la referencia y registra ambos — la referencia que escribiste y el commit al que se resolvió:

# 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

Ambas mitades se ganan su lugar. El commit es lo que obtiene la compilación, así que la compilación es reproducible. La referencia es aquello por lo que la compilación busca la entrada, y eso es lo que te permite seguir escribiendo ref: hello-world-0.1.0 en la Recipe y aun así resolver al commit exacto en el que estaba ese tag cuando se escribió el lockfile.

Generar el ejemplo

Puedes compilar este ejemplo con los comandos de abajo, o hacer que tu asistente de IA lo compile por ti.

Escribe el ejemplo en una carpeta nueva con su nombre:

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

Después imprime los comandos que hay que ejecutar a continuación. El primero entra en la carpeta nueva:

Terminal window
cd chart-from-git-repository

Compilación

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

Este ejemplo incluye dos releases, así que se nombra la que hay que compilar. La primera compilación necesita un lockfile, por eso aquí se pasa --auto-pull; ejecutar una vez antes aggrega pull --release release-chart.yaml hace lo mismo y permite que cada compilación posterior se ejecute sin flag.

El Deployment renderizado lleva los valores que aportó la Release, asignados a los nombres de valor propios del 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 compilación imprime una advertencia:

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

Es exacta y merece leerse en lugar de silenciarse. El Component core/compute/server ofrece un control de dimensionamiento de CPU y memoria; este chart en concreto no expone valores para él, así que la Recipe no asigna nada ahí. Una Recipe sourced asigna lo que el chart que obtiene acepta realmente, y el compilador informa del valor que no llegó a ninguna parte en lugar de fingir que llegó.

Con un asistente de IA

Un asistente de IA configurado con las herramientas de Aggrega puede hacer lo mismo: pégale este prompt.

Usa solo las herramientas de Aggrega y no crees ninguna carpeta tú mismo. Si la carpeta del espacio de trabajo aún no contiene una carpeta `chart-from-git-repository`, llama una sola vez a la herramienta `scaffold` con `example` establecido en `chart-from-git-repository` y sin `dir`: escribe el ejemplo en una nueva carpeta `chart-from-git-repository`. Después llama a la herramienta `build` con `workspace_root` establecido en `chart-from-git-repository`, `release` establecido en `release-chart.yaml`, `auto_pull` establecido en true y `write` establecido en true. Dime qué archivos escribió la compilación; están en `chart-from-git-repository/dist/`.

Cuando la referencia se mueve

Un tag puede volver a apuntarse en el repositorio. Cuando eso ocurre, el siguiente aggrega pull ordinario encuentra que la referencia se resuelve en un sitio distinto del commit que registró, y se detiene en lugar de adoptarlo:

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

Nombra ambos commits, así que puedes ver exactamente qué se movió antes de decidir. El lockfile se queda como estaba — la detención llega antes de que se escriba nada — y adoptar el nuevo commit es un acto deliberado:

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

Una referencia movida es el caso para el que existe --upgrade: un pull ordinario mantiene el commit que registra el lockfile, y solo una actualización adopta el lugar al que apunta ahora la referencia. Un --upgrade sin más descarta todas las fijaciones registradas, así que primero pide confirmación. También hace falta --pin-sources, porque esta Recipe registra además el commit de su source en el entity.lock que tiene al lado: la actualización reescribe esa fijación al nuevo commit, mientras que sin el flag el pull se detiene en el lock y nombra aggrega pin. Haz commit del entity.lock reescrito junto con la Recipe.

Una edición hecha en este espacio de trabajo, en el Aggregate o en la Release por ejemplo, es una deriva de otro tipo: la siguiente compilación la informa, y un aggrega pull --release release-chart.yaml ordinario la elimina.

Fijar un commit en ref: en lugar de un tag es la otra forma de obtener la misma garantía, a costa de una coordenada que ningún humano puede leer.

La release de salvaguarda

release-negative.yaml está pensada para fallar, y está aquí porque una ruta de obtención ejercitada solo en su camino feliz no te dice nada sobre sus protecciones. Despliega el mismo Aggregate mediante manifest-negative.yaml, que enlaza una Recipe idéntica a la que funciona salvo por su referencia — nombra un tag que el repositorio no tiene:

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]

El repositorio es accesible y la clonación tiene éxito; simplemente no hay tal referencia en él, así que no hay ningún commit que fijar ni nada que archivar.

Qué necesita este ejemplo de la red

A diferencia de la mayoría de los espacios de trabajo de aquí, este clona un repositorio real en su primera compilación, así que esa compilación necesita acceso saliente al host nombrado en url. Una vez que existen el lockfile y la caché de resolución, las compilaciones posteriores leen de la caché y se ejecutan sin ninguna red — aggrega build --release release-chart.yaml --offline vuelve a compilar los mismos bytes.