Criando cadeias de ferramentas

Como criar uma cadeia de ferramentas a partir de um modelo usando o console

Você pode usar um modelo como ponto de partida para criar uma cadeia de ferramentas que inclua um conjunto específico de integrações de ferramentas. Dependendo do modelo que você usar, é possível criar uma cadeia de ferramentas que tenha um conjunto específico de integrações de ferramentas ou uma cadeia de ferramentas vazia em que é possível incluir integrações de ferramentas. Saiba mais sobre como usar os modelos a partir do IBM Cloud Método de Garagem.

1. Efetue login na IBM Cloud.

2. No console IBM Cloud, clique no ícone Menu > Automação da plataforma > Cadeias de ferramentas.

3. Na página Cadeias de ferramentas, clique em Criar uma cadeia de ferramentas.

4. Na página Create a Toolchain (Criar uma cadeia de ferramentas), clique em um modelo de cadeia de ferramentas.

5. Revise o diagrama da cadeia de ferramentas que você está prestes a criar. O diagrama mostrará cada integração de ferramenta em sua fase de ciclo de vida na cadeia de ferramentas.

   Alguns dos modelos de cadeia de ferramentas têm múltiplas instâncias de uma integração de ferramenta. Por exemplo, o modelo de cadeia de ferramentas "Desenvolver e testar microsserviços com Kubernetes e Helm " em IBM Cloud Public contém quatro instâncias de GitHub e quatro instâncias de Delivery Pipeline.

   O diagrama na imagem a seguir é um exemplo. Ao criar uma cadeia de ferramentas, o diagrama mostrará cada integração de ferramenta que é parte da cadeia de ferramentas.

   

6. Revise as informações padrão para as configurações da cadeia de ferramentas:

   • O nome da cadeia de ferramentas as identifica em IBM Cloud. Se você desejar usar um nome diferente, mude o nome da cadeia de ferramentas.
   • A região na qual criar a cadeia de ferramentas. Se você desejar usar uma região diferente, selecione-a na lista de regiões disponíveis.
   • O grupo de recursos no qual criar a cadeia de ferramentas. Caso queira utilizar um grupo de recursos diferente, selecione-o na lista de grupos de recursos disponíveis.
   • O provedor para seu repositório de origem, como GitHub, GitLab ou Bitbucket. Se quiser usar um provedor de origem diferente, selecione-o na lista de repositórios disponíveis.

7. Na seção Integrações de ferramentas, selecione cada integração de ferramenta que deseja configurar para sua cadeia de ferramentas. Algumas integrações de ferramentas não requerem configuração. Para obter mais informações sobre como configurar as integrações de ferramentas, consulte Configurando integrações de ferramentas.

   Muitas das integrações de ferramenta que compõem uma cadeia de ferramentas requerem um segredo para se autenticar com o serviço do Continuous Delivery.

   Um segredo são credenciais que podem ser fornecidas na forma de uma senha, token de autenticação, chave de API ou certificado. Por exemplo, ao incluir a integração da ferramenta Delivery Pipeline na cadeia de ferramentas, deve-se fornecer um segredo na forma de uma chave de API.

   a. Na seção Integrações de ferramentas, clique em Delivery Pipeline.

   b. Clique em Novo para criar uma chave de API do IBM Cloud®.

   c. Clique em OK para aplicar sua nova chave de API.

   Cada usuário pode ter no máximo 20 chaves de API.

   d. Clique em OK para criar a chave de API sem salvar uma cópia segura da chave.

   e. Para salvar com segurança a chave de API para que você possa usá-la novamente em outros fluxos de trabalho da cadeia de ferramentas:

   • Marque a caixa de seleção Save this key in a secrets store for reuse (Salvar essa chave em um armazenamento de segredos para reutilização ) para integrar com o armazenamento de segredos Key Protect ou Secrets Manager.
   • Se você não tiver uma instância existente de Key Protect ou Secrets Manager, especifique um nome para a instância e o segredo.
   • Clique em OK para aplicar sua nova chave de API.

   f. Para validar se a sua instância Key Protect ou Secrets Manager foi criada com sucesso, vá para o seu IBM Cloud® Lista de recursos e expanda o Serviços twistie. Para visualizar suas chaves de API, na barra de menus, clique em Manage > Access (IAM) e selecione IBM Cloud® API keys.

   g. A chave de API que você criou e copiou no Key Project agora está disponível para uso na página Criar uma cadeia de ferramentas. Qualquer integração de ferramenta que requerer um segredo exibirá um ícone de chave. Clique no ícone de chave para abrir a caixa de diálogo Secrets Picker e recuperar segredos de uma ou mais instâncias de Key Protect ou Secrets Manager.

