Go-Module in Artifact Registry speichern

Repository erstellen

So erstellen und konfigurieren Sie ein neues Repository:

1. Führen Sie den folgenden Befehl aus, um ein neues Repository zu erstellen:

   gcloud artifacts repositories create REPOSITORY \
       --repository-format=go \
       --location=LOCATION \
       --description=DESCRIPTION
   

   Ersetzen Sie Folgendes:

   • REPOSITORY ist der Name des Repositorys. Repository-Namen können für jeden Repository-Speicherort in einem Projekt nur einmal vorkommen.
   • LOCATION ist der regionale oder multiregionale Speicherort für das Repository. Sie können dieses Flag weglassen, wenn Sie einen Standard-Speicherort festgelegt haben. Führen Sie den Befehl gcloud artifacts locations list aus, um eine Liste der unterstützten Speicherorte aufzurufen.
   • DESCRIPTION ist eine optionale Beschreibung des Repositorys. Geben Sie keine vertraulichen Daten an, da Repository-Beschreibungen nicht verschlüsselt werden.

2. Führen Sie den folgenden Befehl aus, um die Repository-Details aufzurufen.

     gcloud artifacts repositories describe --location=LOCATION REPOSITORY
   

   Die Ausgabe sollte so aussehen:

     Encryption: Google-managed key
     Repository Size: 0.000MB
     createTime: '2022-06-03T20:20:01.644813Z'
     format: GO
     mode: STANDARD_REPOSITORY
     name: projects/my-project/locations/us-west1/repositories/my-repo
     updateTime: '2022-06-03T20:20:01.644813Z'
   

Standardwerte für gcloud-Befehle festlegen

Sie können Ihre gcloud CLI-Befehle vereinfachen, indem Sie die Standardwerte für Projekt-, Repository- und Standortwerte konfigurieren. Nachdem die Standardeinstellungen konfiguriert wurden, sind die Tags --project, --location und --repository nicht mehr erforderlich.

Go-Modul verpacken und hochladen

Das package-go-module-gcloud CLI-Add-on packt Ihre Go-Module, sodass Sie sie mit dem Befehl gcloud versionieren und in Artifact Registry hochladen können.

Go-Modul erstellen

Erstellen Sie zuerst ein einfaches Go-Modul, das Sie in Ihr Repository hochladen können.

1. Erstellen Sie in Ihrem Basisverzeichnis ein Verzeichnis namens „foo“ für Ihr Modul.

   mkdir foo
   

2. Wechseln Sie in das Verzeichnis Ihres Moduls und führen Sie go mod init aus, um eine go.mod-Datei für Ihr Modul zu erstellen.

     cd foo \
     go mod init example.com/foo
   

   Ersetzen Sie example.com/foo durch den Modulpfad. Weitere Informationen finden Sie in der Go-Module-Referenz.

3. Erstellen Sie im Verzeichnis „foo“ eine foo.go-Datei mit folgendem Inhalt:

   
   package foo
   
   const HelloWorld = "Hello World!"
   

Modul verpacken und hochladen

Verpacken Sie das Modul und laden Sie es in Ihr Repository hoch:

  gcloud artifacts go upload --project=PROJECT \
      --repository=REPOSITORY \
      --location=LOCATION \
      --module-path=example.com/foo \
      --version=VERSION \
      --source=SOURCE_LOCATION

Ersetzen Sie Folgendes:

• PROJECT durch Ihre Google Cloud Projekt-ID.
• REPOSITORY durch den Namen des Repositorys, in dem das Paket gespeichert ist.
• Ersetzen Sie LOCATION durch den regionalen oder multiregionalen Speicherort des Repositorys.
• example.com/foo durch den Modulpfad. Weitere Informationen finden Sie in der Go-Module-Referenz.
• VERSION mit der semantischen Version des Moduls im Format vX.Y.Z, wobei X die Hauptversion, Y die Nebenversion und Z die Patchversion ist.
• SOURCE_LOCATION durch den Pfad zum Stammverzeichnis Ihres Go-Moduls. Wenn Sie das Flag --source weglassen, wird standardmäßig das aktuelle Verzeichnis verwendet.

Das Modul wird in Artifact Registry hochgeladen.

