集成工具链到开发中心

前提条件

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

添加并集成工具

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

      表1 添加工具参数说明

      参数名称	参数说明
      工具LOGO	单击系统默认图片上的“点击修改”，可选择系统预置图片作为工具LOGO，也可单击“上传LOGO”，上传本地图片作为工具LOGO，上传图片支持JPG或PNG，尺寸建议使用48*48px，最大2MB。
      工具名称	自定义工具名称，最大长度为50，禁止输入';|$<>#=+%字符，且不能与已有的工具名称重复。
      工具编码（可选）	输入工具编码，工具编码是工具在系统内的唯一标识，不支持重复。以字母开头，支持数字、字母、下划线（_），支持3~64个字符。
      工具类型	选择工具类型，支持选择代码检查、缺陷、流水线、发布通知、代码仓、需求、测试、版本活动和其他共9种类型，可多选。
      工具描述	输入工具描述，最大长度256。

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

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

      图1 工具类型
      

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。 须知： SHA1安全强度不高，不建议使用。

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

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

     4. 开启同步按钮后，需要配置对应的接口信息，配置完成后，单击“保存”。
        

        • 配置的接口需要参考工具链同步信息接口规格说明实现。
        • 支持IPV4配置或域名配置，域名地址限制https、http开头，例如https://example.com。
        • 同步租户信息接口需填写域名+/sync/v1/tenant部分内容。

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

   • 页面集成：通过页面集成配置，可以将第三方系统的页面集成到开发平台。
     1. 配置页面地址并选择页面集成方式，页面集成方式包括原窗口内嵌和新开窗口，如图2所示。

        发布通知及其他类型工具不显示配置页面，其余不同类型工具显示不同的配置页面。可以单击“添加页面”，添加其他需要集成的自定义页面。

        图2 页面集成
        
     2. 配置完成后单击“保存”。
   • 接口集成：通过接口集成配置，可以将第三方系统的数据集成到开发平台。
     1. 配置接口地址。
        发布通知及测试类型工具暂无接口集成配置。其余不同类型工具显示不同的配置接口。

        

        • 配置的接口需要参考工具链同步信息接口规格说明实现。
        • 支持IPV4配置或域名配置，域名地址限制https、http开头，例如https://example.com。
     2. 配置完成后单击“保存”。

4. 发布工具。

   单击工具卡片右下角的“发布”，发布该工具。

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

更多操作

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