Apusic文档中心
首页
  • 应用服务器 AAS
  • 负载均衡器 ALB
  • 分布式消息队列 ADMQ
  • 分布式缓存 AMDC
  • 分布式配置中心 ADCC
  • Java开发工具包软件 AJDK
  • 搜索引擎 ASE
  • 中间件云平台 ACP
  • 统一管理平台 AUMP
  • 云原生中间件管理 ACMP
  • DevOps平台 ADOP
  • 许可授权中心 ACLS
  • Copilot智能问答系统 ACS
  • 监控平台 AMP
  • 智能日志 AILP
  • 应用性能管理 AAPM
  • 智能告警 AAlarm
  • 主数据管理 AMDM
  • 数据交换平台 ADXP
  • 企业服务总线 AESB
  • 数据智脑 ADPR
  • 服务治理 ASGP
  • 统一身份管理 AIDM
  • 标准模板
  • Markdown教程 (opens new window)
  • VuePress官方社区 (opens new window)
  • 帮助
贡献文档 (opens new window)
首页
  • 应用服务器 AAS
  • 负载均衡器 ALB
  • 分布式消息队列 ADMQ
  • 分布式缓存 AMDC
  • 分布式配置中心 ADCC
  • Java开发工具包软件 AJDK
  • 搜索引擎 ASE
  • 中间件云平台 ACP
  • 统一管理平台 AUMP
  • 云原生中间件管理 ACMP
  • DevOps平台 ADOP
  • 许可授权中心 ACLS
  • Copilot智能问答系统 ACS
  • 监控平台 AMP
  • 智能日志 AILP
  • 应用性能管理 AAPM
  • 智能告警 AAlarm
  • 主数据管理 AMDM
  • 数据交换平台 ADXP
  • 企业服务总线 AESB
  • 数据智脑 ADPR
  • 服务治理 ASGP
  • 统一身份管理 AIDM
  • 标准模板
  • Markdown教程 (opens new window)
  • VuePress官方社区 (opens new window)
  • 帮助
贡献文档 (opens new window)
文档中心
  • 金蝶Apusic统一管理平台

  • 金蝶Apusic研发运维一体化平台

    • v1.0

      • 产品简介
      • 产品白皮书
      • 快速入门
      • 安装手册
      • 用户手册
  • 金蝶Apusic云原生中间件平台

  • 金蝶Apusic许可授权中心

  • 金蝶Apusic中间件云平台

  • 金蝶ApusicCopilot智能问答系统

用户手册

# 产品介绍

金蝶Apusic研发运营平台(Apusic DevOps Platform,简称:ADOP)是金蝶天燕云计算股份有限公司经过多年经验积累,维护实践、自主研发和技术创新,包含着软件生命周期中计划-代码编写-构建-测试-发布-部署-运行-监控的全流程管理,借助 DevOps 体系持续改进提升组织流程和工程实践的流动性、反馈效率,并建立学习型组织。逐步从传统管理模式向 IT 敏捷转变,最终达到业务敏捷的目标。

# 范围和读者

本手册介绍ADOPV1.0产品的使用详细说明,适用于ADOP产品的用户,ADOP产品技术顾问,ADOP产品维护人员,以及希望学习了解ADOP产品的相关人员。

# 约定与术语

一些约定的缩略词诠释

ADOP金蝶天燕研发运营平台(Apusic DevOps Platform)

# 平台配置管理

本章主要描述ADOP的控制设置和访问管理。ADOP的访问控制台集成了租户管理、用户管理、角色管理、菜单管理、操作日志、访问日志的功能模块,是整个ADOP平台侧的管理和控制中心。

# 租户的创建和管理

租户管理包含全部、启用、禁用过滤展示,还可通过租户名、账号、联系人搜索。在租户管理模块中可以对租户进行创建、修改、查看、启用禁用、删除、重置密码等操作。启用和禁用状态表示能够通过该租户登陆ADOP,启用状态的租户可以登陆到ADOP,禁用状态的租户则无法登陆。启动和禁用状态可以进行切换。租户列表上有删除租户,会清除租户数据,删除的租户则需要重新创建。创建租户模块中可以配置租户基本信息租户名、租户账号、联系人,创建租户管理员页面添加账号、用户名、联系邮箱、联系电话、描述,新增完成后,租户管理列表新增一条和填写数据一致的信息。

# 用户的创建和管理

用户包含有账号、用户名、状态、角色等信息。ADOP平台使用用户的账号和密码进行登陆认证。在用户管理模块中可以对用户进行创建、修改、查看、启用、禁用、删除、重置密码等操作。启用和禁用状态表示能够通过该用户登陆ADOP,启用状态的用户可以登陆到ADOP,禁用状态的用户则无法登陆。启动和禁用状态可以进行切换。用户列表上有删除用户,会清除用户数据,删除的用户则需要重新创建。