Weitere Informationen zum Erstellen von Go-Modulen finden Sie in dieser Anleitung.

Module auflisten

Führen Sie den folgenden Befehl aus, um das hochgeladene Go-Modul im Standardprojekt, im Standard-Repository und am Standard-Speicherort zu prüfen, wenn die Standardwerte konfiguriert sind:

  gcloud artifacts packages list

Die Ausgabe sollte so aussehen:

  Listing items under project my-project, location us-west1, repository my-repo.

  PACKAGE                   CREATE_TIME          UPDATE_TIME
  example.com/foo           2022-06-03T20:43:39  2022-06-20T20:37:40

Details zur Modulversion ansehen

Führen Sie den folgenden Befehl aus, um die Versionen Ihres Moduls im Standardprojekt, im Standard-Repository und am Standard-Speicherort aufzurufen, wenn die Standardwerte konfiguriert sind:

  gcloud artifacts versions list --package=MODULE_PATH

Die Ausgabe sollte so aussehen:

  Listing items under project my-project, location us-west1, repository my-repo, package example.com/foo.

  VERSION  DESCRIPTION  CREATE_TIME          UPDATE_TIME
  v0.1.0                2022-06-03T20:43:39  2022-06-03T20:43:39
  v0.1.1                2022-06-20T20:37:40  2022-06-20T20:37:40

Module herunterladen

Wenn Sie in Artifact Registry gespeicherte Module importieren möchten, müssen Sie Go anweisen, nach Abhängigkeiten in Artifact Registry zu suchen und die Prüfsummen-Datenbank zu umgehen.

Go-Umgebung einrichten

1. Weisen Sie Go an, Module aus Artifact Registry, dem öffentlichen Go-Modul-Proxy und dann in dieser Reihenfolge aus der Quelle herunterzuladen:

     export GOPROXY=https://LOCATION-go.pkg.dev/PROJECT/REPOSITORY,https://proxy.golang.org,direct
   

   Ersetzen Sie Folgendes:

   • LOCATION ist der regionale oder multiregionale Speicherort des Repositorys.
   • PROJECT ist Ihre Google Cloud Projekt-ID.
   • REPOSITORY ist der Name des Repositorys, in dem das Paket gespeichert ist.

