From a854e484cdc6f1f91604f29f1db6cc78814dd380 Mon Sep 17 00:00:00 2001 From: zhyass <34016424+zhyass@users.noreply.github.com> Date: Fri, 2 Apr 2021 15:55:40 +0800 Subject: [PATCH] *: update the charts docs --- charts/README.md | 36 +++++++++++++------------ docs/zh-cn/charts.md | 62 +++++++++++++++++++++++--------------------- 2 files changed, 51 insertions(+), 47 deletions(-) diff --git a/charts/README.md b/charts/README.md index 828d8a80c..0ff401a56 100644 --- a/charts/README.md +++ b/charts/README.md @@ -55,8 +55,10 @@ The following table lists the configurable parameters of the krypton chart and t | `replicaCount` | The number of pods | `3` | | `busybox.image` | `busybox` image repository. | `busybox` | | `busybox.tag` | `busybox` image tag. | `1.32` | -| `mysql.image` | `mysql` image repository. | `zhyass/percona57` | -| `mysql.tag` | `mysql` image tag. | `beta0.1.0` | +| `mysql.image` | `mysql` image repository. | `kryptondb/percona` | +| `mysql.tag` | `mysql` image tag. | `5.7.33` | +| `mysql.allowEmptyRootPassword` | If set true, allow a empty root password. | `true` | +| `mysql.mysqlRootPassword` | Password for the `root` user. | | | `mysql.mysqlReplicationPassword` | Password for the `qc_repl` user. | `Repl_123`, random 12 characters if not set | | `mysql.mysqlUser` | Username of new user to create. | `qingcloud` | | `mysql.mysqlPassword` | Password for the new user. | `Qing@123`, random 12 characters if not set | @@ -76,21 +78,21 @@ The following table lists the configurable parameters of the krypton chart and t | `mysql.readinessProbe.failureThreshold` | Minimum consecutive failures for the mysql probe to be considered failed after having succeeded. | 3 | | `mysql.extraEnvVars` | Additional environment variables as a string to be passed to the `tpl` function | | | `mysql.resources` | CPU/Memory resource requests/limits for mysql. | Memory: `256Mi`, CPU: `100m` | -| `krypton.image` | `krypton` image repository. | `zhyass/krypton` | -| `krypton.tag` | `krypton` image tag. | `beta0.1.0` | -| `krypton.args` | Additional arguments to pass to the krypton container. | `[]` | -| `krypton.extraEnvVars` | Additional environment variables as a string to be passed to the `tpl` function | | -| `krypton.livenessProbe.initialDelaySeconds` | Delay before krypton liveness probe is initiated | 30 | -| `krypton.livenessProbe.periodSeconds` | How often to perform the krypton probe | 10 | -| `krypton.livenessProbe.timeoutSeconds` | When the krypton probe times out | 5 | -| `krypton.livenessProbe.successThreshold` | Minimum consecutive successes for krypton probe to be considered successful after having failed. | 1 | -| `krypton.livenessProbe.failureThreshold` | Minimum consecutive failures for the krypton probe to be considered failed after having succeeded.| 3 | -| `krypton.readinessProbe.initialDelaySeconds` | Delay before krypton readiness probe is initiated | 10 | -| `krypton.readinessProbe.periodSeconds` | How often to perform the krypton probe | 10 | -| `krypton.readinessProbe.timeoutSeconds` | When the krypton probe times out | 1 | -| `krypton.readinessProbe.successThreshold` | Minimum consecutive successes for krypton probe to be considered successful after having failed. | 1 | -| `krypton.readinessProbe.failureThreshold` | Minimum consecutive failures for the krypton probe to be considered failed after having succeeded.| 3 | -| `krypton.resources` | CPU/Memory resource requests/limits for krypton. | Memory: `128Mi`, CPU: `50m` | +| `xenon.image` | `xenon` image repository. | `kryptondb/xenon` | +| `xenon.tag` | `xenon` image tag. | `1.1.5-alpha` | +| `xenon.args` | Additional arguments to pass to the xenon container. | `[]` | +| `xenon.extraEnvVars` | Additional environment variables as a string to be passed to the `tpl` function | | +| `xenon.livenessProbe.initialDelaySeconds` | Delay before xenon liveness probe is initiated | 30 | +| `xenon.livenessProbe.periodSeconds` | How often to perform the xenon probe | 10 | +| `xenon.livenessProbe.timeoutSeconds` | When the xenon probe times out | 5 | +| `xenon.livenessProbe.successThreshold` | Minimum consecutive successes for xenon probe to be considered successful after having failed. | 1 | +| `xenon.livenessProbe.failureThreshold` | Minimum consecutive failures for the xenon probe to be considered failed after having succeeded. | 3 | +| `xenon.readinessProbe.initialDelaySeconds` | Delay before xenon readiness probe is initiated | 10 | +| `xenon.readinessProbe.periodSeconds` | How often to perform the xenon probe | 10 | +| `xenon.readinessProbe.timeoutSeconds` | When the xenon probe times out | 1 | +| `xenon.readinessProbe.successThreshold` | Minimum consecutive successes for xenon probe to be considered successful after having failed. | 1 | +| `xenon.readinessProbe.failureThreshold` | Minimum consecutive failures for the xenon probe to be considered failed after having succeeded. | 3 | +| `xenon.resources` | CPU/Memory resource requests/limits for xenon. | Memory: `128Mi`, CPU: `50m` | | `metrics.enabled` | Start a side-car prometheus exporter | `true` | | `metrics.image` | Exporter image | `prom/mysqld-exporter` | | `metrics.tag` | Exporter image | `v0.12.1` | diff --git a/docs/zh-cn/charts.md b/docs/zh-cn/charts.md index 9f596e024..945165b89 100644 --- a/docs/zh-cn/charts.md +++ b/docs/zh-cn/charts.md @@ -48,16 +48,18 @@ kubectl delete pvc data-my-release-krypton-2 下表列出了 krypton chart 的配置参数及对应的默认值。 -| 参数 | 描述 | 默认值 | -| -------------------------------------------- | -------------------------------------------------------- | ---------------------------------------- | -| `imagePullPolicy` | 镜像拉取策略 | `IfNotPresent` | -| `fullnameOverride` | 自定义全名覆盖 | | -| `nameOverride` | 自定义名称覆盖 | | -| `replicaCount` | Pod 数目 | `3` | -| `busybox.image` | `busybox` 镜像库地址 | `busybox` | -| `busybox.tag` | `busybox` 镜像标签 | `1.32` | -| `mysql.image` | `mysql` 镜像库地址 | `zhyass/percona57` | -| `mysql.tag` | `mysql` 镜像标签 | `beta0.1.0` | +| 参数 | 描述 | 默认值 | +| -------------------------------------------- | -------------------------------------------------------- | -------------------------------------- | +| `imagePullPolicy` | 镜像拉取策略 | `IfNotPresent` | +| `fullnameOverride` | 自定义全名覆盖 | | +| `nameOverride` | 自定义名称覆盖 | | +| `replicaCount` | Pod 数目 | `3` | +| `busybox.image` | `busybox` 镜像库地址 | `busybox` | +| `busybox.tag` | `busybox` 镜像标签 | `1.32` | +| `mysql.image` | `mysql` 镜像库地址 | `kryptondb/percona` | +| `mysql.tag` | `mysql` 镜像标签 | `5.7.33` | +| `mysql.allowEmptyRootPassword` | 如果为 `true`，允许 root 账号密码为空 | `true` | +| `mysql.mysqlRootPassword` | `root` 用户密码 | | | `mysql.mysqlReplicationPassword` | `qc_repl` 用户密码 | `Repl_123`, 如果没有设置则随机12个字符 | | `mysql.mysqlUser` | 新建用户的用户名 | `qingcloud` | | `mysql.mysqlPassword` | 新建用户的密码 | `Qing@123`, 如果没有设置则随机12个字符 | @@ -68,30 +70,30 @@ kubectl delete pvc data-my-release-krypton-2 | `mysql.livenessProbe.initialDelaySeconds` | Pod 启动后首次进行存活检查的等待时间 | 30 | | `mysql.livenessProbe.periodSeconds` | 存活检查的间隔时间 | 10 | | `mysql.livenessProbe.timeoutSeconds` | 存活探针执行检测请求后，等待响应的超时时间 | 5 | -| `mysql.livenessProbe.successThreshold` | 存活探针检测失败后认为成功的最小连接成功次数 | 1 | +| `mysql.livenessProbe.successThreshold` | 存活探针检测失败后认为成功的最小连接成功次数 | 1 | | `mysql.livenessProbe.failureThreshold` | 存活探测失败的重试次数，重试一定次数后将认为容器不健康 | 3 | -| `mysql.readinessProbe.initialDelaySeconds` | Pod 启动后首次进行就绪检查的等待时间 | 10 | -| `mysql.readinessProbe.periodSeconds` | 就绪检查的间隔时间 | 10 | -| `mysql.readinessProbe.timeoutSeconds` | 就绪探针执行检测请求后，等待响应的超时时间 | 1 | -| `mysql.readinessProbe.successThreshold` | 就绪探针检测失败后认为成功的最小连接成功次数 | 1 | +| `mysql.readinessProbe.initialDelaySeconds` | Pod 启动后首次进行就绪检查的等待时间 | 10 | +| `mysql.readinessProbe.periodSeconds` | 就绪检查的间隔时间 | 10 | +| `mysql.readinessProbe.timeoutSeconds` | 就绪探针执行检测请求后，等待响应的超时时间 | 1 | +| `mysql.readinessProbe.successThreshold` | 就绪探针检测失败后认为成功的最小连接成功次数 | 1 | | `mysql.readinessProbe.failureThreshold` | 就绪探测失败的重试次数，重试一定次数后将认为容器未就绪 | 3 | | `mysql.extraEnvVars` | 其他作为字符串传递给 `tpl` 函数的环境变量 | | | `mysql.resources` | `MySQL` 的资源请求/限制 | 内存: `256Mi`, CPU: `100m` | -| `krypton.image` | `krypton` 镜像库地址 | `zhyass/krypton` | -| `krypton.tag` | `krypton` 镜像标签 | `beta0.1.0` | -| `krypton.args` | 要传递到 krypton 容器的其他参数 | `[]` | -| `krypton.extraEnvVars` | 其他作为字符串传递给 `tpl` 函数的环境变量 | | -| `krypton.livenessProbe.initialDelaySeconds` | Pod 启动后首次进行存活检查的等待时间 | 30 | -| `krypton.livenessProbe.periodSeconds` | 存活检查的间隔时间 | 10 | -| `krypton.livenessProbe.timeoutSeconds` | 存活探针执行检测请求后，等待响应的超时时间 | 5 | -| `krypton.livenessProbe.successThreshold` | 存活探针检测失败后认为成功的最小连接成功次数 | 1 | -| `krypton.livenessProbe.failureThreshold` | 存活探测失败的重试次数，重试一定次数后将认为容器不健康 | 3 | -| `krypton.readinessProbe.initialDelaySeconds` | Pod 启动后首次进行就绪检查的等待时间 | 10 | -| `krypton.readinessProbe.periodSeconds` | 就绪检查的间隔时间 | 10 | -| `krypton.readinessProbe.timeoutSeconds` | 就绪探针执行检测请求后，等待响应的超时时间 | 1 | -| `krypton.readinessProbe.successThreshold` | 就绪探针检测失败后认为成功的最小连接成功次数 | 1 | -| `krypton.readinessProbe.failureThreshold` | 就绪探测失败的重试次数，重试一定次数后将认为容器未就绪 | 3 | -| `krypton.resources` | `krypton` 的资源请求/限制 | 内存: `128Mi`, CPU: `50m` | +| `xenon.image` | `xenon` 镜像库地址 | `kryptondb/xenon` | +| `xenon.tag` | `xenon` 镜像标签 | `1.1.5-alpha` | +| `xenon.args` | 要传递到 xenon 容器的其他参数 | `[]` | +| `xenon.extraEnvVars` | 其他作为字符串传递给 `tpl` 函数的环境变量 | | +| `xenon.livenessProbe.initialDelaySeconds` | Pod 启动后首次进行存活检查的等待时间 | 30 | +| `xenon.livenessProbe.periodSeconds` | 存活检查的间隔时间 | 10 | +| `xenon.livenessProbe.timeoutSeconds` | 存活探针执行检测请求后，等待响应的超时时间 | 5 | +| `xenon.livenessProbe.successThreshold` | 存活探针检测失败后认为成功的最小连接成功次数 | 1 | +| `xenon.livenessProbe.failureThreshold` | 存活探测失败的重试次数，重试一定次数后将认为容器不健康 | 3 | +| `xenon.readinessProbe.initialDelaySeconds` | Pod 启动后首次进行就绪检查的等待时间 | 10 | +| `xenon.readinessProbe.periodSeconds` | 就绪检查的间隔时间 | 10 | +| `xenon.readinessProbe.timeoutSeconds` | 就绪探针执行检测请求后，等待响应的超时时间 | 1 | +| `xenon.readinessProbe.successThreshold` | 就绪探针检测失败后认为成功的最小连接成功次数 | 1 | +| `xenon.readinessProbe.failureThreshold` | 就绪探测失败的重试次数，重试一定次数后将认为容器未就绪 | 3 | +| `xenon.resources` | `xenon` 的资源请求/限制 | 内存: `128Mi`, CPU: `50m` | | `metrics.enabled` | 以 side-car 模式开启 Prometheus Exporter | `true` | | `metrics.image` | Exporter 镜像地址 | `prom/mysqld-exporter` | | `metrics.tag` | Exporter 标签 | `v0.12.1` |