將 DevOps Insights 新增至工具鏈

DevOps Insights 該服務已停止運作,目前無法使用。 了解更多

使用 IBM Cloud® DevOps Insights 協助您改善專案的建置品質。DevOps Insights 是一個提供團隊洞察力與部署風險資料的工具。 藉由將每個應用程式的單元測試、程式碼涵蓋面、功能驗證測試及靜態安全掃描上傳至 DevOps Insights,取得關於應用程式的見解。

開始之前

若要使用 DevOps Insights,您必須具有工具鏈。 工具鏈是一群連接至您其中一個應用程式的工具。 將工具視為應用程式的增強功能,將工具鏈視為實用帶。DevOps Insights與工具鏈中的其他工具(例如GitHub和Delivery Pipeline搭配使用,為您的應用程式聚合資料。

如需工具鏈的相關資訊,請參閱從應用程式建立工具鏈。

整合 DevOps Insights

使用控制台整合DevOps Insights

您可以從工具整合型錄選取 DevOps Insights,以將它新增至任何工具鏈。

  1. 在IBM Cloud控制台中,點選選單圖示漢堡圖示>平台自動化>工具鏈。
  2. 選取工具鏈。
  3. 點擊「新增工具」。
  4. 選取 DevOps Insights 磚。
  5. 按一下建立整合。
  6. 在工具鏈的概述頁面上的 IBM Cloud工具卡上,按一下 DevOps Insights 以查看您的DevOps Insights儀表板。

將DevOps Insights與 API 集成

  1. 取得 IAM 不記名令牌。 或者,如果您使用 SDK,請取得 IAM API 金鑰並使用環境變數設定用戶端選項。

    export CD_TOOLCHAIN_AUTH_TYPE=iam && \
    export CD_TOOLCHAIN_APIKEY={iam_api_key} && \
    export CD_TOOLCHAIN_URL={base_url}
    
  2. 確定要將DevOps Insights工具整合新增到的 工具鏈的區域和 ID。

  3. 將DevOps Insights工具整合加入到工具鏈中。

    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();
    

下表列出並描述了前面步驟中使用的每個變數。

用於新增DevOps Insights工具與 API 整合的變數
變數 說明
{base_url} 工具鏈 API 端點 URL,例如 https://api.us-south.devops.cloud.ibm.com/toolchain/v2。 如需更多關於此端點 URL 的資訊,包括值清單,請參閱 端點 URL。
{iam_api_key} 您的 IAM API 金鑰。
{tool_integration_name} 您的工具整合的名稱。
{toolchain_id} 要新增工具整合的工具鏈的 ID。
{token} 一個有效的 IAM 承載者憑證。

有關DevOps Insights工具整合的更多信息,請參閱 添加DevOps Insights。

將DevOps Insights與 Terraform 集成

  1. 若要安裝 Terraform CLI 並為 Terraform 配置IBM Cloud提供程式插件,請 依照IBM Cloud上的 Terraform 入門 教學進行操作。

  2. 找到包含要新增DevOps Insights工具整合的工具鏈的資源區塊的 Terraform 檔案(例如 main.tf )。 在此文件中,新增配置以建立工具整合。

    以下範例將建立工具鏈(如果不存在),然後使用 ibm_cd_toolchain_tool_devopsinsights 資源新增DevOps Insights工具整合。

    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
    }
    

    有關 ibm_cd_toolchain_tool_devopsinsights 的更多信息,請參閱 Terraform 註冊表文檔中的參數參考詳細資訊。

  3. 初始化 Terraform CLI。

    terraform init
    
  4. 創建 Terraform 執行計劃。 此計劃總結了將DevOps Insights工具整合新增至工具鏈時必須執行的所有操作。

    terraform plan
    
  5. 套用 Terraform 執行計畫。 Terraform 採取所有必要的操作將DevOps Insights工具整合新增至工具鏈。

    terraform apply
    

有關將 Terraform 與Continuous Delivery結合使用的更多信息,請參閱 為Continuous Delivery設定 Terraform。

下一步

在新增 DevOps Insights 之後,您可以發佈其他來源中的品質資料。 這些來源包含工具鏈中的 IBM® Continuous Delivery Pipeline for IBM Cloud®、Jenkins、Travis CI 或其他管線。 若要進一步瞭解,請參閱將多個來源的資料聚集到單一工具鏈。