Archiviare i moduli Go in Artifact Registry

Configura un repository Artifact Registry Go privato, carica un modulo e utilizzalo come dipendenza.

Prima di iniziare

  1. Accedi al tuo Account Google.

    Se non ne hai già uno, crea un nuovo account.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  4. Attiva l'API Artifact Registry.

    Abilita l'API

  5. Installa Google Cloud CLI.

  6. Per initialize gcloud CLI, esegui questo comando: 

    gcloud init
    7.

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  8. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  9. Attiva l'API Artifact Registry.

    Abilita l'API

  10. Installa Google Cloud CLI.

  11. Per initialize gcloud CLI, esegui questo comando: 

    gcloud init
    12.
  12. Installa Go 1.15 o versioni successive.
  13. Installa il componente aggiuntivo gcloud CLI package-go-module: 
    gcloud components install package-go-module

Crea un repository

Per creare e configurare un nuovo repository:

  1. Esegui questo comando per creare un nuovo repository.

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

    Sostituisci quanto segue:

    • REPOSITORY è il nome del repository. Per ogni località del repository in un progetto, i nomi dei repository devono essere univoci.
    • LOCATION è la località a livello di una o più regioni per il repository. Puoi omettere questo flag se imposti un valore predefinito. Per visualizzare un elenco delle località supportate, esegui il comando gcloud artifacts locations list.
    • DESCRIPTION è una descrizione facoltativa del repository. Non includere dati sensibili, poiché le descrizioni dei repository non sono criptate.

  2. Esegui questo comando per visualizzare i dettagli del repository.

      gcloud artifacts repositories describe --location=LOCATION REPOSITORY

    L'output è simile al seguente:

      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'

Imposta i valori predefiniti per i comandi gcloud

Puoi semplificare i comandi gcloud CLI configurando le impostazioni predefinite per i valori di progetto, repository e località. Dopo aver configurato i valori predefiniti, i tag --project, --location e --repository non sono più necessari.

Crea un pacchetto e carica un modulo Go

Il componente aggiuntivo gcloud CLI package-go-module pacchettizza i tuoi moduli Go, consentendoti di eseguire la versione e il caricamento su Artifact Registry utilizzando il comando gcloud.

Crea un modulo Go

Per prima cosa, crea un semplice modulo Go da caricare nel tuo repository.

  1. Nella directory home, crea una directory denominata "foo" per il modulo

    mkdir foo

  2. Cambia directory nella directory del modulo ed esegui go mod init per creare un file go.mod per il modulo.

      cd foo \
  go mod init example.com/foo

    Sostituisci example.com/foo con il percorso del modulo. Per ulteriori informazioni, consulta la documentazione di riferimento ai moduli Go.

  3. Crea un file foo.go nella directory foo con il seguente contenuto:

    
package foo

const HelloWorld = "Hello World!"

Pacchettizzare e caricare il modulo

Pacchettizza e carica il modulo nel tuo repository:

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

Sostituisci quanto segue:

  • PROJECT con il tuo ID progetto Google Cloud.
  • REPOSITORY con il nome del repository in cui è archiviato il pacchetto.
  • LOCATION con la località a livello di una o più regioni del repository.
  • example.com/foo con il percorso del modulo. Per ulteriori informazioni, consulta la documentazione di riferimento ai moduli Go.
  • VERSION con la versione semantica del modulo nel formato vX.Y.Z, dove X è la versione principale, Y è la versione secondaria e Z è la versione patch.
  • SOURCE_LOCATION con il percorso della directory radice del modulo Go. Se ometti il flag --source, il valore predefinito è la directory attuale.

Il modulo viene caricato in Artifact Registry.

Per ulteriori informazioni sulla creazione di moduli Go, guarda questo tutorial.

Elenco moduli

Esegui questo comando per ispezionare il modulo Go caricato nel progetto, nel repository e nella località predefiniti quando sono configurati i valori predefiniti:

  gcloud artifacts packages list

L'output è simile al seguente:

  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

Visualizza i dettagli della versione del modulo

Esegui questo comando per visualizzare le versioni del modulo nel progetto, nel repository e nella località predefiniti quando sono configurati i valori predefiniti:

  gcloud artifacts versions list --package=MODULE_PATH

L'output è simile al seguente:

  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

Scarica moduli

Per importare i moduli archiviati in Artifact Registry, devi indicare a Go di cercare le dipendenze da Artifact Registry e ignorare il database di checksum.

