集成工具链到开发中心

前提条件

已获取组织管理员角色权限，权限申请方法请参见申请权限。

添加并集成工具

1. 在开发中心首页右上角选择“系统配置 > 工具链集成配置”。
2. 添加工具。
   1. 在“工具链集成”页面，单击右上角“添加工具”。
   2. 在“基础信息”页面，配置如表1所示参数。

      表1 添加工具参数说明

      参数名称	参数说明
      工具LOGO	单击系统默认图片上的“点击修改”，可选择系统预置图片作为工具LOGO，也可单击“上传LOGO”，上传本地图片作为工具LOGO，上传图片支持JPG、JPEG、PNG和BMP，最大10MB。
      工具名称	自定义工具名称，最大长度为50，禁止输入';|$<>#=+%字符，且不能与已有的工具名称重复。
      工具编码（可选）	输入工具编码，工具编码是工具在系统内的唯一标识，不支持重复。以字母开头，支持数字、字母、下划线（_），支持3~64个字符。
      工具级别	支持系统级、服务级、版本级。不同级别，对应的页面集成、接口集成不同。
      工具类型	选择工具类型，可多选。 当“工具级别”为“系统级”或“服务级”时，支持代码仓、流水线、需求、缺陷、测试、其他。 当“工具级别”为“版本级”时，支持代码仓、流水线、代码检查、需求、缺陷、测试、发布通知、其他。
      工具描述	输入工具描述，最大长度256。

   3. 单击“确定”。
   4. 在“工具类型确认”页面确认工具类型，单击“确认”，工具链添加后不可修改工具链类型。

      添加的工具会以“草稿”状态显示在“全部”页签及所选的工具类型页签下。

