Implantação do código code-deployment

Saiba como implantar seu código e o que acontece no Cloud Manager depois disso.

Implantar código com o Cloud Manager deploying-code-with-cloud-manager

Depois de configurar o pipeline de produção, incluindo o repositório e os ambientes necessários, você poderá implantar o código.

  1. Clique em Implantar no Cloud Manager para iniciar o processo de implantação.

    Botão Implantar

  2. A tela Execução de pipeline será exibida. Clique em Criar para iniciar o processo.

    Botão Criar

O processo de criação inicia a implantação do código, incluindo as seguintes etapas:

  • Implantação de preparo
  • Teste de preparo
  • Implantação de produção

Você pode revisar as etapas de vários processos de implantação, visualizando os logs ou revisando os resultados dos critérios de teste.

Etapas de implantação deployment-steps

Várias ações ocorrem durante cada etapa da implantação, conforme descrito nesta seção. Consulte a seção Detalhes do processo de implantação para obter detalhes técnicos sobre como o próprio código é implantado nos bastidores.

Etapa de implantação de preparo stage-deployment

A etapa Implantação de preparo inclui as seguintes ações:

  • Validação: esta etapa garante que o pipeline esteja configurado para usar os recursos disponíveis no momento. Por exemplo, se a ramificação configurada existe e se os ambientes estão disponíveis.
  • Teste de build e unidade: essa etapa executa um processo de build em containers. Consulte O ambiente de build para mais detalhes.
  • Verificação de código: esta etapa avalia a qualidade do código de seu aplicativo. Consulte Entender os resultados dos testes para mais detalhes sobre o processo de teste.
  • Implantar para o preparo

Implantação de preparo

Etapa de teste de preparo stage-testing

A etapa Teste de preparo inclui as seguintes ações:

  • Teste de segurança: esta etapa avalia o impacto sobre a segurança do código no ambiente do AEM. Consulte o documento Como entender os resultados do teste para obter detalhes sobre o processo de teste.

Etapa de implantação de produção production-deployment

A etapa Implantação de produção inclui as seguintes ações:

  • Pedido de aprovação

    • Essa opção é ativada ao configurar o pipeline.
    • Com essa opção, você pode agendar a implantação de produção ou clicar em Agora para executar a implantação de produção imediatamente.
  • Programar implantação de produção

    • Essa opção é ativada ao configurar o pipeline.
    • A data e a hora agendadas são especificadas no fuso horário do usuário.
      Programar implantação
  • Suporte do CSE (se estiver habilitado)

  • Implantar para produção

Implantação de produção

Quando a implantação for concluída, o código estará em seu ambiente de destino e você poderá visualizar os logs.

Implantação concluída

Tempos limite timeouts

As seguintes etapas atingirão o tempo-limite se forem deixadas aguardando o feedback do usuário:

Etapa
Tempo limite
Teste de qualidade do código
7 dias
Teste de segurança
7 dias
Teste de desempenho
7 dias
Pedido de aprovação (preparo)
7 dias
Pedido de aprovação (produção)
14 dias
Agendar implantação em produção
14 dias
Implantação de produção gerenciada
14 dias

Detalhes do processo de implantação deployment-process

