向工具链添加 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与应用程序接口整合起来

  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. 确定工具链的区域和 ID that you want to add the DevOps Insights tool integration to.

  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} 工具链应用程序接口端点 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
    

有关在Continuous Delivery 中使用 Terraform 的更多信息,请参阅 为Continuous Delivery设置 Terraform。

后续步骤

添加 DevOps Insights 之后,就可以发布来自其他源的质量数据。 这些源在工具链、Jenkins、Travis CI 或其他管道中包含 IBM® Continuous Delivery Pipeline for IBM Cloud®。 要了解更多信息,请参阅将来自多个源的数据聚集到一个工具链中。