3. 配置工具集成。

   在“工具链集成”页面，单击已添加的工具，进入工具集成配置页面，默认显示工具的“基础信息”页签，可以切换页签配置工具集成。

   • （可选）认证集成：通过认证集成界面，可更改工具所在应用的认证集成参数，认证集成信息主要用于工具免登录鉴权使用。
     1. 当需要对工具进行免登录时，可以开启认证集成开关。
     2. 选择认证集成方式：OAuth2、OIDC、SAML、CAS。
     3. 根据选择的认证集成方式不同，需要配置不同的参数，参数说明如表2所示。配置完成后，单击“保存”。

        保存后会生成client_id和client_secret，可以用于获取用户访问Token，其中client_secret可单击复制一次，复制后请妥善保管，再次复制须重置后操作。

        表2 认证集成配置参数说明

        认证集成方式	参数名称	参数说明
        OAuth2	回调URL	填写认证回调接口，支持IPV4配置或域名配置，域名地址限制https、http开头，例如https://example.com。
        	Refresh Token有效期	允许用户在多久时间内不用重新登录应用的时间。 单位秒，默认为2小时，最长180天。
        	Access Token有效期	允许用户在多久时间内保持登录应用的时间。 单位秒，默认为2小时，最长24小时。
        OIDC	回调URL	填写认证回调接口，支持IPV4配置或域名配置，域名地址限制https、http开头，例如https://example.com。
        	管理员登录URL（可选）	管理员登录应用的URL地址。
        	退出地址（可选）	统一退出接口被调用时将访问此URL退出应用。
        	授权码模式	选择是否开启授权码模式，默认不开启。
        	TOKEN签名算法	支持选择：RS256、RS384、RS512。
        	Refresh Token有效期	允许用户在多久时间内不用重新登录应用的时间。 单位秒，默认为2小时，最长180天。
        	Access Token有效期	允许用户在多久时间内保持登录应用的时间。 单位秒，默认为2小时，最长24小时。
        SAML	SP Entity ID	SP唯一标识，对应SP元数据文件中的“Entity ID”的值。
        	断言消费地址（ACS URL）	SP回调地址（断言消费服务地址），对应SP元数据文件中“AssertionConsumerService”的值，即当认证成功后响应返回的值。
        	Name ID	用户在应用系统中的账号名对应字段，支持选择：邮箱、手机号、用户名、用户id、账号id。
        	NameID Format（可选）	SP支持的用户名称标识格式。对应SP元数据文件中“NameIDFormat”的值。支持选择： urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress urn:oasis:names:tc:SAML:2.0:nameid-format:transient urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
        	Audience URI（可选）	允许使用SAML断言的资源，默认和SP Entity ID相同。
        	Single Logout URL（可选）	服务提供商提供会话注销功能，用户在OrgID注销会话后返回绑定的地址。对应SP元数据文件中“SingleLogoutService” 的值。“SingleLogoutService” 需要支持HTTP Redirect或HTTP POST方式。
        	默认Relay State（可选）	使用在IdP发起的认证中，作为默认的一个值。
        	支持ForceAuth（可选）	如果SP要求重新认证，则强制用户再次认证。
        	Response签名（可选）	是否对SAML Response使用IdP的证书签名。
        	断言签名（可选）	断言需使用IdP的证书签名，对应SP元数据文件中“WantAssertionsSigned”值。
        	数字签名算法（可选）	对Response签名或断言签名的签名算法。支持RSA_SHA256、RSA_SHA512、RSA_RIPEMD160，可在下拉框选择。
        	数字摘要算法（可选）	对Response签名或断言签名的摘要算法。支持SHA256、SHA512、RIPEMD160，可在下拉框选择。
        	验证请求签名（可选）	是否对SAML Request签名进行验证，对应SP元数据文件中“AuthnRequestsSigned”值。
        	验证签名证书	对SAML Request签名进行验证时，需要输入验证签名证书。
        CAS	回调URL	填写认证回调接口，支持IPV4配置或域名配置，域名地址限制https、http开头，例如https://example.com。
        	管理员登录URL（可选）	管理员登录应用的URL地址。
        	退出地址（可选）	统一退出接口被调用时将访问此URL退出应用。

   • （可选）同步集成：通过同步集成，可以将开发中心中的应用数据以及版本发布成功信息同步给配置的第三方系统。应用数据包括租户、产品、服务、微服务和版本信息，其中租户信息需要配置认证集成后才能同步。

     系统级工具支持同步租户信息。服务级工具支持同步租户、产品、服务、微服务信息。版本级工具支持租户、产品、服务、微服务、版本信息。

     1. 当需要同步数据给第三方系统时，可以开启同步集成开关。

        发布通知类型工具默认开启，且不能关闭。

     2. 输入签名密钥、加密密钥并选择摘要算法，参数说明如表3所示。

        表3 同步集成配置参数说明

        参数名称	参数说明
        签名密钥	用于对回调消息体内容签名。
        加密密钥	用于传输ClientSecret的加密公钥。
        摘要算法	选择加密算法，如：SHA256或SHA1。 建议使用SHA256。

     3. 选择需要同步的信息，并开启同步按钮。

        工具类型为发布通知时，“发布成功后通知”默认开启，且不能关闭，可以同步版本发布成功信息。

     4. 开启同步按钮后，需要配置对应的接口信息，配置完成后，单击“保存”。
        • 配置的接口需要参考工具链同步信息接口规格说明实现。
        • 支持IPV4配置或域名配置，域名地址限制https、http开头，例如https://example.com。
        • 同步租户信息接口需填写域名+/sync/v1/tenant部分内容。

     同步集成配置后，同步数据给第三方的日志可在“同步日志”模块查看，可以通过接口类型及同步结果进行筛选。

   • 页面集成：通过页面集成配置，可以将第三方系统的页面集成到开发中心。

     集成的页面URL的参数可以根据在管理开发中心服务元模型中添加的元模型进行配置。

     • 系统级工具

       新增页面：单击“新增页面”，在弹框中输入集成的页面名称、选择集成的页面打开方式、输入集成的页面地址，单击“确定”。

       编辑页面：在新增的页面右侧，单击。

       删除页面：在新增的页面右侧，单击。

     • 服务级工具

       代码仓、流水线、需求、缺陷、测试类型的工具发布前必须初始化，单击“页面数据初始化”，初始化页面配置，不同类型的工具初始化参数不同，具体以界面为准。初始化配置完成后，可以单击进行修改，但不支持修改页面名称。

       用户还可以自定义页面，在“自定义”页签，单击“新增页面”或“添加页面”，输入集成的页面名称、选择集成的页面打开方式、输入集成的页面地址，单击“确定”；编辑页面，在新增的页面右侧，单击；删除页面，在新增的页面右侧，单击。

     • 版本级工具

       代码仓、流水线、代码检查、需求、缺陷、测试类型的工具发布前必须初始化，单击“页面数据初始化”，初始化页面配置，不同类型的工具初始化参数不同，具体以界面为准。版本活动根据需求初始化。初始化配置完成后，可以单击进行修改，但不支持修改页面名称。

       用户还可以自定义页面，在“自定义”页签，单击“新增页面”或“添加页面”，输入集成的页面名称、选择集成的页面打开方式、输入集成的页面地址，单击“确定”；编辑页面，在新增的页面右侧，单击；删除页面，在新增的页面右侧，单击。

   • 接口集成：通过接口集成配置，可以将第三方系统的数据集成到开发中心。
     • 系统级工具：不支持接口集成。
     • 服务级工具

       代码仓、流水线、需求、缺陷类型的工具发布前必须初始化，单击“接口数据初始化”，初始化接口数据配置，不同类型的工具初始化参数不同，具体以界面为准，初始化时接口规格详见工具链同步信息接口规格说明。初始化配置完成后，可以单击进行修改，但不支持修改接口名称。

     • 版本级工具

       代码仓、流水线、代码检查、需求、缺陷类型的工具发布前必须初始化，单击“接口数据初始化”，初始化接口数据配置，不同类型的工具初始化参数不同，具体以界面为准，初始化时接口规格详见工具链同步信息接口规格说明。版本活动根据需要初始化。初始化配置完成后，可以单击进行修改，但不支持修改接口名称。

       测试、发布通知、其他类型的工具，单击“接口数据初始化”，仅支持初始化版本活动参数，初始化时接口规格详见工具链同步信息接口规格说明。初始化配置完成后，在接口右侧单击进行修改，不支持修改接口名称。

4. 发布工具。

   在“工具链集成”页面，单击工具卡片右下角的“发布”，发布该工具。

   工具发布后，可以在“系统配置 > 菜单管理”页面，添加菜单并为菜单关联该工具集成的页面，具体操作请参见管理开发中心系统菜单。可以在“系统配置 > 版本活动管理”页面，为版本活动关联该工具集成的接口，具体操作请参见管理开发中心版本活动。

更多操作

您还可以对添加的工具进行如表4所示的操作。