基于 Helm 命令安装

基于 Helm 命令安装

本文主要介绍如何使用 Helm 来安装 Zadig 系统。建议使用官网 Helm 安装命令生成工具 (opens new window)进行安装。

温馨提示

使用 Helm 命令在现有 Kubernetes 集群上安装 Zadig。适合对 Helm 有一定了解的用户。

前置条件

安装 Helm v3.5+，这是一个简单的命令行工具，可以从此处 (opens new window)获取。
若需要使用 Zadig 内置的存储组件（MySQL / MongoDB / MinIO）并开启持久化，在安装之前，需要配置 Kubernetes 默认的 StorageClass。
受限于部分类型集群网络插件及其配置，Service 的后端 Pod 可能无法通过该 Service 访问自身，在安装之前请确保集群中不存在此问题。
Kubernetes 集群版本：v1.16~v1.26。

步骤 1：创建 Namespace

添加 Zadig 官方 Chart 仓库。

helm repo add koderover-chart https://koderover.tencentcloudcr.com/chartrepo/chart

创建 namespace。

kubectl create ns zadig

步骤 2：安装 Zadig

Zadig 支持两种访问方式，一种是提供访问域名，另一种是直接使用 IP + PORT 的方式访问。不同的访问方式需要设置不同的变量，可用参数请参考可选参数列表。

域名访问

请确保你有已备案的域名。请将流量转发到 gateway-proxy 服务。

export NAMESPACE=<Zadig 安装的 NAMESPACE>
export DOMAIN=<DOMAIN>
helm upgrade --install zadig koderover-chart/zadig --namespace ${NAMESPACE} --version=1.18.0 --set endpoint.FQDN=${DOMAIN} \
    --set global.extensions.extAuth.extauthzServerRef.namespace=${NAMESPACE} \
    --set "dex.config.staticClients[0].redirectURIs[0]=http://${DOMAIN}/api/v1/callback,dex.config.staticClients[0].id=zadig,dex.config.staticClients[0].name=zadig,dex.config.staticClients[0].secret=ZXhhbXBsZS1hcHAtc2VjcmV0"

IP + PORT 访问

IP 为 Kubernetes 任一节点的外网可访问 IP。

export NAMESPACE=<Zadig 安装的 NAMESPACE>
export IP=<IP>
export PORT=<PORT>
helm upgrade --install zadig koderover-chart/zadig --namespace ${NAMESPACE} --version=1.18.0 --set endpoint.type=IP \
    --set endpoint.IP=${IP} \
    --set gloo.gatewayProxies.gatewayProxy.service.httpNodePort=${PORT} \
    --set global.extensions.extAuth.extauthzServerRef.namespace=${NAMESPACE} \
    --set gloo.gatewayProxies.gatewayProxy.service.type=NodePort \
    --set "dex.config.staticClients[0].redirectURIs[0]=http://${IP}:${PORT}/api/v1/callback,dex.config.staticClients[0].id=zadig,dex.config.staticClients[0].name=zadig,dex.config.staticClients[0].secret=ZXhhbXBsZS1hcHAtc2VjcmV0"

Zadig Chart 参数列表

Zadig Chart 除了 Zadig 系统外，还内置了一些必要的组件 MySQL、MongoDB、MinIO，可以根据你的安装环境实际情况选择是否安装这些组件

Gateway Proxy 参数列表

Key	说明	Value 示例	默认值
gloo.gatewayProxies.gatewayProxy.service.type	Gateway Proxy 服务的暴露方式，可选项为 LoadBalancer、NodePort、ClusterIP	LoadBalancer	LoadBalancer

MongoDB 参数列表

MongoDB 连接参数

Key	说明	Value 示例	默认值
connections.mongodb.connectionString	MongoDB 连接串	mongodb://root:zadig@kr-mongodb:27017	mongodb://root:zadig@kr-mongodb:27017
connections.mongodb.db	Zadig 所使用的 MongoDB 的 DB	zadig	zadig

内置 MongoDB 安装参数