# 角色关联用户和管理

“角色”是用于权限控制功能的一个抽象概念,一个“角色”代表了一组权限的集合,不同的角色可能会包含不同的权限。ADOP平台通过给用户分配不同的角色,而角色又有不同的权限,实现用户的权限管理。总体上来说,就是用户所拥有的权限,就是用户当前的角色的权限的并集。在角色管理模块中,角色类型分为项目角色、平台角色、租户角色,角色可以关联用户用户,租户角色的用户数量是本租户所关联用户的数量,租户使用角色关联用户时,只能关联本租户下的用户。项目层角色(项目所有者、项目经理、产品、开发、测试、运维);平台层角色(超级管理员、系统管理员、安全管理员、安全审计员);租户层角色(团队所有者、团队管理员、团队成员、项目管理)。

平台层

角色 菜单 权限说明
超级管理员 平台后台管理所有菜单 拥有平台所有权限。启用三员管理后不可用用。
系统管理员(三员) 平台后台管理所有菜单 拥有除角色管理相关的所有权限
安全管理员(三员) 角色管理菜单管理权限管理 可以设置权限、菜单以及管理角色
安全审计员(三员) 用户管理角色管理操作日志访问日志 可以对用户使用情况进行审计,但不能进行任何操作

租户层

角色 菜单 权限说明
团队所有者 租户所有菜单 团队所有者不能变更,可以设置团队管理员
团队管理员 管理中心-所有权限DevOps-所有权限租户成员所有权限 有除设置团队管理员的所有权限
团队成员 DevOps-我的项目
项目管理(扩展角色,暂不实现) 管理中心-项目所有权限DevOps-所有权限租户成员所有权限

项目层

角色 菜单 权限说明
项目所有者 项目所有菜单 项目所有者默认为创建人,可以分配项目经理,所有者可转移
项目经理 项目所有菜单
产品 流水线
开发 代码仓库流水线
测试 流水线
运维

权限配置

平台管理员可以自定义配置角色权限

# 操作日志审计

ADOP平台会将登陆用户所做的重要操作进行审计日志记录。通过审计日志可以知道什么用户在什么时候做了什么操作。例如:用户A在2021.12.01日新增加了一个用户,那么这个信息将会被记录下来,用户可以通过查看日志审计得知这一条信息。ADOP平台的很多操作如用户创建删除、启用或禁用用户、用户的权限变更、监控任务变更、监控模板变更等许多的操作都会进行审计日志记录。审计日志能让平台的维护和管理更加有条理、让信息的改动变更有迹可循。

# 访问日志

ADOP平台会将登陆平台侧的用户进行审计日志记录。通过审计日志可以知道什么用户在什么时候登陆了平台。例如:用户A在2021.12.01日在一台笔记本上登陆了ADOP平台,那么这个信息将会被记录下来,用户可以通过查看日志审计得知这一条信息。审计日志能让登陆的用户有迹可循。

# 用户访问

# 用户访问入口

# 用户首页

提供公告、通知、我的工作台、我的项目的快速入口,当用户想要快速获取项目消息时,可通过首页点击对应的链接进入。

# 公告

平台管理人员可根据需要向所有用户发布公告消息,当遇到产品升级、系统升级和安全事件时,平台管理员可创建不同类别的公告发布给平台用户,首页显示5条公告,更多按钮可跳转到全部通知列表。

# 通知

用户能够接收到后台系统提示的消息,通知消息支持链接跳转,首页显示5条通知,更多按钮可跳转到全部通知列表。

# 我的工作台

用户可以看到自己最紧急的5个任务,点击标题链接可以跳转到具体的任务,点击更多按钮可跳转到工作台列表。

# 管理中心

# 业务概述

本章主要描述ADOP的控制设置和访问管理。ADOP的访问控制台集成了项目管理、用户管理、角色管理、组织设置、操作日志、公告管理的功能模块,是整个ADOP租户平台的管理和控制中心。

# 项目的创建和管理

项目管理包含我参与的、我负责的过滤展示,我参与的包含了我负责的项目。租户新增项目模块中可以添加项目标识、项目名称、描述、图标、项目负责人、联系方式,新增完成后,对应的项目负责人可以查看到新增的项目

# 集群的创建和管理

集群管理可以通过添加集群名称、集群标识、集群秘钥、面试导入ACP创建的集群、也可以通过添加集群名称、集群标识、集群IP\域名、认证方式、描述导入已经创建的Kubernetes集群,在集群管理模块可以修改ACP、Kubernetes集群信息。用户只能集群在同一个租户下不能重复,集群的启用禁用体现在用户能否进行选择,停用后不影响已有项目的使用,删除了集群并不会删除项目。

# 用户的创建和管理

