Mudanças para criar e implantar no Google Cloud

Neste documento, você verá as diferenças entre o Container Registry e o Artifact Registry ao criar imagens de contêiner com o Cloud Build e implantá-las em ambientes de execução do Google Cloud, como Cloud Run ou Google Kubernetes Engine.

Neste guia, as comparações se concentram nos repositórios padrão do Artifact Registry, em repositórios regulares do Artifact Registry que são independentes do Container Registry e compatíveis com todos os recursos do Artifact Registry. Se o administrador configurar repositórios com suporte ao domínio gcr.io, as solicitações para nomes de host gcr.io serão redirecionadas automaticamente para um repositório correspondente do Artifact Registry, mas Ainda é preciso considerar algumas diferenças no fluxo de trabalho, incluindo:

  • Criação de repositórios: no Artifact Registry, só é possível enviar imagens para um repositório existente.
  • Permissões: o Artifact Registry tem permissões próprias para controlar o acesso aos repositórios.

Para saber mais sobre as diferenças entre o Container Registry e o Artifact Registry usando um cliente Docker, consulte Alterações no envio e na extração com o Docker.

Use essas informações para adaptar os comandos, a configuração ou a documentação atual voltada ao Container Registry com o Cloud Build.

Antes de começar

Veja o que é necessário para seguir este documento:

  1. ativou o Artifact Registry no projeto;
  2. ativou a API Cloud Build e a API de qualquer outro serviço do Google Cloud que você esteja usando com o Artifact Registry.

Alterações no fluxo de trabalho

Quando você usa o Cloud Build com o Container Registry no mesmo projeto, o fluxo de trabalho tem a seguinte aparência:

  1. Crie, marque e envie uma imagem para o repositório com o Cloud Build, usando um Dockerfile ou um arquivo de configuração do build.

    O exemplo a seguir cria a imagem my-image, marca-a com tag1 e a envia para o host gcr.io no projeto my-project:

    gcloud builds submit --tag gcr.io/my-project/my-image:tag1
    
  2. Os ambientes de execução do Google Cloud, como o Cloud Run e o Google Kubernetes Engine, extraem imagens do registro.

    Por exemplo, o comando implanta a imagem da etapa anterior no Cloud Run como my-service.

    gcloud run deploy my-service --image gcr.io/my-project/my-image:tag1
    

O fluxo de trabalho do Container Registry combina as responsabilidades do administrador com a criação e a implantação.

  • Quando você ativa algumas APIs do Google Cloud, a API Container Registry é ativada automaticamente. Isso significa que os usuários desses serviços têm acesso implícito ao Container Registry no mesmo projeto. Por exemplo, os usuários que podem executar versões no Cloud Build podem enviar imagens para registros e adicionar hosts de registro por padrão.
  • A conta de serviço do Cloud Build tem permissões para criar buckets de armazenamento do Cloud Storage. Isso significa que a conta pode adicionar automaticamente hosts do Container Registry a um projeto na primeira vez que enviar uma imagem para o host. Isso também significa que a conta pode criar, ler e gravar em buckets de armazenamento em todo o projeto, incluindo buckets não usados pelo Container Registry.

No Artifact Registry, há uma separação clara dos papéis de administrador e de criação que alteram as etapas no fluxo de trabalho de criação e implantação. Para adaptar o fluxo de trabalho do Container Registry no Artifact Registry, faça as alterações a seguir. Cada etapa inclui informações adicionais sobre como modificar o fluxo de trabalho.

  1. Novo: Ativar a API Artifact Registry.

    Ative a API Artifact Registry. O Cloud Build e os ambientes de execução, como o Cloud Run e o GKE, não ativam automaticamente a API.

  2. Novo: crie o repositório de destino do Docker se ainda não houver um. É preciso criar um repositório antes de enviar qualquer imagem para ele. O envio de uma imagem não pode acionar a criação de um repositório e a conta de serviço do Cloud Build não tem permissões para criar repositórios.

  3. Alterado: criar, marcar e enviar uma imagem para o repositório com o Cloud Build, usando um Dockerfile ou um arquivo de configuração de versão.

    O comando de exemplo a seguir é igual ao exemplo do Container Registry, mas usa um caminho de repositório do Artifact Registry para a imagem.

    gcloud builds submit --tag us-central1-docker.pkg.dev/my-repo/my-image:tag1
    
  4. Alterado: implante a imagem em um ambiente de execução do Google Cloud, como o Cloud Run ou o GKE.

    O comando de exemplo a seguir é o mesmo do Container Registry, mas usa o caminho do repositório do Artifact Registry para a imagem.

    gcloud run deploy my-service --image us-central1-docker.pkg.dev/my-repo/my-image:tag1
    

