Auf dieser Seite wird erläutert, wie Sie Helm 3-Diagramme verwalten, die als OCI-Container-Images gespeichert sind. Dazu gehört auch, dass Sie Diagramme hoch- (hochladen), abrufen (herunterladen), auflisten, taggen und löschen.
Hinweise
- Wenn das Ziel-Repository nicht vorhanden ist, erstellen Sie ein neues Repository. Wählen Sie Docker als Repository-Format aus.
- Prüfen Sie, ob Sie die erforderlichen Berechtigungen für das Repository haben.
- (Optional) Konfigurieren Sie Standardeinstellungen für Google Cloud CLI-Befehle.
Installieren Sie Helm 3.8.0 oder höher. In früheren Versionen von Helm ist die Unterstützung von Diagrammen im OCI-Format eine experimentelle Funktion.
Führen Sie
helm version
aus, um Ihre Version zu prüfen.Konfigurieren Sie Helm für die Authentifizierung bei Artifact Registry.
Diagramme erstellen oder abrufen
Diese Dokumentation konzentriert sich auf die Verwaltung Ihrer Diagrammbilder. Dabei wird davon ausgegangen, dass Sie bereits Diagramme haben oder mit dem Erstellen von Diagrammen vertraut sind. Weitere Informationen zum Erstellen von Diagrammen oder zum Abrufen öffentlich verfügbarer Diagramme in Artifact Hub finden Sie in den folgenden Informationen in der Helm-Dokumentation.
- Unter Verwendung von Helm wird beschrieben, wie Sie Diagramme aus dem öffentlichen Artifact Hub abrufen und ein Diagramm vor der Installation anpassen.
- Unter Diagramme werden Diagramme beschrieben und das Erstellen von Diagrammen.
- Im Best Practices-Leitfaden für Diagramme werden Konventionen und Best Practices beschrieben.
Diagramm verpacken
Bevor Sie ein Diagramm an Artifact Registry übertragen können, müssen Sie es als Diagrammarchiv verpacken.
Wechseln Sie in das Verzeichnis, das Ihr Diagramm enthält.
Verpacken Sie das Diagramm.
helm package CHART-PATH
Ersetzen Sie CHART-PATH durch den Pfad zu dem Verzeichnis, das die Datei
Chart.yaml
enthält.
Helm verwendet den Diagrammnamen und die Version als Archivdateiname. Wenn Sie beispielsweise ein Diagramm mit dem Namen my-chart
und der Versionsnummer 0.1.0
haben, lautet der Paketname my-chart-0.1.0.tgz
.
Sie können das Diagramm jetzt per Push an Artifact Registry übertragen.
Diagramm übertragen
Nachdem Sie das Diagramm verpackt haben, können Sie es per Push in Artifact Registry übertragen.
Führen Sie den folgenden Befehl aus, um das Diagramm per Push zu übertragen:
helm push my-chart-0.1.0.tgz oci://LOCATION-docker.pkg.dev/PROJECT/REPOSITORY
Ersetzen Sie die folgenden Werte:
- LOCATION ist der regionale oder multiregionale Standort des Repositorys.
- PROJECT ist Ihre Google Cloud-Projekt-ID. Wenn die Projekt-ID einen Doppelpunkt (`:`) enthält, finden Sie weitere Informationen unter Auf Domains beschränkte Projekte.
- REPOSITORY ist der Name des Repositorys.
Helm verwendet Informationen aus Chart.yaml
für den Namen und das Tag des OCI-Container-Images. Betrachten Sie den folgenden Beispielbefehl:
helm push my-chart-0.1.0.tgz oci://us-west1-docker.pkg.dev/my-project/my-repo
Helm lädt das Diagrammarchiv als Bild my-chart
mit dem Tag 0.1.0
hoch.
Listen Sie die Images im Repository auf, um zu prüfen, ob der Push-Vorgang erfolgreich war.
gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT/REPOSITORY
Diagramme werden abgerufen
So rufen Sie ein Diagramm ab:
Führen Sie den folgenden Befehl aus, um das Diagrammarchiv abzurufen:
helm pull oci://LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE \ --version VERSION
Wenn Sie das Diagrammarchiv abrufen und seinen Inhalt extrahieren möchten, fügen Sie das Flag
--untar
hinzu.helm pull oci://LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE \ --version VERSION \ --untar
Ersetzen Sie die folgenden Werte:
- LOCATION ist der regionale oder multiregionale Standort des Repositorys.
- PROJECT ist Ihre Google Cloud-Projekt-ID. Wenn die Projekt-ID einen Doppelpunkt (`:`) enthält, finden Sie weitere Informationen unter Auf Domains beschränkte Projekte.
- REPOSITORY ist der Name des Repositorys, in dem das Image gespeichert ist.
- IMAGE ist der Name des Images im Repository.
- VERSION ist die semantische Version des Diagramms. Dieses Flag ist erforderlich. Helm unterstützt das Abrufen eines Diagramms mit einem Tag nicht.
Diagramme installieren
Installieren Sie ein in Artifact Registry gespeichertes Diagramm mit dem Befehl helm install.
helm install RELEASE \
oci://LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE \
--version VERSION
Im folgenden Beispiel wird ein Release namens release1
mit der Version 0.1.0
des Diagramms us-west1-docker.pkg.dev/nyap-test/helm-repo/my-chart
installiert:
helm install release1 oci://us-west1-docker.pkg.dev/nyap-test/helm-repo/my-chart --version 0.1.0
Diagramme auflisten
Sie können Diagramme über die Google Cloud Console oder die Befehlszeile auflisten. Wenn Sie Container-Images und -Diagramme im selben Docker-Repository speichern, werden beide Artefakttypen in der Liste angezeigt.
Console
So zeigen Sie Images in einem Repository an:
Öffnen Sie in der Cloud Console die Seite Repositories.
Klicken Sie auf das Repository mit dem Container-Image.
Klicken Sie auf ein Bild, um die zugehörigen Versionen aufzurufen.
gcloud
So listen Sie alle Images im Standardprojekt, im Repository und am Standort auf, wenn die Standardwerte konfiguriert sind:
gcloud artifacts docker images list
Führen Sie den folgenden Befehl aus, um Images in einem Repository an einem bestimmten Speicherort aufzulisten:
gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT/REPOSITORY
Führen Sie den folgenden Befehl aus, um alle Digests und Tags für ein bestimmtes Image aufzulisten:
gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE \
--include-tags
Ersetzen Sie die folgenden Werte:
- LOCATION ist der regionale oder multiregionale Standort des Repositorys.
- PROJECT ist Ihre Google Cloud-Projekt-ID. Wenn die Projekt-ID einen Doppelpunkt (`:`) enthält, finden Sie weitere Informationen unter Auf Domains beschränkte Projekte.
- REPOSITORY ist der Name des Repositorys, in dem das Image gespeichert ist.
- IMAGE ist der Name des Images im Repository.
--include-tags
zeigt alle Image-Versionen einschließlich Digests und Tags an. Wenn dieses Flag nicht angegeben wird, enthält die zurückgegebene Liste nur übergeordnete Container-Images.
Angenommen, Sie haben ein Image mit folgenden Merkmalen:
- Speicherort des Repositorys:
us-west1
- Repository-Name:
my-repo
- Projekt-ID:
my-project
- Image-Name:
my-image
Der vollständige Repository-Name lautet:
us-west1-docker.pkg.dev/my-project/my-repo
Der vollständige Image-Name lautet:
us-west1-docker.pkg.dev/my-project/my-repo/my-image
Weitere Informationen zum Format der Image-Namen finden Sie unter Repository- und Image-Namen.
Dateien auflisten
Sie können Dateien in einem Repository, Dateien in allen Versionen eines bestimmten Container-Images oder Dateien in einer bestimmten Version eines Images auflisten.
Bei allen folgenden Befehlen können Sie eine maximale Anzahl von Dateien festlegen, die zurückgegeben werden sollen. Dazu fügen Sie dem Befehl das Flag --limit
hinzu.
So listen Sie alle Dateien im Standardprojekt, Repository und am Speicherort auf, wenn die Standardwerte konfiguriert sind:
gcloud artifacts files list
Führen Sie den folgenden Befehl aus, um Dateien in einem bestimmten Projekt, Repository und Speicherort aufzulisten:
gcloud artifacts files list \
--project=PROJECT \
--repository=REPOSITORY \
--location=LOCATION
So listen Sie Dateien für alle Versionen eines bestimmten Container-Images auf:
gcloud artifacts files list \
--project=PROJECT \
--repository=REPOSITORY \
--location=LOCATION \
--package=PACKAGE
So listen Sie Dateien für eine bestimmte Container-Image-Version auf:
gcloud artifacts files list \
--project=PROJECT \
--repository=REPOSITORY \
--location=LOCATION \
--package=PACKAGE \
--version=VERSION
So listen Sie Dateien für ein bestimmtes Tag auf:
gcloud artifacts files list \
--project=PROJECT \
--repository=REPOSITORY \
--location=LOCATION \
--package=PACKAGE \
--tag=TAG
Ersetzen Sie die folgenden Werte:
LOCATION
: der regionale oder multiregionale Standort des Repositorys.PROJECT
: Ihre Google Cloud-Projekt-ID. Wenn die Projekt-ID einen Doppelpunkt (`:`) enthält, finden Sie weitere Informationen unter Auf Domains beschränkte Projekte.REPOSITORY
: der Name des Repositorys, in dem das Image gespeichert ist.PACKAGE
: der Name des ImagesVERSION
: Image-Digest, ein String, der mitsha256:
beginntTAG
ist das mit dem Container-Image verknüpfte Tag.
Images löschen
In einem Artifact Registry-Repository können Sie ein ganzes Container-Image oder eine bestimmte Image-Version löschen, die mit einem Tag oder Digest verknüpft ist. Wenn Sie ein Image gelöscht haben, kann dieser Vorgang nicht mehr rückgängig gemacht werden.
So löschen Sie ein in Artifact Registry gespeichertes Image:
Console
Öffnen Sie in der Cloud Console die Seite Repositories.
Klicken Sie auf den Image-Namen, um die Versionen des Images aufzurufen.
Wählen Sie die Versionen aus, die Sie löschen möchten.
Klicken Sie auf Löschen.
Klicken Sie im Bestätigungsdialogfeld auf Löschen.
gcloud
Um ein Image und alle zugehörigen Tags zu löschen, führen Sie folgenden Befehl aus:
gcloud artifacts docker images delete LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE --delete-tags
Um eine bestimmte Image-Version zu löschen, verwenden Sie einen der folgenden Befehle:
gcloud artifacts docker images delete LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE:TAG [--delete-tags]
oder
gcloud artifacts docker images delete LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE@IMAGE-DIGEST [--delete-tags]
Dabei gilt:
- LOCATION ist der regionale oder multiregionale Standort des Repositorys.
- PROJECT ist Ihre Google Cloud-Projekt-ID. Wenn die Projekt-ID einen Doppelpunkt (`:`) enthält, finden Sie weitere Informationen unter Auf Domains beschränkte Projekte.
- REPOSITORY ist der Name des Repositorys, in dem das Image gespeichert ist.
- IMAGE ist der Name des Images im Repository.
- TAG ist das Tag für die Version, die Sie löschen möchten.
Wenn mehrere Tags mit derselben Image-Version verknüpft sind, müssen Sie
--delete-tags
angeben, damit die Image-Version ohne vorheriges Entfernen der Tags gelöscht wird. - IMAGE-DIGEST ist der sha256-Hash-Wert für die Version, die Sie löschen möchten. Wenn ein Tag mit dem Image-Digest verknüpft ist, müssen Sie
--delete-tags
angeben, damit die Image-Version ohne vorheriges Entfernen des Tags gelöscht wird. - Mit
--delete-tags
werden alle Tags entfernt, die auf die Image-Version angewendet werden. Mit diesem Flag können Sie das Löschen einer Image-Version erzwingen, wenn Folgendes gilt:- Sie haben ein Tag angegeben, aber mit der Image-Version sind weitere Tags verknüpft.
- Sie haben einen Image-Digest mit mindestens einem Tag angegeben.
Nächste Schritte
- Informationen zum Verwalten von Docker-Images
- Laden Sie einzelne Dateien aus Ihrem Repository herunter, ohne Helm-Befehle zu verwenden.