用户包含有账号、用户名、状态、角色等信息。ADOP平台使用用户的账号和密码进行登陆认证。在用户管理模块中可以对用户进行创建、修改、查看、启用禁用、删除等操作。启用和禁用状态表示能够通过该用户登陆ADOP,启用状态的用户可以登陆到ADOP,禁用状态的用户则无法登陆。启动和禁用状态可以进行切换。用户列表上有删除用户,会清除用户数据,删除的用户则需要重新创建。

# 角色关联用户和管理

“角色”是用于权限控制功能的一个抽象概念,一个“角色”代表了一组权限的集合,不同的角色可能会包含不同的权限。ADOP平台通过给用户分配不同的角色,而角色又有不同的权限,实现用户的权限管理。总体上来说,就是用户所拥有的权限,就是用户当前的角色的权限的并集。在角色管理模块中,角色类型分为项目角色、平台角色、租户角色,角色可以关联用户用户,租户角色的用户数量是本租户所关联用户的数量,租户使用角色关联用户时,只能关联本租户下的用户。项目层角色(项目所有者、项目经理、产品、开发、测试、运维);平台层角色(超级管理员、系统管理员、安全管理员、安全审计员);租户层角色(团队所有者、团队管理员、团队成员、项目管理)。

平台层

角色 菜单 权限说明
超级管理员 平台后台管理所有菜单 拥有平台所有权限。启用三员管理后不可用用。
系统管理员(三员) 平台后台管理所有菜单 拥有除角色管理相关的所有权限
安全管理员(三员) 角色管理菜单管理权限管理 可以设置权限、菜单以及管理角色
安全审计员(三员) 用户管理角色管理操作日志访问日志 可以对用户使用情况进行审计,但不能进行任何操作

租户层

角色 菜单 权限说明
团队所有者 租户所有菜单 团队所有者不能变更,可以设置团队管理员
团队管理员 管理中心-所有权限DevOps-所有权限租户成员所有权限 有除设置团队管理员的所有权限
团队成员 DevOps-我的项目
项目管理(扩展角色,暂不实现) 管理中心-项目所有权限DevOps-所有权限租户成员所有权限

项目层

角色 菜单 权限说明
项目所有者 项目所有菜单 项目所有者默认为创建人,可以分配项目经理,所有者可转移
项目经理 项目所有菜单
产品 流水线
开发 代码仓库流水线
测试 流水线
运维

角色管理列表界面 关联用户

角色管理关联界面选择可选用户进入已选用户,全选人员可以选择“全部移至右边”。

关联用户界面

# 组织设置

# 安全设置

登录验证策略页面

租户管理员可以设置用户会话时间,超过设置的会话时间未操作,会退出当前账号;租户可以设置用户在设定时间,登录失败的的次数,锁定账号的时间。

密码策略页面

租户管理员可以设置密码的包含的字符种类以及密码的最小长度,以及密码的有效期

# 操作日志

ADOP平台会将登陆用户所做的重要操作进行审计日志记录。通过审计日志可以知道什么用户在什么时候做了什么操作。例如:用户A在2021.12.01日新增加了一个用户,那么这个信息将会被记录下来,用户可以通过查看日志审计得知这一条信息。ADOP平台的很多操作如用户创建删除、启用或禁用用户、用户的权限变更、监控任务变更、监控模板变更等许多的操作都会进行审计日志记录。审计日志能让平台的维护和管理更加有条理、让信息的改动变更有迹可循。

# 公告管理

公告管理模块是用来发布公告信息或及时通知的功能模块,可以帮助用户便捷高效的发布公告、查看公告、管理公告。

# 公告的创建和管理

在公告管理功能详情页中可以进行发布公告、编辑公告、删除、发布、取消发布公告的操作。公告的类型分为服务公告、安全公告、升级公告和其他公告。

# 公告栏展示

在用户登录后,可以在控制台的右侧找到公告栏,公告栏中能看到最新发布的公告信息。

# 公告栏内容

在公告栏中点击需要查看内容的公告标题,可以查看公告详细内容。

# DevOps管理

ADOP平台进入DevOps模块,DevOps 项目支持多样化灵活的分支和集成策略管理,可以针对不同业务和技术要求,选用不同的分支策略,通过定义的流水线,在指定时间发布。在一个项目中即可完成自动化构建、验证、部署等工作。从需求开始,端到端覆盖需求、开发、测试、部署四个环节,让交付过程更加高效顺畅且可视化,实现安全、稳定、可持续的全生命周期研发管理。

# 我的项目

进入我的项目模块,项目列表分类展示“我参与的””我负责的“”全部项目“”归档项目“

点击项目名称链接,进入项目内,可以在项目管理模块下对项目进行管理、代码仓库模块下新增和修改代码仓库、流水线模块下对流水线的编排、项目设置模块下对项目信息和成员设置等功能

