Armazenar módulos Go no Artifact Registry

Configure um repositório Go privado do Artifact Registry, faça upload de um módulo e use-o como dependência.

Antes de começar

  1. Faça login na sua Conta do Google.

    Se você ainda não tiver uma, inscreva-se agora.

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Artifact Registry API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  5. Instale a Google Cloud CLI.

  6. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

  7. Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  9. Verify that billing is enabled for your Google Cloud project.

  10. Enable the Artifact Registry API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  11. Instale a Google Cloud CLI.

  12. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

  13. Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init
  14. Instale o Go1.15 ou uma versão mais recente.
  15. Instale o complemento da CLI gcloud package-go-module: 
    gcloud components install package-go-module

Criar um repositório

Para criar e configurar um novo repositório:

  1. Execute o comando abaixo para criar um novo repositório.

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

    Substitua:

    • REPOSITORY é o nome do repositório. Para cada local de repositório em um projeto, os nomes dos repositórios precisam ser exclusivos.
    • LOCATION é o local regional ou multirregional do repositório. É possível omitir essa flag se você definir um padrão. Para conferir uma lista de locais compatíveis, execute o comando gcloud artifacts locations list.
    • DESCRIPTION é uma descrição opcional do repositório. Não inclua dados sensíveis, já que as descrições do repositório não são criptografadas.

  2. Execute o comando abaixo para conferir os detalhes do repositório.

      gcloud artifacts repositories describe --location=LOCATION REPOSITORY

    A saída será assim:

      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'

Definir padrões para comandos gcloud

É possível simplificar os comandos gcloud CLI ao configurar os padrões para valores de projeto, repositório e local. Depois que os padrões forem configurados, as tags --project, --location e --repository não serão necessárias.

Empacotar e fazer upload de um módulo Go

O complemento da CLI gcloud package-go-module empacota seus módulos Go, permitindo que você crie versões e faça upload para o Artifact Registry usando o comando gcloud.

Criar um módulo Go

Primeiro, crie um módulo Go simples para fazer upload no repositório.

  1. No diretório inicial, crie um diretório chamado "foo" para o módulo.

    mkdir foo

  2. Mude os diretórios para o diretório do módulo e execute go mod init para criar um arquivo go.mod para o módulo.

      cd foo \
  go mod init example.com/foo

    Substitua example.com/foo pelo caminho do módulo. Consulte a referência de módulos Go para mais informações.

  3. Crie um arquivo foo.go no diretório foo com o seguinte conteúdo:

    
package foo

const HelloWorld = "Hello World!"

Empacotar e fazer upload do módulo

Empacote e faça upload do módulo para o repositório:

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

Substitua:

  • PROJECT pelo ID do projeto Google Cloud .
  • REPOSITORY pelo nome do repositório em que o pacote está armazenado.
  • LOCATION pelo local regional ou multirregional location do repositório.
  • example.com/foo pelo caminho do módulo. Consulte a referência de módulos Go para mais informações.
  • VERSION com a versão semântica do módulo no formato vX.Y.Z, em que X é a versão principal, Y é a versão secundária e Z é a versão do patch.
  • SOURCE_LOCATION pelo caminho para o diretório raiz do módulo Go. Se você omitir a flag --source, o padrão será o diretório atual.

O módulo é enviado para o Artifact Registry.

Para mais informações sobre como criar módulos Go, consulte este tutorial.

Listar módulos

Execute o comando abaixo para inspecionar o módulo Go enviado no projeto, repositório e local padrão quando os valores padrão estiverem configurados:

  gcloud artifacts packages list

A saída será assim:

  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

Conferir detalhes da versão do módulo

Execute o comando abaixo para conferir as versões do módulo no projeto, repositório e local padrão quando os valores padrão estiverem configurados:

  gcloud artifacts versions list --package=MODULE_PATH

A saída será assim:

  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

Fazer download de módulos

Para importar módulos armazenados no Artifact Registry, é necessário instruir o Go a procurar dependências no Artifact Registry e ignorar o banco de dados de soma de verificação.

