典型应用场景
快速使用租户管理
租户管理模块是ZStack Cloud云平台提供的OA系统,支持组织架构、用户、项目管理等基础功能,还支持统一认证、工单管理、独立区域管理等高级功能。本场景以基础功能为例,介绍新用户快速使用流程。
示例使用流程如下:
- admin创建组织架构树;
- admin创建用户并将用户加入对应的组织架构;
- admin指定部门负责人;
- admin全局共享基本资源;
- admin创建项目并指定项目负责人;
- 项目负责人创建自定义角色;
- 项目负责人为项目添加成员并绑定角色;
- 登录云平台。
假定客户场景如下:
该公司包含北京和上海两个子公司,需分别创建组织架构树,组织架构列表如下:
团队 子部门 Company-BJ Sales-BJ Company-SH Dev-SH QA-SH 部门负责人列表如下:
部门 部门负责人 Company-BJ Tomas Sales-BJ Ben Company-SH Frank Dev-SH Tom QA-SH Bill 用户列表如下:
姓名 用户名 密码 部门 Tomas Tomas password Company-BJ Ben Ben password Sales-BJ Amy Amy password Sales-BJ Shelly Shelly password Sales-BJ Bill Bill password QA-SH Sam Sam password QA-SH Chil Chil password QA-SH Frank Frank password Company-SH John John password Dev-SH Jack Jack password Dev-SH Tom Tom password Dev-SH 项目列表如下:
项目 项目成员 项目负责人 项目成员角色 开发项目A-SH Jack、Frank、John、Tom Jack 普通项目成员 销售项目A-BJ Tomas、Ben、Amy、Shelly Tomas 普通项目成员
admin创建组织架构树
admin根据公司组织架构在私有云云平台创建组织架构树。
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 组织架构,进入组织架构界面,点击组织架构右侧加号,弹出创建组织架构界面。
可参考以下示例输入相应内容:
名称:输入组织名称
简介:可选项,可留空不填
类型:选择组织类型,可选择添加子部门或新团队,默认选择添加新团队
添加子部门,需指定上级部门,在已添加的子部门或新团队中选择。
负责人:可选项,指定相应的用户作为负责人
部门运营管理员:可选项,可为新团队指定部门运营管理员,协助admin进行部门管理
- 部门运营管理员负责整个部门的运营管理,包括项目管理、工单审批、查看账单以及部门核心资源监控等。
- 若用户已绑定其他角色,不支持设置为部门运营管理员。
- 若用户已设置为部门运营管理员,不支持绑定其他角色。
配额设置:支持为组织手动设置配额,可设置的资源如下:
- 计算资源:包括云主机数量、运行中云主机数量、CPU数量、GPU设备数量、内存、云主机调度策略数量、弹性裸金属实例的配额设置
- 存储资源:包括云盘快照数量、数据云盘数量、可用存储容量、镜像数量、所有镜像容量、备份数据、可用备份容量的配额设置。其中,备份数据和可用备份容量配置项需同时拥有灾备服务模块许可证
- 网络资源:包括VXLAN网络数量、三层网络数量、安全组数量、虚拟IP数量、弹性IP数量、端口转发数量、负载均衡器数量、监听器数量的配额设置
- 其他:包括定时任务数量、定时器数量、资源报警器、事件报警器、通知对象、标签的配额设置
参考表 1: 组织架构列表,重复此步骤,完成组织架构树创建。
admin创建用户并将用户加入对应的组织架构
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 用户,进入用户界面,点击创建用户,弹出创建用户界面,请参考表 3: 用户列表,并根据以下步骤使用模板导入方式批量创建用户,并将用户加入对应的组织。
本示例场景中,项目列暂时留空不填;简介、邮箱地址、手机号码、编号可按需填写。
在创建用户界面,添加方式选择模板导入,操作步骤如下:
下载配置模板文件
点击下载模板按钮,下载csv格式的配置模板文件,如配置模板文件所示:
用户名、姓名、密码为必填参数,且用户名必须全局唯一。
按规定格式填写用户的配置信息
配置模板包括表头和一行示例,编辑模板时需删除或覆盖该示例。
填写配置模板时,可参考以下示例输入相应内容:
姓名:输入用户姓名
用户名:设置用户名,作为登录名需全局唯一
密码:设置用户登录密码
简介:可选项,可留空不填
手机号码:可选项,输入用户手机号码
邮箱地址:可选项,输入用户邮箱地址
编号:可选项,输入用户编号,例如工号
组织架构:可选项,可将用户加入到一个或多个组织架构
- 组织架构必须为已有组织,输入格式:以符号“/”分隔,例如Company/Dev;
- 若组织架构路径重复,附带顶级部门uuid,例如Company(f11444d42701483791370e9f8b9300b9)/Dev;
- 同时加入多个组织,以”&&“分隔,例如Company/Dev&&Company/QA。
项目:可选项,可将用户加入到一个或多个项目
- 项目必须为已有项目,加入单个项目时,直接输入项目名称,例如project-01;
- 同时加入多个项目,以”&&“分隔,例如project-01&&project-02。
配置文件填写完成后,可通过浏览器直接上传到云平台,确认无误后点击确定按钮,云平台将根据配置文件开始创建用户,如添加配置文件所示:
admin指定部门负责人
参考表 2: 部门负责人列表,重复以下操作,为每个部门添加部门负责人。
在组织架构界面,点击右上角更多操作 > 更换部门负责人按钮,将对应用户指定为部门负责人。
admin全局共享基本资源
为了保证项目正常使用,需要全局共享云盘规格、计算规格、镜像、私有网络/VXLAN Pool等基本资源。
以镜像为例,在镜像管理界面,选中一个或多个镜像,点击操作 > 设置共享模式按钮,设置为全局共享,如图 3: 全局共享资源所示:
重复上述操作,全局共享其他基本资源。
admin创建项目并指定项目负责人
在项目界面,点击创建项目按钮,弹出创建项目界面。
可参考以下示例输入相应内容:
名称:设置项目名称
简介:可选项,可留空不填
项目配置方式:项目配置方式可选择手动设置或使用项目模板
若选择手动设置方式,需设置以下内容:
配额方式:设置项目配额,对项目资源总量进行控制
- 计算资源:包括云主机数量、运行中云主机数量、CPU数量、GPU设备数量、内存、云主机调度策略数量、弹性裸金属实例的配额设置
- 存储资源:包括云盘快照数量、数据云盘数量、可用存储容量、镜像数量、所有镜像容量、备份数据、可用备份容量的配额设置。其中,备份数据和可用备份容量配置项需同时拥有灾备服务模块许可证
- 网络资源:包括VXLAN网络数量、三层网络数量、安全组数量、虚拟IP数量、弹性IP数量、端口转发数量、负载均衡器数量、监听器数量的配额设置
- 其他:包括定时任务数量、定时器数量、资源报警器、事件报警器、通知对象、标签的配额设置
若选择使用项目模板方式,需设置以下内容:
项目模板:若选择项目模板方式设置项目配额,需选择已有的项目模板,可直接使用模板定义的配额来配置项目
所属区域:需指定项目所属的区域,一个项目只可归属于一个区域
回收策略:默认为无限制,也可选择指定时间回收或指定费用回收
无限制:
创建项目后,项目内资源默认一直处于启用状态。
指定时间回收:
- 项目有效期限不足14天时,项目成员登录云平台智能操作助手将弹出项目即将过期的提醒信息。
- 项目过期后,项目内资源按照指定的控制策略回收。
如选择指定时间回收,需设置以下内容:
截止时间:设置项目到期时间
回收动作:提供以下三种回收动作
- 禁止项目成员登录:过期后,项目成员均禁止登录此项目,项目内资源(云主机、VPC路由器)仍将正常运行
- 禁止项目成员登录且停止项目资源:过期后,项目内所有运行中的资源(云主机、VPC路由器)会被停止,项目禁止登录
- 删除项目:过期后,项目会被删除,处于已删除状态,项目禁止登录,项目内所有资源(云主机、VPC路由器)会被停止
项目内的VPC路由器停止后,其上的网络服务将停止,云主机将不能访问外网。
指定费用回收:
项目计费总额到达费用限额时触发项目过期,项目过期后,项目内资源按照指定的控制策略回收。
如选择指定费用回收,需设置以下内容:
费用限额:设置项目到期的费用限额
回收动作:提供以下三种回收动作
- 禁止项目成员登录:过期后,项目成员均禁止登录此项目,项目内资源(云主机、VPC路由器)仍将正常运行
- 禁止项目成员登录且停止项目资源:过期后,项目内所有运行中的资源(云主机、VPC路由器)会被停止,项目禁止登录
- 删除项目:过期后,项目会被删除,处于已删除状态,项目禁止登录,项目内所有资源(云主机、VPC路由器)会被停止
项目内的VPC路由器停止后,其上的网络服务将停止,云主机将不能访问外网。
登录时间限制:可选项,可设置项目内成员允许/禁止登录项目的时间段
若不设置,代表不限制登录时间。支持以下两种限制策略:按允许登录时间和按禁止登录时间。
- 允许登录时间:可设置每天/每周某几天项目内成员可登录项目的时间。设置后,项目内成员仅可在允许登录时间段内登录项目
- 禁止登录时间:可设置每天/每周某几天项目内成员不可登录项目的时间。设置后,项目内成员在禁止登录时间段内无法登录项目
- 若设置的时间段早于或包含当前云平台时间,限制策略在下个时间周期生效。
- 若同时设置了项目回收策略和登录时间限制策略,优先执行项目回收策略。
项目负责人:可选项,指定相应的用户作为项目负责人
成员:可选项,添加相关用户进入项目作为项目成员
部门:可选项,将项目加载到部门,加载后支持按部门计费
计费价目:可选项,选择项目使用的计费价目,留空不填将使用默认计费价目
安全组限制:默认禁用,若启用,项目成员创建云主机时将强制绑定安全组
- 启用安全组限制前,需确保项目拥有至少1个安全组配额。
- 启用安全组限制后,将为该项目创建一个默认安全组。
- 支持通过全局设置(项目安全组限制开关)全局控制创建项目时安全组限制功能的启用状态。默认禁用,若启用,将默认为项目启用安全组限制。
- 规则:可选项,启用安全组限制后,可在创建项目时直接设置安全组规则,也可在创建项目后设置
本场景请参考表 4: 项目列表创建开发项目A-SH(ZONE-SH)、销售项目A-BJ(ZONE-BJ)并指定项目负责人,其中项目负责人以外的选项可暂时不填。
项目负责人创建自定义角色
项目负责人可使用Chrome浏览器或FireFox浏览器打开项目登录界面(http://management_node_ip:5000/#/project),输入相应用户名和密码登录云平台。
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 角色,进入角色界面,点击创建角色,弹出创建角色界面。
不同项目的项目负责人可参考以上步骤为项目创建角色。其中,用户可按需配置普通项目成员权限服务。
项目负责人为项目添加成员并绑定角色
项目负责人在项目详情页点击成员 > 添加项目成员,可参考表 4: 项目列表为本项目添加成员并绑定角色。
不同项目的项目负责人可参考以上步骤,为项目添加成员并绑定角色。
登录云平台
加入项目并赋予角色的用户,可正常登录并使用平台资源,进行各种操作。项目成员可使用Chrome浏览器或FireFox浏览器打开项目登录界面(http://management_node_ip:5000/#/project),输入相应用户名和密码登录云平台。
项目成员登录云平台后,其所属全部项目以卡片形式陈列,选择项目进入。
至此,租户管理快速使用介绍完成。
平台管理
自定义权限配置:自定义网络管理员
ZStack Cloud支持API粒度的权限控制,使用自定义角色权限来满足用户不同场景的需求,本场景以自定义网络管理员角色为例进行介绍。
示例使用流程如下:
- admin创建平台用户(Jerry);
- admin自定义网络管理员平台角色;
- 将网络管理员角色绑定到用户(Jerry)。
假定客户场景如下:
上海某公司需要构建网络管理员角色,拥有二层网络、三层网络、网络服务、公网计费等网络相关所有权限,协助admin共同管理云平台网络资源。
| 权限服务 | 备注 |
|---|---|
| 计费管理相关接口 | 提供计费相关功能,用于公网IP计费。 |
| 镜像服务器相关接口 | 提供镜像服务器功能,添加云路由镜像,用于创建云路由器、VPC路由器。 |
| 集群相关接口 | 提供集群相关功能,二层网络加载到集群才能正常使用。 |
| 镜像相关接口 | 提供镜像相关功能,添加路由器镜像,用于创建VPC路由器。 |
| 计算规格相关接口 | 提供计算规格相关功能,创建路由器规格,用于创建VPC路由器。 |
| 二层网络资源相关接口 | 提供二层网络相关功能,支持L2NoVlanNetwork、L2VlanNetwork、VxlanNetwork类型二层网络。 |
| 三层网络相关接口 | 提供三层网络相关功能,支持公有网络、扁平网络、VPC网络。 |
| 网络服务相关接口 | 提供网络服务相关功能,包括:安全组、虚拟IP、弹性IP、端口转发、负载均衡、SNAT、DHCP、IPsec等网络服务。 |
| OSPF相关接口 | 提供OSPF动态路由相关功能,作用于VPC路由器。 |
| 路由资源相关接口 | 提供VPC路由器、VPC网络等相关功能。 |
| 云主机相关接口 | 提供云主机相关功能,用于创建VPC路由器。 |
| VPC相关接口 | 提供VPC路由器及VPC网络等相关功能。 |
| 区域相关接口 | 提供区域相关功能,网络资源具有区域属性,加载到区域才能正常使用。 |
| ZWatch相关接口 | 提供报警相关功能,用于路由器、三层网络、虚拟IP相关报警。 |
admin创建平台用户(Jerry)
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 用户 > 本地用户,进入本地用户界面,点击创建用户,弹出创建用户界面。
如已添加ZStack IAM认证服务器,不支持创建本地用户,仅支持创建统一认证用户。
在创建用户界面,添加方式选择自定义,可参考以下示例输入相应内容:
姓名:输入用户姓名
简介:可选项,可留空不填
用户名(用于登录):设置用户名,作为登录名需全局唯一
密码:设置用户登录密码
确认密码:再次输入登录密码
直系部门:可选项,可将用户直接添加至对应的部门中
手机号码:可选项,输入用户手机号码
邮箱地址:可选项,输入用户邮箱地址
编号:可选项,输入用户编号,例如工号
平台角色:可选项,可为用户指定一个或多个平台角色,指定后需设置管理区域
- 用户绑定平台角色后,将拥有对应区域的管理权限。平台角色的权限仅在用户自身管控的区域内生效。
- 用户绑定平台角色后,需要从项目登录入口登录云平台。
管理区域:设置平台角色管控的区域
- 选择区域后,用户将只可管控指定区域。
- 一个平台角色可管控多个区域,一个区域可由多个平台角色共同管控。
项目:可选项,可将用户加入到一个或多个项目
用户加入项目并绑定项目角色后,将拥有该项目的使用权限,管控项目内的数据。
如图 5: 创建用户所示,点击确定按钮,创建平台用户(Jerry)。
admin自定义网络管理员平台角色
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 角色,进入角色界面,点击创建角色,弹出创建角色界面。
创建角色分为以下三步:
基础信息
可参考以下示例输入相应内容:
名称:设置角色名称
简介:可选项,可留空不填
角色类型:选择平台角色
网络管理员属于平台成员。
根角色:设置根角色,根角色用于限制自定义角色的权限范围,自定义角色的权限继承自根角色,为根角色权限的子集。
界面权限
按照上述网络管理员角色权限列表选择权限服务以及权限配置
确认信息
检查将要创建的角色,支持跳转修改,如图 8: 确认信息所示:
将网络管理员角色绑定到用户(Jerry)
在用户界面选中已创建的用户Jerry,点击操作 > 修改平台角色按钮,在弹出的修改平台角色弹窗中选择网络管理员,点击确定按钮,将网络管理员角色绑定到用户(Jerry)。
将网络管理员角色绑定到用户(Jerry)后,Jerry拥有网络管理相关权限,支持网络相关所有操作,支持协助admin共同管理云平台网络资源。
默认权限配置:监控大屏管理员
ZStack Cloud预置了多种系统角色,方便用户快速使用,本场景以监控大屏角色为例进行介绍。
假定客户场景如下:
上海某公司需要一个大屏管理员角色,专门负责云平台大屏的实时监控。
示例使用流程如下:
- admin创建平台用户并绑定监控大屏角色(Liz)
- 登录监控大屏用户(Liz)
admin创建平台用户(Liz)
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 用户 > 本地用户,进入本地用户界面,点击创建用户,弹出创建用户界面。
如已添加ZStack IAM认证服务器,不支持创建本地用户,仅支持创建统一认证用户。
在创建用户界面,添加方式选择自定义,可参考以下示例输入相应内容:
姓名:输入用户姓名
简介:可选项,可留空不填
用户名(用于登录):设置用户名,作为登录名需全局唯一
密码:设置用户登录密码
确认密码:再次输入登录密码
直系部门:可选项,可将用户直接添加至对应的部门中
手机号码:可选项,输入用户手机号码
邮箱地址:可选项,输入用户邮箱地址
编号:可选项,输入用户编号,例如工号
平台角色:选择监控大屏角色,用户将拥有监控大屏角色的权限
- 用户绑定平台角色后,将拥有对应区域的管理权限。平台角色的权限仅在用户自身管控的区域内生效。
- 用户绑定平台角色后,需要从项目登录入口登录云平台。
管理区域:设置平台角色管控的区域
- 选择区域后,用户将只可管控指定区域。
- 一个平台角色可管控多个区域,一个区域可由多个平台角色共同管控。
项目:可选项,可将用户加入到一个或多个项目
用户加入项目并绑定项目角色后,将拥有该项目的使用权限,管控项目内的数据。
登录监控大屏用户(Liz)
使用Chrome浏览器或FireFox浏览器打开项目登录界面(http://management_node_ip:5000/#/project),监控大屏用户(Liz)输入相应用户名和密码登录云平台,进入云平台首页,点击右上角的大屏监控入口按钮,可在新页面打开大屏监控。
使用监控大屏角色需要注意以下情况:
- 监控大屏用户没有用户主页,无法自行修改密码,仅admin/平台管理员/普通平台成员支持为其修改。
- 监控大屏默认语言、监控大屏主题跟随云平台现有配置,仅admin/平台管理员/普通平台成员支持修改。
- 监控大屏用户登录后一直运行,关闭网页依然保持登录。若需要退出登录,访问登录跳转链接即可( http://management node_ip:port/#/login,例如:http://172.20.11.50:5000/#/login)。
独立区域管理
独立区域管理是是租户管理提供的子功能之一,如图 12: 独立区域管理示意图所示:
示例实践流程如下:
- admin登录并创建两个用户并绑定平台管理员,分别管控上海、北京两个区域;
- 平台管理员-SH登录云平台,构建上海分公司的组织架构,并创建相应的项目;
- 平台管理员-BJ登录云平台,构建北京分公司的组织架构,并创建相应的项目;
- 功能验证。
假定客户场景如下:
某企业用户在上海、北京各有一个分公司,总部管理员(即:admin)分别指定相应的平台管理员,实现两地数据中心的独立管理。
admin登录并创建两个用户并绑定平台管理员
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 用户 > 本地用户,进入本地用户界面,点击创建用户,弹出创建用户界面。
如已添加ZStack IAM认证服务器,不支持创建本地用户,仅支持创建统一认证用户。
在创建用户界面,添加方式选择自定义,可参考以下示例输入相应内容:
姓名:输入用户姓名
简介:可选项,可留空不填
用户名(用于登录):设置用户名,作为登录名需全局唯一
密码:设置用户登录密码
确认密码:再次输入登录密码
直系部门:可选项,可将用户直接添加至对应的部门中
手机号码:可选项,输入用户手机号码
邮箱地址:可选项,输入用户邮箱地址
编号:可选项,输入用户编号,例如工号
平台角色:选择平台管理员角色,并选择对应的管理区域ZONE-SH
- 用户绑定平台角色后,将拥有对应区域的管理权限。平台角色的权限仅在用户自身管控的区域内生效。
- 用户绑定平台角色后,需要从项目登录入口登录云平台。
管理区域:设置平台角色管控的区域ZONE-SH
- 选择区域后,用户将只可管控指定区域。
- 一个平台角色可管控多个区域,一个区域可由多个平台角色共同管控。
项目:可选项,可将用户加入到一个或多个项目
用户加入项目并绑定项目角色后,将拥有该项目的使用权限,管控项目内的数据。
如图 13: 创建平台管理员用户所示,创建用户(平台管理员-SH):
同理,创建用户(平台管理员-BJ)。
平台管理员-SH登录云平台,构建上海分公司的组织架构,并创建相应的项目
使用Chrome浏览器或FireFox浏览器打开项目登录界面(http://management_node_ip:5000/#/project),平台管理员-SH输入相应用户名和密码登录云平台。
通过创建用户方式,将上海分公司人员录入云平台。
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 用户 > 本地用户,进入本地用户界面,点击创建用户,弹出创建用户界面。
如已添加ZStack IAM认证服务器,不支持创建本地用户,仅支持创建统一认证用户。
在创建用户界面,添加方式选择自定义,可参考以下示例输入相应内容:
姓名:输入用户姓名
简介:可选项,可留空不填
用户名(用于登录):设置用户名,作为登录名需全局唯一
密码:设置用户登录密码
确认密码:再次输入登录密码
直系部门:可选项,可将用户直接添加至对应的部门中
手机号码:可选项,输入用户手机号码
邮箱地址:可选项,输入用户邮箱地址
编号:可选项,输入用户编号,例如工号
平台角色:可选项,可为用户指定一个或多个平台角色,指定后需设置管理区域
- 用户绑定平台角色后,将拥有对应区域的管理权限。平台角色的权限仅在用户自身管控的区域内生效。
- 用户绑定平台角色后,需要从项目登录入口登录云平台。
管理区域:设置平台角色管控的区域
- 选择区域后,用户将只可管控指定区域。
- 一个平台角色可管控多个区域,一个区域可由多个平台角色共同管控。
项目:可选项,可将用户加入到一个或多个项目
用户加入项目并绑定项目角色后,将拥有该项目的使用权限,管控项目内的数据。
- 本场景下,项目、直系部门此时尚未创建,所以留空。
- 支持使用手动添加和模板导入两种方式创建用户。
构建上海分公司的组织架构。
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 组织架构,进入组织架构界面,点击组织架构右侧加号,弹出创建组织架构界面。
可参考以下示例输入相应内容:
名称:输入组织名称
简介:可选项,可留空不填
类型:选择组织类型,可选择添加子部门或新团队,默认选择添加新团队
添加子部门,需指定上级部门,在已添加的子部门或新团队中选择。
负责人:可选项,指定相应的用户作为负责人
部门运营管理员:可选项,可为新团队指定部门运营管理员,协助admin进行部门管理
- 部门运营管理员负责整个部门的运营管理,包括项目管理、工单审批、查看账单以及部门核心资源监控等。
- 若用户已绑定其他角色,不支持设置为部门运营管理员。
- 若用户已设置为部门运营管理员,不支持绑定其他角色。
配额设置:支持为组织手动设置配额,可设置的资源如下:
- 计算资源:包括云主机数量、运行中云主机数量、CPU数量、GPU设备数量、内存、云主机调度策略数量、弹性裸金属实例的配额设置
- 存储资源:包括云盘快照数量、数据云盘数量、可用存储容量、镜像数量、所有镜像容量、备份数据、可用备份容量的配额设置。其中,备份数据和可用备份容量配置项需同时拥有灾备服务模块许可证
- 网络资源:包括VXLAN网络数量、三层网络数量、安全组数量、虚拟IP数量、弹性IP数量、端口转发数量、负载均衡器数量、监听器数量的配额设置
- 其他:包括定时任务数量、定时器数量、资源报警器、事件报警器、通知对象、标签的配额设置
在组织架构界面,平台管理员-SH构建的上海分公司的组织架构如图 15: 上海分公司的组织架构所示:
创建项目。
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 项目管理 > 项目,进入项目界面,点击创建项目,弹出创建项目界面。
可参考以下示例输入相应内容:
名称:设置项目名称
简介:可选项,可留空不填
项目配置方式:项目配置方式可选择手动设置或使用项目模板
若选择手动设置方式,需设置以下内容:
配额方式:设置项目配额,对项目资源总量进行控制
- 计算资源:包括云主机数量、运行中云主机数量、CPU数量、GPU设备数量、内存、云主机调度策略数量、弹性裸金属实例的配额设置
- 存储资源:包括云盘快照数量、数据云盘数量、可用存储容量、镜像数量、所有镜像容量、备份数据、可用备份容量的配额设置。其中,备份数据和可用备份容量配置项需同时拥有灾备服务模块许可证
- 网络资源:包括VXLAN网络数量、三层网络数量、安全组数量、虚拟IP数量、弹性IP数量、端口转发数量、负载均衡器数量、监听器数量的配额设置
- 其他:包括定时任务数量、定时器数量、资源报警器、事件报警器、通知对象、标签的配额设置
若选择使用项目模板方式,需设置以下内容:
项目模板:若选择项目模板方式设置项目配额,需选择已有的项目模板,可直接使用模板定义的配额来配置项目
所属区域:需指定项目所属的区域,一个项目只可归属于一个区域
回收策略:默认为无限制,也可选择指定时间回收或指定费用回收
无限制:
创建项目后,项目内资源默认一直处于启用状态。
指定时间回收:
- 项目有效期限不足14天时,项目成员登录云平台智能操作助手将弹出项目即将过期的提醒信息。
- 项目过期后,项目内资源按照指定的控制策略回收。
如选择指定时间回收,需设置以下内容:
截止时间:设置项目到期时间
回收动作:提供以下三种回收动作
- 禁止项目成员登录:过期后,项目成员均禁止登录此项目,项目内资源(云主机、VPC路由器)仍将正常运行
- 禁止项目成员登录且停止项目资源:过期后,项目内所有运行中的资源(云主机、VPC路由器)会被停止,项目禁止登录
- 删除项目:过期后,项目会被删除,处于已删除状态,项目禁止登录,项目内所有资源(云主机、VPC路由器)会被停止
项目内的VPC路由器停止后,其上的网络服务将停止,云主机将不能访问外网。
指定费用回收:
项目计费总额到达费用限额时触发项目过期,项目过期后,项目内资源按照指定的控制策略回收。
如选择指定费用回收,需设置以下内容:
费用限额:设置项目到期的费用限额
回收动作:提供以下三种回收动作
- 禁止项目成员登录:过期后,项目成员均禁止登录此项目,项目内资源(云主机、VPC路由器)仍将正常运行
- 禁止项目成员登录且停止项目资源:过期后,项目内所有运行中的资源(云主机、VPC路由器)会被停止,项目禁止登录
- 删除项目:过期后,项目会被删除,处于已删除状态,项目禁止登录,项目内所有资源(云主机、VPC路由器)会被停止
项目内的VPC路由器停止后,其上的网络服务将停止,云主机将不能访问外网。
登录时间限制:可选项,可设置项目内成员允许/禁止登录项目的时间段
若不设置,代表不限制登录时间。支持以下两种限制策略:按允许登录时间和按禁止登录时间。
- 允许登录时间:可设置每天/每周某几天项目内成员可登录项目的时间。设置后,项目内成员仅可在允许登录时间段内登录项目
- 禁止登录时间:可设置每天/每周某几天项目内成员不可登录项目的时间。设置后,项目内成员在禁止登录时间段内无法登录项目
- 若设置的时间段早于或包含当前云平台时间,限制策略在下个时间周期生效。
- 若同时设置了项目回收策略和登录时间限制策略,优先执行项目回收策略。
项目负责人:可选项,指定相应的用户作为项目负责人
成员:可选项,添加相关用户进入项目作为项目成员
部门:可选项,将项目加载到部门,加载后支持按部门计费
计费价目:可选项,选择项目使用的计费价目,留空不填将使用默认计费价目
安全组限制:默认禁用,若启用,项目成员创建云主机时将强制绑定安全组
- 启用安全组限制前,需确保项目拥有至少1个安全组配额。
- 启用安全组限制后,将为该项目创建一个默认安全组。
- 支持通过全局设置(项目安全组限制开关)全局控制创建项目时安全组限制功能的启用状态。默认禁用,若启用,将默认为项目启用安全组限制。
- 规则:可选项,启用安全组限制后,可在创建项目时直接设置安全组规则,也可在创建项目后设置
以项目模板为例,创建项目页面如创建项目所示:
在项目界面,平台管理员-SH创建的上海分公司的相应项目如图 16: 上海分公司的相应项目所示:
平台管理员-BJ登录云平台,构建北京分公司的组织架构,并创建相应的项目
同理,平台管理员-BJ登录云平台,构建北京分公司的组织架构,并创建相应的项目。
功能验证
独立区域管理场景搭建完成后,可通过以下几个方面进行验证:
平台管理员划分区域后,只可管控所在区域内的资源。
例如,平台管理员-SH只可管控上海区域内的资源,北京区域资源不可见,如图 17: 平台管理员-SH视角所示:
项目只可归属于一个区域,只可访问使用所属区域内的资源。
例如,平台管理员-SH创建的项目只可归属于上海区域,只可访问使用上海区域内的资源,如图 18: 平台管理员-SH视角所示:
项目成员只可访问使用所属项目内的资源。
例如,上海区域内的项目开发项目A-SH,项目负责人Jack、项目管理员Tom、项目成员Frank/John均只可访问使用开发项目A-SH内的资源。
admin可对所有区域进行巡查和管理。
本场景下,admin可对上海区域和北京区域进行巡查和管理,如图 19: admin视角所示:
项目管理
指定时间回收项目
ZStack Cloud支持多种回收策略和回收动作,本场景将结合指定时间回收的回收策略以及禁止项目内成员登录的回收动作进行验证。
示例验证步骤如下:
- 平台管理员-SH将某项目的项目周期设置为定时回收,回收策略设置为禁止登录;
- 该项目有效期限不足14天时,项目成员登录云平台后将收到项目即将过期的提醒信息;
- 该项目过期后,项目成员禁止登录此项目,项目内云主机仍正常运行;
- 平台管理员-SH将已过期的项目恢复后,项目正常登录,项目内相关资源正常运行。
假定客户场景如下:
上海某公司开发组项目A-SH项目,包括以下成员:Jack(项目负责人)、Tom(项目管理员)、Frank(普通项目成员)、John(普通项目成员)。为了按时间控制项目进度,选择指定时间回收项目。
平台管理员-SH将开发项目A-SH的回收策略设置为指定时间回收,回收动作设置为禁止项目内成员登录。
创建项目或已有项目均可对项目回收策略进行设置,本场景以已有项目修改回收策略为例。
平台管理员-SH从项目登录界面(http://management_node_ip:5000/#/project)登录云平台后,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 项目管理 > 项目,进入项目界面,点击开发项目A-SH展开其详情页,在总览子页面,将回收策略设置为指定时间回收,回收动作设置为禁止项目内成员登录。
该项目有效期限不足14天时,项目负责人(Jack)/项目管理员(Tom)/项目成员(John)登录云平台后将弹出项目即将过期的提醒信息。
该项目过期后,项目负责人(Jack)/项目管理员(Tom)/项目成员(John)均禁止登录此项目,项目内云主机仍正常运行。
开发项目A-SH过期后,项目负责人(Jack)/项目管理员(Tom)/项目成员(John)从项目登录界面(http://management_node_ip:5000/#/project)登录云平台后,禁止登录开发项目A-SH。
项目过期后,项目内云主机仍正常运行。
平台管理员-SH将已过期的项目恢复后,项目正常登录,项目内相关资源正常运行。
平台管理员-SH将已过期的项目恢复。
平台管理员-SH从项目登录界面(http://management_node_ip:5000/#/project)登录云平台后,进入项目界面,选中已过期的开发项目A-SH,点击更多操作 > 恢复过期项目,弹出恢复项目界面,重新设置回收策略相关信息,从而将已过期项目恢复。
项目正常登录,项目内相关资源正常运行。
项目负责人(Jack)/项目管理员(Tom)/项目成员(John)从项目登录界面(http://management_node_ip:5000/#/project)登录云平台后,开发项目A-SH恢复正常登录。
已过期的项目恢复后,项目内相关资源正常运行。
指定项目启用/禁用“安全组限制”功能
ZStack Cloud支持对指定项目灵活启用或禁用“安全组限制”功能,实现启用该功能时,项目内云主机强制绑定项目的默认安全组或自定义安全组;禁用该功能时,按需绑定/不绑定安全组,高效实现云主机通过安全组进行隔离。本文主要验证指定项目启用“安全组限制”功能以及指定项目禁用“安全组限制”功能两个场景。
假定客户场景1如下:
江苏某公司已使用业务网VPC-Network1创建了10台云主机运行常态业务(其中包括云主机A),并已配置防火墙以保障业务网安全。现由于业务激增,需使用同一业务网新增云主机运行激增业务,要求新增云主机与已有的常态业务云主机通过安全组实现网络隔离。公司成立项目组A负责此事,项目组A由一位项目负责人和两位普通项目成员组成,已预创建了普通项目成员角色。
指定项目启用“安全组限制”功能示例使用流程如下:
- admin打开全局设置安全组限制开关。
- admin创建项目组A,添加项目成员Jack、Rose,并绑定普通项目成员角色。
- admin将VPC-Network1指定共享给项目组A。
- 项目成员Jack和Rose使用VPC-Network1分别创建云主机B和云主机C,并绑定项目默认安全组。
- 验证云主机A和云主机B、云主机C是否已通过安全组进行网络隔离。
假定客户场景2如下:
浙江某公司成立项目组B,包含项目负责人Bob以及两个项目成员Tom、Jerry。公司指派该项目组使用业务网VPC-Network2运行10台云主机以承载重要业务(其中包括云主机A1),并通过配置防火墙保障业务网安全,云主机也通过绑定项目默认安全组实现精细化网络安全管控。现由于业务增加,要求项目组B使用同一业务网创建2台云主机运行新增业务,无需绑定安全组,实现与已有云主机网络隔离。
指定项目禁用“安全组限制”功能示例使用流程如下:
- admin关闭项目组B安全组限制”开关。
- 项目成员Tom和Jerry使用VPC-Network2分别创建云主机D和云主机F,不绑定安全组。
- 验证云主机D和云主机F与云主机A1是否已通过安全组进行网络隔离。
指定项目启用“安全组限制”功能
admin打开全局设置安全组限制开关。
在ZStack Cloud主菜单,点击设置 > 平台设置 > 全局设置 > 基本设置 > 运营管理 > 租户管理,修改项目安全组限制默认值为默认开启。
admin创建项目组A,添加项目成员Jack、Rose,并绑定普通项目成员角色。
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 项目管理 > 项目,进入项目界面,点击创建项目,弹出创建项目界面。
可参考以下示例输入相应内容:
名称:设置项目名称
简介:可选项,可留空不填
项目配置方式:项目配置方式可选择手动设置或使用项目模板,本次选择手动设置
配额设置:设置项目配额,对项目资源总量进行控制
- 计算资源:包括云主机数量、运行中云主机数量、CPU数量、GPU设备数量、内存、云主机调度策略数量、弹性裸金属实例的配额设置
- 存储资源:包括云盘快照数量、数据云盘数量、可用存储容量、镜像数量、所有镜像容量、备份数据、可用备份容量的配额设置。其中,备份数据和可用备份容量配置项需同时拥有灾备服务模块许可证
- 网络资源:包括VXLAN网络数量、三层网络数量、安全组数量、虚拟IP数量、弹性IP数量、端口转发数量、负载均衡器数量、监听器数量的配额设置
- 其他:包括定时任务数量、定时器数量、资源报警器、事件报警器、通知对象、标签的配额设置
所属区域:需指定项目所属的区域,一个项目只可归属于一个区域
回收策略:默认为无限制,也可选择指定时间回收或指定费用回收,本次选择无限制
登录时间限制:可选项,可设置项目内成员允许/禁止登录项目的时间段,本次选择不限制
项目负责人:可选项,指定相应的用户作为项目负责人
所属部门:可选项,将项目加载到部门,加载后支持按部门计费
计费价目:可选项,选择项目使用的计费价目,留空不填将使用默认计费价目
安全组限制:默认禁用,若启用,项目成员创建云主机时将强制绑定安全组
- 启用安全组限制前,需确保项目拥有至少1个安全组配额。
- 启用安全组限制后,将为该项目创建一个默认安全组。
- 支持通过全局设置(项目安全组限制开关)全局控制创建项目时安全组限制功能的启用状态。默认禁用,若启用,将默认为项目启用安全组限制。
- 规则:可选项,启用安全组限制后,可在创建项目时直接设置安全组规则,也可在创建项目后设置
进入项目组A详情页,点击成员 > 添加项目成员,弹出添加成员弹窗,将Jack和Rose添加为项目成员,并绑定普通项目成员角色。
admin将VPC-Network1指定共享给项目组A。
在ZStack Cloud主菜单,点击资源中心 > 网络资源 > VPC网络,选择网络VPC-Network1,指定共享给项目组A。
项目成员Jack和Rose使用VPC-Network1分别创建云主机B和云主机C,并绑定默认安全组。
Jack和Rose分别以项目成员的身份登录云平台,在ZStack Cloud主菜单,点击资源中心 > 云资源池 > 虚拟资源 > 云主机,进入云主机界面。支持标准创建和快捷创建,本次选择快捷创建。
可参考以下示例输入相应内容:
名称:设置私有云云主机的名称
简介:可选项,可留空不填
数量:设置云主机数量
标签:可选项,可为云主机绑定一个或多个标签
计算规格:选择云主机的计算规格
镜像:选择创建云主机所需要的镜像
根云盘规格:选择根云盘规格
数据云盘:按需添加数据云盘
网络配置:配置网络和网络服务相关参数,支持添加多条网络配置。需要配置以下参数:
- 网络:选择创建云主机使用的三层网络,支持:VPC网络、公有网络、扁平网络。本次选择admin共享的VPC-Network1
- 设置默认网络:选择一个网络作为云主机的默认网络
- 启用SR-IOV:可选项,使用SR-IOV网卡虚拟化功能,为云主机透传一张VF类型的网卡。默认不启用此功能,若具备硬件条件可开启此功能
- 指定IP:可选项,可自定义指定云主机网卡的IP地址。默认不指定,通过DHCP自动分配
- MAC地址:可选项,可自定义配置云主机MAC地址。默认不启用该功能,由系统自动分配
- 安全组:必选项,选择项目默认安全组
- 弹性IP:可选项,可为云主机绑已有弹性IP
User Data:支持导入 User Data,即用户自定义数据。通过上传自定义的参数或脚本,对主机做一些定制化配置或完成特定任务
点击 确定,创建云主机。
验证云主机B和云主机C与云主机A是否已通过安全组进行网络隔离。
分别进入云主机B和云主机C系统,通过ping命令验证与云主机A的网络连通性。
指定项目禁用“安全组限制”功能
admin关闭项目组B安全组限制”开关。
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 项目,进入项目页面。点击项目组B,进入项目组B的总览页,关闭项目安全组限制开关。
项目成员Tom和Jerry使用VPC-Network2分别创建云主机D和云主机F,不绑定安全组。
Tom和Jerry分别以项目成员的身份登录云平台,在ZStack Cloud主菜单,点击资源中心 > 云资源池 > 虚拟资源 > 云主机,进入云主机界面。支持标准创建和快捷创建,本次选择快捷创。
可参考以下示例输入相应内容:
名称:设置私有云云主机的名称
简介:可选项,可留空不填
数量:设置云主机数量
标签:可选项,可为云主机绑定一个或多个标签
计算规格:选择云主机的计算规格
镜像:选择创建云主机所需要的镜像
根云盘规格:选择根云盘规格
数据云盘:按需添加数据云盘
网络配置:配置网络和网络服务相关参数,支持添加多条网络配置。需要配置以下参数:
- 网络:选择创建云主机使用的三层网络,支持:VPC网络、公有网络、扁平网络。本次选择admin共享的VPC-Network1
- 设置默认网络:选择一个网络作为云主机的默认网络
- 启用SR-IOV:可选项,使用SR-IOV网卡虚拟化功能,为云主机透传一张VF类型的网卡。默认不启用此功能,若具备硬件条件可开启此功能
- 指定IP:可选项,可自定义指定云主机网卡的IP地址。默认不指定,通过DHCP自动分配
- MAC地址:可选项,可自定义配置云主机MAC地址。默认不启用该功能,由系统自动分配
- 安全组:可选项,本次不绑定安全组
- 弹性IP:可选项,可为云主机绑已有弹性IP
User Data:支持导入 User Data,即用户自定义数据。通过上传自定义的参数或脚本,对主机做一些定制化配置或完成特定任务
点击 确定,创建云主机。
验证云主机D和云主机F与云主机A1是否已通过安全组进行网络隔离。
分别进入云主机D和云主机F系统,通过ping命令验证与云主机A的网络连通性。
工单管理
介绍
工单管理是租户管理提供的子功能之一。
为了更高效地为每个项目提供基础资源支持,项目成员(项目负责人/项目管理员/普通项目成员)可对云平台资源提出工单申请,根据每个项目自定义工单审批流程,对工单进行审批,最终由admin/项目负责人/部门运营管理员/自定义审批人员进行审批,支持申请云主机、删除云主机、修改云主机配置、修改项目周期和修改项目配额五种工单类型。
ZStack Cloud主要包括以下几种类型的工单流程:
默认流程:项目成员提交工单—>admin审批工单。此流程适用于以下几种场景:
- 未设置工单流程的工单,将使用默认流程提交工单。
- 修改项目周期类型的工单,将使用默认流程提交工单。
- 修改项目配额类型的工单,将使用默认流程提交工单。
- 删除自定义工单流程,将使用默认流程自动重新提交工单。
自定义流程:项目成员提交工单—>自定义审批工单—>admin/项目负责人/部门运营管理员审批工单。此流程适用于以下几种场景:
- 申请云主机、删除云主机、修改云主机配置类型的工单,优先使用设置的自定义工单流程提交工单。
- 修改有效状态的工单流程,将使用修改后的自定义工单流程自动重新提交工单。
- 修改已失效状态的工单流程,需要使用修改后的自定义工单流程手动重新提交工单。
前提
使用工单管理功能,需提前准备以下工作:
admin请提前安装最新版本ZStack Cloud,并部署完成创建云主机必要的资源。
详情可参考《用户手册》安装部署章节。
admin请提前购买租户管理模块许可证,安装租户管理模块。
详情可参考《许可(license)更新说明》。
admin/平台成员请提前创建用户,构建组织架构树,并基于组织中的用户创建相关项目。
详情可参考《租户管理使用教程》。
默认审批流程
工单审批的默认审批流程为:项目成员提交工单—>admin审批工单。
默认审批流程将通过以下几个场景介绍:
工单修改项目周期
本场景将使用默认审批流程,以提交工单修改项目周期为例,结合工单审批过程中撤销、驳回、重新提交、admin通过工单、删除工单等工单审批过程中涉及到的操作进行介绍。
示例使用流程如下:
- Frank(普通项目成员)提交工单
- Frank(普通项目成员)撤回工单
- admin驳回工单
- Frank(普通项目成员)重新提交工单
- admin通过工单并修改项目周期
- Frank(普通项目成员)删除已处理工单
假定客户场景如下:
上海某公司开发组项目A-SH项目,包括以下成员:Jack(项目负责人)、Tom(项目管理员)、Frank(普通项目成员)、John(普通项目成员)。因项目(指定时间回收)即将到期,所以通过工单申请的方式修改项目周期。
Frank(普通项目成员)提交工单
Frank所在项目(指定时间回收)即将到期,因项目运行较好续费第二期,所以他决定通过工单审批的方式修改项目周期,继续使用项目资源。提交工单的流程如下:
Frank(普通项目成员)从项目登录界面(http://management_node_ip:5000/#/project)登录云平台,进入项目,在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 工单审批 > 我的工单,进入我的工单界面,点击创建工单按钮,可参考以下示例输入相应内容:
工单信息:设置工单相关基础信息
- 工单类型:选择修改项目周期工单类型
申请内容:设置工单申请内容:
工单名称:设置工单名称
备注:可选项,可留空不填
申请人:默认显示工单申请人的用户名
申请项目:默认显示项目成员当前进入的项目
申请内容:设置申请的工单内容信息,具体包括:
- 项目回收策略:默认显示指定时间回收
- 当前截止时间:默认显示项目截至时间
- 申请截至时间:设置新的截至时间
当前仅指定时间回收的项目支持此操作,若使用其他回收策略,工单类型不显示修改项目周期选项。
Frank(普通项目成员)撤回工单
Frank发现修改项目周期的工单创建重复了,决定撤回工单:修改项目周期,撤回工单步骤如下所示:
勾选需要撤回的工单(修改项目周期),点击撤回按钮,在弹出的撤回工单对话框中,添加备注信息,点击确定按钮,撤回工单。如图 32: 撤回工单所示:
工单撤回后,将在已处理页面显示,状态为已撤回。
admin驳回工单
Frank提交的工单将直接走到admin,已撤回的工单admin不可见。admin从主登录界面(http://management_node_ip:5000/#/login)登录云平台后,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 工单审批 > 我的审批按钮,进入我的审批界面的待办事项子页面,如图 33: admin-我的审批所示:
admin认为Frank申请的项目周期太大,驳回了该工单。在我的审批页面勾选该工单,点击操作栏 X 号按钮,如图 34: admin-驳回工单所示:
点击确定按钮,驳回工单。工单驳回后,可在已办事项中查看。
Frank(普通项目成员)重新提交工单
Frank被驳回的工单将进入我的工单的已处理子页面,如图 35: 被驳回的工单所示:
点击该工单名称,可在工单详情页的处理记录子页面查看工单记录,以及备注信息,如图 36: 工单详情页所示:
此时,Frank需要重新提交工单,并按照admin的备注修改工单内容。选择已驳回的目标工单,点击重新提交,弹出重新提交界面,修改完成后,点击确定按钮,完成工单重新提交。重新提交后,工单继续回到admin审批阶段,并显示在已提交页面。
admin通过工单并修改项目周期
admin重新收到Frank的工单申请,查看后无误,决定通过此工单并修改项目周期。admin进入我的审批界面的待办事项子页面,勾选该工单,点击通过按钮,在弹出的通过工单窗口,点击确定按钮通过工单并修改项目周期。如图 37: 通过工单所示:
admin通过工单后,修改项目周期申请立即生效。
审批结束后,工单流程中的处理人支持在工单详情页查看日志,若执行失败,请根据日志提示排查原因。如图 38: 查看日志所示:
Frank(普通项目成员)删除已处理工单
工单提交人删除已处理的工单后,admin可在已归档页面查看该条工单信息。
Frank进入已处理页面,选中已处理的工单,点击删除按钮,在弹出的删除界面,点击确定按钮,删除工单。如图 39: Frank(普通项目成员)删除已处理工单所示:
admin可进入我的审批界面的已归档子页面查看Frank(普通项目成员)已删除的工单记录,并查看工单详情。如图 40: admin-已归档所示:
工单修改项目配额
本场景将使用默认审批流程,以修改项目配额为例,介绍项目负责人提交工单场景。支持修改的配额如下:
| 配额类型 | 配额条目 |
|---|---|
| 计算资源 | 云主机数量 |
| 运行中云主机数量 | |
| CPU数量 | |
| 内存 | |
| GPU设备数量 | |
| 云主机调度策略数量 | |
| 存储资源 | 云盘快照数量 |
| 数据云盘数量 | |
| 可用存储容量 | |
| 镜像数量 | |
| 所有镜像容量 | |
| 备份数量(需拥有灾备服务模块许可证) | |
| 可用备份容量(需拥有灾备服务模块许可证) | |
| 网络资源 | VXLAN网络数量 |
| 三层网络数量 | |
| 安全组数量 | |
| 虚拟IP数量 | |
| 弹性IP数量 | |
| 端口转发数量 | |
| 负载均衡器数量 | |
| 监听器数量 | |
| 其他 | 定时任务数量 |
| 定时器数量 | |
| 资源报警器 | |
| 事件报警器 | |
| 接收端 | |
| 标签 |
示例使用流程如下:
- Jack(项目负责人)提交工单
- admin通过工单并修改项目配额
假定客户场景如下:
上海某公司开发组项目A-SH项目,包括以下成员:Jack(项目负责人)、Tom(项目管理员)、Frank(普通项目成员)、John(普通项目成员)。因项目配额不足,所以通过工单申请的方式修改项目配额。
Jack(项目负责人)提交工单
Jack所在项目(开发组项目A-SH)因配额不足,无法创建资源,所以他决定通过工单审批的方式修改项目配额。提交工单的流程如下:
Jack(项目负责人)从项目登录界面(http://management_node_ip:5000/#/project)登录云平台,进入项目,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 工单审批 > 我的工单按钮,在我的工单界面,点击创建工单按钮,可参考以下示例输入相应内容:
工单信息:设置工单相关基础信息
- 工单类型:选择修改项目配额工单类型
申请内容:设置工单申请配额的内容,支持添加多条:
名称:设置工单名称
备注:可选项,可留空不填
申请人:默认显示工单申请人的用户名
申请项目:默认显示项目成员当前进入的项目
申请配置:选择对应类型需要修改配额的条目,详情请参考表 6: 支持修改配额列表。
- 配额类型:选择配额类型,包括:计算资源、存储资源、网络资源、其他
- 当前配额:默认显示当前配额
- 申请配额:输入申请的配额,需大于当前配额
admin通过工单并修改项目配额
admin收到Jack的工单,查看后无误,决定通过此工单并修改项目配额。admin进入我的审批界面的待办事项子页面,勾选该工单,点击通过按钮,在弹出的通过工单窗口,点击确定按钮通过工单并修改项目周期。如图 42: 通过工单所示:
admin通过工单后,修改项目配额申请立即生效。
审批结束后,工单流程中的处理人支持在工单详情页查看日志,若执行失败,请根据日志提示排查原因。如图 43: 查看日志所示:
自定义审批流程
自定义工单审批流程为:项目成员提交工单—>自定义审批工单—>admin/项目负责人/部门运营管理员审批工单。
自定义审批流程将通过以下几个场景介绍:
工单删除云主机
本场景将以提交工单删除云主机为例,使用admin通过工单,介绍正常通过审批的情况下,自定义审批的基本流程。
若使用工单删除云主机,建议admin将普通项目成员的删除云主机权限(DestroyVmInstance)、恢复云主机权限(RecoverVmInstance)禁用,如图 44: 禁用权限所示:
可通过以下方法进行禁用删除云主机权限:
- 若新创建角色,进入配置角色权限步骤,在权限服务云主机相关接口中进行配置。
- 若已有角色,进入角色详情页的界面权限和API权限子页面,点击修改按钮进行修改。
示例使用流程如下:
- admin创建工单流程
- John(普通项目成员)提交工单
- Frank(一级审批)通过工单
- Jack(项目负责人)通过工单
- admin通过工单并删除云主机
假定客户场景如下:
上海某公司开发组项目A-SH项目,包括以下成员:Jack(项目负责人)、Tom(项目管理员)、Frank(普通项目成员)、John(普通项目成员)。因项目成员没有删除云主机权限,无法删除云主机,只能通过工单申请的方式删除云主机。
admin创建工单流程
admin从主登录界面(http://management_node_ip:5000/#/login)登录云平台后,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 工单审批 > 流程管理,进入流程管理界面,点击创建工单流程按钮,进入创建工单流程界面,可参考以下示例输入相应内容:
名称:输入工单流程名称
简介:可选项,可留空不填
项目:选择一个项目
工单类型:选择删除云主机
流程设置:展示工单流程详情
初始流程设置界面包括最基本的两个步骤:提交工单—>执行环节,执行环节支持选择admin、项目负责人、部门运营管理员作为责任人。
执行环节:选择部署责任人,支持admin、项目负责人、部门运营管理员
执行环节不同责任人的区别如下:
- 执行环节为admin时,自定义审批流程中必须添加环节;执行环节为项目负责人时/部门运营管理员,自定义审批流程中可以不添加环节。
- 申请云主机类型的工单,admin通过并部署云主机,可以通过高级部署按钮,进行高级设置;项目负责人通过工单,部署云主机时,不能进行高级设置。
如果需要添加环节,请在流程中点击加号按钮即可。可参考以下示例输入相应内容:
- 环节名称:输入新增环节的名称
- 处理人:选择工单审批处理人。指定项目后,工单流程的处理人将从该项目中选择
- 点击已添加的工单环节后面的删除符号,可删除这条环节。
- 点击添加环节可继续添加审批环节,所有环节添加完成后,点击确定按钮,完成工单流程创建。
本场景以admin作为执行环节,根据以上创建步骤创建自定义流程为:John(普通项目成员)提交工单—Frank(一级审批)—>Jack(项目负责人审批)—>admin审批。
John(普通项目成员)提交工单
John想要删除两台云主机,因没有删除云主机权限,他决定通过工单审批的方式删除云主机。提交工单的流程如下:
从项目登录界面(http://management_node_ip:5000/#/project)登录云平台,进入项目,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 工单审批 > 我的工单,进入我的工单界面,点击创建工单按钮,可参考以下示例输入相应内容:
工单信息:设置工单相关基础信息
- 工单类型:选择删除云主机工单类型
申请内容:选择需要删除云主机
- 名称:设置工单名称
- 备注:可选项,可留空不填
- 申请人:默认显示工单申请人的用户名
- 申请项目:默认显示项目成员当前进入的项目
- 申请资源:选择需要删除的云主机
John通过上述流程创建了一个工单:删除云主机,该工单会按照自定义审批流程,首先走到Frank(一级审批),如图 47: 创建工单完成所示:
Frank(一级审批)通过工单
Frank认为John删除云主机的要求合理,通过审批。
Frank从项目登录界面(http://management_node_ip:5000/#/project)登录云平台,进入项目,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 工单审批 > 我的审批按钮,在我的审批界面的待办事项子页面,勾选这条工单,点击通过按钮,在弹出的通过工单页面,填写备注信息,点击确定按钮,审批通过该工单,如图 48: Frank通过审批所示:
Frank(一级审批)审批完成后,工单将进入已办事项页面,工单流程将进入下一审批环节。
Jack(项目负责人)通过工单
Jack认为John删除云主机的要求合理,通过审批。
审批方式与一级审批相同。进入我的审批界面的待办事项子页面,勾选这条工单,点击通过按钮,在弹出的通过工单页面,填写备注信息,点击确定按钮,审批通过该工单。
admin通过工单并删除云主机
admin认为John删除云主机的要求合理,通过审批。
admin从主登录界面(http://management_node_ip:5000/)登录云平台,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 工单审批 > 我的审批按钮,进入我的审批界面的待办事项子页面,勾选该工单,点击通过按钮,在弹出的通过工单窗口,点击确定按钮,通过工单并删除云主机。如图 49: 通过工单所示:
admin通过工单后,删除云主机的申请立即生效。
审批结束后,工单流程中的处理人支持在工单详情页查看日志,若执行失败,请根据日志提示排查原因。如图 50: 查看日志所示:
- 删除云主机采用延时删除策略,删除后云主机变更到已删除列表,支持恢复操作。
- 若需要彻底删除,需要手动彻底删除或根据全局设置(管理员设置)中的彻底删除时延生效。
工单申请云主机
本场景将以提交工单申请云主机为例,使用admin通过工单,结合自定义工单审批过程中涉及到的工单流程变更、删除工单流程等自定义工单审批过程中涉及到的操作介绍。
若使用工单申请云主机,建议admin将普通项目成员的创建云主机权限(CreateVmInstance)禁用,如图 51: 禁用创建云主机权限所示:
可通过以下方法进行禁用创建云主机权限:
- 若新创建角色,进入配置角色权限步骤,在权限服务云主机相关接口中进行配置。
- 若已有角色,进入角色详情页的界面权限和API权限子页面,点击修改按钮进行修改。
示例使用流程如下:
- admin创建工单流程
- John(普通项目成员)提交工单
- Frank(一级审批)通过工单
- 工单流程失效
- admin修改工单流程
- John(普通项目成员)重新提交工单
- 完成审批流程
- admin删除工单审批流程
假定客户场景如下:
上海某公司开发组项目A-SH项目,包括以下成员:Jack(项目负责人)、Tom(项目管理员)、Frank(普通项目成员)、John(普通项目成员)。因项目成员没有创建云主机权限,无法创建云主机,只能通过工单申请的方式创建云主机。
admin创建工单流程
admin从主登录界面(http://management_node_ip:5000/#/login)登录云平台后,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 工单审批 > 流程管理,进入流程管理界面,点击创建工单流程按钮,进入创建工单流程界面,可参考以下示例输入相应内容:
名称:输入工单流程名称
简介:可选项,可留空不填
项目:选择一个项目
工单类型:选择申请云主机
流程设置:展示工单流程详情
初始流程设置界面包括最基本的两个步骤:提交工单—>执行环节,执行环节支持选择admin、项目负责人、部门运营管理员作为责任人。
执行环节:选择部署责任人,支持admin、项目负责人、部门运营管理员
执行环节不同责任人的区别如下:
- 执行环节为admin时,自定义审批流程中必须添加环节;执行环节为项目负责人/部门运营管理员时,自定义审批流程中可以不添加环节。
- 申请云主机类型的工单,admin通过并部署云主机,可以通过高级部署按钮,进行高级设置;项目负责人通过工单,部署云主机时,不能进行高级设置。
如果需要添加环节,请在流程中点击加号按钮即可。可参考以下示例输入相应内容:
- 环节名称:输入新增环节的名称
- 处理人:选择工单审批处理人。指定项目后,工单流程的处理人将从该项目中选择
- 点击已添加的工单环节后面的删除符号,可删除这条环节。
- 点击添加环节可继续添加审批环节,所有环节添加完成后,点击确定按钮,完成工单流程创建。
本场景以admin作为执行环节,根据以上创建步骤创建自定义流程为:John(普通项目成员)提交工单—Frank(一级审批)—>Jack(项目负责人审批)—>admin审批。
John(普通项目成员)提交工单
John急需一台云主机,因没有创建云主机权限,他决定通过工单审批的方式申请所需的云主机。提交工单的流程如下:
从项目登录界面(http://management node_ip:5000/#/project)登录云平台,进入项目,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 工单审批 > 我的工单,进入我的工单界面,点击创建工单按钮,可参考以下示例输入相应内容:
创建工单:设置工单相关基础信息
- 工单类型:选择申请云主机工单类型
- 虚拟化技术:支持选择创建KVM/ESX云主机,本场景下选择创建KVM云主机
申请内容分为以下步骤:
工单信息:
- 名称:设置工单名称
- 备注:可选项,可留空不填
- 申请人:默认显示工单申请人的用户名
- 申请项目:默认显示项目成员当前进入的项目
基础配置:
名称:设置云主机名称
简介:可选项,可留空不填
数量:设置申请的云主机数量
计算规格:选择创建云主机的计算规格
镜像:选择创建云主机的镜像
数据云盘:可选项,可为云主机创建并加载数据云盘
- 数据云盘规格:选择云平台已有的数据云盘规格
- VirtioSCSI:可选项,可为云主机创建VirtioSCSI类型的数据云盘
高级:创建云主机时,可对云主机进行高级配置,高级配置均为可选项
资源配置:
- 网络:选择创建云主机的网络
- GPU设备:可选项,通过指定规格或指定设备方式为云主机加载GPU设备
系统配置:
- SSH公钥:云主机注入SSH公钥后,用户可SSH免密登录运行中的云主机
- User Data:支持导入User Data,即用户自定义数据,通过上传自定义的参数或脚本,对主机做一些定制化配置或完成特定任务
- 控制台密码:设置控制台密码,长度为6-18位
- 控制台模式:打开控制台使用的模式,支持VNC、SPICE、VNC+SPICE,默认为VNC
John通过上述流程创建了一个工单:申请云主机,该工单会按照自定义审批流程,首先走到Frank(一级审批),如图 54: 创建工单完成所示:
Frank(一级审批)通过工单
Frank认为John申请的云主机要求合理,通过审批。
Frank从项目登录界面(http://management_node_ip:5000/#/project)登录云平台,进入项目,在ZStack Cloud私有云主菜单,点击运营管理 > 租户管理 > 工单审批 > 我的审批按钮,在我的审批界面的待办事项子页面,勾选这条工单,点击通过按钮,在弹出的通过工单页面,填写备注信息,点击确定按钮,审批通过该工单,如图 55: Frank通过审批所示:
Frank(一级审批)审批完成后,工单将进入已办事项页面,工单流程将进入下一审批环节。
工单流程失效
工单流程中的某环节审批人被删除或移除项目时,工单流程失效。该项目内所有未走完工单将被驳回。
恰巧,此时Frank离开了这个开发项目,Jack(项目管理员)将Frank从项目移除。此时,工单流程失效。流程失效后,John提交的工单将被驳回;且admin看到工单流程就绪状态将显示为无效,如图 56: admin-工单流程失效所示:
此时,John重新提交工单会报错,需等admin修改审批流程后,才能重新提交工单。
admin修改工单流程
admin进入流程管理界面,点击更多操作 > 修改工单流程按钮,如图 57: 修改工单流程所示:
进入修改工单流程后,删除Frank(一级审批),删除后可点击添加环节按钮添加新的环节,本场景仅删除但不添加新流程。admin工单流程修改完成后,点击确定按钮,将保存新的工单流程,此时,admin会看到工单流程就绪状态将变为有效。
- 如果修改工单流程前工单流程状态为有效,重新修改工单流程后,所有采用该流程审批将按照新流程重新开始进行。
- 如果修改工单流程前工单流程状态为无效,重新修改工单流程后,原被驳回的工单需要手动重新提交。
John(普通项目成员)重新提交工单
因为工单流程中成员被删除导致的John被驳回的工单将进入我的工单的已处理子页面,John需要进入此页面,勾选该工单,点击重新提交按钮,重新提交工单。
完成审批流程
重新提交工单后,该工单会重新回到已提交页面,并使用新流程重新进行。Jack(项目负责人审批)、admin依次通过审批后,将自动部署John申请的云主机。
admin通过工单后,申请的云主机将自动部署到项目。
审批结束后,工单流程中的处理人支持在工单详情页查看日志,若执行失败,请根据日志提示排查原因。如图 58: 查看日志所示:
至此,一套完整的自定义工单审批流程就结束了,John可以自由使用申请到的云主机,当然,这个云主机属于John所在的项目。
admin删除工单审批流程
此外,自定义工单审批流程中还会遇到admin删除工单审批流程的场景。
如果工单未完成时,admin删除了工单审批流程,使用此流程的项目将使用默认流程(提交->admin),所有正在使用此流程的工单 将按默认流程重新提交。如图 59: 删除工单流程所示:
John根据工单流程,又重新提交了一个工单,但工单还没走完时,admin进入流程管理界面,删除了John所在项目的工单流程,John的工单将自动使用默认流程(提交->admin)重新提交,如图 60: John工单按默认流程重新提交所示:
统一认证SSO
前提
使用统一认证SSO功能,需要提前准备以下工作:
- 提前准备好需要添加的服务器,若拥有两个服务器,支持主备无缝切换。
- 提前安装最新版本ZStack Cloud,具体方式请参考《用户手册》安装部署章节。
- 此功能依赖租户管理模块,请提前购买租户管理模块许可证,安装租户管理模块。详情可参考《许可证(License)更新说明》。
登录说明
添加OIDC、OAuth2、CAS或SAML统一认证服务器后,打开云平台登录页面时,默认选中统一身份认证登录。单击以统一认证服务器名称显示的登录按钮后,页面将跳转至对应的统一认证系统;完成身份验证后,自动返回云平台。若需使用本地用户登录,可切换至本地登录。
若统一认证服务器生成了云平台免密登录URL,统一认证用户也可通过该URL从统一门户等业务应用系统免密登录云平台。
AD用户创建云主机
ZStack Cloud支持对接AD/LDAP统一认证系统,实现AD/LDAP用户登录云平台,操作云平台资源。本场景介绍AD用户如何登录云平台并创建云主机。AD用户创建云主机的基本示例流程如下:
- ZStack Cloud云平台管理员(admin)在云平台上添加AD认证服务器
- AD用户登录云平台
- AD用户创建云主机
假定客户场景如下:
| 名称 | 参数 |
|---|---|
| 主服务器IP/域 | 172.24.254.21 |
| SSL/TLS加密 | 支持 |
| 主服务器端口 | 389 |
| 基本DN | dc=adtest,dc=zs |
| 用户DN | CN=Administrator,CN=Users,DC=adtest,DC=zs |
| 密码 | password |
| 过滤规则 | (&(name=filterName)(description=departure)) |
| 云平台参数 | AD参数 |
|---|---|
| 登录属性 | cn |
| 用户名 | cn |
| 姓名 | name |
| 手机号 | telephoneNumber |
| 邮箱 | |
| 编号 | employeeID |
| 简介 | description |
| 云平台参数 | AD参数 |
|---|---|
| 组织映射方式 | Group |
| 组织名称 | cn |
| 组织简介 | description |
ZStack Cloud云平台管理员(admin)在云平台上添加AD认证服务器
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 统一认证SSO,进入统一认证SSO界面,点击添加统一认证服务器,在云平台添加AD认证服务器。
请参考以下示例输入相应内容:
选择服务器类型:此处选择AD服务器
配置AD服务器:设置AD服务器相关的基本信息和配置信息
可参考以下示例输入相应内容:
名称:自定义AD服务器名称
简介:可选项,设置备注信息或简介信息
类型:已选择AD
主服务器IP/域:输入主AD服务器IP地址或域
主服务器端口:输入主AD服务器对应的端口
SSL/TLS加密:选择是否开启SSL/TLS加密,默认开启
- 勾选表示使用SSL/TLS加密,此方式默认使用636端口,支持自定义修改。
- 不勾选表示不使用任何加密方式,此方式默认使用389端口,支持自定义修改。
备服务器IP/域:可选项,输入备AD服务器IP地址
备服务器端口:可选项,输入备AD服务器对应的端口
配置信息:配置同步AD用户范围相关配置信息,需要设置以下参数:
基本DN:输入基本DN,用于检索AD用户及组织架构的根节点,规定同步AD用户及组织架构的范围
用户DN:输入用户DN,拥有查询基本DN范围内所有用户权限的特殊用户,用于登录AD服务器并获取相关数据
密码:用户DN对应的登录密码
过滤策略:选择是否在同步用户信息时进行过滤,默认不过滤。若打开开关,可配置过滤机制与过滤规则
过滤机制:支持黑名单和白名单两种过滤机制
- 若选择黑名单,同步用户信息时,过滤规则中配置的用户信息将不会同步至云平台。
- 若选择白名单,同步用户信息时,只有在过滤规则中配置的用户信息才会同步至云平台。
过滤规则:用于过滤基本DN中的用户
- 过滤规则输入长度受AD服务器配置限制,超出限制可能导致过滤规则不生效,请提前确认。
- 过滤规则输入语法与AD过滤语法一致,详情请参考微软官方链接。
- 例如:若过滤机制选择黑名单,过滤规则设置为(&(name=filterName)(description=departure)),表示过滤基本DN中name=filterName且description=departure的用户。
AD服务器配置完成后,点击下一步按钮,自动测试连接并进入下一步,或点击测试连接按钮,手动检测配置正确性以及AD服务器连通性。
- 若测试成功,点击下一步按钮,继续设置其他参数。
- 若测试失败,请参考右上角报错信息修改配置并重新测试,直到测试成功。
映射规则:设置登录属性以及AD与云平台间的用户映射、组织映射
可参考以下示例输入相应内容:
登录属性(用于AD认证):指定用于云平台登录的AD用户属性
例如:若使用cn作为登录属性,AD用户可使用cn相应的value(例如:xiaoming)作为云平台登录名。
用户映射规则:选择或输入AD用户与云平台用户之间的映射关系,需要设置以下参数:
用户名:设置云平台用户的用户名与AD用户的用户名映射关系
例如:若用户名映射cn,云平台创建用户的用户名将使用cn相应的value(例如:xiaoming)。
ZStack Cloud云平台中用户的用户名不能重复,若同步AD用户与云平台原有用户名重复,系统将自动为同步过来AD用户的用户名增加随机码。
姓名:设置云平台用户的姓名与AD用户的姓名映射关系
例如:若姓名映射name,云平台创建用户的姓名将使用name相应的value(例如:xiaozhang)。
手机号:可选项,设置云平台用户的手机号与AD用户的手机号映射关系
例如:若手机号映射telephoneNumber,云平台创建用户的手机号将使用telephoneNumber相应的value(例如:13800000000)。
邮箱:可选项,设置云平台用户的邮箱与AD用户的邮箱映射关系
例如:若邮箱映射mail,云平台创建用户的邮箱将使用mail相应的value(例如:xxx@xxx.xx)。
编号:可选项,设置云平台用户的编号与AD用户的编号映射关系
例如:若编号映射employeeID,云平台创建用户的编号将使用employeeID相应的value(例如:001)。
简介:可选项,设置云平台用户的简介与AD用户的简介映射关系
例如:若简介映射description,云平台创建用户的简介将使用description相应的value(例如:开发部-小明)。
自定义属性:自定义用户映射属性,需要设置以下参数:
- 系统用户属性:设置系统用户属性,可与原有属性重复,例如:工号
- AD/LDAP用户属性:设置AD用户属性,例如:employeeID
同步组织映射:选择是否同步映射组织,默认不勾选;勾选后,同时将用户基本DN范围内的AD组织同步到云平台组织列表
映射组织方式:选择映射组织方式,用于划分AD中的用户账号
- Group:通过Group参数区分组织架构树的子节点,将AD组织同步到云平台组织列表(推荐);
- OU:通过OU参数区分组织架构树的子节点,将AD组织同步到云平台组织列表。
组织映射关系:按照Group或OU方式,将用户基本DN范围内的AD组织同步到云平台组织列表,需要设置以下参数:
名称:设置云平台组织的组织名称与AD组织的组织名称映射关系
例如:若组织名称映射cn,云平台创建组织的组织名称将使用cn相应的value(例如:开发部)。
简介:可选项,设置云平台组织的组织简介与AD组织的组织简介映射关系
例如:若组织简介映射description,云平台创建组织的组织简介将使用description相应的value(例如:开发部-后端)
点击下一步按钮,系统将自动测试登录属性、用户映射、组织映射是否可以建立,成功后,自动添加映射规则。
填写AD映射参数对应的值不能为空,否则可能导致测试失败。若测试失败,请根据报错信息修改后重新点击下一步按钮,直到测试并添加映射规则成功。
确认提交:查看将要添加AD服务器的相关信息,支持跳转修改
点击确定按钮,将根据设置的配置添加AD服务器,并创建统一认证用户、添加组织架构。
AD用户登录云平台
将AD用户加入项目并分配权限,然后使用Chrome浏览器或FireFox浏览器打开项目登录界面(http://management_node_ip:5000/#/project),并切换到AD/LDAP用户登录选项,输入登录属性对应的用户名及密码登录云平台。
- 除登录方式外,统一认证用户与云平台本地用户没有任何区别,支持加入项目、加入部门、配置权限等租户管理常规操作。
- 将统一认证用户加入项目并分配权限才能正常使用,否则登录后显示空白页。
AD用户创建云主机
AD用户登录云平台后,点击资源中心 > 云资源池 > 虚拟资源 > 云主机,进入云主机页面,使用快捷方式创建云主机。详细可参考创建云主机(快捷创建)。
至此,AD用户创建云主机介绍完成。
LDAP用户创建云主机
ZStack Cloud支持对接AD/LDAP统一认证系统,实现AD/LDAP用户登录云平台,操作云平台资源。本场景介绍LDAP用户如何登录云平台并创建云主机。LDAP用户创建云主机的基本示例流程如下:
- ZStack Cloud云平台管理员(admin)在云平台上添加LDAP认证服务器
- LDAP用户登录云平台
- LDAP用户创建云主机
假定客户场景如下:
| 名称 | 参数 |
|---|---|
| 主服务器IP/域 | 172.20.198.123 |
| SSL/TLS加密 | 不支持 |
| 主服务器端口 | 389 |
| 基本DN | dc=mevoco,dc=com |
| 用户DN | cn=Manager,dc=mevoco,dc=com |
| 密码 | password |
| 过滤规则 | (&(name=filterName)(description=departure)) |
| 云平台参数 | LDAP参数 |
|---|---|
| 登录属性 | cn |
| 用户名 | cn |
| 姓名 | cn |
| 手机号 | mobile |
| 邮箱 | |
| 编号 | employeeNumber |
| 简介 | description |
ZStack Cloud云平台管理员(admin)在云平台上添加LDAP认证服务器
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 统一认证SSO,进入统一认证SSO界面,点击添加统一认证服务器,在云平台添加LDAP认证服务器。
请参考以下示例输入相应内容:
选择服务器类型:此处选择LDAP服务器
配置LDAP服务器:设置LDAP服务器相关的基本信息和配置信息。
可参考以下示例输入相应内容:
基本信息:配置用于添加LDAP服务器的基本信息,需要设置以下参数:
类型:已选择LDAP
名称:自定义LDAP服务器名称
简介:可选项,设置备注信息或简介信息
主服务器IP/域:输入主LDAP服务器IP地址或域
SSL/TLS加密:选择是否开启SSL/TLS加密,默认开启
- 勾选表示使用SSL/TLS加密,此方式默认使用636端口,支持自定义修改。
- 勾选后,云平台访问LDAP认证服务器时默认会检查SSL证书,支持通过全局设置SSL证书检查开关设置是否跳过检查。
- 不勾选表示不使用任何加密方式,此方式默认使用389端口,支持自定义修改。
主服务器端口:输入主LDAP服务器对应的端口
备服务器IP/域:可选项,输入备LDAP服务器IP地址
备服务器端口:可选项,输入备LDAP服务器对应的端口
配置信息:配置同步LDAP用户范围相关配置信息,需要设置以下参数:
基本DN:输入基本DN,用于检索LDAP用户的根节点,规定同步LDAP用户的范围
用户DN:输入用户DN,拥有查询基本DN范围内所有用户权限的特殊用户,用于登录LDAP服务器并获取相关数据
过滤策略:选择是否在同步用户信息时进行过滤,默认不过滤。若打开开关,可配置过滤机制与过滤规则
过滤机制:支持黑名单和白名单两种过滤机制
- 若选择黑名单,同步用户信息时,过滤规则中配置的用户信息将不会同步至云平台。
- 若选择白名单,同步用户信息时,只有在过滤规则中配置的用户信息才会同步至云平台。
过滤规则:用于过滤基本DN中的用户
- 过滤规则输入长度受LDAP服务器配置限制,超出限制可能导致过滤规则不生效,请提前确认。
- 过滤规则输入语法与LDAP过滤语法一致,详情请参考微软官方链接。
- 例如:若过滤机制选择黑名单,过滤规则设置为(&(name=filterName)(description=departure)),表示过滤基本DN中name=filterName且description=departure的用户。
LDAP服务器配置完成后,点击下一步按钮,自动测试连接并进入下一步,或点击测试连接按钮,检测配置正确性以及LDAP服务器连通性。
- 若测试成功,点击下一步按钮,继续设置其他参数。
- 若测试失败,请参考右上角报错信息修改配置并重新测试,直到测试成功。
映射规则:设置登录属性以及LDAP与云平台间的用户映射。
可参考以下示例输入相应内容:
登录属性(用于LDAP认证):指定用于云平台登录的LDAP用户属性
例如:若使用cn作为登录属性,LDAP用户可使用cn相应的value(例如:xiaoming)作为云平台登录名。
用户映射:选择或输入LDAP用户与云平台用户之间的映射关系,需要设置以下参数:
用户名:设置云平台用户的用户名与LDAP用户的用户名映射关系
例如:若用户名映射cn,云平台创建用户的用户名将使用cn相应的value(例如:xiaoming)。
ZStack Cloud云平台中用户的用户名不能重复,若同步LDAP用户与云平台原有用户名重复,系统将自动为同步过来LDAP用户的用户名增加随机码。
姓名:设置云平台用户的姓名与LDAP用户的姓名映射关系
例如:若姓名映射cn,云平台创建用户的姓名将使用cn相应的value(例如:xiaozhang)。
手机号:可选项,设置云平台用户的手机号与LDAP用户的手机号映射关系
例如:若手机号映射mobile,云平台创建用户的手机号将使用mobile相应的value(例如:13800000000)。
邮箱:可选项,设置云平台用户的邮箱与LDAP用户的邮箱映射关系
例如:若邮箱映射mail,云平台创建用户的邮箱将使用mail相应的value(例如:xxx@xxx.xx)。
编号:可选项,设置云平台用户的编号与LDAP用户的编号映射关系
例如:若编号映射employeeNumber,云平台创建用户的编号将使用employeeNumber相应的value(例如:001)。
简介:可选项,设置云平台用户的简介与LDAP用户的简介映射关系
例如:若简介映射description,云平台创建用户的简介将使用description相应的value(例如:开发部-小明)。
自定义属性:自定义用户映射属性,需要设置以下参数:
- 系统用户属性:设置系统用户属性,可与原有属性重复,例如:工号
- AD/LDAP用户属性:设置LDAP用户属性,例如:employeeNumber
点击下一步按钮,系统将自动测试登录属性、用户映射是否可以建立,成功后,自动添加映射规则。
请确保填写LDAP映射参数,否则可能导致测试失败。若测试失败,请根据右上报错信息修改后重新点击下一步按钮,直到测试并添加映射规则成功。
确认提交:查看将要添加LDAP服务器的相关信息,支持跳转修改
点击确定按钮,将根据设置的配置添加LDAP服务器,并创建统一认证用户。
LDAP用户登录云平台
将LDAP用户加入项目并分配权限,然后使用Chrome浏览器或FireFox浏览器打开项目登录界面(http://management_node_ip:5000/#/project),并切换到AD/LDAP用户登录选项,输入登录属性对应的用户名及密码登录云平台。
- 除登录方式外,统一认证用户与云平台本地用户没有任何区别,支持加入项目、加入部门、配置权限等租户管理常规操作。
- 将统一认证用户加入项目并分配权限才能正常使用,否则登录后显示空白页。
LDAP用户创建云主机
LDAP用户登录云平台后,点击资源中心 > 云资源池 > 虚拟资源 > 云主机,进入云主机页面,使用快捷方式创建云主机。详细可参考创建云主机 (快捷创建)。
至此,LDAP用户创建云主机介绍完成。
OIDC用户创建云主机
OIDC认证系统中的用户已同步至ZStack Cloud云平台,并已为相关用户配置项目或平台角色。
ZStack Cloud支持对接OIDC/OAuth2/CAS等统一认证系统,实现OIDC/OAuth2/CAS用户免密登录云平台,操作云平台资源。本场景以OIDC用户为例介绍OIDC/OAuth2/CAS用户如何免密登录云平台并创建云主机。OIDC用户创建云主机的基本示例流程如下:
- OIDC认证系统管理员将ZStack Cloud云平台配置为认证系统客户端
- ZStack Cloud云平台管理员(admin)在云平台上添加OIDC认证服务器
- OIDC用户免密登录云平台
- OIDC用户创建云主机
OIDC认证系统管理员将ZStack Cloud云平台配置为认证系统的客户端
OIDC认证系统管理员需登录对应认证系统,将云平台配置为认证系统的客户端,从而为云平台生成唯一标识符(Client ID)以及密钥(Client Secret)。
ZStack Cloud云平台管理员(admin)在云平台上添加OIDC认证服务器
在ZStack Cloud主菜单,点击运营管理 > 租户管理 > 人员与权限 > 统一认证SSO,进入统一认证SSO界面,点击添加统一认证服务器,在云平台添加OIDC认证服务器。
请参考以下示例输入相应内容:
选择服务器类型:此处选择OIDC服务器
配置OIDC服务器:设置OIDC服务器相关的基本信息和配置信息
可参考以下示例输入相应内容:
名称:设置统一认证服务器名称
简介:可选项,可留空不填
类型:已选择OIDC
认证供应商:负责收集、存储用户身份信息,如用户名、密码等,在用户登陆时负责认证用户的服务。支持以下认证供应商:标准协议、正方单点登录SSO、阿里IDaaS(私有化)、MaxKey单点登录SSO、以及上传的统一认证SSO类型的插件
云平台API URL:用于认证服务器认证通过后,重定向至云平台的URL
若云平台API服务配置了反向代理,此处仅需将URL中的原始地址和端口替换为代理后的地址和端口,注意保留后续参数与路径。
示例:
- 原配置:https://192.168.1.100:8080/api/auth/callback
- 反代后:https://api.example.com:8443/api/auth/callback
此URL需与认证服务器配置的回调地址保持一致。
云平台UI URL:云平台系统内部实现免密登录的重定向模板。
若云平台UI地址配置了反向代理,此处仅需将模板中的原始地址和端口替换为代理后的地址和端口,注意保留后续参数与路径。
示例:
- 原模板:https://192.168.1.200:80/login/sso?token=<token>
- 反代后:https://portal.example.com/login/sso?token=<token>
此模板直接影响登录跳转功能,配置错误将导致SSO失败。
配置信息:配置云平台与OIDC认证服务器对接所需信息,需要设置以下参数:
- Client ID:认证系统为云平台分配的唯一标识符
- Client Secret:认证系统为云平台分配的密钥
- Scope:用于指定请求访问令牌或ID令牌时,获取的用户属性范围,如用户名(name)、电子邮件地址(email)、电话号码(phone)等。指定Scope后,返回的令牌将包含对应属性
- Authorization Request URL:授权码(Authorization Code)模式下,用于获取授权许可的请求 URL
- Token Request URL:从认证服务器获取访问 Token(Access Token)的请求URL
- Userinfo Request URL:从认证服务器获取用户信息的请求URL
- Logout URL: 用于云平台退出登录后调用 Logout URL 注销会话,下一次登录云平台时需重新登录统一认证系统。若留空不填,则云平台退出登录后不会立即清理登录信息,会话有效期内仍可再次免密登录云平台
映射规则:设置OIDC认证服务器用户与云平台间的用户映射
可参考以下示例输入相应内容:
用户映射规则:统一认证用户同步至云平台后,将具备云平台属性。映射规则用于建立统一认证属性与云平台属性之间的映射关系
用户名:设置云平台用户的用户名与OIDC认证服务器中用户某一属性的映射关系。用户名在云平台全局范围内唯一标识一个用户,需确保填写认证系统中同样具有唯一标识的用户属性
例如:若用户名映射username,则同步至云平台的用户的用户名将使用username相应的value(例如:xiaoming)
姓名:设置云平台用户的姓名与OIDC认证服务器中用户某一属性的映射关系
例如:若姓名映射name,云平台创建用户的姓名将使用name相应的value(例如:xiaozhang)。
手机号:可选项,设置云平台用户的手机号与OIDC认证服务器中用户某一属性的映射关系
例如:若手机号映射telephoneNumber,云平台创建用户的手机号将使用telephoneNumber相应的value(例如:13800000000)。
邮箱:可选项,设置云平台用户的邮箱与OIDC认证服务器中用户某一属性的映射关系
例如:若邮箱映射mail,云平台创建用户的邮箱将使用mail相应的value(例如:xxx@xxx.xx)。
编号:可选项,设置云平台用户的编号与OIDC认证服务器中用户某一属性的映射关系
例如:若编号映射employeeID,云平台创建用户的编号将使用employeeID相应的value(例如:001)。
简介:可选项,设置云平台用户的简介与OIDC认证服务器中用户某一属性的映射关系
例如:若用户简介映射description,云平台创建用户的简介将使用description相应的value(例如:开发部-后端)
成员组:可选项,设置云平台成员组与统一认证服务器中成员组的映射关系。
例如:若成员组映射usergroup,云平台创建的成员组将使用usergroup相应的value(例如:group1、group2).
若云平台已存在多个同名成员组,统一认证用户免密登录后,将同时加入这些同名成员组。若不希望用户加入多个成员组,可修改成员组名称或删除多余的成员组。
确认提交:查看将要添加OIDC服务器的相关信息
点击确定按钮,将根据设置的配置添加OIDC服务器,并同步统一认证用户信息。
OIDC用户免密登录云平台
添加OIDC/OAuth2/CAS统一认证服务器后,用户直接打开云平台登录页面时,默认选中统一身份认证登录。单击以统一认证服务器名称显示的登录按钮后,页面将跳转至对应的统一认证系统;完成身份验证后,自动返回云平台。若需使用本地用户登录,可切换至本地登录。
此外,统一认证服务器添加至云平台后,会生成云平台免密登录URL。业务应用系统的管理员将该URL配置至应用系统后(例如:统一门户网站),OIDC/OAuth2/CAS用户即可点击对应应用图标,实现免密登录云平台。
OIDC用户创建云主机
OIDC用户登录云平台后,点击资源中心 > 云资源池 > 虚拟资源 > 云主机,进入云主机页面,使用快捷方式创建云主机。详细可参考创建云主机 (快捷创建)。
至此,OIDC用户创建云主机介绍完成。