# 项目设置

# 修改项目信息

项目标识:在新建项目时编写,填写后不可在项目设置中修改

项目名称:项目名称可以在项目设置中修改,修改后项目列表中显示为修改后的项目名称

图标:图标可修改,修改后的图标在管理中心-项目管理;DevOps-我的项目列表中展示

项目负责人:项目负责人修改后,DevOps-我的项目列表中显示的内容和修改的一致

联系方式:联系方式可以修改

状态:默认启用

归档:项目完成后,可以归档项目

反归档:归档后的项目会在DevOps-我的项目-归档项目中展示

删除:删除项目后不会在列表中展示

# 添加成员

点击成员管理菜单,进入项目成员列表;点击左上方的“添加成员”按钮,选择成员以及成员角色;点击“确定”后,项目成员成功添加在项目成员列表中

# 项目管理

# 项目概览

项目概览可以查看最近7天、最近14天、最近30天、最近90天的工作项、缺陷、缺陷趋势

# 项目协同

创建需求

新建项目后,进入项目管理-项目协同,创建需求,填写必要的信息后保存

(1)处理人:在项目设置中添加成员,添加成员后可以下拉选择处理人,指定为处理人之后,处理人会接收到工作通知,优先级高的任务会在处理人的首页-我的工作台显示

修改和删除需求

在项目协同列表点击项目标题链接,进入需求,可通过修改需求状态设定来完成需求;也可以删除需求。

新增任务

新建项目后,进入项目管理-项目协同,创建任务,填写必要的信息后保存

处理人:在项目设置中添加成员,添加成员后可以下拉选择处理人,指定为处理人之后,处理人会接收到工作通知,优先级高的任务会在处理人的首页-我的工作台显示

修改和删除需求

在项目协同列表点击项目标题链接,进入需求,可通过修改需求状态设定来完成需求;也可以删除需求。

新增缺陷

新建项目后,进入项目管理-项目协同,新建缺陷,填写必要的信息后保存

处理人:在项目设置中添加成员,添加成员后可以下拉选择处理人,指定为处理人之后,处理人会接收到工作通知,优先级高的任务会在处理人的首页-我的工作台显示

严重程度:缺陷可以选择严重程度阻断、严重、一般、轻微、建议

修改和删除缺陷

在项目协同列表点击项目标题链接,进入缺陷,可通过修改缺陷状态设定来完成缺陷;也可以删除缺陷。

# 代码仓库

点击代码仓库模板,展示代码仓库列表,用户可以新增、修改、删除代码仓库

# 新增仓库

填写新增仓库的必填项:仓库名称、仓库地址、用户名、密码,选择正确的认证方式,输入完成后,点击“测试”按钮,可以验证仓库地址、用户名、密码的正确性,测试不通过会有友好的提示,只有测试通过才能点击“确认”按钮,新增完成后的仓库会在代码仓库列表中展示。

# 修改仓库

选择一条在代码仓库列表中的数据,点击左上方的“修改仓库”按钮,修改仓库后,点击“测试”按钮,可以验证仓库地址、用户名、密码的正确性,测试不通过会有友好的提示,只有测试通过才能点击“确认”按钮,修改完成后,代码仓库列表显示的是修改后的信息。

# 删除代码仓库

选择一条仓库数据,点击列表右端的“删除”按钮,中断提示“确定删除选择项?”

# 流水线

# 创建流水线

# 新建流水线

点击流水线列表左上角的“新建流水线”按钮,开始创建流水线

# 选择流水线模版

新建流水线时,选择对应的开发语言,可以查看当前语言下的默认流水线模版。

# 完成新建

完成创建后,默认进入到流水线的编排界面,可以继续流水线的输入源和流程编排。用户可以修改流水线的基本信息、流程配置、触发配置、变量与缓存等配置,实现对流水线行为的调整。

# 配置流水线

# 基本信息

用户可在基本信息页签中,修改流水线名称

# 流程配置

通过流程配置页签,你可以定义持续交付的自动化流程,将构建,部署,测试,管控等组件化能力进行编排和串通,完成从开发到上线过程的自动化流程。

Flow 流水线提供了以下编排能力:

  • 阶段:在流水线中需要按顺序执行的一组任务的集合,一个阶段可以是手动运行也可以是自动运行的。阶段之间串行执行;
  • 任务:在阶段中具体需要完成的动作,任务之间可以串行执行也可以并行执行,目前任务包含:代码扫描,单元测试,构建, 部署,合并代码,人工审核等功能。
  • 步骤:步骤作为流水线最底层的核心能力,所有的流水线都是通过步骤的编排组合而成的。
# 配置流水线代码源

流水线源,作为流水线的输入源头,可以从文件托管服务或者其他第三方服务中获取原料,并将这些原料放入到工作区。

