HAP Cloud功能手册

HAP Cloud功能分四个层：全局层、组织层、项目层、用户层

I 全局层

选中顶部导航栏的【管理】选项，即可进入全局层

全局层

一、 用户服务

1. 服务

• 所有服务的列表
• 可根据搜索条件查询服务

服务

1.1 搜索服务

• 不选择属性，根据输入值全局搜索
• 选择一个属性：ID、服务编码、服务名称、描述，输入相应属性值进行模糊搜索

2.权限

• 所有权限的列表
• 可根据搜索条件查询权限
• 根据角色层级（全局层/组织层/项目层）、服务、类型；或根据输入值进行搜索

权限

2.1 搜索权限

• 先选择角色层级：全局层/组织层/项目层，进行层级过滤
• 然后根据输入值进行搜索；或通过选择服务/类型进行权限过滤

3.角色

• 权限的集合
• 可创建、根据所选角色创建、删除、编辑、停用/启用、查看详情、根据搜索条件查询角色

角色

3.1 创建角色

必填项：

• 角色名：角色创建成功并启用后，可在角色分配（与角色权限相对应的层级）的自定义角色中，根据角色名选择

• 角色编码：

  • 具有唯一性
  • 用于与Git Lab角色关联

• 权限：全局层与组织层/项目层不可共存，组织层与项目层权限可共存。选择权限时，如果对于功能所需的权限不清楚，可以使用导航栏右上角的调试功能来查看

image.png

选填项：

• 角色标签：实现不同系统之间角色的映射

  • 角色标签选项是针对GItLab或其他平台的角色灵活变更
  • 角色标签的选项不是固定的，可根据对应的其他平台进行设置，角色标签代表的是与其他平台角色关联关系

• 是否可编辑：目前不可选，所有新建的角色都默认勾选可编辑

• 是否启用：勾选后，角色可以被应用到角色分配中

创建角色

3.2 根据所选角色创建

• 操作：勾选要被继承的角色后，选中【根据所选角色创建】
• 结果：新建的角色将继承被选角色的权限

3.3 其他操作

• 删除：如果为内置角色，不可删除；不为内置角色，可删除
• 详情：可查看创建角色时的信息
• 编辑：如果是从后台数据库导入的角色，则不可编辑；前端创建的角色默认都可编辑
• 启用/停用：停用角色后，角色信息依然存在，但在分配角色时无该角色选项

4.菜单配置

• 侧边栏/菜单栏
• 可创建、配置菜单栏

菜单配置

4.1 菜单配置

1. 层级选择

   • 通过选择层级，来查看、配置不同层级（全局层/组织层/项目层）的菜单栏

2. 勾选要添加到菜单栏的目录/菜单

3. 点击[将所选菜单项添加至菜单结构]

4. 在菜单展示页将出现刚刚添加的目录/菜单，可拖动进行位置顺序调节

菜单配置流程

4.2 添加目录

必填项：

• 目录中文名称
• 目录英文名称
• 目录编码

选填项：

• 目录ICON（目录图标）

  1. 在搜索栏，输入图标名称进行搜索
  2. 鼠标悬停在图标上，显示图标全称
  3. 在添加栏，输入图标全称
  4. 点击添加按钮
  5. 弹出弹窗，点击确认

添加目录图标流程

后继操作：

• 创建目录成功后，该目录在菜单配置页和菜单展示页底部
• 长按鼠标右键，可对该目录进行位置拖动
• 注：只有目录下有菜单时，该目录才在菜单栏显示；否则该目录在菜单栏不显示

添加目录后

4.3 其他操作

• 删除：目录可删除，菜单不可删除
• 详情：在菜单配置页可查看菜单详情（目录不可）
• 编辑：在菜单展示页可编辑目录（菜单不可）

其他操作

5.角色分配（全局层）

• 管理成员（类型：用户/服务）角色
• 可对成员分配、删除、更改、查看（按成员/角色）角色
• 所有用户创建后，在全局层都被赋予【用户服务平台使用者】这个角色

5.1 角色分配（全局层）可选角色

• 用户服务

  • 用户服务平台管理员：菜单管理、角色管理、用户管理（初始化导入）、角色分配（组织层）及除服务发布之外所有功能
  • 用户服务平台使用者：只能进入平台，无其他任何功能权限

• 用户管理

  • 用户管理服务平台管理员

• 系统

  • 框架服务平台使用者

• 微服务管理服务

  • 微服务管理服务管理员

• 自定义角色

  • 如：项目查看者

5.2 分配、更改角色

• 分配角色：

• （1）点击【添加】

