注意
在现有 Kubernetes 集群上安装 Zadig。可生产使用。
步骤 1：准备资源
- Kubernetes 集群版本：v1.16~v1.26
- Helm v3.5.0 + 版本
注意事项
- 若需要使用 Zadig 内置的存储组件（MySQL / MongoDB / MinIO），在安装之前，需要配置 Kubernetes
默认的 StorageClass，以支持创建 PVC 用于数据持久化 - 受限于部分类型集群网络插件及其配置，Service 的后端 Pod 可能无法通过该 Service 访问自身，在安装之前请确保集群中不存在此问题
- 配置 kube-dns 服务，以支持服务和 Pod 之间的按名称寻址
步骤 2：准备安装环境
- 需要一台可以正常连通该集群的机器用于执行安装脚本。
- 确保该机器已经安装了 kubectl 客户端 并且可以使用管理员的权限操作该集群。
步骤 3：下载安装脚本
根据实际情况，可从以下源选择相应的 Zadig 版本。
| 场景 | 下载源 | 说明 |
|---|---|---|
| 快速体验 | 官方下载源：https://download.koderover.com/install?type=quickstart GitHub 源：https://github.com/koderover/zadig/releases/download/v1.18.0/install_quickstart.sh | 不提供持久化存储能力，不推荐生产使用 |
| 生产使用 | 官方下载源：https://download.koderover.com/install?type=standard GitHub 源：https://github.com/koderover/zadig/releases/download/v1.18.0/install.sh | 提供持久化存储能力 |
根据实际情况下载安装脚本并添加可执行权限，使用 GitHub 源下载示例如下：
# 快速体验：
curl -LO https://github.com/koderover/zadig/releases/download/v1.18.0/install_quickstart.sh
chmod +x ./install_quickstart.sh
# 生产使用：
curl -LO https://github.com/koderover/zadig/releases/download/v1.18.0/install.sh
chmod +x ./install.sh
提示
下表为安装脚本支持配置的环境变量，安装时会使用默认值进行安装，如果有配置的需求，可以在执行安装脚本之前通过环境变量进行配置。
# 例如：配置 IP 访问地址
export IP=<node external ip>
export PORT=< 30000 - 32767 任一端口>
# 如果出现端口占用情况，换一个端口再尝试
| 变量名称 | 默认值 | 是否必填 | 说明 |
|---|---|---|---|
| NAMESPACE | zadig | 否 | Kubernetes 命名空间 |
| DOMAIN | 和 IP 二选一 | 访问 Zadig 系统域名， 仅生产脚本可用，域名流量需要解析到 gateway-proxy 服务 | |
| IP | 和 DOMAIN 二选一 | Kubernetes 集群任一节点的外网 IP 地址，用于访问 Zadig 系统 | |
| PORT | 使用 IP 访问必填 | 任意合法的 Kubernetes 端口， K8S 默认端口范围为 30000 - 32767 | |
| SERVICE_TYPE | NodePort | 否 | Zadig 网关的服务暴露方式，可选值： NodePort, LoadBalancer。 默认值： NodePort |
| STORAGE_SIZE | 20G | 否 | 内置数据库和对象存储各自的数据存储大小 |
| STORAGE_CLASS | 否 | 若集群内支持持久存储卷，可以设置该变量，避免 Zadig 的数据库服务重启后数据丢失 注：仅生产脚本可用 | |
| MONGO_URI | 否 | Zadig 业务数据存储，配置多个地址时需要进行转义，例如：mongodb://user:password@8.10.20.20\,8.10.20.30。若不配置，使用安装脚本中内置的单节点 MongoDB 注：仅生产脚本可用 | |
| MONGO_DB | zadig | 否 | Zadig 业务数据库名称 注：仅生产脚本可用 |
| MYSQL_HOST | "" | 否 | Zadig 用户信息数据存储，若不配置，使用安装脚本中内置的单节点 MySQL 注：仅生产脚本可用 |
| MYSQL_PORT | "" | 否 | MySQL 数据库端口 注：仅生产脚本可用 |
| MYSQL_USERNAME | "" | 否 | MySQL 数据库用户名 注：仅生产脚本可用 |
| MYSQL_PASSWORD | "" | 否 | MySQL 数据库密码 注：仅生产脚本可用 |
| ENCRYPTION_KEY | 否 | 由安装过程生成，用于数据加密解密，。重装系统时需设置 ENCRYPTION_KEY，才能保证之前的数据可以被正确解密 |
步骤 4：开始安装
快速体验安装
执行快速体验安装脚本
export IP=<IP>
# Kubernetes 集群任一节点的外网 IP 地址，用于访问 Zadig 系统
# 如果你有自己的域名，可以配置你可用的域名 export DOMAIN = <DOMAIN>
export PORT=<任一合法 Kubernetes 端口>
# 如果出现端口占用情况，换一个端口再尝试
./install_quickstart.sh
生产级使用
如果你需要生产级使用，建议配置持久化的数据存储，然后执行正式版安装脚本。
- 使用外置高可用的 MongoDB 和 MySQL。具体配置如下。
注意
对 MongoDB 及 MySQL 的版本要求如下：
- MongoDB ≥ 3.4
- MySQL ≥ 5.7
export IP=<IP>
export PORT=<任一合法 Kubernetes 端口>
export EMAIL=example@koderover.com
export PASSWORD=zadig
# 配置高可用的 MySQL。
# 安装前需要手动在该 MySQL 实例中创建名为 dex 的 database
export MYSQL_HOST=<MYSQL_HOST>
export MYSQL_PORT=<MYSQL_PORT>
export MYSQL_USERNAME=<MYSQL_USERNAME>
export MYSQL_PASSWORD=<MYSQL_PASSWORD>
# 配置高可用的 MongoDB
export MONGO_URI=<MONGO_URI>
export MONGO_DB=<MONGO_DB>
./install.sh
步骤 5：验证安装结果
安装过程预计持续 10 分钟左右，受硬件配置和网络情况影响，不同环境下的时间可能不同， 当看到如图的输出时，说明安装已经完成，届时可以通过命令查看服务启动状态。
kubectl -n zadig get po
步骤 6：访问系统
在安装结果输出中，你可以获得系统的访问地址。
Zadig 卸载
支持使用脚本来一键卸载当前安装的 Zadig 系统，只需执行卸载脚本即可：
#根据实际安装的 namespace 修改
export NAMESPACE=zadig
#根据实际安装的版本，选择对应版本的卸载脚本
curl -SsL https://github.com/koderover/zadig/releases/download/v1.18.0/uninstall.sh |bash
官方最新版卸载脚本：
curl -SsL https://download.koderover.com/install?type=uninstall | bash