Implantar um serviço ou job do Cloud Run

Este documento descreve como implantar seus aplicativos, incluindo serviços e jobs do Cloud Run.

O Cloud Deploy permite implantar cargas de trabalho baseadas em contêineres em qualquer serviço do Cloud Run ou job. Todos os recursos do Cloud Deploy são compatíveis quando você implanta em destinos do Cloud Run para serviços do Cloud Run, mas as implantações de canário não são compatíveis com jobs do Cloud Run.

Este documento descreve as três configurações principais que você precisa concluir em para implantar no Cloud Run:

Limitações

  • Só é possível implantar um serviço ou job do Cloud Run por destino.

  • Não é possível executar uma implantação canário. com um job do Cloud Run.

    No entanto, os serviços do Cloud Run podem usar uma implantação canário.

Antes de começar

Crie a configuração de destino.

O destino pode ser configurado no YAML do pipeline de entrega ou em um arquivo separado. Além disso, é possível configurar mais de um destino no mesmo arquivo.

Na definição do destino, crie uma estrofe de run para identificar o local em que o serviço do Cloud Run será criado.

A sintaxe para especificar o serviço ou job do Cloud Run na definição de destino é a seguinte:

run:
 location: projects/[project_name]/locations/[region_name]

Esse identificador de recurso usa os seguintes elementos:

  • [project_name] é o nome do projeto do Google Cloud em que seu O serviço ou job do Cloud Run será criado.

    Faça isso para cada destino. Recomendamos um projeto diferente para cada serviço ou job do Cloud Run. Se você quiser mais de um serviço ou trabalho no mesmo projeto, você precisa usar Perfis do Skaffold no arquivo de configuração skaffold.yaml.

  • [region_name] é a região em que o serviço ou job será criado. Seu serviço ou trabalho pode estar em qualquer região compatível com o Cloud Run.

Confira a seguir um exemplo de configuração de destino, que define o serviço ou job do Cloud Run a ser criado:

      apiVersion: deploy.cloud.google.com/v1
      kind: Target
      metadata:
       name: dev
      description: development service
      run:
       location: projects/my-app/locations/us-central1

É possível definir esse destino dentro de um pipeline de entrega do Cloud Deploy ou separadamente. De qualquer forma, é necessário registrar o destino antes de criar a versão para implantar seu serviço ou trabalho do Cloud Run.

Criar a configuração do Skaffold

Confira a seguir um arquivo skaffold.yaml de exemplo de Implantação do Cloud Run:

apiVersion: skaffold/v4beta7
kind: Config
metadata: 
  name: cloud-run-application
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}

Neste arquivo skaffold.yaml...

  • manifests.rawYaml fornece os nomes dos componentes do Cloud Run definições de serviço.

    Neste exemplo, service.yaml é o arquivo que define uma serviço do Cloud Run que o Skaffold implantará. Esse nome de arquivo pode ser qualquer coisa, mas por convenção é service.yaml para um serviço e job.yaml para um job.

  • A estrofe deploy especifica como você quer que o manifesto seja implantado, especificamente, o projeto e a localização. deploy é obrigatório.

    Recomendamos que você deixe o campo {} em branco. O Cloud Deploy preenche essa informação durante a renderização com base no projeto e no local da definição de destino.

    No entanto, para o desenvolvimento local, é possível fornecer valores aqui. No entanto, O Cloud Deploy sempre usa o projeto e o local do destino da definição, independentemente de os valores serem fornecidos aqui.

Criar as definições de serviço do Cloud Run

Para criar uma definição de serviço do Cloud Run, crie um manualmente ou copiar um de um serviço existente. Ambos são descritos nesta seção.

Opção 1: criar um novo service.yaml do Cloud Run

O service.yaml define o serviço do Cloud Run. Quando você cria uma versão, o Skaffold usa essa definição para implantar seu serviço.

Veja um exemplo simplificado:

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
 name: [SERVICE_NAME]
spec:
 template:
  spec:
   containers:
   - image: [IMAGE_PATH]

Em que:

  • [SERVICE_NAME] é um nome para este serviço do Cloud Run.

  • [IMAGE_PATH] aponta para a imagem ou as imagens de contêiner que você está implantando com esse serviço.

