Configurar condições para um estágio

Configurar uma condição Entrada (console)

1. Preencha todos os pré-requisitos, como criar o recurso e o ARN para uma regra em que um recurso é fornecido, como o AWS CloudWatchAlarm.

2. Faça login no AWS Management Console e abra o console do CodePipeline em http://console.aws.amazon.com/codesuite/codepipeline/home.

   Os nomes e status de todos os pipelines vinculados à sua Conta da AWS são exibidos.

3. Em Nome, selecione o nome do pipeline que você deseja editar.

4. Na página de detalhes do pipeline, selecione Editar.

5. Na página Editar, para a ação que você deseja editar, escolha Editar estágio.

6. Selecione Adicionar condição de entrada. O cartão de Condição de entrada antes do estágio é exibido com a opção Falha disponível para essa condição.

7. Selecione Adicionar regra e faça o seguinte.

   1. Em Nome da regra, insira um nome para a regra. Neste exemplo, insira MyAlarmRule.

   2. Em Provedor de regras, escolha o provedor de regras pré-configurado para adicionar à condição. Neste exemplo, escolha AWS CloudWatchAlarm e siga as etapas abaixo.

   3. Em Região, escolha a Região para a condição ou deixe o padrão.

   4. Em Nome do alarme, escolha o recurso do CloudWatch a ser usado para a regra. Você já deve ter criado o recurso na conta.

   5. (Opcional) Em Tempo de espera, insira a quantidade de tempo que o CodePipeline aguardará se o alarme estiver no estado ALARM quando for avaliado pela primeira vez. Se o alarme estiver no estado OK quando a regra for verificada pela primeira vez, a regra será imediatamente bem-sucedida.

   6. (Opcional) Insira o estado de alarme específico para monitorar e insira o ARN do perfil, se apropriado.

   7. Ao concluir a edição do cenário, selecione Concluído. Na página de edição do pipeline, selecione Salvar.

8. Após a execução, veja o resultado.

Configurar uma condição de entrada com um resultado Ignorar (console)

1. Preencha todos os pré-requisitos, como criar o recurso e o ARN para uma regra em que um recurso é fornecido, como o AWS CloudWatchAlarm.

2. Faça login no AWS Management Console e abra o console do CodePipeline em http://console.aws.amazon.com/codesuite/codepipeline/home.

   Os nomes e status de todos os pipelines vinculados à sua Conta da AWS são exibidos.

3. Em Nome, selecione o nome do pipeline que você deseja editar.

4. Na página de detalhes do pipeline, selecione Editar.

5. Na página Editar, para a ação que você deseja editar, escolha Editar estágio.

6. Selecione Adicionar condição de entrada e, em seguida, escolha Ignorar como resultado.

7. Selecione Adicionar regra e faça o seguinte.

   1. Em Nome da regra, insira um nome para a regra. Neste exemplo, insira MyAlarmRule.

   2. Em Provedor de regras, escolha o provedor de regras pré-configurado para adicionar à condição. Neste exemplo, escolha VariableCheck e siga as etapas abaixo.

      

   3. Em Região, escolha a Região para a condição ou deixe o padrão.

   4. Em Variável, escolha a variável com a qual comparar, como #{SourceVariables.FullRepositoryName} para um pipeline que tenha uma ação de origem do GitHub Versão 2. Insira o nome do repositório e escolha o operador, como Equals.

   5. Ao concluir a edição do cenário, selecione Concluído. Na página de edição do pipeline, selecione Salvar.

8. Após a execução, veja o resultado.

   

9. Para analisar os detalhes, selecione Revisar. O detalhe no exemplo a seguir mostra que o resultado configurado para a condição é Ignorar, que não pode ser substituído. O status da regra é Falha porque a condição não foi atendida.

   

Configurar a condição e as regras (CLI)

