Ir para o conteúdo

Implantação em um clique no Jitterbit App Builder

Introdução

Desde o App Builder 4.52, é possível configurar um processo semi-automatizado para implantar um app de um ambiente do App Builder (a origem) para outro (o destino). (Desde o App Builder 4.53, você pode implantar e instalar pacotes automaticamente em um único clique, marcando um ambiente de destino como padrão.)

Uma visão geral das etapas é a seguinte:

  1. No ambiente de destino:

    1. Configure uma chave de API.

    2. Configure o ambiente.

  2. No ambiente de origem:

    1. Configure um provedor de segurança HTTP.

    2. Configure o ambiente de origem.

Dica

Um caso de uso típico para este recurso é simplificar a implantação de apps, por exemplo, de desenvolvimento para QA, ou de QA para produção. Nestes exemplos, origem e destino seriam os seguintes:

%%{init: {"themeVariables": {"lineColor": "#6b7280", "edgeLabelBackground": "#f5f5f5"}}}%% flowchart LR DEV["Development
(Source)"] --> QA1["QA
(Target)"] QA2["QA
(Source)"] --> PROD["Production
(Target)"]

Pré-requisitos

O usuário do ambiente de destino (aquele para o qual a chave de API é criada) deve ter a função Deployment.

O usuário do ambiente de origem (aquele que faz a implantação) precisa ter as funções Administrator ou Developer.

No destino

Configure uma chave de API

Para configurar uma chave de API no ambiente de destino, siga estas etapas:

  1. Crie um provedor de segurança de chave de API:

    1. Selecione IDE > Security Providers.

    2. Clique no botão + Security Provider.

    3. Na página Provider, configure, habilite e salve um provedor do tipo API Key:

      Provider

  2. Configure um usuário para realizar as implantações em um clique:

    1. (Opcional) Crie um novo usuário. Se você deseja realizar as implantações em um clique usando um usuário existente, vá para a próxima etapa.

    2. Acesse IDE > User Management e abra a guia Groups.

    3. No painel Groups, selecione Deployment.

    4. O painel Membership agora lista todos os usuários pertencentes ao grupo selecionado. Clique no botão + Membership.

    5. Use o menu suspenso para selecionar o usuário que você deseja usar e clique no ícone . Esse usuário agora pertence ao grupo que tem as permissões necessárias para implantar uma versão.

  3. Gere uma chave de API para o usuário que realizará as implantações:

    1. Se você saiu da página User Management, retorne a ela acessando IDE > User Management.

    2. Na guia Users, o painel Users lista todos os usuários. Localize e selecione aquele para o qual você deseja autorizar implantações.

    3. Clique no ícone do usuário selecionado. A caixa de diálogo User é aberta.

    4. Acesse More > Keys. A caixa de diálogo Keys é aberta.

    5. Clique em Create. A caixa de diálogo Generate Key é aberta.

    6. No campo Provider, selecione o provedor de segurança criado acima. Clique em Save. O App Builder criará uma chave de API para o usuário.

      Aviso

      A chave de API será exibida apenas uma vez. Certifique-se de copiar e armazenar com segurança.

  4. (Desde o App Builder 4.68.) Associe o provedor de segurança ao serviço web do aplicativo Vinyl - Release Management, o aplicativo de sistema integrado e lacrado cuja API REST recebe solicitações de implantação em um clique neste ambiente. Um serviço web de aplicativo lacrado não pode ser reconfigurado de dentro do app, portanto isso é feito a partir de Applications:

    1. Em Security Providers, no painel Security Providers, selecione More > Applications.

    2. Encontre Vinyl - Release Management e clique no ícone em sua coluna Web Service. A caixa de diálogo Authentication Providers é aberta.

  5. Clique em + Authentication. A caixa de diálogo Provider abre.

  6. Selecione o provedor de segurança criado acima. Se o ambiente de destino usa um provedor HTTP com Authentication Type definido como Basic, ou um provedor Authorization Server, selecione esse. Clique em Save.

Configure o ambiente de destino

Para configurar o ambiente de destino, siga estas etapas:

  1. Selecione IDE > Create Release.

  2. Selecione a aba Environments.

  3. Em Current Environment, clique no botão Configure.

  4. Na janela pop-up, defina os valores dos seguintes campos:

    • Name: Um nome para este ambiente de destino.

    • URL: A URL deste ambiente de destino.

    • Authentication: Selecione a chave de API criada na seção anterior.

    • Enable Deployment: Selecionado.

    • Allow Install On Deploy: Selecionado.

  5. Clique no botão Save:

Target environment

Na origem

Configure um provedor de segurança HTTP

Para configurar um provedor de segurança HTTP no ambiente de origem, siga estas etapas:

  1. Selecione IDE > Security Providers.

  2. Clique no botão + Security Provider.

  3. Na página Provider, configure, ative e salve um provedor do tipo HTTP (listado na seção Data Source Authentication) com Authentication Type definido como API Key.

  4. Clique no botão Save. Painéis adicionais aparecem.

  5. Em Endpoints, clique no botão + Credential. A janela pop-up Credential abre.

  6. Defina os seguintes campos:

    • Type: API Key

    • Key: Digite a chave de API do destino, que você criou anteriormente.

  7. Feche a janela pop-up Credential.

HTTP security provider

Configure o ambiente de origem

Para configurar o ambiente de origem, siga estas etapas:

  1. Defina o ambiente atual:

    1. Selecione IDE > Create Release.

    2. Selecione a aba Environments.

    3. Em Current Environment, clique no botão Configure.

    4. Na janela pop-up, defina os valores dos seguintes campos:

      • Name: Um nome para este ambiente de origem.

      • URL: A URL deste ambiente de origem.

      • Enable Deployment: Selecionado.

      • Allow Install On Deploy: Selecionado.

    5. Clique no botão Save.

  2. Defina o ambiente de destino:

    1. Em Target Environments, clique no botão + Target Environment.

    2. Defina os valores dos seguintes campos:

      • Name: Digite um nome para o ambiente de destino.

      • URL: A URL de acesso do ambiente de destino.

      • Authentication: Selecione o provedor HTTP criado na seção anterior.

      • Supports Deployment: Selecionado.

        • Default: (Opcional, aparece quando Supports Deployment é selecionado.) Selecione para fazer deploy automaticamente neste ambiente, a menos que outro seja selecionado.
      • Supports Install On Deploy: Selecionado.

        • Default: (Opcional, aparece quando Supports Install on Deploy é selecionado.) Selecione para instalar pacotes automaticamente durante o deployment.
    3. Clique no botão Save e feche a janela pop-up Environment.

Source environment

Realize uma implantação em um clique

Para usar o recurso de deploy com um clique, siga estas etapas:

  1. Crie um release:

    1. Selecione IDE > Create Release.

    2. Selecione a aba Create a Release.

    3. Clique no botão + Solution.

    4. Use o assistente Solution para definir o que fazer deploy.

  2. Compile a solução:

    1. Clique no botão Build para o novo template de release.
  3. Implantar a versão:

    1. Aguarde uma notificação do App Builder informando que a compilação foi concluída.

    2. Execute um dos seguintes procedimentos:

      1. Clique no botão Ver Versão da notificação. A aba Todas as Versões abre.

      2. Descarte a notificação e selecione a aba Todas as Versões.

    3. Clique no botão Implantar da solução compilada.

    4. Se a opção Padrão estiver marcada para Suporta Implantação e Suporta Instalar ao Implantar no ambiente de destino, nenhuma ação adicional é necessária.

      Caso contrário, prossiga com as seguintes etapas:

      1. No popup Implantar Versão, abra o menu Ambiente e selecione o ambiente de destino.

      2. Marque a caixa de seleção Instalar ao Implantar.

      3. Clique no botão Implantar.

Confirme que uma versão foi implantada

Após realizar uma implantação com um clique, você pode confirmar que a versão foi implantada executando o seguinte:

  1. Faça login no ambiente de destino.

  2. Navegue até IDE > Instalar Versão.

  3. Verifique se o pacote existe e foi instalado.