分配角色

• （2）输入成员（用户：用户名），选择角色

分配角色

• 更改角色分配：
• 点击角色名，出现下图列表即可继续角色更改

更改角色

• 注意：

  • 对已存在在角色分配列表里的成员，若进行【添加】操作会报错（因为【添加】操作是对没有被分配过角色的成员进行的），而应在更新操作中进行角色的更改

已被分配角色的成员无法进行添加操作

已被分配角色的成员只能进行更改操作

5.3 其他操作

• 删除角色分配：可删除角色分配列表中的数据

删除角色分配

• 查看角色分配：可按成员/角色方式查看

角色分配查看方式

• 搜索角色分配：可根据搜索条件查找角色分配列表的数据项
  • 不选择属性，根据输入值进行全局搜素
  • 选择一个属性：类型（用户/服务）、成员、昵称，输入相应属性值进行模糊搜索

II 组织层

• 选中顶部导航栏的【组织/项目】选项

导航栏-组织层

• 弹出组织/项目列表的弹窗
  • 在下拉菜单中选择一个组织，组织/项目列表则变为被选组织与该组织下的所有项目
  • 鼠标右键双击组织/项目列表的第一项-组织项，则进入该组织

组织/项目菜单-组织

一、用户服务

1.用户

• 管理平台用户
• 可创建、删除、查看详情、编辑、搜索、启用/禁用、解锁、管理是否为LDAP用户

1.1 创建用户

必填项：

• 用户名：

  • 具有唯一性
  • 可用于登陆，角色分配

• 昵称：

  • 用户的别名
  • 例如，‘张三’在公司的工号为‘01’，可将这个用户的用户名设为‘01’，因为具有唯一性，用于登陆，这个用户的昵称则可设为‘张三’，便于识别

• 组织名称：

  • 用户所在的组织
  • 当前默认所有用户都属于运营组织

• 密码、确认密码：

  • 用户登陆系统所需的密码
  • 两次密码输入要一致
  • 密码的设置要符合密码策略
  • 当用户是LDAP用户时，前端设置的密码无效

• 邮箱：

  • 具有唯一性
  • 用户要填写真实有效的邮箱
  • 邮箱可用于登陆、找回密码

选填项：

• 语言:默认为English
• 是否启用：未启用用户时，用户为未激活状态，不可登陆系统
• 是否为LDAP用户（使用公司统一认证登陆密码进行登陆）：为LDAP用户时，密码为公司系统中存储的密码，在页面前端填入的密码无效；用户本人修改密码时，只能通过公司系统修改，在平台前端修改无效，且不能在平台使用忘记密码功能

创建用户

1.2 其他操作

• 详情：查看用户创建时所填信息

• 编辑：更改用户信息，信息更改无误后，点击’保存’生效

• 删除：删除用户数据

• 搜索：

  • 不选择属性，根据输入值进行全局搜索
  • 选择一个属性：用户名、昵称、认证来源（LDAP用户/非LDAP用户）、语言、是否启用（启用/未启用）、是否锁住（锁住/未锁住），输入相应的属性值进行搜索

• 启用/停用：

  • 启用时，用户状态为启用，可登陆平台进行权限内的操作
  • 停用时，用户状态为未启用，用户变为未激活状态，无法登陆系统

• 解锁：

  • 当用户多次输错密码被锁住无法登陆时，则出现解锁选项
  • 解锁后该用户则可登陆平台进行操作

2.项目

• 管理项目列表
• 可创建、编辑、搜索、启用/停用项目

2.1 创建项目

必填项：

• 项目编码：

  • 具有唯一性
  • 不能包含大写字母、中文、特殊字符

• 项目名称：

  • 具有唯一性
  • 项目名称长度限定为4-30字符

创建项目

2.2 其他操作

• 编辑：项目代码一旦创建,不可编辑，只可编辑项目名称

• 搜索：

  • 不选择属性，根据输入值进行全局搜索
  • 选择一个属性：项目ID（创建后自动生成）、项目编码、项目名称，输入相应的属性值进行搜索

• 启用/停用：项目停用后，项目信息仍在项目列表中，但是不可应用该项目或进入该项目进行操作

注：项目一旦创建，不可删除

3.用户组

• 将用户分组统一进行管理
• 可创建、删除、编辑、搜索用户组，可在用户组内添加、删除用户

3.1 创建用户组

• 必填项：

• 用户组编码

  • 具有唯一性

• 用户组名：填写用户组的名称

• 用户组描述：附加的对用户组的描述信息

创建用户组

3.2 其他操作