• Abra um terminal (Linux, macOS ou Unix) ou prompt de comando (Windows) e use o AWS CLI para executar o comando update-pipeline, especificando a condição de falha na estrutura do pipeline. O exemplo a seguir configura uma condição de entrada para um estágio chamado Deploy:

  {
      "name": "Deploy",
      "actions": [
          {
              "name": "Deploy",
              "actionTypeId": {
                  "category": "Deploy",
                  "owner": "AWS",
                  "provider": "S3",
                  "version": "1"
              },
              "runOrder": 1,
              "configuration": {
                  "BucketName": "MyBucket",
                  "Extract": "false",
                  "ObjectKey": "object.xml"
              },
              "outputArtifacts": [],
              "inputArtifacts": [
                  {
                      "name": "SourceArtifact"
                  }
              ],
              "region": "us-east-1",
              "namespace": "DeployVariables"
          }
      ],
      "beforeEntry": {
          "conditions": [
              {
                  "result": "FAIL",
                  "rules": [
                      {
                          "name": "MyAlarmRule",
                          "ruleTypeId": {
                              "category": "Rule",
                              "owner": "AWS",
                              "provider": "CloudWatchAlarm",
                              "version": "1"
                          },
                          "configuration": {
                              "AlarmName": "CWAlarm",
                              "WaitTime": "1"
                          },
                          "inputArtifacts": [],
                          "region": "us-east-1"
                      }
                  ]
              }
          ]
      }
  } 

  Para ter mais informações sobre como configurar condições de sucesso para reversão de estágio, consulte SuccessConditions na Referência de API do CodePipeline.

• Atualize o modelo conforme mostrado no snippet a seguir. O exemplo a seguir configura uma condição de entrada com uma regra chamada MyMonitorRule:

  Name: Deploy
  Actions:
  - Name: Deploy
    ActionTypeId:
      Category: Deploy
      Owner: AWS
      Provider: S3
      Version: '1'
    RunOrder: 1
    Configuration:
      BucketName: MyBucket
      Extract: 'false'
      ObjectKey: object.xml
    OutputArtifacts: []
    InputArtifacts:
    - Name: SourceArtifact
    Region: us-east-1
    Namespace: DeployVariables
  BeforeEntry:
    Conditions:
    - Result: FAIL
      Rules:
      - Name: MyMonitorRule
        RuleTypeId:
          Category: Rule
          Owner: AWS
          Provider: CloudWatchAlarm
          Version: '1'
        Configuration:
          AlarmName: CWAlarm
          WaitTime: '1'
        InputArtifacts: []
        Region: us-east-1 

  Para ter mais informações sobre como configurar condições beforeEntry, consulte AWS::CodePipeline::Pipeline BeforeEntryConditions em StageDeclaration no Guia do usuário do AWS CloudFormation.

Configurar uma condição “em caso de falha” (console)

1. Preencha todos os pré-requisitos, como criar o recurso e o ARN para uma regra em que um recurso é fornecido, como a regra LambdaInvoke.

2. Faça login no AWS Management Console e abra o console do CodePipeline em http://console.aws.amazon.com/codesuite/codepipeline/home.

   Os nomes e status de todos os pipelines vinculados à sua Conta da AWS são exibidos.

3. Em Nome, selecione o nome do pipeline que você deseja editar.

4. Na página de detalhes do pipeline, selecione Editar.

5. Na página Editar, para a ação que você deseja editar, escolha Editar estágio.

6. Selecione Adicionar condição de falha. O cartão de Condição de falha é exibido com a opção Reverter disponível para essa condição.

7. Selecione Adicionar regra e faça o seguinte.

   1. Em Nome da regra, insira um nome para a regra. Neste exemplo, insira MyLambdaRule.

   2. Em Provedor de regras, escolha o provedor de regras pré-configurado para adicionar à condição. Neste exemplo, escolha AWS LambdaInvoke e siga as etapas abaixo.

   3. Em Região, escolha a Região para a condição ou deixe o padrão.

   4. Em Artefatos de entrada, escolha o artefato de criação.

   5. Em Nome da função, escolha o recurso Lambda a ser usado para a regra. Você já deve ter criado o recurso na conta.

   6. (Opcional) Em Parâmetros do usuário, insira os pares que representem parâmetros para configuração adicional.

   7. (Opcional) Em ARN do perfil, insira o ARN do perfil, se configurado.

   8. (Opcional) Em Tempo limite em minutos, insira o tempo em minutos que a regra deve esperar antes do tempo limite.

   9. Ao concluir a edição do cenário, selecione Concluído. Na página de edição do pipeline, selecione Salvar.

Configurar uma condição onFailure com um resultado de repetição (console)

1. Preencha todos os pré-requisitos, como criar o recurso e o ARN para uma regra em que um recurso é fornecido, como o AWS CloudWatchAlarm.

2. Faça login no AWS Management Console e abra o console do CodePipeline em http://console.aws.amazon.com/codesuite/codepipeline/home.

   Os nomes e status de todos os pipelines vinculados à sua Conta da AWS são exibidos.

3. Em Nome, selecione o nome do pipeline que você deseja editar.

4. Na página de detalhes do pipeline, selecione Editar.

5. Na página Editar, para a ação que você deseja editar, escolha Editar estágio.

