Lernhelm

Anhang B. Chart Repository API

In Kapitel 7 haben wir uns mit Karten-Repositories beschäftigt. Dieser Anhang befasst sich kurz mit der Chart Repository API, der zugrunde liegenden Spezifikation, die Helm die Arbeit mit Chart Repositories ermöglicht.

Die Chart Repository API ist leichtgewichtig, da nur ein einziger HTTP-Endpunkt implementiert werden muss: GET /index.yaml.

In 99 % der Fälle stellen die Chart-Repositories auch Chart-Paket-Tarballs (.tgz) und die zugehörigen Provenance-Dateien (.prov) bereit. Es ist jedoch auch möglich, diese Dateien auf einer separaten Domain zu hosten.

Wie in Kapitel 7 ausführlich beschrieben, stellt index.yaml den Repository-Index dar, der eine vollständige Liste aller verfügbaren Kartenversionen im Repository enthält. Das Format dieser Datei ist spezifisch für Helm, und es gibt derzeit nur eine API-Version (1).

index.yaml

Bei der Implementierung der Chart Repository API muss dein Dienst eine HTTP GET /index.yaml Route relativ zu der angegebenen Repository URL bereitstellen. Die Antwort auf diese Anfrage muss einen Statuscode 200 OK zurückgeben, und der Antwortkörper muss eine gültige index.yaml sein, wie im Folgenden beschrieben.

Hinweis

Der Endpunkt GET /index.yaml muss sich nicht an der Wurzel des URL-Pfads befinden. Bei einer angegebenen Repository-URL wie https://example.com/charts muss die GET /index.yaml -Route beispielsweise unter https://example.com/charts/index.yaml erreichbar sein .

Das index.yaml Format

Es folgt eine einfache, gültige ...