流水线会对输入获取并放入工作区的原料进行处理,处理的目的可能是执行的内容可能是编译打包、执行自动化任务、版本制作。

流水线处理输出的结果可能包括软件的测试报告、压缩文件、目录、文档等等。

在流水线的编辑页面, 点击「添加流水线源」按钮,可以为流水线添加输入代码源,如下所示:

代码源可以是项目代码源,也可以是自定义代码源,注意选择后不能修改,如需修改,删除后再选择想要的代码源方式

选择项目代码源,在代码库中选中需要的代码仓库

选择自定义代码源,可以通过代码仓地址、账号、密码连接到代码源

# 增加阶段

在流水线编排页面,点击“+”可以添加阶段,点击后,会生成一个新的阶段,并默认生成当前阶段中的一个流水线任务,通过选择任务模版,可以快速创建当前阶段中的流水线任务。

任务新建后,点击任务卡片,可以通过任务抽屉进行任务配置。

# 在阶段中添加任务

增加并行任务

在流水线编排页面,移动到一个阶段,会出现“+并行任务”,移动并点击后,可以选择任务模版,完成创建。

并行任务图片

添加串行任务

在流水线编排页面,hover 到一个任务,会出现“+”,既可以在该任务的前后添加串行任务,可以选择任务模版,完成创建。

串行任务图片

# 触发配置
# 变量与缓存
# 字符变量

进入流水线编辑页面,可以通过定义环境变量实现流水线过程定制化,可以在执行过程的任何阶段使用这些变量

私密模式用于保护私一些含有私密信息的配置项,私密模式下的参数值会加密显示,在执行日志中也不会显示

选择运行时设置,可以在流水线运行时进行参数动态配置

# 运行选择变量

运行选择变量新建变量只需输入参数、选项,每一个变量都有一个默认值

当手动运行流水线时,流程运行配置会弹出设置的变量和值,运行选择变量会显示默认值,可下拉选择其他值

# 手工触发流水线执行

手工触发,用户可在流水线点击运行来进行手动执行,也可以在编辑页面点击“保存并运行”进行手动执行。

# 查看流水线最近运行

访问流水线列表,会在列表中展示当前流水线的【最近一次运行结果】的状态和运行缩略图。

点击某条流水线,会展示当前流水线最近一次的运行结果,包括以下内容:

  • 当前流水线的触发信息上下文,包括:当前流水线运行状态,运行人,开始时间,运行时间,流水线执行锁对应的代码信息等
  • 当前流水线的具体执行阶段,任务和对应的操作

# 流水线插件

在流水线中,用户可以通过配置任务插件的方式,增强流水线的能力,完成各种期望的流水线操作。

# 安全扫描

# Java代码扫描

提供对java代码的质量问题的扫描能力

  • jdk版本:编译和扫描时使用的jdk版本
  • maven版本:编译和扫描时使用的maven版本
  • 红线信息:当任何一个红线配置能不被满足时,构建任务将失败
# Java漏洞扫描

提供对java代码的安全漏洞扫描能力

  • jdk版本:编译和扫描时使用的jdk版本
  • maven版本:编译和扫描时使用的maven版本
  • 扫描前执行命令:扫描前执行的编译指令,在可以在这里重新maven setting文件的位置
  • 红线信息:当任何一个红线配置能不被满足时,构建任务将失败
# Golang代码扫描

  • go版本:编译和扫描时使用的go版本
  • go扫描器版本:编译和扫描时使用的go扫描器版本
  • 是否增量扫描:当满足任何一个红线配置时,构建任务将失败
  • 排除子目录: 去除不需要扫描的目录
  • 扫描前执行命令:设置go依赖仓库地址
  • 红线信息:当任何一个红线配置能不被满足时,构建任务将失败
# Golang漏洞扫描

  • go版本:编译和扫描时使用的go版本
  • 扫描前执行命令:设置go依赖仓库地址
  • 红线信息:当任何一个红线配置能不被满足时,构建任务将失败

# 构建

# Java构建

  • jdk版本:编译和扫描时使用的jdk版本
  • maven版本:编译和扫描时使用的maven版本
  • 命令:执行构建时使用的maven命令,在这里可以重新指定maven setting文件的位置
# Golang构建

  • go版本:编译时使用的go版本
  • 扫描前执行命令:设置go依赖仓库地址
# Node构建

  • Node版本:编译时使用的Node.js版本
  • 执行命令:编译时使用的构建命令
# 镜像构建并推送至镜像仓库

根据Dockerfile构建镜像,并推送至平台制品库或外部仓库

推送至平台制品库

  • 镜像仓库:选择平台制品库中类型为Docker的仓库
  • 镜像:填写镜像名称与版本
  • Dockerfile:填写源代码中的Dockerfile路径
  • 参数配置:Docker构建构建时的构建参数
  • 制品属性:推送到制品库时,附加的制品属性信息

