Executar hooks antes e depois da implantação

Neste documento, descrevemos como executar programas ou operações arbitrárias antes ou depois da implantação.

É possível configurar o Cloud Deploy e o Skaffold para executar ações de pré ou pós-implantação, ou ambas. Esses programas, executados dessa forma, são chamados de "hooks". Os hooks de pré e pós-implantação são executados como jobs de pré e pós-implantação no lançamento.

É possível configurar cada hook para ser executado em um ambiente de execução especificado do Cloud Deploy, mas, se você estiver implantando no Google Kubernetes Engine, poderá configurar opcionalmente para ser executado no cluster do GKE em que o aplicativo está sendo implantado.

Os hooks de implantação são considerados idempotentes. Se uma ação for executada mais de uma vez, não haverá efeito adicional.

Como os hooks de implantação funcionam?

A seguir, descrevemos as etapas para configurar hooks de implantação e o processo do Skaffold e do Cloud Deploy para executar esses hooks:

  1. Você configura o skaffold.yaml usado para uma determinada versão de forma a incluir customActions que identificam a imagem ou as imagens de contêiner a serem usadas para executar os hooks e o comando ou script específico a ser executado em cada contêiner.

  2. Você configura hooks em uma ou mais etapas na progressão do pipeline de entrega. Cada uma delas faz referência a um dos customActions configurados em skaffold.yaml.

  3. Antes da execução do job de implantação do lançamento, o Skaffold executa todos os comandos configurados em skaffold.yaml que são referenciados em uma estrofe predeploy na progressão do pipeline.

    O hook predeploy sempre é executado como o primeiro job na fase.

  4. Depois que o job de implantação do lançamento for executado, o Cloud Deploy vai executar todos os comandos configurados em skaffold.yaml que são referenciados em uma estrofe postdeploy na progressão do pipeline.

Os hooks de implantação são executados no ambiente de execução padrão do Cloud Deploy ou em um ambiente de execução alternativo especificado. Para implantações no GKE, é possível executar os hooks no mesmo cluster em que o aplicativo está sendo implantado.

Como usar hooks de implantação com uma implantação canário

Ao configurar hooks de implantação para uma implantação canário, há várias coisas a saber:

  • Na etapa de pipeline de entrega, a configuração do hook (predeploy e postdeploy) está em strategy.canary.canaryDeployment ou strategy.canary.customCanaryDeployment.phaseConfigs, em vez de strategy.standard.

  • Para um canary automatizado, os hooks predeploy são executados antes da implantação apenas na primeira fase, e os hooks postdeploy são executados após a implantação apenas na última fase (estável).

Configurar ações no Skaffold

No arquivo skaffold.yaml, a seção customActions usa uma ou mais seções customActions, configuradas da seguinte maneira:

customActions:
- name: ACTION_NAME
  containers:
  - name: CONTAINER_NAME
    image: IMAGE
    command: [COMMANDS_TO_RUN]
    args: [LIST_OF_ARGS]

Nesta estrofe customerActions:

  • ACTION_NAME

    É um nome para essa ação. O nome pode ser qualquer coisa, mas precisa ser exclusivo no skaffold.yaml. Esse é o nome que será referenciado nas ações de pré e pós-implantação definidas na etapa do pipeline de entrega.

  • CONTAINER_NAME

    É um nome para o contêiner específico. O nome pode ser qualquer coisa, mas precisa ser exclusivo no skaffold.yaml.

  • IMAGE

    É o nome da imagem do contêiner em que o comando será executado.

  • COMMANDS_TO_RUN

    É uma lista de pontos de entrada a serem executados nesse contêiner. "/bin/sh" é um comando típico para especificar aqui, para invocar um shell. Inclua o comando a ser executado nesse shell nos argumentos.

  • LIST_OF_ARGS

    É uma lista de argumentos a serem fornecidos ao comando. É uma lista separada por vírgulas, com cada argumento entre aspas. Se o COMMAND_TO_RUN for "/bin/sh", um dos argumentos aqui será "-c", e outro será todo o comando que você quer executar no shell que está invocando.

    Veja um exemplo:

    command: ["/bin/sh"]
args: ["-c", `echo "This command ran!"`]

Para saber mais sobre as ações personalizadas do Skaffold, consulte a documentação do Skaffold.

Configurar o pipeline para referenciar as ações

Para concluir a configuração dos hooks de implantação, configure o pipeline de entrega para referenciar as ações personalizadas definidas no arquivo skaffold.yaml. As ações de pré e pós-implantação são configuradas em uma ou mais etapas específicas na progressão do pipeline.

Veja como configurar hooks pré e pós-implantação em um estágio de pipeline ao usar uma estratégia de implantação standard:

serialPipeline:
  stages:
  - targetId: hooks-staging
    profiles: []
    strategy:
      standard:
        predeploy:
          actions: ["PREDEPLOY-ACTION"]
        postdeploy:
          actions: ["POSTDEPLOY-ACTION"]

