Exibir o URL da aplicação no diagrama do fluxo de trabalho - Amazon CodeCatalyst

Exibir o URL da aplicação no diagrama do fluxo de trabalho

Se seu fluxo de trabalho implantar uma aplicação, você poderá configurar o Amazon CodeCatalyst para exibir o URL da aplicação como um link clicável. Esse link aparece no console do CodeCatalyst, dentro da ação que o implantou. O diagrama de fluxo de trabalho a seguir mostra o URL de Exibir aplicação que aparece na parte inferior de uma ação.

Exibir URL da aplicação

Ao tornar esse URL clicável no console do CodeCatalyst, você pode verificar rapidamente a implantação da aplicação.

nota

O URL da aplicação não é compatível com a ação Implantar no Amazon ECS.

Para habilitar esse recurso, adicione uma variável de saída à sua ação com um nome que contenha appurl ou endpointurl. Você pode usar um nome com ou sem um traço (-), sublinhado (_) ou espaço ( ). A string diferencia maiúsculas e minúsculas. Defina o valor da variável como o URL http ou https da aplicação implantada.

nota

Se você estiver atualizando uma variável de saída existente para incluir o app url, ou a string endpoint url, atualize todas as referências a essa variável para usar o novo nome da variável.

Para ver as etapas detalhadas, consulte um destes procedimentos:

Quando terminar de configurar o URL, verifique se ele aparece conforme o esperado seguindo estas instruções:

Para exibir o URL da aplicação na ação “Implantação do AWS CDK”
  1. Se você estiver usando a ação Implantação do AWS CDK, adicione um constructo CfnOutput (que é um par de valor-chave) no código da aplicação AWS CDK:

    • O nome da chave deve conter appurl, ouendpointurl, com ou sem um traço (-), sublinhado (_) ou espaço ( ). A string diferencia maiúsculas e minúsculas.

    • O valor deve ser o URL http ou https da aplicação implantada.

    Por exemplo, o código do AWS CDK pode ser semelhante a:

    import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib'; import * as dynamodb from 'aws-cdk-lib/aws-dynamodb'; import * as s3 from 'aws-cdk-lib/aws-s3'; import { Construct } from 'constructs'; import * as cdk from 'aws-cdk-lib'; export class HelloCdkStack extends Stack { constructor(scope: Construct, id: string, props?: StackProps) { super(scope, id, props); const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', { removalPolicy: RemovalPolicy.DESTROY, }); new CfnOutput(this, 'APP-URL', { value: https://mycompany.myapp.com, description: 'The URL of the deployed application', exportName: 'myApp', }); ... } }

    Para ter mais informações sobre o constructo CfnOutput, consulte a interface CfnOutputProps na Referência da AP do AWS Cloud Development Kit (AWS CDK).

  2. Salve e confirme seu código.

  3. Vá para Como verificar se o URL da aplicação foi adicionado.

Como exibir o URL da aplicação na ação “Implantar pilha do AWS CloudFormation”
  1. Se você estiver usando a ação Implantar pilha do AWS CloudFormation, adicione uma saída à seção Outputs no modelo do CloudFormation ou do AWS SAM com estas características:

    • A chave (também chamada de ID lógico) deve conter appurl, ouendpointurl, com ou sem um traço (-), sublinhado (_) ou espaço ( ). A string diferencia maiúsculas e minúsculas.

    • O valor deve ser o URL http ou https da aplicação implantada.

    Por exemplo, o modelo do CloudFormation pode ser semelhante a:

    "Outputs" : { "APP-URL" : { "Description" : "The URL of the deployed app", "Value" : "https://mycompany.myapp.com", "Export" : { "Name" : "My App" } } }

    Para ter mais informações sobre as saídas do CloudFormation, consulte Saídas no Guia do usuário do AWS CloudFormation.

  2. Salve e confirme seu código.

  3. Vá para Como verificar se o URL da aplicação foi adicionado.

Para exibir o URL da aplicação em todas as outras ações

Se você estiver usando outra ação para implantar a aplicação, como a ação de criação ou o GitHub Actions, faça o seguinte para que o URL da aplicação seja exibido.

  1. Defina uma variável de ambiente na seção Inputs ou Steps da ação no arquivo de definição do fluxo de trabalho. A variável deve ter estas características:

    • O name deve conter appurl, ou endpointurl, com ou sem um traço (-), sublinhado (_) ou espaço ( ). A string diferencia maiúsculas e minúsculas.

    • O valor deve ser o URL http ou https da aplicação implantada.

    Por exemplo, uma ação de criação pode ser semelhante a esta:

    Build-action: Identifier: aws/build@v1 Inputs: Variables: - Name: APP-URL Value: https://mycompany.myapp.com

    … Ou esta:

    Actions: Build: Identifier: aws/build@v1 Configuration: Steps: - Run: APP-URL=https://mycompany.myapp.com

    Para ter mais informações sobre definição de variáveis de ambiente, consulte Definição de uma variável.

  2. Exporte a variável.

    Por exemplo, sua ação de criação pode ser semelhante a esta:

    Build-action: ... Outputs: Variables: - APP-URL

    Para ter informações sobre exportação de variáveis, consulte Exportação de uma variável para que outras ações possam usá-la.

  3. (Opcional) Selecione Validar para validar o código YAML do fluxo de trabalho antes de confirmar.

  4. Selecione Confirmar, insira uma mensagem de confirmação e escolha Confirmar novamente.

  5. Vá para Como verificar se o URL da aplicação foi adicionado.

Como verificar se o URL da aplicação foi adicionado
  • Inicie a execução de um fluxo de trabalho, caso ele não tenha sido iniciado automaticamente. A nova execução deve ter o URL da aplicação exibido como um link clicável no diagrama de fluxo de trabalho. Para ter mais informações sobre como iniciar execuções, consulte Iniciar um fluxo de trabalho executado manualmente.