IBM Cloud Docs
Incluindo o DevOps Insights em sua cadeia de ferramentas

Incluindo o DevOps Insights em sua cadeia de ferramentas

Use o IBM Cloud® DevOps Insights para ajudar a melhorar a qualidade de construção de seus projetos. O DevOps Insights é uma ferramenta que produz dados para os insights da equipe e para a avaliação dos riscos de implementação. Para obter insights sobre seu aplicativo, faça upload de testes de unidade, cobertura de código, testes de verificação funcional e varreduras de segurança estática para cada aplicativo no DevOps Insights.

Antes de Iniciar

Para usar o DevOps Insights, deve-se ter uma cadeia de ferramentas. Uma cadeia de ferramentas é um grupo de ferramentas anexado a um de seus aplicativos. As ferramentas podem ser consideradas aprimoramentos para o aplicativo e a cadeia de ferramentas é o repositório desses recursos. O DevOps Insights trabalha em conjunto com outras ferramentas da cadeia de ferramentas, como o GitHub e o Delivery Pipeline, para agregar os dados de seu aplicativo.

Para obter mais informações sobre cadeias de ferramentas, consulte Criando uma cadeia de ferramentas por meio de um app.

Integrando o DevOps Insights

Integração de DevOps Insights usando o console

É possível incluir o DevOps Insights em qualquer cadeia de ferramentas, selecionando-o no catálogo de integração de ferramenta.

  1. No console IBM Cloud, clique no ícone de hambúrguer Menu > Automação da plataforma > Cadeias de ferramentas.
  2. Selecione sua cadeia de ferramentas.
  3. Clique em Incluir ferramenta.
  4. Selecione o tile DevOps Insights.
  5. Clique em Criar integração.
  6. Na página de visão geral da cadeia de ferramentas, na placa Ferramentas da IBM Cloud, clique em DevOps Insights para visualizar seu painel DevOps Insights.

Integração de DevOps Insights com a API

  1. Obter um token de portador de IAM. Como alternativa, se você estiver usando um SDK, obtenha uma chave de API do IAM e defina 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. Determine a região e o ID da cadeia de ferramentas à qual você deseja adicionar a integração da ferramenta DevOps Insights.

  3. Inclua a integração de ferramenta do DevOps Insights na cadeia de ferramentas.

    curl -X POST \
      {base_url}/toolchains/{toolchain_id}/tools \
      -H 'Authorization: Bearer {token}' \
      -H 'Accept: application/json` \
      -H 'Content-Type: application/json' \
        -d '{
        "tool_type_id": "draservicebroker",
        "name": "{tool_integration_name}"
      }'
    
    const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
    ...
    (async () => {
       const toolchainService = CdToolchainV2.newInstance();
       const draPrototypeModel = {
          toolchainId: {toolchain_id},
          toolTypeId: 'draservicebroker',
          name: {tool_integration_name}
       };
       const draTool = await toolchainService.createTool(draPrototypeModel);
    })();
    
    import (
    	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
    )
    ...
    toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
    toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
    createDraToolOptions := toolchainClient.NewCreateToolOptions({toolchain_id}, "draservicebroker")
    createDraToolOptions.SetName({tool_integration_name})
    draTool, response, err := toolchainClient.CreateTool(createDraToolOptions)
    
    from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
    ...
    toolchain_service = CdToolchainV2.new_instance()
    dra_tool = toolchain_service.create_tool(
       name = {tool_integration_name},
       toolchain_id = {toolchain_id},
       tool_type_id = "draservicebroker"
    )
    
    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 createDraToolOptions = new CreateToolOptions.Builder()
       .name({tool_integration_name})
       .toolchainId({toolchain_id})
       .toolTypeId("draservicebroker")
       .build();
    Response<ToolchainToolPost> response = toolchainService.createTool(createDraToolOptions).execute();
    ToolchainToolPost draTool = response.getResult();
    

A tabela a seguir lista e descreve cada uma das variáveis usadas nas etapas anteriores.

Variáveis para adicionar a integração da ferramenta DevOps Insights com a API
Variável Descrição
{base_url} O URL do ponto de extremidade da API do Toolchain, por exemplo, https://api.us-south.devops.cloud.ibm.com/toolchain/v2. Para obter mais informações sobre esse URL de endpoint, incluindo uma lista de valores, consulte URL de endpoint.
{iam_api_key} Sua chave de API do IAM.
{tool_integration_name} Um nome para a integração de sua ferramenta.
{toolchain_id} A ID da cadeia de ferramentas à qual adicionar a integração da ferramenta.
{token} Um token de portador de IAM válido.

Para obter mais informações sobre a integração da ferramenta DevOps Insights, consulte Adição de DevOps Insights.

Integração de DevOps Insights com o 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. Localize o arquivo Terraform (por exemplo, main.tf) que contém o bloco de recursos para a cadeia de ferramentas à qual você deseja adicionar a integração da ferramenta DevOps Insights. Nesse arquivo, adicione a configuração para criar a integração da ferramenta.

    O exemplo a seguir cria a cadeia de ferramentas se ela não existir e, em seguida, adiciona a integração de ferramentas DevOps Insights usando o recurso ibm_cd_toolchain_tool_devopsinsights.

    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
    }
    
    resource "ibm_cd_toolchain_tool_devopsinsights" "cd_toolchain_tool_insights" {
      toolchain_id = ibm_cd_toolchain.cd_toolchain.id
    }
    

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

  3. Inicialize a CLI do Terraform.

    terraform init
    
  4. Crie um plano de execução do Terraform. Esse plano resume todas as ações que devem ser executadas para adicionar a integração da ferramenta DevOps Insights à cadeia de ferramentas.

    terraform plan
    
  5. Aplique o plano de execução do Terraform. O Terraform executa todas as ações necessárias para adicionar a integração da ferramenta DevOps Insights à cadeia de ferramentas.

    terraform apply
    

Para obter mais informações sobre o uso do Terraform com Continuous Delivery, consulte Configuração do Terraform para Continuous Delivery.

Próximas etapas

Depois de incluir o DevOps Insights, é possível publicar dados de qualidade de outras fontes. Essas fontes incluem o IBM® Continuous Delivery Pipeline for IBM Cloud® na cadeia de ferramentas, o Jenkins, o Travis CI ou outros pipelines. Para saber mais, veja agregando dados de várias fontes em uma única cadeia de ferramentas.