Como adicionar uma integração de ferramenta usando o console

Você pode adicionar integrações de ferramentas em sua cadeia de ferramentas usando o console.

1. No console IBM Cloud, clique no ícone Menu > Automação da plataforma > Cadeias de ferramentas.
2. Na página Cadeias de ferramentas, clique em uma cadeia de ferramentas para abrir a sua página de Visão geral. Como alternativa, na página Detalhes do app em seu app, clique no nome da cadeia de ferramentas.
3. Para ver uma lista das integrações de ferramentas a serem adicionadas, clique em “Adicionar ”.
4. Clique em uma integração de ferramenta que deseja incluir.
5. Insira quaisquer informações necessárias para configurar a integração de ferramenta.
6. Clique em Criar integração para incluir a integração de ferramenta em sua cadeia de ferramentas.

Como adicionar uma integração de ferramenta com a API

Você pode adicionar integrações de ferramentas em sua 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. Consulte o ID da cadeia de ferramentas no qual deseja criar sua integração de ferramentas.

3. Consulte o valor tool_type_id que corresponde à integração da ferramenta que você deseja adicionar.

4. Adicione a integração da ferramenta à cadeia de ferramentas pretendida.

   curl -X POST --location --header "Authorization: Bearer {iam_token}" \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --data '{ "name": "{tool_name}", "tool_type_id": "{tool_type_id}", "parameters": {tool_parameters} }' \
     "{base_url}/toolchains/{toolchain_id}/tools"
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   const toolchainService = CdToolchainV2.newInstance();
   ...
   (async() => {
      const toolPrototypeModel = {
         toolchainId: {toolchain_id},
         toolTypeId: {tool_type_id},
         name: {tool_name},
         parameters: {tool_parameters}
      };
      const response = await toolchainService.createTool(toolPrototypeModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   createToolOptions := toolchainClient.NewCreateToolOptions({toolchain_id}, {tool_type_id})
   createToolOptions.SetName({tool_name})
   createToolOptions.SetParameters({tool_parameters})
   tool, response, err := toolchainClient.CreateTool(createToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   tool = toolchain_service.create_tool(
      name = {tool_name},
      toolchain_id = {toolchain_id},
      tool_type_id = {tool_type_id},
      parameters = {tool_parameters}
   )
   

   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.CdToolchain;
   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.model.*;
   ...
   CdToolchain toolchainService = CdToolchain.newInstance();
   CreateToolOptions createToolOptions = new CreateToolOptions.Builder()
      .name({tool_name})
      .parameters({tool_parameters})
      .toolchainId({toolchain_id})
      .toolTypeId({tool_type_id})
      .build();
   Response<ToolchainToolPost> response = toolchainService.createTool(createToolOptions).execute();
   ToolchainToolPost tool = response.getResult();
   

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

Como adicionar uma integração de ferramenta com Terraform

Você pode adicionar integrações de ferramentas à sua 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. Neste arquivo, adicione a configuração para criar instâncias de recursos usando a Linguagem de Configuração do HashiCorp (HCL). Para obter mais informações sobre o uso dessa linguagem de configuração, consulte a documentação Terraform.

   O exemplo a seguir cria uma integração de ferramentas Delivery Pipeline usando o recurso ibm_cd_toolchain_tool_pipeline, em que toolchain_id é um GUID que representa a cadeia de ferramentas na qual será criada a integração da ferramenta.

   data "ibm_cd_toolchain" "cd_toolchain" {
     toolchain_id = {toolchain_id}
   }
   resource "ibm_cd_toolchain_tool_pipeline" "cd_pipeline" {
     toolchain_id = data.ibm_cd_toolchain.cd_toolchain.id
     parameters {
       name = "myPipeline"
     }
   }
   

   Para obter mais informações sobre recursos de integração de ferramentas, veja a lista completa de recursos de integração de ferramentas suportados no IBM Cloud 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 a integração da ferramenta.

   terraform plan
   

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

   terraform apply
   

Como atualizar uma integração de ferramentas usando o console

Se você adiou a configuração da integração de uma ferramenta ao criar uma cadeia de ferramentas, um botão “Configurar” será exibido no cartão correspondente. Se você configurou uma integração de ferramenta ao criar uma cadeia de ferramentas, é possível atualizar as configurações por meio do console.

1. No console IBM Cloud, clique no ícone Menu > Automação da plataforma > Cadeias de ferramentas.
2. Na página “Cadeias de ferramentas”, clique na cadeia de ferramentas que contém a integração da ferramenta que você deseja atualizar para abrir a página “Visão geral” dela. Como alternativa, na página Detalhes do app em seu app, clique no nome da cadeia de ferramentas.
3. Se precisar configurar uma integração de ferramenta pela primeira vez, em seu cartão, clique em Configurar.
4. Quando tiver finalizado a configuração da integração de ferramenta, clique em Salvar integração.
5. Se você precisar atualizar uma configuração da integração da ferramenta, clique no ícone Ações > Configurar.
6. Quando tiver finalizado a atualização das configurações, clique em Salvar integração.

Como atualizar uma integração de ferramentas com a API

Se você configurou uma integração de ferramenta ao criar uma cadeia de ferramentas, é possível atualizar as configurações por meio da 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. Consulte o ID da cadeia de ferramentas onde a integração da ferramenta existe.

3. Usando o ID da cadeia de ferramentas, olhe para cima o ID da integração da ferramenta.

4. Atualize a integração da ferramenta dentro da cadeia de ferramentas direcionada.

   curl -X PATCH --location --header "Authorization: Bearer {iam_token}" \
     --header "Accept: application/json" \
     --header "Content-Type: application/merge-patch+json" \
     --data '{ "name": "{new_tool_name}", "parameters": {new_tool_parameters} }' \
     "{base_url}/toolchains/{toolchain_id}/tools/{tool_id}"
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   const toolchainService = CdToolchainV2.newInstance();
   ...
   (async() => {
      const toolPatchModel = {
         toolchainId: {toolchain_id},
         toolId: {tool_id},
         name: {new_tool_name},
         parameters: {new_tool_parameters}
      };
      const response = await toolchainService.updateTool(toolPatchModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   toolPatchModel := map[string]interface{}{
      "name": {new_tool_name},
      "parameters": {new_tool_parameters},
   }
   updateToolOptions := toolchainClient.NewUpdateToolOptions({toolchain_id}, {tool_id}, toolPatchModel)
   tool, response, err := toolchainClient.UpdateTool(updateToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   tool = toolchain_service.update_tool(
      toolchain_id = {toolchain_id},
      tool_id = {tool_id},
      toolchain_tool_prototype_patch = {
         "name": {new_tool_name},
         "parameters": {new_tool_parameters}
      }
   )
   

   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.CdToolchain;
   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.model.*;
   ...
   CdToolchain toolchainService = CdToolchain.newInstance();
   HashMap<String,Object> toolchainToolPrototypePatch = new HashMap<>();
   toolchainToolPrototypePatch.put("name", {new_tool_name});
   toolchainToolPrototypePatch.put("parameters", {new_tool_parameters});
   UpdateToolOptions updateToolOptions = new UpdateToolOptions.Builder()
      .toolchainId({toolchain_id})
      .toolId({tool_id})
      .toolchainToolPrototypePatch(toolchainToolPrototypePatch)
      .build();
   Response<ToolchainToolPatch> response = toolchainService.updateTool(updateToolOptions).execute();
   ToolchainToolPatch tool = response.getResult();
   

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

Como atualizar uma integração de ferramentas com Terraform

Se você configurou uma integração de ferramenta ao criar uma cadeia de ferramentas, é possível atualizar as configurações usando o Terraform.

1. Instale o CLI Terraform e configure o plug-in do provedor IBM Cloud para Terraform, seguindo o tutorial para Introdução ao Terraform em IBM Cloud.

2. Use o arquivo de configuração Terraform que você usou para criar a integração da ferramenta. Se a sua integração de ferramentas não foi criada com Terraform, execute terraform import para evitar criar outra integração de ferramentas. Para obter mais informações sobre o uso dessa linguagem de configuração, consulte a documentação Terraform.

   O exemplo a seguir atualiza o nome de uma integração de ferramenta Delivery Pipeline existente usando o recurso ibm_cd_toolchain_tool_pipeline, em que toolchain_id é um GUID que representa a cadeia de ferramentas onde a integração da ferramenta existe.

   data "ibm_cd_toolchain" "cd_toolchain" {
     toolchain_id = {toolchain_id}
   }
   resource "ibm_cd_toolchain_tool_pipeline" "cd_pipeline" {
     toolchain_id = data.ibm_cd_toolchain.cd_toolchain.id
     parameters {
       name = "myUpdatedPipelineName"
     }
   }
   

   Para obter mais informações sobre recursos de integração de ferramentas, veja a lista completa de recursos de integração de ferramentas suportados no IBM Cloud 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 modificar a integração da ferramenta.

   terraform plan
   

5. Aplique o plano de execução do Terraform. O Terraform toma todas as ações necessárias para modificar a integração da ferramenta.

   terraform apply
   

Como excluir uma integração de ferramentas usando o console

Você pode excluir integrações de ferramentas da sua cadeia de ferramentas usando o console. Se você excluir uma integração de ferramenta a partir de sua cadeia de ferramentas, a exclusão não poderá ser desfeita.

1. No console IBM Cloud, clique no ícone Menu > Automação da plataforma > Cadeias de ferramentas.
2. Na página Cadeias de ferramentas, clique em uma cadeia de ferramentas para abrir a sua página de Visão geral. Como alternativa, na página Detalhes do app em seu app, clique no nome da cadeia de ferramentas.
3. Sobre a integração da ferramenta que deseja excluir, clique no ícone Ações > Excluir.
4. Confirme clicando em Excluir.

Como excluir uma integração de ferramenta com a API

Você pode excluir integrações de ferramentas da sua cadeia de ferramentas com a API. Se você excluir uma integração de ferramenta a partir de sua cadeia de ferramentas, a exclusão não poderá ser desfeita.

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. Consulte o ID da cadeia de ferramentas onde a integração da ferramenta existe.

3. Usando o ID da cadeia de ferramentas, olhe para cima o ID da integração da ferramenta.

4. Excluir a integração da ferramenta dentro da cadeia de ferramentas direcionada.

   curl -X DELETE --location --header "Authorization: Bearer {iam_token}" \
     "{base_url}/toolchains/{toolchain_id}/tools/{tool_id}"
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   const toolchainService = CdToolchainV2.newInstance();
   ...
   (async() => {
      const response = await toolchainService.deleteTool({
         toolchainId: {toolchain_id},
         toolId: {tool_id}
      });
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   deleteToolOptions := toolchainClient.NewDeleteToolOptions({toolchain_id}, {tool_id})
   response, err := toolchainClient.DeleteTool(deleteToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   response = toolchain_service.delete_tool(
      toolchain_id = {toolchain_id},
      tool_id = {tool_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();
   DeleteToolOptions deleteToolOptions = new DeleteToolOptions.Builder()
      .toolchainId({toolchain_id})
      .toolId({tool_id})
      .build();
   Response<Void> response = toolchainService.deleteTool(deleteToolOptions).execute();
   

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

Como excluir uma integração de ferramenta com Terraform

Você pode excluir integrações de ferramentas da sua cadeia de ferramentas com Terraform. Se você excluir uma integração de ferramenta a partir de sua cadeia de ferramentas, a exclusão não poderá ser desfeita.

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. Use o arquivo de configuração Terraform que você usou para criar a integração da ferramenta. Comente ou remova o recurso de integração da ferramenta a partir do arquivo de configuração.

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 excluir a integração da ferramenta.

   terraform plan
   

5. Aplique o plano de execução do Terraform. O Terraform toma todas as ações necessárias para excluir a integração da ferramenta.

   terraform apply