6. Na parte inferior do estágio, em Configuração de etapa automatizada:, escolha Habilitar nova tentativa automática em caso de falha na etapa. Em Modo Repetir, escolha Repetir estágio com falha ou Repetir ações com falha.

   

7. Escolha adicionar uma condição onFailure, depois selecione Adicionar regra e insira uma regra para a condição.

   1. Em Nome da regra, insira um nome para a regra. Neste exemplo, insira MyAlarmRule.

   2. Em Provedor de regras, escolha o provedor de regras pré-configurado para adicionar à condição. Neste exemplo, escolha CloudWatchAlarm e siga as etapas abaixo.

   3. Em Região, escolha a Região para a condição ou deixe o padrão.

   4. Em Nome do alarme, escolha o recurso configurado para o alerta.

   5. Ao concluir a edição do cenário, selecione Concluído. Na página de edição do pipeline, selecione Salvar.

8. Após a execução, veja o resultado.

Configurar a condição e as regras (CLI)

• Abra um terminal (Linux, macOS ou Unix) ou prompt de comando (Windows) e use o AWS CLI para executar o comando update-pipeline, especificando a condição de falha na estrutura do pipeline. O exemplo a seguir configura uma condição “em caso de falha” para um estágio chamado Deploy:

  {
      "name": "Deploy",
      "actions": [
          {
              "name": "Deploy",
              "actionTypeId": {
                  "category": "Deploy",
                  "owner": "AWS",
                  "provider": "S3",
                  "version": "1"
              },
              "runOrder": 1,
              "configuration": {
                  "BucketName": "MyBucket",
                  "Extract": "false",
                  "ObjectKey": "object.xml"
              },
              "outputArtifacts": [],
              "inputArtifacts": [
                  {
                      "name": "SourceArtifact"
                  }
              ],
              "region": "us-east-1",
              "namespace": "DeployVariables"
          }
      ],
      "onFailure": {
          "conditions": [
              {
                  "result": "ROLLBACK",
                  "rules": [
                      {
                          "name": "MyLambdaRule",
                          "ruleTypeId": {
                              "category": "Rule",
                              "owner": "AWS",
                              "provider": "LambdaInvoke",
                              "version": "1"
                          },
                          "configuration": {
                              "FunctionName": "my-function"
                          },
                          "inputArtifacts": [
                              {
                                  "name": "SourceArtifact"
                              }
                          ],
                          "region": "us-east-1"
                      }
                  ]
              }
          ]
      }
  }

  Para ter mais informações sobre como configurar condições de falha, consulte FailureConditions na Referência de API do CodePipeline.

• Atualize o modelo conforme mostrado no snippet a seguir. O exemplo a seguir configura uma condição OnFailure com uma regra chamada MyMonitorRule:

  name: Deploy
  actions:
  - name: Deploy
    actionTypeId:
      category: Deploy
      owner: AWS
      provider: S3
      version: '1'
    runOrder: 1
    configuration:
      BucketName: MyBucket
      Extract: 'false'
      ObjectKey: object.xml
    outputArtifacts: []
    inputArtifacts:
    - name: SourceArtifact
    region: us-east-1
    namespace: DeployVariables
  onFailure:
    conditions:
    - result: ROLLBACK
      rules:
      - name: MyMonitorRule
        ruleTypeId:
          category: Rule
          owner: AWS
          provider: CloudWatchAlarm
          version: '1'
        configuration:
          AlarmName: AlarmOnHelloWorldInvocation
          AlarmStates: ALARM
          WaitTime: '1'
        inputArtifacts: []
        region: us-east-1
  

  Para ter mais informações sobre como configurar condições de falha, consulte OnFailure em StageDeclaration no Guia do usuário do AWS CloudFormation.

Configurar uma condição “em caso de sucesso” (console)

1. Preencha todos os pré-requisitos, como criar o recurso e o ARN para uma regra em que um recurso é fornecido, como o AWS LambdaRule.

2. Faça login no AWS Management Console e abra o console do CodePipeline em http://console.aws.amazon.com/codesuite/codepipeline/home.

   Os nomes e status de todos os pipelines vinculados à sua Conta da AWS são exibidos.

3. Em Nome, selecione o nome do pipeline que você deseja editar.

4. Na página de detalhes do pipeline, selecione Editar.

5. Na página Editar, para a ação que você deseja editar, escolha Editar estágio.

6. Selecione Adicionar condição de êxito. O cartão de Condição de sucesso no estágio é exibido. Selecione a opção Reversão ou Falha exibida como os resultados disponíveis para esse tipo de condição.

