官方运维工具
本文指导已购买 Zadig 产品及服务的企业,如何使用官方运维工具进行安装与升级。建议联系官方获取支持。 该工具支持远程升级、回滚及问题诊断,便于企业高效实施 Zadig。以下为资源准备及操作步骤。
# 资源准备
- Kubernetes 集群,版本 v1.16+,建议 2 台 8C16G,需管理员权限
- 一台可连通集群并已安装 kubectl(opens new window) 的机器
- 网络:
- IP+端口方式需集群节点有外部 IP
- 域名方式需准备可用域名
- 数据库:
- 高可用 MongoDB(v4.4+)
- 高可用 MySQL(v5.7+)
注意事项
- 部分集群网络插件可能导致 Service 后端 Pod 无法自访问,请提前验证
- 配置 kube-dns,确保服务和 Pod 可按名称寻址
# 安装官方运维工具
# 安装准备
- 需要一台可以正常连通 K8s 集群的机器用于执行安装命令
- 确保该机器已经安装了 kubectl 客户端 并且可以使用管理员的权限操作 K8s 集群
# 执行安装
执行以下命令安装客户控制台:
curl -sS https://admin.8slan.com/api/plutus/customer/installer/install_plutus_customer.sh | bash
安装成功输出:
...
plutus customer installation complete
visit {访问地址} to access plutus customer
use password: {密码} to login to plutus
plutus customer installation completed in 36 seconds
2
3
4
5
# 配置授权凭证
提示
如首次登录不成功,可能系统正在初始化,请耐心等待。
使用输出的访问地址和密码登录客户控制台,按提示配置授权凭证(由官方签发)。


# [推荐] 官方安装支持
开启「供应商维护配置」后,Zadig 官方可远程协助安装。

勾选后保存即可。
# 安装 Zadig
# 步骤 1:选择版本
客户控制台 > 版本,点击发现新版本,选择所需版本后点击部署进入参数配置。
提示
若忘记控制台登录密码,可以通过以下命令找回:
kubectl get cm plutus-customer-config -n {控制台所在的命名空间} -o=jsonpath='{.data.PLUTUS_PASSWORD}'使用
IP + 端口方式访问控制台时,若忘记具体端口,可以通过以下命令查看:kubectl get svc plutus-customer-portal -n {控制台所在的命名空间}

# 步骤 2:配置参数
设置参数后点击部署。
安装耗时视硬件和网络而定。可用
kubectl -n {Namespace} get pod查询服务状态,状态为部署成功即完成。

配置说明:
命名空间:Zadig 安装命名空间Release 名称:可自定义Helm values 文件:Zadig 安装参数(支持 YAML 或 key/value 配置)- 这里查看参数说明
# 步骤 3:访问系统
首次登录需注册系统管理员。

# 步骤 4:配置许可证
注册登录后,选择「付费版」配置许可证。


# 升级 Zadig
注意
请勿跨版本升级。
# 步骤 1:备份数据
- 务必备份数据,参考:备份数据
- 备份当前安装参数

# 步骤 2:执行升级
客户控制台 > 版本,点击发现新版本,选择新版本后点击部署。

将备份参数填入 Helm values 文件 后部署。
提示
升级时请勿修改命名空间和 Release 名称。

# 步骤3:验证升级
部署成功后清理浏览器缓存,登录 Zadig,检查以下功能:
- 账号系统可正常登录
- 项目/工作流/环境/服务/构建/系统集成数据正常
- 环境服务实例、工作流可正常运行
- 高频功能可用
# 回滚 Zadig
注意
回滚前请确保 Zadig 停机,回滚过程中勿使用系统。
# 步骤 1:恢复数据
恢复目标版本备份数据,参考:数据导入
# 步骤 2:执行回滚
客户控制台 > 版本,选择目标版本后点击部署。

配置 Helm values 文件,填入备份参数。
提示
回滚时请勿修改命名空间和 Release 名称。

# 步骤 3:验证回滚
部署成功后清理浏览器缓存,登录 Zadig,检查以下功能:
- 账号系统可正常登录
- 项目/工作流/环境/服务/构建/系统集成数据正常
- 环境服务实例、工作流可正常运行
- 高频功能可用
# 安装参数说明
# 通用安装参数
| 参数名 | 必填 | 备注 |
|---|---|---|
| global.extensions.extAuth.extauthzServerRef.namespace | 是 | Zadig 安装所在的 Namespace |
| endpoint.FQDN | 使用域名访问 Zadig 时必填 | 访问 Zadig 系统的完整 URL |
| endpoint.type | 使用 IP+Port 访问 Zadig 时必填 | 设置为固定值: IP |
| endpoint.IP | 使用 IP+Port 访问 Zadig 时必填 | K8s 节点任一可外网访问的 IP |
| gloo.gatewayProxies.gatewayProxy.service.httpNodePort | 使用 IP+Port 访问 Zadig 时必填 | 指定的端口号 < 30000 - 32767> |
| gloo.gatewayProxies.gatewayProxy.service.type | 使用 IP+Port 访问 Zadig 时必填 | 固定值: NodePort |
| dex.config.staticClients[0].redirectURIs[0] | 是 | 使用域名方式访问:http://${endpoint.FQDN}/api/v1/callback使用 IP+Port 方式访问: http://${IP}:${PORT}/api/v1/callback |
| protocol | 否 | 访问 ZaidgX 系统使用的具体协议,默认为 http |
# 高可用安装参数
高可用版本使用外置的 MongoDB, MySQL 组件,数据持久化及高可用性由具体的 MongoDB, MySQL 服务提供商保障
| 参数名 | 必填 | 备注 |
|---|---|---|
| tags.mysql | 是 | 是否安装内置的 MySQL,指定为 false |
| connections.mysql.host | 是 | MySQL 连接地址 |
| connections.mysql.auth.user | 是 | MySQL 用户名 |
| connections.mysql.auth.password | 是 | MySQL 密码 |
| dex.config.storage.config.host | 是 | Dex 系统所使用的 MySQL Host |
| dex.config.storage.config.port | 是 | Dex 系统所使用的 MySQL 端口 |
| dex.config.storage.config.user | 是 | Dex 系统所使用的 MySQL 用户名 |
| dex.config.storage.config.password | 是 | Dex 系统所使用的 MySQL 密码 |
| tags.mongodb | 是 | 是否安装内置的 MongoDB,指定为 false |
| connections.mongodb.connectionString | 是 | MongoDB 数据库连接串,配置多个地址时需要进行转义,比如:mongodb://user:password@8.10.20.20\,8.10.20.30 |
| ee.mongodb.db | 是 | MongoDB 数据库名称 |


