You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by pa...@apache.org on 2022/05/27 08:03:11 UTC
[shardingsphere] branch master updated: Update helm documentation (#18005)
This is an automated email from the ASF dual-hosted git repository.
panjuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 56dea024819 Update helm documentation (#18005)
56dea024819 is described below
commit 56dea024819f756beead6d46a7461feab9ef9789
Author: Ghoul_Lee <wi...@gmail.com>
AuthorDate: Fri May 27 16:03:03 2022 +0800
Update helm documentation (#18005)
* UPDATE: 1. Updated the hierarchy of values 2. Deleted the deployment configuration for storage nodes 3. Updated the relevant description in the documentation
ADD: 1. Import the common chart in bitnami
* Update doc about helm
* refactor computer node to compute node
* add new line
* refactor computer
* remove lock file
* remove tgz file, change maintainers, add install form source
* add helm doc
* Add helm doc
---
.../quick-start/shardingsphere-proxy-quick-start.cn.md | 1 +
.../quick-start/shardingsphere-proxy-quick-start.en.md | 1 +
.../user-manual/shardingsphere-proxy/startup/helm.cn.md | 15 +++++++++++----
.../user-manual/shardingsphere-proxy/startup/helm.en.md | 17 ++++++++++++-----
shardingsphere-charts/README.md | 6 ++++--
shardingsphere-charts/README_ZH.md | 16 +++++++++-------
.../shardingsphere-proxy/charts/governance/Chart.yaml | 2 +-
shardingsphere-charts/shardingsphere-proxy/values.yaml | 2 +-
8 files changed, 40 insertions(+), 20 deletions(-)
diff --git a/docs/document/content/quick-start/shardingsphere-proxy-quick-start.cn.md b/docs/document/content/quick-start/shardingsphere-proxy-quick-start.cn.md
index e5c6edbd83c..b84d2b67705 100644
--- a/docs/document/content/quick-start/shardingsphere-proxy-quick-start.cn.md
+++ b/docs/document/content/quick-start/shardingsphere-proxy-quick-start.cn.md
@@ -9,6 +9,7 @@ weight = 2
目前 ShardingSphere-Proxy 可以通过以下方式：
- [二进制发布包](/cn/user-manual/shardingsphere-proxy/startup/bin/)
- [Docker](/cn/user-manual/shardingsphere-proxy/startup/docker/)
+- [Helm](/cn/user-manual/shardingsphere-proxy/startup/helm/)
## 规则配置
diff --git a/docs/document/content/quick-start/shardingsphere-proxy-quick-start.en.md b/docs/document/content/quick-start/shardingsphere-proxy-quick-start.en.md
index 71d02419034..e128f2f3d37 100644
--- a/docs/document/content/quick-start/shardingsphere-proxy-quick-start.en.md
+++ b/docs/document/content/quick-start/shardingsphere-proxy-quick-start.en.md
@@ -9,6 +9,7 @@ weight = 2
ShardingSphere-Proxy is available at:
- [Binary Distribution](/en/user-manual/shardingsphere-proxy/startup/bin/)
- [Docker](/en/user-manual/shardingsphere-proxy/startup/docker/)
+- [Helm](/en/user-manual/shardingsphere-proxy/startup/helm/)
## Rule Configuration
diff --git a/shardingsphere-charts/README_ZH.md b/docs/document/content/user-manual/shardingsphere-proxy/startup/helm.cn.md
similarity index 90%
copy from shardingsphere-charts/README_ZH.md
copy to docs/document/content/user-manual/shardingsphere-proxy/startup/helm.cn.md
index 006306a581b..eb76881a129 100644
--- a/shardingsphere-charts/README_ZH.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/startup/helm.cn.md
@@ -1,3 +1,8 @@
++++
+title = "使用 Helm"
+weight = 3
++++
+
# 使用 Helm
使用 [Helm](https://helm.sh/) 在 Kubernetes 集群中引导 ShardingSphere-Proxy 实例进行安装。
@@ -39,7 +44,9 @@ helm install shardingsphere-proxy shardingsphere/shardingsphere-proxy
#### 源码安装
```shell
-cd shardingsphere-proxy
+cd shardingsphere-proxy/charts/governance
+helm dependency build
+cd ../..
helm dependency build
cd ..
helm install shardingsphere-proxy shardingsphere-proxy
@@ -83,14 +90,14 @@ helm uninstall shardingsphere-proxy
### 计算节点--ShardingSphere-Proxy 配置项
-| 配置项 | 描述 | 值 |
-| ------------------------------------ |-----------------------------------| ----------------------------- |
+| 配置项 | 描述 | 值 |
+|------------------------------------|-----------------------------------|-------------------------------|
| `compute.image.repository` | ShardingSphere-Proxy 的镜像名 | `apache/shardingsphere-proxy` |
| `compute.image.pullPolicy` | ShardingSphere-Proxy 镜像拉取策略 | `IfNotPresent` |
| `compute.image.tag` | ShardingSphere-Proxy 镜像标签 | `5.1.2` |
| `compute.imagePullSecrets` | 拉取私有仓库的凭证 | `[]` |
| `compute.resources.limits` | ShardingSphere-Proxy 容器的资源限制 | `{}` |
-| `compute.resources.requests.memory | ShardingSphere-Proxy 容器申请的内存 | `1.6Gi` |
+| `compute.resources.requests.memory` | ShardingSphere-Proxy 容器申请的内存 | `2Gi` |
| `compute.resources.requests.cpu` | ShardingSphere-Proxy 容器申请的 cpu 核数 | `200m` |
| `compute.replicas` | ShardingSphere-Proxy 节点个数 | `3` |
| `compute.service.type` | ShardingSphere-Proxy 网络模式 | `ClusterIP` |
diff --git a/shardingsphere-charts/README.md b/docs/document/content/user-manual/shardingsphere-proxy/startup/helm.en.md
similarity index 92%
copy from shardingsphere-charts/README.md
copy to docs/document/content/user-manual/shardingsphere-proxy/startup/helm.en.md
index aa22bda1801..83ac30ba150 100644
--- a/shardingsphere-charts/README.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/startup/helm.en.md
@@ -1,3 +1,8 @@
++++
+title = "Use Helm"
+weight = 3
++++
+
# Use Helm
Use [Helm](https://helm.sh/) to provide guidance for the installation of ShardingSphere-Proxy instance in Kubernetes cluster.
@@ -38,10 +43,12 @@ helm install shardingsphere-proxy shardingsphere/shardingsphere-proxy
#### Source installation
```shell
-cd shardingsphere-proxy
+cd shardingsphere-proxy/charts/governance
helm dependency build
-cd ..
-helm install shardingsphere-proxy shardingsphere-proxy
+cd ../..
+helm dependency build
+cd ..
+helm install shardingsphere-proxy shardingsphere-proxy
```
Charts will be installed with default configuration if above commands executed.
@@ -83,13 +90,13 @@ Delete all release records by default, add `--keep-history` to keep them.
### Compute-Node ShardingSphere-Proxy parameters
| Name | Description | Value |
-| ----------------------------------- | ------------------------------------------------------------ | ----------------------------- |
+| ----------------------------------- | ------------------------------------------------------------ |-------------------------------|
| `compute.image.repository` | Image name of ShardingSphere-Proxy. | `apache/shardingsphere-proxy` |
| `compute.image.pullPolicy` | The policy for pulling ShardingSphere-Proxy image | `IfNotPresent` |
| `compute.image.tag` | ShardingSphere-Proxy image tag | `5.1.2` |
| `compute.imagePullSecrets` | Specify docker-registry secret names as an array | `[]` |
| `compute.resources.limits` | The resources limits for the ShardingSphere-Proxy containers | `{}` |
-| `compute.resources.requests.memory` | The requested memory for the ShardingSphere-Proxy containers | `1.6Gi` |
+| `compute.resources.requests.memory` | The requested memory for the ShardingSphere-Proxy containers | `2Gi` |
| `compute.resources.requests.cpu` | The requested cpu for the ShardingSphere-Proxy containers | `200m` |
| `compute.replicas` | Number of cluster replicas | `3` |
| `compute.service.type` | ShardingSphere-Proxy network mode | `ClusterIP` |
diff --git a/shardingsphere-charts/README.md b/shardingsphere-charts/README.md
index aa22bda1801..ee9f1b9867c 100644
--- a/shardingsphere-charts/README.md
+++ b/shardingsphere-charts/README.md
@@ -38,7 +38,9 @@ helm install shardingsphere-proxy shardingsphere/shardingsphere-proxy
#### Source installation
```shell
-cd shardingsphere-proxy
+cd shardingsphere-proxy/charts/governance
+helm dependency build
+cd ../..
helm dependency build
cd ..
helm install shardingsphere-proxy shardingsphere-proxy
@@ -89,7 +91,7 @@ Delete all release records by default, add `--keep-history` to keep them.
| `compute.image.tag` | ShardingSphere-Proxy image tag | `5.1.2` |
| `compute.imagePullSecrets` | Specify docker-registry secret names as an array | `[]` |
| `compute.resources.limits` | The resources limits for the ShardingSphere-Proxy containers | `{}` |
-| `compute.resources.requests.memory` | The requested memory for the ShardingSphere-Proxy containers | `1.6Gi` |
+| `compute.resources.requests.memory` | The requested memory for the ShardingSphere-Proxy containers | `2Gi` |
| `compute.resources.requests.cpu` | The requested cpu for the ShardingSphere-Proxy containers | `200m` |
| `compute.replicas` | Number of cluster replicas | `3` |
| `compute.service.type` | ShardingSphere-Proxy network mode | `ClusterIP` |
diff --git a/shardingsphere-charts/README_ZH.md b/shardingsphere-charts/README_ZH.md
index 006306a581b..21981c30d5e 100644
--- a/shardingsphere-charts/README_ZH.md
+++ b/shardingsphere-charts/README_ZH.md
@@ -39,10 +39,12 @@ helm install shardingsphere-proxy shardingsphere/shardingsphere-proxy
#### 源码安装
```shell
-cd shardingsphere-proxy
-helm dependency build
-cd ..
-helm install shardingsphere-proxy shardingsphere-proxy
+cd shardingsphere-proxy/charts/governance
+helm dependency build
+cd ../..
+helm dependency build
+cd ..
+helm install shardingsphere-proxy shardingsphere-proxy
```
执行上述命令以执行默认配置进行安装。
@@ -83,14 +85,14 @@ helm uninstall shardingsphere-proxy
### 计算节点--ShardingSphere-Proxy 配置项
-| 配置项 | 描述 | 值 |
-| ------------------------------------ |-----------------------------------| ----------------------------- |
+| 配置项 | 描述 | 值 |
+|------------------------------------|-----------------------------------|-------------------------------|
| `compute.image.repository` | ShardingSphere-Proxy 的镜像名 | `apache/shardingsphere-proxy` |
| `compute.image.pullPolicy` | ShardingSphere-Proxy 镜像拉取策略 | `IfNotPresent` |
| `compute.image.tag` | ShardingSphere-Proxy 镜像标签 | `5.1.2` |
| `compute.imagePullSecrets` | 拉取私有仓库的凭证 | `[]` |
| `compute.resources.limits` | ShardingSphere-Proxy 容器的资源限制 | `{}` |
-| `compute.resources.requests.memory | ShardingSphere-Proxy 容器申请的内存 | `1.6Gi` |
+| `compute.resources.requests.memory` | ShardingSphere-Proxy 容器申请的内存 | `2Gi` |
| `compute.resources.requests.cpu` | ShardingSphere-Proxy 容器申请的 cpu 核数 | `200m` |
| `compute.replicas` | ShardingSphere-Proxy 节点个数 | `3` |
| `compute.service.type` | ShardingSphere-Proxy 网络模式 | `ClusterIP` |
diff --git a/shardingsphere-charts/shardingsphere-proxy/charts/governance/Chart.yaml b/shardingsphere-charts/shardingsphere-proxy/charts/governance/Chart.yaml
index 3d05378478a..6afce950022 100644
--- a/shardingsphere-charts/shardingsphere-proxy/charts/governance/Chart.yaml
+++ b/shardingsphere-charts/shardingsphere-proxy/charts/governance/Chart.yaml
@@ -17,7 +17,7 @@
apiVersion: v2
name: governance
-description: A Helm chart for ShardingSphere-Proxy governance node
+description: A Helm chart for ShardingSphere-Proxy governance node
# A chart can be either an 'application' or a 'library' chart.
#
diff --git a/shardingsphere-charts/shardingsphere-proxy/values.yaml b/shardingsphere-charts/shardingsphere-proxy/values.yaml
index 96ba338ba2f..231b3bfdd27 100644
--- a/shardingsphere-charts/shardingsphere-proxy/values.yaml
+++ b/shardingsphere-charts/shardingsphere-proxy/values.yaml
@@ -56,7 +56,7 @@ governance:
## @section Compute-Node parameters
##
compute:
- ## @section Compute-Node ShardingSphere-Proxy parameters
+ ## @section Compute-Node ShardingSphere-Proxy parameters
## ref: https://kubernetes.io/docs/concepts/containers/images/
## @param compute.image.repository Image name of ShardingSphere-Proxy.
## @param compute.image.pullPolicy The policy for pulling ShardingSphere-Proxy image