• 删除：删除会删除用户组信息及与用户组关联的数据

• 编辑：不可编辑用户组编码，可编辑用户组名、用户组描述

• 搜索：

  • 不选择属性，根据输入值进行全局搜索
  • 选择一个属性：组ID(创建用户组时默认生成)、组编码、组名、描述，输入相应的属性值进行搜索

• 管理用户组用户

  • 添加用户：选中添加用户选项后，进入到系统全用户列表，根据搜索条件查找用户进行勾选添加
  

  添加用户组用户-1
  

  添加用户组用-2
  • 删除用户：展开用户组，出现该用户组的用户列表，可直接进行删除操作
  

  删除用户组用户

4.客户端

• 与服务器相对应，为客户提供本地服务的程序，即第三方应用程序
• 可创建、删除、编辑、详情查看、搜索客户端

4.1 创建客户端

必填项：

• 客户端名称

  • 具有唯一性

• 密钥：使用客户端的密码。例如用户登陆需要用户名和密码，密钥相当于密码

• 授权类型：客户端必须得到用户的授权（authorization grant），才能获得令牌（access token），进而凭令牌获取本平台资源。下面提供了五种授权方式：

  • password：密码模式，用户向客户端提供自己的用户名和密码。客户端使用这些信息，向"服务商提供商"索要授权
  • implicit：简化模式，不通过第三方应用程序的服务器，直接在浏览器中向认证服务器申请令牌，跳过了"授权码"这个步骤，因此得名。所有步骤在浏览器中完成，令牌对访问者是可见的，且客户端不需要认证
  • client_credentials：客户端模式，客户端以自己的名义，而不是以用户的名义，向"服务提供商"进行认证。严格地说，客户端模式并不属于OAuth框架所要解决的问题。在这种模式中，用户直接向客户端注册，客户端以自己的名义要求"服务提供商"提供服务，其实不存在授权问题
  • authorization_code：授权码模式，是功能最完整、流程最严密的授权模式。它的特点就是通过客户端的后台服务器，与"服务提供商"的认证服务器进行互动
  • refresh_token：表示早前收到的更新令牌，如果用户访问的时候，客户端的"访问令牌"已经过期，则需要使用"更新令牌"申请一个新的访问令牌

选填项：

• 访问授权超时：access_token_validity,assecc token的有效时间
• 授权超时：refresh_token_validity,refresh token的有效时间
• 重定向地址：用户的登陆后从登陆界面跳转的地址
• 附加信息：用json格式添加客户端的附加信息。如{ "description": "string"，"name": "string"}

创建客户端

4.2 其他操作

• 详情：可查看创建客户端时所填的信息
• 编辑：
  • 客户端ID在创建客户端后自动生成，不可编辑
  • 除客户端ID外，其他属性都可编辑
• 删除：可删除客户端信息

5.LDAP

• 轻量目录访问协议
• 可更新LDAP信息

5.1 更新LDAP

必填项：

• LDAP名称：通过应用LDAP访问LDAP 目录服务器中注册的用户、群组条目，方便统一管理用户的密码登陆方式

选填项：

• 服务器地址：LDAP要访问的服务器地址
• LDAP属性名：要访问的数据的名称
• 加密方式
  • SSL
  • TSL
  • STARTTLS
• 基础DN：获取数据的路径
• 描述：对该LDAP得附加信息

6.密码策略

• 规定密码强度规则，即密码必须符合的规则；规定密码使用规则
• 可更新密码策略

登陆安全策略：使用密码登陆时的规则

• 是否开启密码输错锁定：勾选后，密码输错锁定策略将生效

  • 最大输错次数：密码输错次数超过填写的最大输错次数后，该用户将会被锁定，无法登陆系统
  • 密码输错锁定时间（秒）：用户被锁定后，经过输入的密码输错锁定时间（秒）后，系统自动将该用户解锁，该用户可重新进行输入密码登入系统的操作
  

  密码输错锁定规则

• 是否下线其他设备：勾选后，只允许用户登陆一台设备，若登陆其他设备，自动将上一台设备的登陆状态下线

• 密码失效时长（秒）：密码有效期，若超过这个有效期，需重新设置密码

• 输错次数：若超过填入的输错次数，则出现验证码验证

密码安全策略：密码创建或更改时需要满足的规则