2. So schließen Sie Ihr Modul von der Überprüfung mit der öffentlichen Prüfsummen-Datenbank aus:

     export GONOSUMDB=MODULE_PATH_REGEX
   

   Ersetzen Sie MODULE_PATH_REGEX durch Ihren Modulpfad oder einen regulären Ausdruck, wenn Sie mehrere Module ausschließen möchten.

   Wenn Sie Ihr Modul example.com/foo von der Überprüfung mit der öffentlichen Prüfsummen-Datenbank ausschließen möchten, führen Sie den folgenden Befehl aus:

     export GONOSUMDB=example.com/foo
   

   Wenn Sie möchten, dass alle Module mit Modulpfaden, die mit example.com beginnen, nicht anhand der öffentlichen Prüfsummen-Datenbank geprüft werden, führen Sie den folgenden Befehl aus:

     export GONOSUMDB=example.com/*
   

Bei Artifact Registry authentifizieren

Wenn Sie verpackte Go-Module als Abhängigkeiten aus Artifact Registry herunterladen, verwendet das Go-Binärprogramm die Anmeldedaten in Ihrer .netrc-Datei, um sich bei Artifact Registry zu authentifizieren. Um die Authentifizierung zu vereinfachen, können Sie den Go Credential Helper verwenden, um die Tokens in Ihrer .netrc-Datei für die Authentifizierung bei Artifact Registry zu aktualisieren.

Der Speicherort Ihrer .netrc-Datei kann mit der Umgebungsvariable „netrc“ festgelegt werden. Wenn die Variable NETRC nicht festgelegt ist, liest der Befehl go unter UNIX-ähnlichen Plattformen $HOME/.netrc oder unter Windows %USERPROFILE%\_netrc.

Artifact Registry unterstützt die folgenden Authentifizierungsmethoden.

Kurzlebige Anmeldedaten (empfohlen)

Verwenden Sie das Go-Tool für Artifact Registry Credential Helper, um die Authentifizierungstokens in Ihrer .netrc-Datei zu aktualisieren.

Dienstkontoschlüssel verwenden

Verwenden Sie diese Option, wenn Sie in Ihrer Umgebung keine Anmeldedaten für die Authentifizierung verwenden können. Fügen Sie den unverschlüsselten Dienstkontoschlüssel in Ihre .netrc-Datei ein.

Fügen Sie GONOPROXY den Go Credential Helper hinzu.

Bevor Sie den Go Credential Helper verwenden können, müssen Sie ihn der Liste GONOPROXY hinzufügen, damit Go ihn direkt von GitHub herunterlädt. Wenn Sie andere Module haben, die direkt von der Quelle heruntergeladen werden sollen, können Sie sie in einer kommagetrennten Liste hinzufügen, wie im folgenden Beispiel gezeigt:

  export GONOPROXY=MODULE_PATH1, MODULE_PATH2

Dabei sind MODULE_PATH1 und MODULE_PATH2 die Modulpfade der Module, die aus der Quelle heruntergeladen werden sollen.

So fügen Sie den Go-Credential Helper Ihrer GONOPROXY-Liste hinzu und führen ihn aus, um Ihre Anmeldedaten einzurichten:

1. Fügen Sie Ihrem GONOPROXY den Go-Credential-Helper hinzu.

     export GONOPROXY=github.com/GoogleCloudPlatform/artifact-registry-go-tools
   

2. Führen Sie den folgenden Befehl aus, um Ihre Artifact Registry-Anmeldedaten mit dem Go-Modul-Pakettool zu Ihrer .netrc-Datei hinzuzufügen:

     GOPROXY=proxy.golang.org \
         go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.4.0 \
         add-locations --locations=LOCATION \
         [--json_key=path/to/service/account/key.json]
   

   Dabei ist LOCATION der regionale oder multiregionale Standort Ihres Repositorys. Wenn Sie mehrere Standorte hinzufügen möchten, geben Sie sie als durch Kommas getrennte Liste ein.

   Der Go Credential Helper fügt Ihrer .netrc-Datei Einstellungen für die Authentifizierung bei Artifact Registry hinzu. Wenn Sie das Flag --json_key übergeben, wird der Schlüssel Ihrer netrc-Datei für die Passwortauthentifizierung hinzugefügt.

Modul als Abhängigkeit verwenden

1. Wenn Sie kurzlebige Anmeldedaten für die Authentifizierung bei Artifact Registry verwenden, müssen Sie Ihr OAuth-Token mit dem folgenden Befehl aktualisieren:

     GOPROXY=proxy.golang.org \
     go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.4.0 refresh
   

2. Erstellen Sie in Ihrem Basisverzeichnis ein Verzeichnis mit dem Namen „bar“.

     mkdir bar
   

3. Wechseln Sie in das Verzeichnis Ihres Moduls und führen Sie go mod init aus, um eine go.mod-Datei für Ihr Paket zu erstellen.

     cd bar \
     go mod init example.com/bar
   

   Ersetzen Sie example.com/bar durch den Modulpfad. Weitere Informationen finden Sie in der Go-Module-Referenz.

4. Wenn Sie die in Artifact Registry gespeicherte Version von „foo“ benötigen, bearbeiten Sie die Datei go.mod so, dass sie dem folgenden Beispiel ähnelt:

   
   module example.com/bar
   
   go 1.19
   
   require example.com/foo v0.1.0
   

   Ersetzen Sie Folgendes:

   • example.com/foo ist der Modulpfad des erforderlichen Moduls.
   • v0.1.0 ist die in Artifact Registry gespeicherte Version.

5. Erstellen Sie eine main.go-Datei in Ihrem bar-Verzeichnis mit folgendem Inhalt:

     
     package main
   
     import (
       "fmt"
   
       foo "example.com/foo"
     )
   
     func main() {
       fmt.Println(foo.HelloWorld)
     }
   
     
   

6. Führen Sie „go mod tidy“ aus, um Abhängigkeiten herunterzuladen, einschließlich des „foo“-Pakets:

     go mod tidy
   

7. Führen Sie das Balkenmodul aus:

     go run .
   

   Die Ausgabe sollte so aussehen:

     Hello World!