Além disso, o Artifact Registry usa papéis diferentes do Container Registry para controlar o acesso a imagens. É necessário configurar permissões nas seguintes situações:

  • Os ambientes de execução do Cloud Build ou do Google Cloud estão em um projeto diferente do Artifact Registry.
  • Use contas de serviço personalizadas para serviços do Google Cloud, como o Cloud Build ou o GKE, em vez de contas de serviço padrão.
  • Você concedeu permissões a outras contas de usuário ou serviço.

Ative a API

Pontos principais

A comparação a seguir descreve a ativação da API para cada serviço:

Container Registry

Quando você ativa as seguintes APIs do Google Cloud, a API Container Registry também é ativada automaticamente:

  • Ambiente flexível do App Engine
  • Cloud Build
  • Cloud Functions
  • Cloud Run
  • Verificação de contêiner ou verificação sob demanda no Artifact Analysis
  • Google Kubernetes Engine

Com as permissões padrão, os usuários que podem executar builds no Cloud Build, verificar contêineres com o Artifact Analysis ou implantar contêineres nos ambientes de execução do Google Cloud implicitamente têm acesso a imagens no Container Registry quando o registro está no mesmo projeto.

Artifact Registry

Ative a API Artifact Registry. Serviços como Cloud Build, Cloud Run e GKE não ativam automaticamente a API Artifact Registry.

É possível ativar várias APIs no mesmo projeto usando a gcloud. Por exemplo, para ativar a API Cloud Build e a API Artifact Registry, execute o comando:

gcloud services enable
    artifactregistry.googleapis.com \
    cloudbuild.googleapis.com

Como adicionar registros e repositórios

Pontos principais

  • É preciso criar um repositório Docker do Artifact Registry antes de enviar uma imagem para ele.
  • O Container Registry armazena todas as imagens em uma única multirregião no mesmo bucket de armazenamento. No Artifact Registry, é possível criar vários repositórios na mesma região ou multirregião com políticas de acesso separadas.

A comparação a seguir descreve a configuração do repositório em cada serviço:

Container Registry

No Container Registry é possível adicionar até quatro hosts de registro ao seu projeto. Para adicionar um host de registro, envie a primeira imagem.

  1. Para adicionar um registro como gcr.io ao seu projeto, uma conta com o papel Administrador de armazenamento no nível do projeto envia uma imagem inicial.

    Por exemplo, se o host gcr.io não existir no projeto my-project, enviar a imagem gcr.io/my-project/my-image:1.0 acionará as seguintes etapas:

    1. Adicionar o host gcr.io ao projeto
    2. Crie um bucket de armazenamento para gcr.io no projeto.
    3. Armazenar a imagem como gcr.io/my-project/my-image:1.0
  2. Após esse envio inicial, é possível conceder permissões ao bucket de armazenamento de outros usuários.

Por padrão, o Cloud Build tem as permissões necessárias para criar um bucket de armazenamento. Portanto, o push inicial da imagem e os push subsequentes não são distinguíveis.

Dentro de um projeto, um host de registro armazena todas as imagens no mesmo bucket de armazenamento. No exemplo a seguir, o projeto my-project tem duas imagens chamadas web-app no registro gcr.io. Um deles fica diretamente no ID do projeto my-project. A outra imagem está no repositório team1.

gcr.io/my-project/web-app
gcr.io/my-project/team1/web-app

Artifact Registry

O Cloud Build não tem permissões para criar um repositório.