O Cloud Manager carrega todos os arquivos target/*.zip de destino produzidos pelo processo de criação para um local de armazenamento. Esses artefatos são recuperados desse local durante as fases de implantação do pipeline.

Quando o Cloud Manager é implantado em topologias que não são de produção, a meta é concluir a implantação o mais rápido possível. Portanto, os artefatos são implantados em todos os nós simultaneamente da seguinte maneira:

  1. O Cloud Manager determina se cada artefato é um pacote do AEM ou do Dispatcher.

  2. O Cloud Manager remove todos os que são do Dispatcher do balanceador de carga para isolar o ambiente durante a implantação.

    • A menos que configurado de outra forma, você pode ignorar as alterações do balanceador de carga nas implantações de desenvolvimento e preparo. Ou seja, para o ambiente de desenvolvimento, desconecte e conecte etapas em pipelines de não produção e, para o ambiente de preparo, o pipeline de produção.

    Ignorar balanceador de carga

    note note
    NOTE
    Espera-se que os clientes 1-1-1 usem esse recurso.
  3. Cada artefato do AEM é implantado em toda instância do AEM por meio de APIs de gerenciamento de pacotes, e as dependências de pacote determinam a ordem da implantação.

    • Para saber mais sobre como você pode usar pacotes para instalar novas funcionalidades, transferir conteúdo entre instâncias e fazer backup do conteúdo do repositório. Consulte Gerenciador de pacotes.
    note note
    NOTE
    Todos os artefatos do AEM são implantados tanto para o autor quanto para os editores. Os modos de execução devem ser usados quando configurações específicas de nó são necessárias. Para saber mais sobre como os modos de execução permitem ajustar a sua instância do AEM para uma finalidade específica, consulte a seção Modos de execução do documento Implantação no AEM as a Cloud Service.
  4. O artefato do Dispatcher é implantado em cada Dispatcher da seguinte maneira:

    1. O backup das configurações atuais é feito e copiado para um local temporário.
    2. Todas as configurações são excluídas, exceto os arquivos imutáveis. Consulte Configurações do Dispatcher para mais detalhes. Essa abordagem limpa os diretórios para garantir que nenhum arquivo órfão seja deixado para trás.
    3. O artefato é extraído para o diretório httpd. Arquivos imutáveis não são substituídos. Quaisquer alterações feitas em arquivos imutáveis no repositório Git serão ignoradas no momento da implantação. Esses arquivos são fundamentais para a estrutura do Dispatcher do AMS e não podem ser alterados.
    4. O Apache executa um teste de configuração. Se nenhum erro for encontrado, o serviço é reiniciado. Se ocorrer um erro, as configurações são restauradas a partir do backup, o serviço é reiniciado e o erro é relatado ao Cloud Manager.
    5. Cada caminho especificado na configuração do pipeline é invalidado ou removido do cache do Dispatcher.
    note note
    NOTE
    O Cloud Manager espera que o artefato do Dispatcher contenha o conjunto completo de arquivos. Todos os arquivos de configuração do Dispatcher devem estar presentes no repositório Git. Arquivos ou pastas ausentes resultarão em falhas de implantação.
  5. Após a implantação bem-sucedida de todos os pacotes do AEM e do Dispatcher em todos os nós, os pacotes do Dispatcher são adicionados novamente ao balanceador de carga, e a implantação será concluída.

    note note
    NOTE
    Você pode ignorar as alterações do balanceador de carga em implantações de desenvolvimento e preparo. Ou seja, para ambientes de desenvolvimento, desconecte e conecte etapas em pipelines de não produção e, para ambientes de preparo, o pipeline de produção.

Implantação para a fase de produção deployment-production-phase

O processo de implantação das topologias de produção é um pouco diferente para minimizar o impacto para visitantes de sites do AEM.

As implantações de produção geralmente seguem as mesmas etapas descritas acima, mas de maneira contínua:

  1. Implante pacotes do AEM para o autor.
  2. Desconecte dispatcher1 do balanceador de carga.
  3. Implante pacotes do AEM para publish1 e o pacote do Dispatcher para dispatcher1 em paralelo, e, em seguida, limpe o cache do Dispatcher.
  4. Coloque dispatcher1 de volta no balanceador de carga.
  5. Quando dispatcher1 estiver novamente em serviço, desconecte dispatcher2 do balanceador de carga.
  6. Implante pacotes do AEM para publish2 e o pacote do Dispatcher para dispatcher2 em paralelo, e, em seguida, limpe o cache do Dispatcher.
  7. Coloque dispatcher2 de volta no balanceador de carga.

Esse processo continua até que a implantação tenha atingido todos os editores e dispatchers na topologia.

Modo de execução de pipeline de emergência emergency-pipeline

Em situações críticas, os clientes do Adobe Managed Services podem precisar implantar alterações de código em seus ambientes de preparo e produção imediatamente. Essa capacidade permite que eles ignorem o ciclo completo de testes do Cloud Manager.

Para lidar com essas situações, o pipeline de produção do Cloud Manager pode ser executado em um modo de emergência. Quando esse modo é usado, as etapas de teste de segurança e desempenho não são executadas. Todas as outras etapas, incluindo qualquer etapa de aprovação configurada, são executadas como no modo de execução normal do pipeline.

NOTE
O recurso de modo de execução de pipeline de emergência é ativado programa por programa. A ativação é feita pelos engenheiros de sucesso do cliente.

Usar o modo de execução de pipeline de emergência using-emergency-pipeline

Ao iniciar a execução de um pipeline de produção, você pode escolher entre o modo normal e o modo de emergência em uma caixa de diálogo. Essa opção estará disponível se o recurso de modo de execução de pipeline de emergência estiver ativado para o programa. Essa opção fica disponível após a habilitação do recurso.

Executar opções de pipeline

Ao visualizar a página de detalhes da execução do pipeline para uma execução em modo de emergência, as navegações estruturais na parte superior da tela mostram um indicador de que o pipeline está sendo executado no modo de emergência.

Navegação estrutural no modo de emergência

A execução de um pipeline no modo de emergência também pode ser feita por meio da API ou CLI do Cloud Manager. Para iniciar uma execução em modo de emergência, envie uma solicitação PUT para o ponto de acesso de execução do pipeline com o parâmetro de consulta ?pipelineExecutionMode=EMERGENCY ou, ao usar a CLI:

$ aio cloudmanager:pipeline:create-execution PIPELINE_ID --emergency

Reexecutar uma implantação de produção reexecute-deployment

Em casos raros, as etapas de implantação de produção podem falhar por motivos transitórios. Nesses casos, é possível executar novamente a etapa de implantação em produção, desde que ela tenha sido concluída, independentemente de ter sido bem-sucedida, cancelada ou malsucedida. A reexecução é realizada com o mesmo pipeline, que consiste nas três etapas a seguir:

  1. A etapa de validação: a mesma validação que ocorre durante uma execução de pipeline normal.
  2. A etapa de build: no contexto de uma reexecução, a etapa de build copia artefatos, sem executar um novo processo build real.
  3. A etapa de implantação em produção: usa as mesmas configurações e opções que a etapa de implantação em produção em uma execução de pipeline normal.

Nessas circunstâncias, quando uma reexecução for possível, a página de status do pipeline de produção fornecerá a opção Reexecutar ao lado da opção tradicional Baixar log de compilação.

A opção Reexecutar na janela de visão geral do pipeline

NOTE
Em uma reexecução, a etapa de compilação apresenta informações na interface que indicam que está copiando artefatos, não os recompilando.

Limitações limitations

  • A reexecução da etapa de implantação de produção só está disponível para a última execução.
  • A reexecução não está disponível para execuções de reversão ou de atualização por push.
  • Se a última execução falhar em qualquer ponto antes da etapa de implantação em produção, não será possível iniciar uma reexecução.

Reexecutar API reexecute-api

Além de estar disponível na interface, a API do Cloud Manager pode ser usada para acionar reexecuções e identificar execuções que foram acionadas como reexecuções.

Acionar uma reexecução triggering

Para acionar uma reexecução, uma solicitação PUT precisa ser feita para o link HAL http://ns.adobe.com/adobecloud/rel/pipeline/reExecute no estado da etapa de implantação de produção.

  • Se esse link estiver presente, a execução poderá ser reiniciada dessa etapa.
  • Se estiver ausente, a execução não poderá ser reiniciada a partir dessa etapa.

Esse link só está disponível para a etapa de implantação de produção.

 {
  "_links": {
    "http://ns.adobe.com/adobecloud/rel/pipeline/logs": {
      "href": "/api/program/4/pipeline/1/execution/953671/phase/1575676/step/2983530/logs",
      "templated": false
    },
    "http://ns.adobe.com/adobecloud/rel/pipeline/reExecute": {
      "href": "/api/program/4/pipeline/1/execution?stepId=2983530",
      "templated": false
    },
    "http://ns.adobe.com/adobecloud/rel/pipeline/metrics": {
      "href": "/api/program/4/pipeline/1/execution/953671/phase/1575676/step/2983530/metrics",
      "templated": false
    },
    "self": {
      "href": "/api/program/4/pipeline/1/execution/953671/phase/1575676/step/2983530",
      "templated": false
    }
  },
  "id": "6187842",
  "stepId": "2983530",
  "phaseId": "1575676",
  "action": "deploy",
  "environment": "weretail-global-b75-prod",
  "environmentType": "prod",
  "environmentId": "59254",
  "startedAt": "2022-01-20T14:47:41.247+0000",
  "finishedAt": "2022-01-20T15:06:19.885+0000",
  "updatedAt": "2022-01-20T15:06:20.803+0000",
  "details": {
  },
  "status": "FINISHED"

A sintaxe do valor href do link HAL é apenas um exemplo e o valor real deve sempre ser lido do link HAL, portanto, não deve ser gerado.

O envio de uma solicitação PUT a este ponto de acesso resultará em uma resposta 201, se bem-sucedido. O corpo da resposta é a representação da nova execução. Essa funcionalidade é semelhante a iniciar uma execução normal por meio da API.

Identificar uma reexecução identifying

O sistema identifica execuções reexecutadas pelo valor RE_EXECUTE no campo de acionador.

recommendation-more-help
c6cdc82b-cee9-48e0-a6ee-48149d5e72c3