推送至外部仓库

  • 仓库地址:外部仓库的链接地址
  • 用户名:填写外部仓库的访问用户名
  • 密码:填写外部仓库的访问密码
  • 镜像:填写镜像名称与版本
  • Dockerfile:填写源代码中的Dockerfile路径
  • 参数配置:Docker构建构建时的构建参数
  • 制品属性:推送到制品库时,附加的制品属性信息

# 测试

# Maven单元测试

  • jdk版本:编译和扫描时使用的jdk版本
  • maven版本:编译和扫描时使用的maven版本
  • 命令:单元测试所执行的命令
  • 测试报告路径:用于提取测试报告
  • 测试报告文件:用于提取测试报告
  • 红线信息:当任何一个红线配置能不被满足时,构建任务将失败
# Golang单元测试

  • go版本:执行单元测试的golang版本
  • 命令:单元测试所执行的命令
  • 测试报告路径:用于提取测试报告
  • 测试报告文件:用于提取测试报告
  • 测试报告html:用于提取测试报告
  • 红线信息:当任何一个红线配置能不被满足时,构建任务将失败

# 上传

# 构建物上传

# 执行

# 执行命令

  • 命令:需要执行的shell命令
  • 环境变量:在执行命令前被注入到环境中的环境变量

# 发布

# K8S部署

插件提供了通用的 Kubernetes 部署能力支持,通过内置的 Kubectl 工具将 Kubernetes YAML资源描述文件部署到任意集群中。在原生 Kubectl 的能力基础上, 流水线还内置了动态模板的能力,从而帮助用户可以快速实现容器应用的构建与发布。

(1)k8s集群类型:下拉选择自定义集群或者容器服务集群

(2)k8s集群名称:填写集群名称

(3)k8s集群配置:填写 Kubernetes 集群证书文件

(4)命名空间:命名空间不能一样

在流水线运行页面,点击任务的日志按钮即可查看 Kubernetes的 部署日志内容:

日志输出,如下所示,日志中会包含当前所有扫描到的 YAML 文件,kubectl apply后的标准输出,以及当前变更执行后的所有资源概要信息。

如果部署失败,可以查看 Kubernetes 部署日志了解以及排查定位问题

# Helm部署

插件提供了对于 Helm 的发布支持,用户可以将代码库中的 Chart 部署到 Kubernetes 集群。

(1)集群名称:输入连接的集群名称

(2)集群连接:填写 Kubernetes 集群证书文件

(3)helm版本:选择helm版本

(4)命名空间:命名空间不能一样

(5)本地chart路径:设置 Helm chart 在代码库中的相对路径

(6)release名称:输入release名称

(7)变量:用户可以在任务配置中添加变量。在发布时会默认覆盖 values.yaml 中定义的内容

查看日志,如果运行失败可以快速地定位问题

# 制品库

# 制品仓库概览

用户可以在制品仓库中长期存储生成的制品文件,用于后续业务或者进行追溯。 制品支持版本管理,用户可以查看制品的不同版本,也可以删除无用的版本。制品支持属性管理,用户可以为制品备注属性,便于查看。 制品库当前提供了Generic通用制品库和Docker镜像库两种类型。

用户可通过创建新仓库创建不同类型的仓库,创建的仓库会出现在左侧列表中。用户可以通过设置仓库,调整某个已创建仓库的配置。

# 管理Generic仓库

Generic通用制品库可以存储任意类型的制品文件,用户可以通过脚本推送或者页面上传的方式上传制品。

# 创建仓库

  • 仓库类型:选择所要创建的仓库类型,同类型的仓库可以创建多个
  • 名称:仓库的名称,名称会作为访问制品路径的一部分,所以必须为小写且不允许特殊字符。
  • 描述:仓库的描述信息
  • 使用范围:仓库中制品的可见范围。(公开:所有人可见,团队:当前租户用户可见,项目:当前项目用户可见)
# 基本信息

用户进入仓库设置后,可以修改仓库的基本信息。

  • 删除仓库:仓库可以被项目管理员删除,删除仓库后,仓库空间将被释放,所有制品都将丢失。
# 代理配置

通用制品库不支持代理设置

# 版本策略

制品被发布到制品库后,可能会被第三方使用,如果制品文件被变更,可能导致混乱。 通过版本测试,可以制品上传后,是否可以被重新上传覆盖。

  • 允许覆盖版本:版本上传后,可以重新上传该版本的文件
  • 禁止覆盖版本:版本上传后,只能上传新版本,已有版本不允许覆盖。
# 清理策略