Uma conta com o papel Administrador de repositório do Artifact Registry precisa criar o repositório antes de enviar imagens para ele. Em seguida, você pode conceder permissões ao repositório para outros usuários.

No Artifact Registry, cada repositório é um recurso separado. Portanto, todos os caminhos de imagem precisam incluir um repositório.

Caminhos de imagem válidos:

us-central1-docker.pkg.dev/my-project/team1/web-app:1.0
us-central1-docker.pkg.dev/my-project/team2/web-app:1.0

Caminho de imagem inválido (não inclui um repositório) :

us-central1-docker.pkg.dev/my-project/web-app:1.0

Os exemplos a seguir mostram situações em que o envio de uma imagem para um repositório ausente falha.

  • Enviar uma imagem para us-central1-docker.pkg.dev/my-project/team1 se us-central1-docker.pkg.dev/my-project/team1 não existir.
  • Enviar uma imagem para us-central1-docker.pkg.dev/my-project/team2 quando us-central1-docker.pkg.dev/my-project/team1 existe, mas us-central1-docker.pkg.dev/my-project/team2 não existe.

Como conceder permissões

Pontos principais

  • Os serviços do Google Cloud têm acesso equivalente de leitura ou gravação ao Container Registry e ao Artifact Registry. No entanto, não é possível criar repositórios na conta de serviço padrão do Cloud Build.
  • Conceda os papéis apropriados do Artifact Registry a outras contas que acessem o Artifact Registry.
  • O Container Registry é compatível com o controle de acesso no nível do bucket de armazenamento. O Artifact Registry é compatível com o controle de acesso no nível do repositório.

A comparação a seguir descreve as permissões de cada serviço:

Container Registry

O Container Registry usa os papéis do Cloud Storage para controlar o acesso. O Cloud Build tem as permissões obrigatórias no papel de administrador do Storage para adicionar hosts do Container Registry a um projeto.

Visualizador de objetos do Storage no nível do bucket de armazenamento
Extrair (ler) imagens de hosts de registro existentes no projeto.
Gravador de bucket legado no nível do bucket de armazenamento
Enviar (gravar) e extrair (ler) imagens de hosts de registro no projeto.
Administrador do Storage para envolvidos no projeto
Adicione um host de registro a um projeto enviando uma imagem inicial para o host.

Após o envio da imagem inicial para um registro, você concede papéis do Cloud Storage a outras contas que exigem acesso ao bucket de armazenamento. Qualquer conta com todas as permissões no papel Administrador de armazenamento pode ler, gravar e excluir buckets de armazenamento e objetos de armazenamento em todo o projeto.

As permissões em um bucket de armazenamento se aplicam a todos os repositórios no Registro. Por exemplo, qualquer usuário com permissões de leitor de objetos do Storage no bucket para gcr.io/my-project pode ler imagens em todos estes repositórios:

gcr.io/my-project/team1
gcr.io/my-project/team2
gcr.io/my-project/test
gcr.io/my-project/production

Artifact Registry

O Artifact Registry tem as próprias funções para controlar o acesso. Esses papéis fornecem separação clara entre papéis de usuário administrador e de repositório.

O Cloud Build tem permissões no papel de gravador do Artifact Registry, já que ele só precisa enviar e extrair imagens.

Somente contas que gerenciam repositórios devem ter o papel de Administrador de repositórios do Artifact Registry ou Administrador do Artifact Registry.

Leitor do Artifact Registry
Liste artefatos e repositórios. Faça o download de artefatos.
Gravador do Artifact Registry
Liste artefatos e repositórios. Faça o download de artefatos, faça upload de novas versões deles e adicione ou atualize tags.
Administrador do repositório do Artifact Registry
Permissões do Artifact Registry Writer e permissões para excluir artefatos e tags.
Administrador do Artifact Registry
Permissões e permissões de administrador do repositório do Artifact Registry para criar, atualizar, excluir e conceder permissões aos repositórios.

É possível aplicar essas permissões no nível do repositório. Exemplo:

  • Conceda acesso à Equipe 1 para us-central1-docker.pkg.dev/my-project/team1
  • Conceda acesso à Equipe 2 para us-central1-docker.pkg.dev/my-project/team2.