Opção 2: copiar um service.yaml de um serviço atual usando o console do Google Cloud

É possível criar um serviço usando o console do Google Cloud ou usar um serviço existente e copiar o service.yaml dele.

Para receber o service.yaml usando a Google Cloud CLI:

gcloud run services describe [service_name] --format=export

Para acessar o service.yaml no console do Google Cloud:

  1. No console do Google Cloud, acesse a página "Serviços do Cloud Run".

  2. Selecione o serviço existente com a definição que você quer usar.

Ou crie um novo e selecione-o. Quando você seleciona o serviço, a página "Detalhes do serviço" é mostrada:

página de detalhes do serviço no console do Google Cloud, mostrando a guia YAML

  1. Selecione a guia YAML.

  2. Clique em Editar e copie o conteúdo do YAML em um novo arquivo chamado service.yaml, no seu sistema de arquivos, de modo que o Skaffold possa usá-lo quando você criar uma versão.

Criar suas definições de job do Cloud Run

Para implantar uma definição de job do Cloud Run, você pode criar uma manualmente ou copiar uma de um job existente. Ambos são descritos nesta seção.

Os jobs não são necessariamente executados quando implantados pelo Cloud Deploy. Isso é diferente dos serviços, que executam aplicativos após a implantação. A forma como um job é invocado depende do job por conta própria.

Opção 1: criar um novo job.yaml do Cloud Run

O job.yaml define sua job do Cloud Run. Quando você cria uma versão, o Skaffold usa essa definição para implantar o job.

Confira um exemplo simplificado:

apiVersion: run.googleapis.com/v1
kind: Job
metadata:
 name: [JOB_NAME]
spec:
  template:
  spec:
   containers:
   - image: [IMAGE_PATH]

Em que:

  • [JOB_NAME] é um nome para este job do Cloud Run.

  • [IMAGE_PATH] aponta para a imagem do contêiner que você está implantando para esse job.

Opção 2: copiar um job.yaml de um job usando o console do Google Cloud

É possível criar um job usando o console do Google Cloud ou um atual. e copie o job.yaml de lá.

Para acessar o job.yaml usando a Google Cloud CLI:

gcloud run jobs describe [job_name] --format=export

Para acessar o job.yaml no console do Google Cloud:

  1. No console do Google Cloud, acesse a página de jobs do Cloud Run.

  2. Selecione o job atual com a definição que você quer usar.

Ou crie um novo e selecione-o. Quando você selecionar o job, a página "Detalhes do job" será mostrada:

Página de detalhes do job no console do Google Cloud, mostrando a guia YAML

  1. Selecione a guia YAML.

  2. Clique em Editar e copie o conteúdo do YAML em um novo arquivo chamado job.yaml, no seu sistema de arquivos, de modo que o Skaffold possa usá-lo quando você criar uma versão.

Como tudo funciona em conjunto

Agora que você tem o serviço ou a definição do job do Cloud Run, A configuração do skaffold.yaml e o destino do Cloud Deploy definição, e você registrou seu destino como um recurso do Cloud Deploy, invocar o pipeline de entrega para criar uma versão e avançar na progressão de destinos definidos no pipeline.

O guia de início rápido Implantar um app no Cloud Run usando o Cloud Deploy mostra tudo isso em ação.

Comportamento dos serviços em revisões

Quando você reimplanta um serviço, a nova revisão é baseada implantou service.yaml. Nada na revisão anterior é mantido, a menos que seja o mesmo no YAML recém-implantado. Por exemplo, se há definições de configuração ou marcadores na revisão anterior que não estão no novo YAML, essas configurações ou rótulos estarão ausentes da nova revisão.

Como acionar jobs do Cloud Run

Depois de implantar um job, é possível acionar conforme descrito na documentação do Cloud Run.

Como implantar serviços e jobs do Cloud Run em vários projetos

Se você precisar implantar serviços ou jobs que estejam em projetos diferentes, seus conta de serviço de execução precisa permissão para acessar os projetos em que esses serviços ou jobs estão definidos.

Consulte Conta de serviço de execução do Cloud Deploy e Papéis e permissões do Identity and Access Management para mais informações.

A seguir