当制品或制品版本过多时,需要对无用的版本进行清理。制品库会根据规则定期清理无用的版本,以释放空间。

  • 单个制品版本保留X个:针对与每个制品的最大保留版本数,超过此数量的版本将被删除
  • 保留被标记为"已发布"的制品: 如果制品的版本已被标记为已发布,则该版本不会被清理。
  • 开启自动清理与每日触发清理时间:开启自动清理后,每天会按照触发清理时间,对该仓库的所有制品版本进行清理。
  • 立即手工清理:立即对仓库中的制品进行清理,如制品库制品与制品版本较多时,该过程的制品时间可能会较长,将影响到制品库的使用,请谨慎操作。
# 制品上传

用户点击上传制品按钮后,可以在页面手工上传制品。支持制品的批量上传和打包上传。
制品文件上传时,可以修改文件名。

  • 版本号:上传的制品的版本号
  • 每个文件生成一个制品:将每个上传文件生成一个制品,每个文件都有单独的版本管理
  • 每所有文件打包成一个制品:将上传文件打包成一个文件,统一进行版本管理
# 管理制品版本

制品上传后,可以在对应制品库的制品列表中看到对应制品,用户可以查阅版本数、最近版本和最新版本的上传时间。 用户可以删除当前版本,此时次新版本将成为最新版本,版本数量也会减少。当一个制品的所有版本都被删除后,该制品也会被删除。

用户可以在制品查看页面,进行版本切换。通过切换按钮切换到对应版本进行查看。切换后制品的最新版本并不会变化。

# 查看制品与制品属性

用户可以查看上传制品的属性,文件列表并进行制品下载也可以查看和编辑版本属性。

# 管理Docker仓库

Dcoker镜像制品库可以存储Docker镜像类型的制品文件,用户可以通过流水线推送功能将制品推送到Docker制品库中。

# 创建仓库

  • 仓库类型:选择所要创建的仓库类型,同类型的仓库可以创建多个
  • 名称:仓库的名称,名称会作为访问制品路径的一部分,所以必须为小写且不允许特殊字符。
  • 描述:仓库的描述信息
  • 使用范围:仓库中制品的可见范围。(公开:所有人可见,团队:当前租户用户可见,项目:当前项目用户可见)
# 基本信息

  • 删除仓库:仓库可以被项目管理员删除,删除仓库后,仓库空间将被释放,所有制品都将丢失。
# 代理配置

用户可以为私有仓库配置代理源,以便拉去其它仓库的镜像

  • 名称:代理的镜像仓库的名称
  • 地址:代理的镜像仓库的地址
  • 用户名:代理的镜像仓库的访问用户名
  • 密码:代理的镜像仓库的访问用户密码
  • 代理类型:代理的镜像仓库类型(公开源:可以公开使用的源,私有源:第三方搭建需要鉴权的源)
# 版本策略

制品被发布到制品库后,可能会被第三方使用,如果制品文件被变更,可能导致混乱。 通过版本测试,可以制品上传后,是否可以被重新上传覆盖。

  • 允许覆盖版本:版本上传后,可以重新上传该版本的文件
  • 禁止覆盖版本:版本上传后,只能上传新版本,已有版本不允许覆盖。
# 清理策略

当制品或制品版本过多时,需要对无用的版本进行清理。制品库会根据规则定期清理无用的版本,以释放空间。

  • 单个制品版本保留X个:针对与每个制品的最大保留版本数,超过此数量的版本将被删除
  • 保留被标记为"已发布"的制品: 如果制品的版本已被标记为已发布,则该版本不会被清理。
  • 开启自动清理与每日触发清理时间:开启自动清理后,每天会按照触发清理时间,对该仓库的所有制品版本进行清理。
  • 立即手工清理:立即对仓库中的制品进行清理,如制品库制品与制品版本较多时,该过程的制品时间可能会较长,将影响到制品库的使用,请谨慎操作。
# 制品上传

docker制品库不提供web页面上传的功能。用户可通过流水线推送镜像功能或者docker push命令推送镜像到制品库。

# 管理制品版本

制品上传后,可以在对应制品库的制品列表中看到对应制品,用户可以查阅版本数、最近版本和最新版本的上传时间。 用户可以删除当前版本,此时次新版本将成为最新版本,版本数量也会减少。当一个制品的所有版本都被删除后,该制品也会被删除。

用户可以在制品查看页面,进行版本切换。通过切换按钮切换到对应版本进行查看。切换后制品的最新版本并不会变化。

# 查看与维护制品版本属性

用户可以查看上传制品的属性,也可以查看和编辑版本属性。

# 流水线模板

# 流水线模版

进入流水线模板菜单,点击右上角的“新增模板”,开始新建流水线模板

模板无需配置代码源,将构建,部署,测试,管控等组件化能力进行编排和串通,配置完成从开发到上线过程的自动化流程,可供流水线选择模板,创建新的流水线。

新阶段:一组任务可以组合成一个阶段,阶段之间新建多个任务,任务可以船型,也可并行