• 是否开启密码检查：勾选后，密码检查规则将生效
  • 最小密码长度：设置密码时，密码长度不能小于填入的最小密码长度
  • 最少小写字母数：密码中至少应包含的小写字母数
  • 最少大写字母数：密码中至少应包含的大写字母数
  • 最少特殊字符数：密码中至少应包含的特殊字符数
  • 密码正则：定义针对给定文本检查的匹配模式，通过填入特定的正则表达式来制定密码规则
  • 是否密码不可与账号相同：勾选后，密码不能和用户名相同
  • 最大近期密码数：与最近n次密码不能相同。例：若填入数值为3，则表示不能与最近3次历史密码相同

密码策略

7.角色分配(组织层)

• 管理成员（类型：用户/服务）角色
• 可对成员分配、删除、更改、查看（按成员/角色）角色
• 所有系统用户初始都被分配了默认的【运营组织】的【组织查看者】的角色

7.1 角色分配（组织层）可选角色

• 用户服务

  • 用户服务组织管理员：组织层可进入单个组织界面（默认为运营组织）且有组织层【用户服务】所有功能权限-可管理用户、项目、用户组、客户端、LDAP、密码策略、角色分配（组织层）；项目层可进入所有项目的单个项目界面，具有项目层【用户服务】所有功能权限-可角色分配（项目层）
  • 用户服务组织维护者
  • 用户服务项目管理员：组织层只有【项目】项目管理功能权限；项目层具有【用户服务】所有功能权限-可角色分配（项目层）
  • 组织查看者：组织层只可进入单个组织界面（默认为运营组织）而无任何功能权限
  • 项目查看者：组织层可进入【项目】项目管理界面查看项目列表而无操作权限；项目层可进入所有项目的单个项目界面而无任何功能权限

• 部署管理

  • 部署管理员：组织层可进入单个组织界面（默认为运营组织）且有组织层【部署管理】所有功能权限-可资源管理、网关管理、域名管理、服务管理、服务部署、部署详情（阶段及日志）、设置自动部署

• 运营监控

  • 运营监控查看者：全流程信息监控查看。组织层可进入单个组织界面（默认为运营组织）且有组织层【智能监控】所有功能权限-性能监控、模板控制、指标控制

• 移动管理

  • 移动开发管理员：组织层可进入单个组织界面（默认为运营组织）且有组织层【移动管理】所有功能权限-APP管理、模块管理

• 文件管理

  • 文件管理员：有文件上传下载接口的权限

• 系统

  • 框架服务组织管理员

• 自定义角色

  • 在全局层具有角色管理的用户在创建组织层角色后，该角色将会在自定义角色中显示
  • 例如：定义了一个组织层角色-项目创建者，该角色权限如下。用户被分配项目创建者角色后，组织层可进入单个组织界面（默认为运营组织）且有组织层【用户服务】的【项目】、【用户】、【用户组】功能权限，和组织层【开发管理】的【环境】功能权限

权限名称	权限描述	权限层级
hap-user-service.password-policy.queryOrganization	查询目标组织密码策略	organization
hap-devops-service.environment.listEnvironment	查询全部环境信息	organization
hap-devops-service.environment.createEnvironment	创建环境	organization
hap-devops-service.environment.checkEnvironmentByName	检查环境名是否可用	organization
hap-devops-service.environment.listEnvironmentByPageSize	分页查询环境信息	organization
hap-devops-service.environment.getEnvironmentByEnvironmentId	环境管理详情	organization
hap-devops-service.environment.updateEnvironment	更新环境	organization
hap-devops-service.environment.deleteEnvironmentByEnvironmentId	删除环境	organization
hap-devops-service.project.checkProject	校验项目code,name是否重复	organization
hap-user-service.project.select	分页查询项目	organization
hap-user-service.project.create	添加项目，organization id不需要，强制当前用户所属organization	organization
hap-user-service.project.checkProjectCode	checkProjectCode	organization
hap-user-service.project.queryOrganizationProject	根据组织id查询项目	organization
hap-user-service.user.select	分页查询	organization
hap-user-service.user.create	新增用户	organization
hap-user-service.user.query	根据删除组织下所有用户	organization
hap-user-service.user.updateUser	通过用户id查询用户	organization
hap-user-service.organization.query	根据组织id查询组织	organization
hap-user-service.role.selectOrganizationRole	查询可分配组织角色列表	organization
hap-user-service.project.update	根据id修改项目信息，只能修改自己组织项目	organization

7.2 分配、更改角色

• 分配角色：

• （1）点击【添加】

分配角色

• （2）输入成员（用户：用户名），选择角色

分配角色

• 更改角色分配：
• 点击角色名，出现下图列表即可继续角色更改

更改角色

• 注意：
  • 对已存在在角色分配列表里的成员，若进行【添加】操作会报错（因为【添加】操作是对没有被分配过角色的成员进行的），而应在更新操作中进行角色的更改