8. Clique em Criar. Várias etapas são executadas automaticamente para configurar sua cadeia de ferramentas. As integrações de ferramentas configuradas variam de acordo com o modelo de cadeia de ferramentas selecionado. Por exemplo, quando você cria um "Desenvolver e testar microserviços com Kubernetes e Helm" toolchain em IBM Cloud Público, estas etapas são executadas:

   • A cadeia de ferramentas é criada.
   • Se você tiver configurado o Delivery Pipeline, os pipelines serão criados e acionados.
   • Se você configurou Event Notifications, a cadeia de ferramentas está configurada para enviar notificações de eventos para o serviço Event Notifications que você especificou.
   • Se você tiver configurado o Sauce Labs, a cadeia de ferramentas será configurada para incluir tarefas de teste do Sauce Labs nos pipelines.
   • Se tiver configurado o PagerDuty, a cadeia de ferramentas será configurada para enviar notificações de alerta para o serviço PagerDuty especificado.
   • Se tiver configurado o Slack, a cadeia de ferramentas será configurada para enviar notificações sobre o status de implementação para o canal Slack especificado.
   • Se tiver configurado a integração de ferramenta do código-fonte, como o GitHub, o repositório GitHub de amostra será clonado na conta do GitHub.

   Agora você pode distribuir notificações de eventos usando a integração da ferramenta Event NotificationsIBM Cloud Event Notifications é o método preferido para distribuir notificações para PagerDuty e outros canais de comunicação, como Slack, e-mail, SMS, notificações por push, webhook, Microsoft® Teams, ServiceNow, e IBM Cloud Functions. Para obter mais informações sobre o uso do site Event Notifications, consulte Ativação de notificações de eventos para toolchains.

Como criar uma cadeia de ferramentas a partir de um app usando o console

É possível criar uma cadeia de ferramentas a partir de seu aplicativo. A cadeia de ferramentas pode suportar desenvolvimento, implementação e monitoramento contínuos e mais, e é associada ao seu app. Cada app pode ser associado a uma cadeia de ferramentas. Ao enviar por push mudanças no repo GitHub da cadeia de ferramentas, o pipeline automaticamente constrói e implementa o app.

1. Se você usou o IBM Cloud Public para criar seu aplicativo, ele está configurado para entrega contínua a partir de um novo repositório GitHub que é preenchido com o código inicial do aplicativo.

2. Na página de configuração da cadeia de ferramentas, revise o diagrama da cadeia de ferramentas que você está prestes a criar. O diagrama mostrará cada integração de ferramenta em sua fase de ciclo de vida na cadeia de ferramentas.

3. Revise as informações padrão para as configurações da cadeia de ferramentas. O nome da cadeia de ferramentas as identifica em IBM Cloud. Se você desejar usar um nome diferente, mude o nome da cadeia de ferramentas.

4. Na seção Integrações de ferramentas, selecione cada integração de ferramenta que deseja configurar para sua cadeia de ferramentas. Algumas integrações de ferramentas não requerem configuração. Para obter mais informações sobre como configurar as integrações de ferramentas, consulte Configurando integrações de ferramentas.

5. Clique em Criar. Várias etapas são executadas automaticamente para configurar sua cadeia de ferramentas. Por exemplo, quando você cria uma cadeia de ferramentas de um app no IBM Cloud Public, estas etapas são executadas:

   • A cadeia de ferramentas é criada.
   • Se você tiver configurado o Delivery Pipeline, os pipelines serão criados e acionados.
   • Se você tiver configurado o GitHub, o repositório GitHub de amostra será clonado na conta do GitHub.