Para detalhes sobre como conceder permissões do Artifact Registry, consulte a documentação do controle de acesso.

Como criar e enviar imagens

Pontos principais

  • É preciso criar um repositório Docker do Artifact Registry antes de enviar uma imagem para ele.
  • Os nomes do host do Artifact Registry são diferentes dos nomes de host do Container Registry.

O Cloud Build pode criar, marcar e enviar uma imagem em uma única etapa.

Com o Container Registry, o Cloud Build pode enviar uma imagem para um host de registro que ainda não existe no projeto do Google Cloud. Para esse envio de imagem inicial, o Cloud Build tem permissões para adicionar automaticamente o host de registro ao projeto.

Para adaptar um fluxo de trabalho do Container Registry:

  1. Configure os repositórios antes de enviar imagens para eles.
  2. Atualize os caminhos da imagem no arquivo de configuração ou crie comandos ou os comandos gcloud builds submit.

Como criar com um arquivo de configuração da versão

Substitua os caminhos do Container Registry para imagens criadas com o caminho para um repositório existente do Artifact Registry.

O seguinte arquivo de exemplo cloudbuild.yaml cria a imagem us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag1:

steps:
- name: 'gcr.io/cloud-builders/docker'
  args: [ 'build', '-t', 'us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag1', '.' ]
images:
- 'us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag1'

Em seguida, crie a imagem com o comando:

gcloud builds submit --config cloudbuild.yaml

Como criar com um Dockerfile

Substitua os caminhos do Container Registry para imagens criadas com o caminho para um repositório existente do Artifact Registry.

O comando de exemplo a seguir cria a imagem us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag1 com uma Dockerfile no diretório atual:

gcloud builds submit --tag us-central1-docker.pkg.dev/my-repo/my-image:tag1

Como implantar imagens

Ponto-chave:

  • Os nomes do host do Artifact Registry são diferentes dos nomes de host do Container Registry.

Para adaptar um fluxo de trabalho do Container Registry, atualize os caminhos de imagem na configuração de implantação e nos comandos de implantação. As seções a seguir mostram exemplos de Cloud Build, Cloud Run e GKE, mas a mesma abordagem se aplica a qualquer outro serviço do Google Cloud que implante imagens.

Cloud Build

Substitua os caminhos do Container Registry para imagens implantadas com o caminho para um repositório existente do Artifact Registry.

O exemplo de arquivo cloudbuild.yaml a seguir implanta a imagem de amostra us-docker.pkg.dev/cloudrun/container/hello.

steps:
- name: 'gcr.io/cloud-builders/gcloud'
  args:
  - 'run'
  - 'deploy'
  - 'cloudrunservice'
  - '--image'
  - 'us-docker.pkg.dev/cloudrun/container/hello'
  - '--region'
  - 'us-central1'
  - '--platform'
  - 'managed'
  - '--allow-unauthenticated'

Cloud Run

Substitua os caminhos do Container Registry para imagens implantadas com o caminho para um repositório existente do Artifact Registry.

Por exemplo, este comando implanta a imagem de amostra us-docker.pkg.dev/cloudrun/container/hello.

gcloud run deploy my-service --image us-docker.pkg.dev/cloudrun/container/hello

GKE;

Substitua os caminhos do Container Registry para imagens criadas com o caminho para um repositório existente do Artifact Registry.

Os exemplos a seguir para o Artifact Registry usam a imagem de amostra us-docker.pkg.dev/artifact-registry-samples/containers/gke/hello-app:1.0.

Como criar um cluster na linha de comando:

kubectl create deployment hello-server --image=us-docker.pkg.dev/artifact-registry-samples/containers/gke/hello-app:1.0

Como especificar uma imagem em um manifesto de implantação:

In a deployment manifest:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
spec:
  replicas: 3
  selector:
    matchLabels:
      run: my-app
  template:
    metadata:
      labels:
        run: my-app
    spec:
      containers:
      - name: hello-app
        image: us-docker.pkg.dev/artifact-registry-samples/containers/gke/hello-app:1.0