Neste YAML:

  • PREDEPLOY_ACTION

    É o mesmo que o ACTION_NAME usado no skaffold.yaml para definir a ação personalizada que você quer executar antes da implantação.

  • POSTDEPLOY_ACTION

    É o mesmo que o ACTION_NAME usado no skaffold.yaml para definir a ação personalizada que você quer executar após a implantação.

É possível especificar mais de uma ação para predeploy e postdeploy, separadas por vírgulas. Quando mais de uma ação é especificada, elas são executadas em série, na ordem em que são especificadas. O job (pré-implantação ou pós-implantação) falha na primeira ação que falha, e as ações restantes não são executadas.

Por padrão, se você estiver executando mais de um contêiner em paralelo e um job falhar, os dois contêineres serão interrompidos. É possível configurar esse comportamento usando a estratégia de falha de ação personalizada do Skaffold.

Executar os hooks no cluster de aplicativos

Por padrão, os hooks de implantação são executados no ambiente de execução do Cloud Deploy. Você também pode configurar o Skaffold para executar essas ações personalizadas no mesmo cluster em que seu aplicativo está sendo executado. Quando você configura ações personalizadas no skaffold.yaml e as ativa em uma etapa do pipeline, a ação é executada automaticamente no cluster desse destino.

Essa capacidade está disponível apenas para implantações no GKE, não no Cloud Run. As implantações no Cloud Run só podem executar hooks no ambiente de execução do Cloud Deploy.

Para executar o hook no cluster, inclua uma estrofe executionMode.kubernetesCluster no arquivo de configuração skaffold.yaml, dentro da estrofe customActions para a ação personalizada específica:

customActions
- name: ACTION_NAME
  containers:
  - name: CONTAINER_NAME
    image: IMAGE
    command: [COMMANDS_TO_RUN]
    args: [LIST_OF_ARGS]
  executionMode:
    kubernetesCluster: {}

Confira a seguir um exemplo de estrofe customActions que inclui executionMode para invocar o contêiner de hook no cluster de aplicativos:

customActions:
- name: predeploy-action
  containers:
  - name: predeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a predeploy action"' ]
  executionMode:
    kubernetesCluster: {}

A seção executionMode é opcional. Se você omitir, o Skaffold vai executar o contêiner de ação personalizada no ambiente de execução do Cloud Deploy.

Variáveis de ambiente disponíveis

O Cloud Deploy fornece e preenche as seguintes variáveis de ambiente no ambiente de execução, que podem ser usadas nos seus hooks:

  • ANTHOS_MEMBERSHIP

    Para destinos do tipo ANTHOS, o nome de recurso totalmente especificado da associação de clusters anexados ao GKE.

  • CLOUD_RUN_LOCATION

    Para destinos do tipo RUN, a região em que o serviço do Cloud Run é implantado.

  • CLOUD_RUN_PROJECT

    Para destinos do tipo RUN, o projeto em que o serviço do Cloud Run foi criado.

  • CLOUD_RUN_SERVICE

    Para destinos do tipo RUN, o nome do serviço do Cloud Run implantado.

  • CLOUD_RUN_SERVICE_URLS

    Para destinos do tipo RUN, o URL ou URLs (lista separada por vírgulas) que os usuários finais vão usar para acessar seu serviço. É possível encontrar essas informações nos detalhes do serviço do Cloud Run no consoleGoogle Cloud .

  • CLOUD_RUN_REVISION

    Para destinos do tipo RUN, a revisão específica do serviço do Cloud Run.

  • GKE_CLUSTER

    Para destinos do tipo GKE, o nome totalmente especificado do recurso do cluster do Google Kubernetes Engine, por exemplo, projects/p/locations/us-central1/clusters/dev.

  • TARGET_TYPE

    O tipo de tempo de execução específico do destino. GKE, ANTHOS ou RUN. Para metas personalizadas, esse campo não é definido.

  • CLOUD_DEPLOY_LOCATION

    A região que contém os recursos do Cloud Deploy.

  • CLOUD_DEPLOY_DELIVERY_PIPELINE

    O ID do pipeline de entrega.

  • CLOUD_DEPLOY_TARGET

    O ID da meta.

  • CLOUD_DEPLOY_PROJECT

    O número do projeto Google Cloud que contém os recursos do Cloud Deploy.

  • CLOUD_DEPLOY_PROJECT_ID

    O ID do projeto Google Cloud .

  • CLOUD_DEPLOY_RELEASE

    O ID da versão em que os hooks serão executados.

  • CLOUD_DEPLOY_ROLLOUT

    O ID do lançamento que contém os jobs para os hooks.

  • CLOUD_DEPLOY_JOB_RUN

    O ID da execução do job que representa a execução atual do job.

  • CLOUD_DEPLOY_PHASE

    A fase no lançamento que contém o job para os hooks.

Implantar parâmetros como variáveis de ambiente

Além das variáveis de ambiente listadas nesta seção, o Cloud Deploy pode transmitir aos seus contêineres personalizados todos os parâmetros de implantação definidos.

Saiba mais.

A seguir