Configurar o ambiente Go

  1. Instrua o Go a fazer o download de módulos do Artifact Registry, do proxy público de módulos Go e, em seguida, da origem nessa ordem:

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

    Substitua:

    • LOCATION pelo local regional ou multirregional localização do repositório.
    • PROJECT é o ID do seu Google Cloud projeto.
    • REPOSITORY pelo nome do repositório em que o pacote está armazenado.

  2. Exclua o módulo da verificação usando o banco de dados público de soma de verificação:

      export GONOSUMDB=MODULE_PATH_REGEX

    Substitua MODULE_PATH_REGEX pelo caminho do módulo ou uma regex se quiser excluir vários módulos.

    Para excluir o módulo example.com/foo da verificação usando o banco de dados público de soma de verificação, execute o comando abaixo:

      export GONOSUMDB=example.com/foo

    Se você quiser que todos os módulos com caminhos de módulo que começam em example.com sejam excluídos da verificação usando o banco de dados público de soma de verificação, execute o comando abaixo:

      export GONOSUMDB=example.com/*

Autenticar no Artifact Registry

Ao fazer o download de módulos Go empacotados para usar como dependências do Artifact Registry, o binário Go usa as credenciais no arquivo netrc para autenticar no Artifact Registry. Para simplificar o processo de autenticação, use o auxiliar de credenciais Go para atualizar os tokens no arquivo netrc para autenticação no Artifact Registry.

O local do arquivo netrc pode ser definido com a variável de ambiente netrc. Se a variável NETRC não estiver definida, o comando go vai ler $HOME/.netrc em plataformas semelhantes ao UNIX ou %USERPROFILE%\_netrc no Windows.

O Artifact Registry é compatível com os seguintes métodos de autenticação.

Credenciais de curta duração (recomendado)
Use a ferramenta auxiliar de credenciais Go do Artifact Registry para atualizar os tokens de autenticação no arquivo netrc.
Usar uma chave de conta de serviço

Use essa opção quando não for possível usar credenciais no ambiente para autenticação. Adicione a chave de conta de serviço não criptografada ao arquivo netrc.

Adicionar o auxiliar de credenciais Go ao GONOPROXY

Antes de usar o auxiliar de credenciais Go, é necessário adicioná-lo à lista GONOPROXY para forçar o Go a fazer o download diretamente do GitHub. Se você tiver outros módulos que quer que sejam baixados diretamente da origem, adicione-os em uma lista separada por vírgulas, conforme mostrado no exemplo abaixo:

  export GONOPROXY=MODULE_PATH1, MODULE_PATH2

Em que MODULE_PATH1 e MODULE_PATH2 são caminhos de módulos a serem baixados da origem.

Para adicionar o auxiliar de credenciais Go à lista GONOPROXY e executá-lo para configurar suas credenciais:

  1. Adicione o auxiliar de credenciais Go ao GONOPROXY.

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

  2. Execute o comando abaixo para adicionar suas credenciais do Artifact Registry ao arquivo netrc com a ferramenta de pacote de módulos Go:

      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]

    Em que LOCATION é o local regional ou multirregional do repositório. Para adicionar vários locais, insira-os como uma lista separada por vírgulas.

    O auxiliar de credenciais Go adiciona configurações ao arquivo netrc para autenticação no Artifact Registry. Se você transmitir a flag --json_key, a chave será adicionada ao arquivo netrc para autenticação de senha.

Usar o módulo como dependência

  1. Se você estiver usando credenciais de curta duração para autenticação no Artifact Registry, será necessário atualizar o token OAuth executando o comando abaixo:

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

  2. No diretório inicial, crie um diretório chamado "bar".

      mkdir bar

  3. Mude os diretórios para o diretório do módulo e execute go mod init para criar um arquivo go.mod para o pacote.

      cd bar \
  go mod init example.com/bar

    Substitua example.com/bar pelo caminho do módulo. Consulte a referência de módulos Go para mais informações.

  4. Para exigir a versão do foo armazenada no Artifact Registry, edite o arquivo go.mod para que ele fique assim:

    
module example.com/bar

go 1.19

require example.com/foo v0.1.0

    Substitua:

    • example.com/foo é o caminho do módulo necessário.
    • v0.1.0 é a versão armazenada no Artifact Registry.

  5. Crie um arquivo main.go no diretório bar com o seguinte conteúdo:

      
  package main

  import (
    "fmt"

    foo "example.com/foo"
  )

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

  6. Execute go mod tidy para fazer o download de dependências, incluindo o pacote foo:

      go mod tidy

  7. Execute o módulo de barra:

      go run .

    A saída será assim:

      Hello World!

Liberar espaço

Para evitar cobranças na conta do Google Cloud pelos recursos usados nesta página, siga as etapas abaixo.

Para evitar cobranças na conta do Google Cloud pelos recursos usados nesta página, siga as etapas abaixo. Antes de remover o repositório, verifique se os módulos que você quer manter estão disponíveis em outro local.

  1. Para excluir o repositório:

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

    Substitua:

    • LOCATION pelo local regional ou multirregional location do repositório.
    • PROJECT pelo ID do projeto Google Cloud .
    • REPOSITORY pelo nome do repositório.

  2. Se quiser remover as configurações padrão de repositório e local que você definiu para a configuração ativa da gcloud, execute os comandos abaixo:

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

A seguir