Criação de uma cadeia de ferramentas com a API

1. Obter um token de portador de IAM. Alternativamente, se você estiver usando um SDK, obtenha uma chave API IAM e configure as opções do cliente usando variáveis de ambiente.

   export CD_TOOLCHAIN_AUTH_TYPE=iam && \
   export CD_TOOLCHAIN_APIKEY={iam_api_key} && \
   export CD_TOOLCHAIN_URL={base_url}
   

2. Consultem o ID do grupo de recursos no qual você deseja criar sua cadeia de ferramentas.

3. Escolha a região na qual você deseja criar sua cadeia de ferramentas.

4. Crie uma instância da cadeia de ferramentas.

   curl -X POST \
     "{base_url}/toolchains" \
     -H 'Authorization: Bearer {token}' \
     -H 'Content-Type: application/json' \
       -d '{
       "name": "{toolchain_name}",
       "resource_group_id": "{resource_group_id}"
     }'
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   const toolchainService = CdToolchainV2.newInstance();
   ...
   (async() => {
      const toolchainPrototypeModel = {
         description: {toolchain_description},
         name: {toolchain_name},
         resourceGroupId: {resource_group_id}
      };
      const response = await toolchainService.createToolchain(toolchainPrototypeModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   createToolchainOptions := toolchainClient.NewCreateToolchainOptions({toolchain_name}, {resource_group_id})
   createToolchainOptions.SetDescription({toolchain_description})
   toolchain, response, err := toolchainClient.CreateToolchain(createToolchainOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   toolchain = toolchain_service.create_toolchain(
      description = {toolchain_description},
      name = {toolchain_name},
      resource_group_id = {resource_group_id}
   )
   

   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.CdToolchain;
   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.model.*;
   ...
   CdToolchain toolchainService = CdToolchain.newInstance();
   CreateToolchainOptions createToolchainOptions = new CreateToolchainOptions.Builder()
      .description({toolchain_description})
      .name({toolchain_name})
      .resourceGroupId({resource_group_id})
      .build();
   Response<ToolchainPost> response = toolchainService.createToolchain(createToolchainOptions).execute();
   ToolchainPost toolchain = response.getResult();
   

A tabela a seguir lista e descreve cada uma das variáveis que são utilizadas nas etapas anteriores.

Para obter mais informações sobre a criação de cadeias de ferramentas com a API, consulte Criar uma cadeia de ferramentas na API IBM Cloud.

Criando uma cadeia de ferramentas com Terraform

1. Para instalar a CLI do Terraform e configurar o plug-in do IBM Cloud Provider para o Terraform, siga o tutorial de Introdução ao Terraform no IBM Cloud®.

2. Crie um arquivo de configuração do Terraform que seja denominado main.tf. Nesse arquivo, adicione a configuração para criar uma cadeia de ferramentas usando a HashiCorp Configuration Language. Para obter mais informações sobre o uso dessa linguagem de configuração, consulte a documentação Terraform.

   O exemplo a seguir cria uma cadeia de ferramentas usando o recurso ibm_cd_toolchain.

   data "ibm_resource_group" "group" {
     name = "default"
   }
   
   resource "ibm_cd_toolchain" "cd_toolchain" {
     name              = "my toolchain"
     resource_group_id = data.ibm_resource_group.group.id
   }
   

   Para obter mais informações sobre ibm_cd_toolchain, consulte os detalhes de referência do argumento na Documentação do Terraform Registry.

3. Inicialize a CLI do Terraform.

   terraform init
   

4. Crie um plano de execução do Terraform. Este plano resume todas as ações que devem ser executadas para criar uma cadeia de ferramentas.

   terraform plan
   

5. Aplique o plano de execução do Terraform. O Terraform toma todas as ações necessárias para criar a cadeia de ferramentas.

   terraform apply