7. Selecione Adicionar regra e faça o seguinte.

   1. Em Nome da regra, insira um nome para a condição. Neste exemplo, insira MyDeploymentRule.

   2. Em Provedor de regras, selecione a regra pré-configurada para adicionar à condição. Neste exemplo, escolha AWS DeploymentWindow e siga as etapas abaixo.

   3. Em Região, escolha a Região para a condição ou deixe o padrão.

   4. Em Cron, insira a expressão cron para a janela de implantação. A expressão cron define os dias e horários em que a implantação deve ser permitida. Para ter informações de referência sobre expressões cron, consulte Using cron and rate expressions to schedule rules.

   5. (Opcional) Em Fuso horário, insira o fuso horário da janela de implantação.

8. Após a execução, veja o resultado.

   

Configurar a condição e as regras (CLI)

• Abra um terminal (Linux, macOS ou Unix) ou prompt de comando (Windows) e use o AWS CLI para executar o comando update-pipeline, especificando a condição de falha na estrutura do pipeline. O exemplo a seguir configura uma condição “em caso de sucesso” para um estágio chamado Deploy, em que a regra é chamada MyDeploymentRule:

  {
      "name": "Deploy",
      "actions": [
          {
              "name": "Deploy",
              "actionTypeId": {
                  "category": "Deploy",
                  "owner": "AWS",
                  "provider": "S3",
                  "version": "1"
              },
              "runOrder": 1,
              "configuration": {
                  "BucketName": "MyBucket",
                  "Extract": "false",
                  "ObjectKey": "object.xml"
              },
              "outputArtifacts": [],
              "inputArtifacts": [
                  {
                      "name": "SourceArtifact"
                  }
              ],
              "region": "us-east-1",
              "namespace": "DeployVariables"
          }
      ],
      "onSuccess": {
         "conditions": [
              {
                  "result": "FAIL",
                  "rules": [
                      {
                          "name": "MyAlarmRule",
                          "ruleTypeId": {
                              "category": "Rule",
                              "owner": "AWS",
                              "provider": "CloudWatchAlarm",
                              "version": "1"
                          },
                          "configuration": {
                              "AlarmName": "CWAlarm",
                              "WaitTime": "1"
                          },
                          "inputArtifacts": [],
                          "region": "us-east-1"
                      }
                  ]
              }
          ]
      }
  }

  Para ter mais informações sobre como configurar condições de sucesso, consulte SuccessConditions na Referência de API do CodePipeline.

• Atualize o modelo conforme mostrado no snippet a seguir. O exemplo a seguir configura uma condição OnSuccess com uma regra chamada MyDeploymentWindowRule:

  name: Deploy
  actions:
  - name: Deploy
    actionTypeId:
      category: Deploy
      owner: AWS
      provider: S3
      version: '1'
    runOrder: 1
    configuration:
      BucketName: MyBucket
      Extract: 'false'
      ObjectKey: object.xml
    outputArtifacts: []
    inputArtifacts:
    - name: SourceArtifact
    region: us-east-1
    namespace: DeployVariables
  onSuccess:
     conditions:
    - result: FAIL
      rules:
      - name: MyMonitorRule
        ruleTypeId:
          category: Rule
          owner: AWS
          provider: CloudWatchAlarm
          version: '1'
        configuration:
          AlarmName: CWAlarm
          WaitTime: '1'
        inputArtifacts: []
        region: us-east-1
  

  Para ter mais informações sobre como configurar condições de falha para reversão de estágio, consulte OnFailure em StageDeclaration no Guia do usuário do AWS CloudFormation.

Como excluir uma condição de estágio

1. Faça login no AWS Management Console e abra o console do CodePipeline em http://console.aws.amazon.com/codesuite/codepipeline/home.

   Os nomes e status de todos os pipelines vinculados à sua Conta da AWS são exibidos.

2. Em Nome, selecione o nome do pipeline que você deseja editar.

3. Na página de detalhes do pipeline, selecione Editar.

4. Na página Editar, para a condição que você deseja editar, escolha Editar estágio.

5. Ao lado da condição que você deseja excluir, selecione Excluir condição.

Como substituir uma condição de estágio

1. Neste exemplo, o estágio do pipeline está sendo executado com uma condição. O botão Substituir está ativado.

   

2. Ao lado da condição que você deseja substituir, escolha Substituir.

   

3. Para analisar os detalhes, selecione Revisar. O detalhe no exemplo a seguir mostra que o resultado configurado para a condição é Falha, que foi substituído. O status da regra é Abandonado devido à substituição.