任务:任务在阶段中添加,每个阶段最少有一个任务,目前包含的任务有:代码扫描,单元测试,构建, 部署,合并代码,人工审核等功能。

步骤:所以的任务都是通过步骤编排组合而成

配置完成后,修改任务的名称以及模板的名称,保存模板后,会在模板列表显示添加的模板

# 任务模版

与流水线线模版类似,用户也可以自定义任务,进行更小粒度的自定义配置。

# 步骤模版

# 环境管理

环境管理提供完整的业务环境管理功能,每个业务环境下可以包含多个多个完整的业务应用。 用户可以通过环境将同类业务应用放在一个一个空间内进行统一管理。使业务与业务系统一一对应,使业务运维变得更加贴近业务和简单。

# 新增环境

用户可以在环境列表中,点击新建环境创建一个业务环境,用于管理某个特定业务。

  • 环境标识:环境的唯一标识,系统内唯一
  • 环境名称:环境的中文描述
  • 集群类型:环境连接的资源类型
  • 集群:具体的资源
  • namespace:环境中的工作空间名称。但不存在用户所期望的空间时,用户可以通过新建按钮创建自己的空间
  • 描述:环境的描述信息
  • 负责人:当前环境的负责人
  • 联系方式:当前环境负责人的联系方式

# 环境概览

# 应用

应用是环境的组成单元,例如在一个大型业务系统中,分为业务系统和数据分析系统,用户可以分别创建两个应用来部署这两个应用。

应用的运行与配置彼此独立,但运行状态与资源情况会被环境统一收集与监控。

# 新建应用

用户可以通过新建应用按钮来创建一个新的应用

  • 应用标识:应用的唯一标识。环境下唯一。
  • 应用名称:应用的中文简称
  • 应用描述:应用的中文描述
  • 图标:用户可以为每个应用分配一个图标,便于用户快速识别应用。

# 应用概览

应用概览提供应用的操作菜单与应用状态信息。用户可以通过应用概览快速了解应用当前的配置情况、运行情况,消耗资源情况。

# 应用编排

应用编排提供了应用组件的依赖关系配置, 应用提供了组件的列表查看模式与拓扑查看模式。 使用户可以快速了解系统组件的依赖情况,并能够快速的找到所需要查阅的组件。

# 应用组件

应用组件是系统的最小单位,应用组件可以是一个数据库,一个springboot应用。在平台中,组件被当做一个可复用的业务单元来使用。
用户可以将系统模版,或其它人配置好的组件引入到自己的应用中,减少了重复配置的繁琐工作。
业务组件包含多个种类,以便用户在不同情况下,根据需要快速生成自己所需的业务配置组件。

# 应用组件新增

应用组件支持多种新增方式,包括直接新增,也可以从仓库或其它应用导入

# 应用组件接入

应用组件接入提供了组件的依赖关系配置与展示。通过配置依赖关系,组件可以使用其它组件的变量。并形成部署组件的部署依赖关系,自动的按照合适的依赖顺序进行部署。

# 应用组件配置-变量

应用组件配置-变量提供应用组件的变量列表。
用户可以通过配置变量,将自身的配置传递给其它组件,也可以将变量配置传入运行环境变量以及替换配置文件中的变量参数。
使用户通过简单的变量修改,即可完成组件行为的调整和变更。

# 应用组件端口

应用组件端口配置提供了组件对外服务的配置,通过端口配置,可以将组件的端口开放到系统外部,供外部用户访问。 端口可以简单的配置开启和关闭,使系统更易控制和管理。

# 预处理

应用会根据组件的依赖关系,自动生成部署顺序,避免了因启动顺序不一致,导致系统不可用或者出错的问题。 用户可在流程中增加自己的自定义行为,如部署成功通知等

# 应用网关

应用网关可以汇总所有组件的端口配置,方便应用管理人员进行接口管理。

管理用户也可以直接进行端口暴露的配置和修改

# 应用备份

应用配置时,可以对应用配置进行备份、导出与导入。
通过该功能,应用配置可以进行离线的迁移和重新部署。

# 应用发布

配置好的应用,可以发布到应用仓库中。供团队和组织复用,通过应用发布能够大大降低环境迁移,配置复用的难度。提升工作效率。

# 网关

环境网关会采集环境下所有应用、组件暴露出的服务端口,方便业务管理员快速了解环境的服务配置信息。

# 设置

环境本身的配置信息,用户可在环境配置中,设置环境的成员与权限。

# 环境信息

环境本身的配置信息,用户可修改环境的名称或删除环境。
删除环境后下的所有配置信息将丢失,请谨慎操作。

# 成员管理

用户可为环境配置成员与角色,方便对环境进行分权限管理。

编辑页面 (opens new window)

← 安装手册 产品动态→

  • 浅色模式