configura l'ambiente Go

  1. Indica Go per scaricare i moduli da Artifact Registry, dal proxy del modulo Go pubblico, e quindi per eseguire l'origine in questo ordine:

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

    Sostituisci quanto segue:

    • LOCATION è la località a livello di una o più regioni del repository.
    • PROJECT è il tuo ID progetto Google Cloud.
    • REPOSITORY è il nome del repository in cui è archiviato il pacchetto.

  2. Escludi il modulo dal controllo utilizzando il database di checksum pubblico:

      export GONOSUMDB=MODULE_PATH_REGEX

    Sostituisci MODULE_PATH_REGEX con il percorso del modulo o con un'espressione regolare se vuoi escludere più moduli.

    Per escludere il modulo example.com/foo dal controllo utilizzando il database di checksum pubblico, esegui questo comando:

      export GONOSUMDB=example.com/foo

    Se vuoi che tutti i moduli con percorsi dei moduli che iniziano con example.com vengano esclusi dalla verifica utilizzando il database di checksum pubblico, esegui questo comando:

      export GONOSUMDB=example.com/*

Autenticazione in Artifact Registry

Durante il download dei moduli Go pacchettizzati da utilizzare come dipendenze da Artifact Registry, il file binario Go utilizza le credenziali nel file netrc per eseguire l'autenticazione in Artifact Registry. Per semplificare il processo di autenticazione, puoi utilizzare l'assistente per le credenziali Go per aggiornare i token nel file netrc per l'autenticazione in Artifact Registry.

La posizione del file netrc può essere impostata con la variabile di ambiente netrc. Se la variabile NETRC non è impostata, il comando go leggerà $HOME/.netrc su piattaforme simili a UNIX o %USERPROFILE%\_netrc su Windows.

Artifact Registry supporta i seguenti metodi di autenticazione.

Credenziali di breve durata (consigliato)
Utilizza lo strumento di supporto delle credenziali di Artifact Registry per aggiornare i token di autenticazione nel file netrc.
Usa una chiave dell'account di servizio

Utilizza questa opzione quando non puoi utilizzare le credenziali nel tuo ambiente per l'autenticazione. Aggiungi la chiave non criptata dell'account di servizio al file netrc.

Aggiungi l'assistente per le credenziali Go a GONOPROXY

Prima di utilizzare l'assistente per le credenziali Go, devi aggiungerlo all'elenco GONOPROXY per forzarne il download direttamente da GitHub. Se vuoi scaricare altri moduli direttamente dall'origine, puoi aggiungerli in un elenco separato da virgole, come mostrato nell'esempio seguente:

  export GONOPROXY=MODULE_PATH1, MODULE_PATH2

dove MODULE_PATH1 e MODULE_PATH2 sono percorsi dei moduli da scaricare dall'origine.

Per aggiungere l'assistente per le credenziali Go al tuo elenco GONOPROXY ed eseguirlo per configurare le tue credenziali:

  1. Aggiungi l'assistente per le credenziali Go a GONOPROXY

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

  2. Esegui questo comando per aggiungere le tue credenziali Artifact Registry al file netrc con lo strumento del pacchetto del modulo Go:

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

    Dove LOCATION è la località a livello di una o più regioni del tuo repository. Per aggiungere più località, inseriscile come elenco separato da virgole.

    L'assistente per le credenziali di Go aggiunge impostazioni al tuo file netrc per l'autenticazione in Artifact Registry. Se passi il flag --json_key, la chiave viene aggiunta al tuo file netrc per l'autenticazione tramite password.

Utilizza il modulo come dipendenza

  1. Se utilizzi credenziali di breve durata per l'autenticazione in Artifact Registry, devi aggiornare il token OAuth eseguendo questo comando:

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

  2. Nella tua directory home, crea una directory denominata "bar"

      mkdir bar

  3. Cambia directory nella directory del modulo ed esegui go mod init per creare un file go.mod per il pacchetto.

      cd bar \
  go mod init example.com/bar

    Sostituisci example.com/bar con il percorso del modulo. Per ulteriori informazioni, consulta la documentazione di riferimento ai moduli Go.

  4. Per richiedere la versione di foo archiviata in Artifact Registry, modifica il file go.mod in modo che sia simile al seguente:

    
module example.com/bar

go 1.19

require example.com/foo v0.1.0

    Sostituisci quanto segue:

    • example.com/foo è il percorso del modulo richiesto
    • v0.1.0 è la versione archiviata in Artifact Registry

  5. Crea un file main.go nella directory bar con i seguenti contenuti:

      
  package main

  import (
    "fmt"

    foo "example.com/foo"
  )

  func main() {
    fmt.Println(foo.HelloWorld)
  }

  6. Esegui go mod tidy per scaricare le dipendenze, incluso il pacchetto foo:

      go mod tidy

  7. Esegui il modulo a barre:

      go run .

    L'output è simile al seguente:

      Hello World!

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questa pagina, segui questi passaggi.

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questa pagina, segui questi passaggi. Prima di rimuovere il repository, assicurati che i moduli che vuoi conservare siano disponibili in un'altra posizione.

  1. Per eliminare il repository:

      gcloud artifacts repositories delete \
      --location=LOCATION \
      --project=PROJECT \
      REPOSITORY

    Sostituisci quanto segue:

    • LOCATION con la località a livello di una o più regioni del repository.
    • PROJECT con il tuo ID progetto Google Cloud.
    • REPOSITORY con il nome del repository.

  2. Se vuoi rimuovere il repository predefinito e le impostazioni di geolocalizzazione che hai configurato per la configurazione di gcloud attiva, esegui questi comandi:

      gcloud config unset artifacts/repository
  gcloud config unset artifacts/location

Passaggi successivi