已被分配角色的成员无法进行添加操作

已被分配角色的成员只能进行更改操作

7.3 其他操作

• 删除角色分配：可删除角色分配列表中的数据

删除角色分配

• 查看角色分配：可按成员/角色方式查看

角色分配查看方式

• 搜索角色分配：可根据搜索条件查找角色分配列表的数据项
  • 不选择属性，根据输入值进行全局搜素
  • 选择一个属性：类型（用户/服务）、成员、昵称，输入相应属性值进行模糊搜索

III 项目层

• 选中顶部导航栏的【组织/项目】选项

image.png

• 弹出组织/项目列表的弹窗
  • 在下拉菜单中选择一个组织，组织/项目列表则变为被选组织与该组织下的所有项目
  • 项目过多时，可在搜索框中对项目名进行模糊搜索
  • 鼠标右键双击组织/项目列表的项目选项，则进入该项目

image.png

一、用户服务

1.角色分配（项目层）

• 管理成员（类型：用户/服务）角色
• 可对成员分配、删除、更改、查看（按成员/角色）角色
• 默认每个项目里，创建该项目的用户有【项目所有者】、【用户服务项目管理员】这两个角色

1.1 角色分配（项目层）可选角色

• 用户服务

  • 项目查看者：只可看到被分配该角色的项目，进去项目界面后无任何功能权限
  • 用户服务项目管理员：只能看到被分配的项目，项目层具有【用户服务】所有功能权限-可角色分配（项目层）

• 开发管理

  • 项目所有者：只能看到被分配的项目，项目层具有【用户服务】所有功能权限-角色分配（项目层）；具有【开发管理】所有功能权限-服务管理、服务发布、环境管理
  • 项目成员：只能看到被分配的项目，项目层只有【开发管理】部分功能权限-服务详情查看、分支管理、服务版本、代码质量查看、服务发布
  • 源代码管理员：只能看到被分配的项目，项目层只有【开发管理】部分功能权限-服务创建、服务详情查看、分支管理、服务版本、代码质量查看、服务发布

• 看板服务

  • 看板项目所有者：只能看到被分配的项目，项目层具有【敏捷管理】所有功能权限-故事管理、冲刺管理、任务和缺陷
  • 看板项目成员：只能看到被分配的项目，项目层只有【敏捷管理】部分功能权限-故事管理、冲刺管理、任务和缺陷

• 洞察数据接口
  -开发监控查看者：只能看到被分配的项目，项目层具有【智能洞察】所有功能权限-全流程信息监控查看

1.2 分配、更改角色

• 分配角色：

• （1）点击【添加】

分配角色

• （2）输入成员（用户：用户名），选择角色

分配角色

• 更改角色分配：
• 点击角色名，出现下图列表即可继续角色更改

更改角色

• 注意：
  • 对已存在在角色分配列表里的成员，若进行【添加】操作会报错（因为【添加】操作是对没有被分配过角色的成员进行的），而应在更新操作中进行角色的更改

已被分配角色的成员无法进行添加操作

已被分配角色的成员只能进行更改操作

1.3 其他操作

• 删除角色分配：可删除角色分配列表中的数据

删除角色分配

• 查看角色分配：可按成员/角色方式查看

角色分配查看方式

• 搜索角色分配：可根据搜索条件查找角色分配列表的数据项
  • 不选择属性，根据输入值进行全局搜素
  • 选择一个属性：类型（用户/服务）、成员、昵称，输入相应属性值进行模糊搜索

IV 用户层

1.用户信息维护

• 不可更改项：

  • 用户名：用户名可用于登陆，一旦创建，不可修改
  • 组织：用户所属组织用户本人不可变更

• 可更改项：

  • 昵称：用户的别称
  • 邮箱：填写真实正确的邮箱，可用于登陆、密码找回
  • 语言：系统界面显示的语言
  • 时区：系统所有与时间有关的操作根据选择的时区进行转换

2.密码更改

• 密码更改要符合系统密码策略
• LDAP用户不能在本系统更改密码，只能在LDAP访问的系统中实现密码的更改
• 更改密码需要输入原始密码
• 更改密码需要确定新密码

3. 授权

• 用户可以通过调用接口创建自己的token
• 可创建、删除、详情查看、编辑、搜索授权

授权管理

3.1 创建授权

• 名称

  • 具有唯一性

• 过期时间

  • token的失效时间
  • 无法选择当前时间之前的

创建授权

3.2 其他操作

• 删除：可删除token数据
• 编辑：可修改token的过期时间，不可修改token名称