Key	说明	Value 示例	默认值
tags.mongodb	是否安装内置的 MongoDB	true	true
mongodb.persistence.enabled	MongoDB 持久化开关	true	true
mongodb.persistence.size	MongoDB 的存储空间大小	20 Gi	20 Gi
mongodb.rootPassword	内置 MongoDB 的 root 用户密码	zadig	nil
mongodb.persistence.existingClaim	如果安装的 MongoDB 需要使用已经存在的 PVC，使用这个字段指定 Claim Name	myclaim	nil

不安装内置的 MongoDB

如果你有自己的 MongoDB，可以选择不安装内置的 MongoDB，版本要求 3.4 及以上，具体配置参数如下。

Key	说明	Value 示例	默认值
tags.mongodb	是否安装内置的 MongoDB	false	true
connections.mongodb.connectionString	Zadig 系统业务数据库连接串，配置多个地址时需要进行转义	mongodb://user:password@8.10.20.20\,8.10.20.30	mongodb://zadig-mongodb:27017
connections.mongodb.db	Zadig 系统使用的默认 DB	zadig	zadig

MinIO 参数列表

提示

如果有自己的 S3 对象存储，可以选择不安装 MinIO。在 Zadig 安装完后成访问 系统设置 -> 对象存储 来配置即可，配置过程详见对象存储。

内置 MinIO 安装参数

Key	说明	Value 示例	默认值
tags.minio	是否安装内置的 MinIO	true	true
minio.persistence.enabled	MinIO 对象存储持久化开关	true	true
minio.persistence.size	MinIO 的存储空间大小	20 Gi	20 Gi
minio.persistence.storageClass	MinIO 的 PVC 使用的 Storage Class，如果开启持久化的情况下，不提供 Storage Class 和 existingClaim，将使用集群默认的 Storage class。在此情况下，如果集群没有默认的 Storage Class，安装将会失败。	storage_class	nil
minio.persistence.existingClaim	如果安装的 MinIO 需要使用已经存在的 PVC，使用这个字段指定 Claim Name	my_pvc	nil

MySQL 参数列表

MySQL 连接参数

Key	说明	Value 示例	默认值
connections.mysql.host	MySQL连接信息	kr-mysql:3306	kr-mysql:3306
connections.mysql.auth.user	MySQL 用户名	root	root
connections.mysql.auth.password	MySQL 密码	zadig	zadig
connections.mysql.db.user	Zadig 用户系统使用的 DB	user	user
connections.mysql.db.dex	Zadig 第三方连接器 Dex 使用的 DB	dex	dex
dex.config.storage.config.database	Dex 系统所使用的 DB，和 `connections.mysql.db.dex` 的值保持一致	dex	dex
dex.config.storage.config.host	Dex 系统所使用的 MySQL Host	zadig-mysql	zadig-mysql
dex.config.storage.config.port	Dex 系统所使用的 MySQL 端口	3306	3306
dex.config.storage.config.user	Dex 系统所使用的 MySQL 用户名	root	root
dex.config.storage.config.password	Dex 系统所使用的 MySQL 密码	zadig	zadig

内置 MySQL 安装参数

Key	说明	Value 示例	默认值
tags.mysql	是否安装内置 MySQL	true	true
mysql.rootPassword	MySQL 密码	zadig	zadig
mysql.persistence.enabled	是否开启持久化存储	true	true
mysql.persistence.size	持久化存储 PVC 的大小	20Gi	20Gi

如果自己提供 MySQL

在安装 Zadig 系统之前，请手动创建 connections.mysql.db.dex 所指定的 Database，以确保 Zadig 系统的正常安装

其他参数

Key	说明	Value 示例	默认值
kubernetes.server	Zadig 安装集群的 Kubernetes API Server 地址	https://10.0.0.1:6443	nil
gloo.k8s.clusterName	安装 Zadig 的集群名称，若修改过集群名称，需要设置此参数	cluster.local	cluster.local

Helm Charts 卸载

注意：只有当你完全知晓每项操作所带来的结果，再去执行该操作。

helm list -n zadig # 获得 Zadig 的 release name
helm uninstall <release name> -n zadig