You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by su...@apache.org on 2022/12/02 03:57:53 UTC
[shardingsphere-on-cloud] branch main updated: chore(helm,doc): update doc,helm for new version (#132)
This is an automated email from the ASF dual-hosted git repository.
sunnianjun pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shardingsphere-on-cloud.git
The following commit(s) were added to refs/heads/main by this push:
new 24e1837 chore(helm,doc): update doc,helm for new version (#132)
24e1837 is described below
commit 24e18370fbb77bec3fed5431cb1c3872a65370d6
Author: Ghoul_Lee <wi...@gmail.com>
AuthorDate: Fri Dec 2 11:57:49 2022 +0800
chore(helm,doc): update doc,helm for new version (#132)
* chore(helm): add nameOverride for helm release
Signed-off-by: windghoul <wi...@gmail.com>
* chore(doc): update doc for new version; update values default value for new version
Signed-off-by: windghoul <wi...@gmail.com>
Signed-off-by: windghoul <wi...@gmail.com>
---
.../values.yaml | 4 +
.../values.yaml | 6 +-
.../apache-shardingsphere-proxy-charts/values.yaml | 10 +-
docs/content/operation-guide/helm/_index.cn.md | 48 +++---
docs/content/operation-guide/helm/_index.en.md | 48 +++---
docs/content/operation-guide/operator/_index.cn.md | 95 ++++++------
docs/content/operation-guide/operator/_index.en.md | 109 ++++++++------
docs/shardingsphere-helm-charts.md | 80 +++++-----
docs/shardingsphere-operator.md | 166 +++++++++++----------
9 files changed, 294 insertions(+), 272 deletions(-)
diff --git a/charts/apache-shardingsphere-operator-charts/values.yaml b/charts/apache-shardingsphere-operator-charts/values.yaml
index 40b1188..5a08441 100644
--- a/charts/apache-shardingsphere-operator-charts/values.yaml
+++ b/charts/apache-shardingsphere-operator-charts/values.yaml
@@ -15,6 +15,10 @@
# limitations under the License.
#
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+##
+nameOverride: apache-shardingsphere-operator
## @section ShardingSphere operator parameters
## @param replicaCount operator replica count
##
diff --git a/charts/apache-shardingsphere-operator-cluster-charts/values.yaml b/charts/apache-shardingsphere-operator-cluster-charts/values.yaml
index 5abbef3..9aabd40 100644
--- a/charts/apache-shardingsphere-operator-cluster-charts/values.yaml
+++ b/charts/apache-shardingsphere-operator-cluster-charts/values.yaml
@@ -15,6 +15,10 @@
# limitations under the License.
#
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+##
+nameOverride: apache-shardingsphere-operator-cluster
## @section ShardingSphere-Proxy cluster parameters
## @param replicaCount ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect
## @param proxyVersion ShardingSphere-Proxy cluster version
@@ -80,7 +84,7 @@ serverConfig:
##
authority:
privilege:
- type: ALL_PRIVILEGES_PERMITTED
+ type: ALL_PERMITTED
users:
- password: root
user: root@%
diff --git a/charts/apache-shardingsphere-proxy-charts/values.yaml b/charts/apache-shardingsphere-proxy-charts/values.yaml
index 7b684fb..a8e104e 100644
--- a/charts/apache-shardingsphere-proxy-charts/values.yaml
+++ b/charts/apache-shardingsphere-proxy-charts/values.yaml
@@ -14,7 +14,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
-
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+nameOverride: apache-shardingsphere-proxy
## @section Governance-Node parameters
## @param governance.enabled Switch to enable or disable the governance helm chart
##
@@ -67,7 +69,7 @@ compute:
pullPolicy: IfNotPresent
## Overrides the image tag whose default is the chart appVersion.
##
- tag: "5.2.0"
+ tag: "5.2.1"
## @param compute.imagePullSecrets Specify docker-registry secret names as an array
## e.g：
## imagePullSecrets:
@@ -102,7 +104,7 @@ compute:
## @param compute.mysqlConnector.version MySQL connector version
##
mysqlConnector:
- version: "5.1.49"
+ version: "5.1.43"
## @param compute.startPort ShardingSphere-Proxy start port
## ShardingSphere-Proxy start port
## ref: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/docker/
@@ -126,7 +128,7 @@ compute:
##
authority:
privilege:
- type: ALL_PRIVILEGES_PERMITTED
+ type: ALL_PERMITTED
users:
- password: root
user: root@%
diff --git a/docs/content/operation-guide/helm/_index.cn.md b/docs/content/operation-guide/helm/_index.cn.md
index 248e2c9..33353ee 100644
--- a/docs/content/operation-guide/helm/_index.cn.md
+++ b/docs/content/operation-guide/helm/_index.cn.md
@@ -12,14 +12,14 @@ chapter = true
1. 添加 ShardingSphere-Proxy 到本地 Helm 仓库：
```shell
-helm repo add shardingsphere-proxy https://apache.github.io/shardingsphere-on-cloud
- helm repo update
+helm repo add shardingsphere https://apache.github.io/shardingsphere-on-cloud
+helm repo update
```
2. 安装 ShardingSphere-Proxy Charts：
```shell
-helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy-charts --version 0.1.0
+helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy-charts
```
### 源码安装
@@ -49,6 +49,12 @@ helm uninstall shardingsphere-proxy
## 参数说明
+### 命名参数
+
+| Name | Description | Value |
+|-------------------|------------------------------------------------------------------------------------------------------------|-------------------------------|
+| `nameOverride ` | nameOverride String to partially override common.names.fullname template (will maintain the release name) | `apache-shardingsphere-proxy` |
+
### 治理节点参数
| Name | Description | Value |
@@ -90,23 +96,9 @@ helm uninstall shardingsphere-proxy
## 配置示例
```yaml
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+nameOverride: apache-shardingsphere-proxy
## @section Governance-Node parameters
## @param governance.enabled Switch to enable or disable the governance helm chart
##
@@ -159,7 +151,7 @@ compute:
pullPolicy: IfNotPresent
## Overrides the image tag whose default is the chart appVersion.
##
- tag: "5.2.0"
+ tag: "5.2.1"
## @param compute.imagePullSecrets Specify docker-registry secret names as an array
## e.g：
## imagePullSecrets:
@@ -194,7 +186,7 @@ compute:
## @param compute.mysqlConnector.version MySQL connector version
##
mysqlConnector:
- version: "5.1.49"
+ version: "5.1.43"
## @param compute.startPort ShardingSphere-Proxy start port
## ShardingSphere-Proxy start port
## ref: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/docker/
@@ -218,10 +210,10 @@ compute:
##
authority:
privilege:
- type: ALL_PRIVILEGES_PERMITTED
+ type: ALL_PERMITTED
users:
- - password: root
- user: root@%
+ - password: root
+ user: root@%
## @section Compute-Node ShardingSphere-Proxy ServerConfiguration mode Configuration parameters
## @param compute.serverConfig.mode.type Type of mode configuration. Now only support Cluster mode
## @param compute.serverConfig.mode.repository.props.namespace Namespace of registry center
@@ -231,7 +223,6 @@ compute:
## @param compute.serverConfig.mode.repository.props.retryIntervalMilliseconds Milliseconds of retry interval
## @param compute.serverConfig.mode.repository.props.timeToLiveSeconds Seconds of ephemeral data live
## @param compute.serverConfig.mode.repository.type Type of persist repository. Now only support ZooKeeper
- ## @param compute.serverConfig.mode.overwrite Whether overwrite persistent configuration with local configuration
##
mode:
type: Cluster
@@ -244,5 +235,8 @@ compute:
retryIntervalMilliseconds: 500
server-lists: "{{ printf \"%s-zookeeper.%s:2181\" .Release.Name .Release.Namespace }}"
timeToLiveSeconds: 60
- overwrite: true
+ ## @param compute.serverConfig.props.proxy-frontend-database-protocol-type proxy frontend database protocol type. Only support: PostgreSQL,openGauss,MariaDB,MySQL
+ ##
+ props:
+ proxy-frontend-database-protocol-type: MySQL
```
diff --git a/docs/content/operation-guide/helm/_index.en.md b/docs/content/operation-guide/helm/_index.en.md
index 43ebc20..e600a20 100644
--- a/docs/content/operation-guide/helm/_index.en.md
+++ b/docs/content/operation-guide/helm/_index.en.md
@@ -12,14 +12,14 @@ chapter = true
1. Add SharedingSphere-Proxy to the local Helm warehouse:
```shell
-helm repo add shardingsphere-proxy https://apache.github.io/shardingsphere-on-cloud
- helm repo update
+helm repo add shardingsphere https://apache.github.io/shardingsphere-on-cloud
+helm repo update
```
2. Install ShardingSphere-Proxy Charts:
```shell
-helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy-charts --version 0.1.0
+helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy-charts
```
### Source Code Installation
@@ -49,6 +49,12 @@ helm uninstall shardingsphere-proxy
## Parameter Description
+### Name parameters
+
+| Name | Description | Value |
+|-------------------|------------------------------------------------------------------------------------------------------------|-------------------------------|
+| `nameOverride ` | nameOverride String to partially override common.names.fullname template (will maintain the release name) | `apache-shardingsphere-proxy` |
+
### Governance Node Parameters
| Name | Description | Value |
@@ -90,23 +96,9 @@ helm uninstall shardingsphere-proxy
## Example
```yaml
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+nameOverride: apache-shardingsphere-proxy
## @section Governance-Node parameters
## @param governance.enabled Switch to enable or disable the governance helm chart
##
@@ -159,7 +151,7 @@ compute:
pullPolicy: IfNotPresent
## Overrides the image tag whose default is the chart appVersion.
##
- tag: "5.2.0"
+ tag: "5.2.1"
## @param compute.imagePullSecrets Specify docker-registry secret names as an array
## e.g：
## imagePullSecrets:
@@ -194,7 +186,7 @@ compute:
## @param compute.mysqlConnector.version MySQL connector version
##
mysqlConnector:
- version: "5.1.49"
+ version: "5.1.43"
## @param compute.startPort ShardingSphere-Proxy start port
## ShardingSphere-Proxy start port
## ref: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/docker/
@@ -218,10 +210,10 @@ compute:
##
authority:
privilege:
- type: ALL_PRIVILEGES_PERMITTED
+ type: ALL_PERMITTED
users:
- - password: root
- user: root@%
+ - password: root
+ user: root@%
## @section Compute-Node ShardingSphere-Proxy ServerConfiguration mode Configuration parameters
## @param compute.serverConfig.mode.type Type of mode configuration. Now only support Cluster mode
## @param compute.serverConfig.mode.repository.props.namespace Namespace of registry center
@@ -231,7 +223,6 @@ compute:
## @param compute.serverConfig.mode.repository.props.retryIntervalMilliseconds Milliseconds of retry interval
## @param compute.serverConfig.mode.repository.props.timeToLiveSeconds Seconds of ephemeral data live
## @param compute.serverConfig.mode.repository.type Type of persist repository. Now only support ZooKeeper
- ## @param compute.serverConfig.mode.overwrite Whether overwrite persistent configuration with local configuration
##
mode:
type: Cluster
@@ -244,6 +235,9 @@ compute:
retryIntervalMilliseconds: 500
server-lists: "{{ printf \"%s-zookeeper.%s:2181\" .Release.Name .Release.Namespace }}"
timeToLiveSeconds: 60
- overwrite: true
+ ## @param compute.serverConfig.props.proxy-frontend-database-protocol-type proxy frontend database protocol type. Only support: PostgreSQL,openGauss,MariaDB,MySQL
+ ##
+ props:
+ proxy-frontend-database-protocol-type: MySQL
```
diff --git a/docs/content/operation-guide/operator/_index.cn.md b/docs/content/operation-guide/operator/_index.cn.md
index fb813a2..2326994 100644
--- a/docs/content/operation-guide/operator/_index.cn.md
+++ b/docs/content/operation-guide/operator/_index.cn.md
@@ -65,34 +65,36 @@ helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluste
### ShardingSphere Operator 参数
-| Name | Description | Value |
-| ------------------------ | ------------------------------------------- | ------------------------- |
-| `replicaCount` | operator replica count | `2` |
-| `image.repository` | operator image name | `sahrdingsphere-operator` |
-| `image.pullPolicy` | image pull policy | `IfNotPresent` |
-| `image.tag` | image tag | `0.0.1` |
-| `imagePullSecrets` | image pull secret of private repository | `[]` |
-| `resources` | operator Resources required by the operator | `{}` |
-| `webhook.port` | operator webhook boot port | `9443` |
-| `health.healthProbePort` | operator health check port | `8081` |
+| Name | Description | Value |
+|--------------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------|
+| `nameOverride` | nameOverride String to partially override common.names.fullname template (will maintain the release name) | `apache-shardingsphere-operator` |
+| `replicaCount` | operator replica count | `2` |
+| `image.repository` | operator image name | `sahrdingsphere-operator` |
+| `image.pullPolicy` | image pull policy | `IfNotPresent` |
+| `image.tag` | image tag | `0.0.1` |
+| `imagePullSecrets` | image pull secret of private repository | `[]` |
+| `resources` | operator Resources required by the operator | `{}` |
+| `webhook.port` | operator webhook boot port | `9443` |
+| `health.healthProbePort` | operator health check port | `8081` |
### ShardingSphere-Proxy Cluster 参数
-| Name | Description | Value |
-| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| `replicaCount` | ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect | `3` |
-| `proxyVersion` | ShardingSphere-Proxy cluster version | `5.2.0` |
-| `automaticScaling.enable` | ShardingSphere-Proxy Whether the ShardingSphere-Proxy cluster has auto-scaling enabled | `false` |
-| `automaticScaling.scaleUpWindows` | ShardingSphere-Proxy automatically scales the stable window | `30` |
-| `automaticScaling.scaleDownWindows` | ShardingSphere-Proxy automatically shrinks the stabilized window | `30` |
-| `automaticScaling.target` | ShardingSphere-Proxy auto-scaling threshold, the value is a percentage, note: at this stage, only cpu is supported as a metric for scaling | `20` |
-| `automaticScaling.maxInstance` | ShardingSphere-Proxy maximum number of scaled-out replicas | `4` |
-| `automaticScaling.minInstance` | ShardingSphere-Proxy has a minimum number of boot replicas, and the shrinkage will not be less than this number of replicas | `1` |
-| `resources` | ShardingSphere-Proxy starts the requirement resource, and after opening automaticScaling, the resource of the request multiplied by the percentage of target is used to trigger the scaling action | `{}` |
-| `service.type` | ShardingSphere-Proxy external exposure mode | `ClusterIP` |
-| `service.port` | ShardingSphere-Proxy exposes port | `3307` |
-| `startPort` | ShardingSphere-Proxy boot port | `3307` |
-| `mySQLDriver.version` | ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty | `5.1.47` |
+| Name | Description | Value |
+|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
+| `nameOverride` | nameOverride String to partially override common.names.fullname template (will maintain the release name) | `apache-shardingsphere-operator-cluster` |
+| `replicaCount` | ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect | `3` |
+| `proxyVersion` | ShardingSphere-Proxy cluster version | `5.2.0` |
+| `automaticScaling.enable` | ShardingSphere-Proxy Whether the ShardingSphere-Proxy cluster has auto-scaling enabled | `false` |
+| `automaticScaling.scaleUpWindows` | ShardingSphere-Proxy automatically scales the stable window | `30` |
+| `automaticScaling.scaleDownWindows` | ShardingSphere-Proxy automatically shrinks the stabilized window | `30` |
+| `automaticScaling.target` | ShardingSphere-Proxy auto-scaling threshold, the value is a percentage, note: at this stage, only cpu is supported as a metric for scaling | `20` |
+| `automaticScaling.maxInstance` | ShardingSphere-Proxy maximum number of scaled-out replicas | `4` |
+| `automaticScaling.minInstance` | ShardingSphere-Proxy has a minimum number of boot replicas, and the shrinkage will not be less than this number of replicas | `1` |
+| `resources` | ShardingSphere-Proxy starts the requirement resource, and after opening automaticScaling, the resource of the request multiplied by the percentage of target is used to trigger the scaling action | `{}` |
+| `service.type` | ShardingSphere-Proxy external exposure mode | `ClusterIP` |
+| `service.port` | ShardingSphere-Proxy exposes port | `3307` |
+| `startPort` | ShardingSphere-Proxy boot port | `3307` |
+| `mySQLDriver.version` | ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty | `5.1.47` |
### 计算节点 ShardingSphere-Proxy ServerConfig 权限相关参数
@@ -133,20 +135,24 @@ helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluste
apache-shardingsphere-operator-charts/values.yaml
```yaml
-## @section ShardingSphere-Proxy operator parameters
-## @param replicaCount operator replica count
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+##
+nameOverride: apache-shardingsphere-operator
+## @section ShardingSphere operator parameters
+## @param replicaCount operator replica count
##
replicaCount: 2
image:
## @param image.repository operator image name
##
- repository: "sahrdingsphere-operator"
+ repository: "ghcr.io/apache/shardingsphere-on-cloud/apache-shardingsphere-operator"
## @param image.pullPolicy image pull policy
##
pullPolicy: IfNotPresent
## @param image.tag image tag
##
- tag: "0.0.1"
+ tag: "0.1.0"
## @param imagePullSecrets image pull secret of private repository
## e.g:
## imagePullSecrets:
@@ -170,17 +176,22 @@ webhook:
##
health:
healthProbePort: 8081
+
```
apache-shardingsphere-operator-cluster-charts/values.yaml
```yaml
-# @section ShardingSphere-Proxy cluster parameters
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+##
+nameOverride: apache-shardingsphere-operator-cluster
+## @section ShardingSphere-Proxy cluster parameters
## @param replicaCount ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect
## @param proxyVersion ShardingSphere-Proxy cluster version
##
replicaCount: "3"
-proxyVersion: "5.2.0"
+proxyVersion: "5.2.1"
## @param automaticScaling.enable ShardingSphere-Proxy Whether the ShardingSphere-Proxy cluster has auto-scaling enabled
## @param automaticScaling.scaleUpWindows ShardingSphere-Proxy automatically scales the stable window
## @param automaticScaling.scaleDownWindows ShardingSphere-Proxy automatically shrinks the stabilized window
@@ -203,11 +214,7 @@ automaticScaling:
## requests:
## cpu: 2
##
-resources:
- limits:
- cpu: '2'
- requests:
- cpu: '1'
+resources: {}
## @param service.type ShardingSphere-Proxy external exposure mode
## @param service.port ShardingSphere-Proxy exposes port
##
@@ -220,7 +227,13 @@ startPort: 3307
## @param mySQLDriver.version ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty
##
mySQLDriver:
- version: "5.1.47"
+ version: "5.1.43"
+## @param imagePullSecrets ShardingSphere-Proxy pull private image repository key
+## e.g:
+## imagePullSecrets:
+## - name: mysecret
+##
+imagePullSecrets: []
## @section ShardingSphere-Proxy ServerConfiguration parameters
## NOTE: If you use the sub-charts to deploy Zookeeper, the server-lists field must be "{{ printf \"%s-zookeeper.%s:2181\" .Release.Name .Release.Namespace }}",
## otherwise please fill in the correct zookeeper address
@@ -238,7 +251,7 @@ serverConfig:
##
authority:
privilege:
- type: ALL_PRIVILEGES_PERMITTED
+ type: ALL_PERMITTED
users:
- password: root
user: root@%
@@ -251,10 +264,8 @@ serverConfig:
## @param serverConfig.mode.repository.props.retryIntervalMilliseconds Milliseconds of retry interval
## @param serverConfig.mode.repository.props.timeToLiveSeconds Seconds of ephemeral data live
## @param serverConfig.mode.repository.type Type of persist repository. Now only support ZooKeeper
- ## @param serverConfig.mode.overwrite Whether overwrite persistent configuration with local configuration
- ##
+ ## @param serverConfig.props.proxy-frontend-database-protocol-type Default startup protocol
mode:
- overwrite: true
repository:
props:
maxRetries: 3
@@ -278,7 +289,7 @@ zookeeper:
enabled: true
## @param zookeeper.replicaCount Number of ZooKeeper nodes
##
- replicaCount: 3
+ replicaCount: 1
## ZooKeeper Persistence parameters
## ref: https://kubernetes.io/docs/user-guide/persistent-volumes/
## @param zookeeper.persistence.enabled Enable persistence on ZooKeeper using PVC(s)
diff --git a/docs/content/operation-guide/operator/_index.en.md b/docs/content/operation-guide/operator/_index.en.md
index 14629cc..7f54a71 100644
--- a/docs/content/operation-guide/operator/_index.en.md
+++ b/docs/content/operation-guide/operator/_index.en.md
@@ -65,47 +65,49 @@ helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluste
### ShardingSphere Operator Parameters
-| Name | Description | Value |
-| ------------------------ | ------------------------------------------- | ------------------------- |
-| `replicaCount` | operator replica count | `2` |
-| `image.repository` | operator image name | `sahrdingsphere-operator` |
-| `image.pullPolicy` | image pull policy | `IfNotPresent` |
-| `image.tag` | image tag | `0.0.1` |
-| `imagePullSecrets` | image pull secret of private repository | `[]` |
-| `resources` | operator Resources required by the operator | `{}` |
-| `webhook.port` | operator webhook boot port | `9443` |
-| `health.healthProbePort` | operator health check port | `8081` |
+| Name | Description | Value |
+|--------------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------|
+| `nameOverride` | nameOverride String to partially override common.names.fullname template (will maintain the release name) | `apache-shardingsphere-operator` |
+| `replicaCount` | operator replica count | `2` |
+| `image.repository` | operator image name | `sahrdingsphere-operator` |
+| `image.pullPolicy` | image pull policy | `IfNotPresent` |
+| `image.tag` | image tag | `0.0.1` |
+| `imagePullSecrets` | image pull secret of private repository | `[]` |
+| `resources` | operator Resources required by the operator | `{}` |
+| `webhook.port` | operator webhook boot port | `9443` |
+| `health.healthProbePort` | operator health check port | `8081` |
### ShardingSphere-Proxy Cluster Parameters
-| Name | Description | Value |
-| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| `replicaCount` | ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect | `3` |
-| `proxyVersion` | ShardingSphere-Proxy cluster version | `5.2.0` |
-| `automaticScaling.enable` | ShardingSphere-Proxy Whether the ShardingSphere-Proxy cluster has auto-scaling enabled | `false` |
-| `automaticScaling.scaleUpWindows` | ShardingSphere-Proxy automatically scales the stable window | `30` |
-| `automaticScaling.scaleDownWindows` | ShardingSphere-Proxy automatically shrinks the stabilized window | `30` |
-| `automaticScaling.target` | ShardingSphere-Proxy auto-scaling threshold, the value is a percentage, note: at this stage, only cpu is supported as a metric for scaling | `20` |
-| `automaticScaling.maxInstance` | ShardingSphere-Proxy maximum number of scaled-out replicas | `4` |
-| `automaticScaling.minInstance` | ShardingSphere-Proxy has a minimum number of boot replicas, and the shrinkage will not be less than this number of replicas | `1` |
-| `resources` | ShardingSphere-Proxy starts the requirement resource, and after opening automaticScaling, the resource of the request multiplied by the percentage of target is used to trigger the scaling action | `{}` |
-| `service.type` | ShardingSphere-Proxy external exposure mode | `ClusterIP` |
-| `service.port` | ShardingSphere-Proxy exposes port | `3307` |
-| `startPort` | ShardingSphere-Proxy boot port | `3307` |
-| `mySQLDriver.version` | ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty | `5.1.47` |
+| Name | Description | Value |
+|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
+| `nameOverride` | nameOverride String to partially override common.names.fullname template (will maintain the release name) | `apache-shardingsphere-operator-cluster` |
+| `replicaCount` | ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect | `3` |
+| `proxyVersion` | ShardingSphere-Proxy cluster version | `5.2.0` |
+| `automaticScaling.enable` | ShardingSphere-Proxy Whether the ShardingSphere-Proxy cluster has auto-scaling enabled | `false` |
+| `automaticScaling.scaleUpWindows` | ShardingSphere-Proxy automatically scales the stable window | `30` |
+| `automaticScaling.scaleDownWindows` | ShardingSphere-Proxy automatically shrinks the stabilized window | `30` |
+| `automaticScaling.target` | ShardingSphere-Proxy auto-scaling threshold, the value is a percentage, note: at this stage, only cpu is supported as a metric for scaling | `20` |
+| `automaticScaling.maxInstance` | ShardingSphere-Proxy maximum number of scaled-out replicas | `4` |
+| `automaticScaling.minInstance` | ShardingSphere-Proxy has a minimum number of boot replicas, and the shrinkage will not be less than this number of replicas | `1` |
+| `resources` | ShardingSphere-Proxy starts the requirement resource, and after opening automaticScaling, the resource of the request multiplied by the percentage of target is used to trigger the scaling action | `{}` |
+| `service.type` | ShardingSphere-Proxy external exposure mode | `ClusterIP` |
+| `service.port` | ShardingSphere-Proxy exposes port | `3307` |
+| `startPort` | ShardingSphere-Proxy boot port | `3307` |
+| `mySQLDriver.version` | ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty | `5.1.47` |
### ShardingSphere-Proxy ServerConfig Authority Related Parameters of Compute Node
-| Name | Description | Value |
-| ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
-| `serverConfig.authority.privilege.type` | authority provider for storage node, the default value is ALL_PERMITTED | `ALL_PRIVILEGES_PERMITTED` |
-| `serverConfig.authority.users[0].password` | Password for compute node. | `root` |
-| `serverConfig.authority.users[0].user` | Username,authorized host for compute node. Format: <username>@<hostname> hostname is % or empty string means do not care about authorized host | `root@%` |
+| Name | Description | Value |
+|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
+| `serverConfig.authority.privilege.type` | authority provider for storage node, the default value is ALL_PERMITTED | `ALL_PERMITTED` |
+| `serverConfig.authority.users[0].password` | Password for compute node. | `root` |
+| `serverConfig.authority.users[0].user` | Username,authorized host for compute node. Format: <username>@<hostname> hostname is % or empty string means do not care about authorized host | `root@%` |
### ShardingSphere-Proxy ServerConfig Mode Related Paraters of Compute Node
| Name | Description | Value |
-| ----------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+|-------------------------------------------------------------------|---------------------------------------------------------------------|------------------------------------------------------------------------|
| `serverConfig.mode.type` | Type of mode configuration. Now only support Cluster mode | `Cluster` |
| `serverConfig.mode.repository.props.namespace` | Namespace of registry center | `governance_ds` |
| `serverConfig.mode.repository.props.server-lists` | Server lists of registry center | `{{ printf "%s-zookeeper.%s:2181" .Release.Name .Release.Namespace }}` |
@@ -120,7 +122,7 @@ helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluste
### ZooKeeper Chart Parameters
| Name | Description | Value |
-| ------------------------------------ | ---------------------------------------------------- | ------------------- |
+|--------------------------------------|------------------------------------------------------|---------------------|
| `zookeeper.enabled` | Switch to enable or disable the ZooKeeper helm chart | `true` |
| `zookeeper.replicaCount` | Number of ZooKeeper nodes | `1` |
| `zookeeper.persistence.enabled` | Enable persistence on ZooKeeper using PVC(s) | `false` |
@@ -133,20 +135,24 @@ helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluste
apache-shardingsphere-operator-charts/values.yaml
```yaml
-## @section ShardingSphere-Proxy operator parameters
-## @param replicaCount operator replica count
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+##
+nameOverride: apache-shardingsphere-operator
+## @section ShardingSphere operator parameters
+## @param replicaCount operator replica count
##
replicaCount: 2
image:
## @param image.repository operator image name
##
- repository: "sahrdingsphere-operator"
+ repository: "ghcr.io/apache/shardingsphere-on-cloud/apache-shardingsphere-operator"
## @param image.pullPolicy image pull policy
##
pullPolicy: IfNotPresent
## @param image.tag image tag
##
- tag: "0.0.1"
+ tag: "0.1.0"
## @param imagePullSecrets image pull secret of private repository
## e.g:
## imagePullSecrets:
@@ -170,17 +176,22 @@ webhook:
##
health:
healthProbePort: 8081
+
```
apache-shardingsphere-operator-cluster-charts/values.yaml
```yaml
-# @section ShardingSphere-Proxy cluster parameters
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+##
+nameOverride: apache-shardingsphere-operator-cluster
+## @section ShardingSphere-Proxy cluster parameters
## @param replicaCount ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect
## @param proxyVersion ShardingSphere-Proxy cluster version
##
replicaCount: "3"
-proxyVersion: "5.2.0"
+proxyVersion: "5.2.1"
## @param automaticScaling.enable ShardingSphere-Proxy Whether the ShardingSphere-Proxy cluster has auto-scaling enabled
## @param automaticScaling.scaleUpWindows ShardingSphere-Proxy automatically scales the stable window
## @param automaticScaling.scaleDownWindows ShardingSphere-Proxy automatically shrinks the stabilized window
@@ -203,11 +214,7 @@ automaticScaling:
## requests:
## cpu: 2
##
-resources:
- limits:
- cpu: '2'
- requests:
- cpu: '1'
+resources: {}
## @param service.type ShardingSphere-Proxy external exposure mode
## @param service.port ShardingSphere-Proxy exposes port
##
@@ -220,7 +227,13 @@ startPort: 3307
## @param mySQLDriver.version ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty
##
mySQLDriver:
- version: "5.1.47"
+ version: "5.1.43"
+## @param imagePullSecrets ShardingSphere-Proxy pull private image repository key
+## e.g:
+## imagePullSecrets:
+## - name: mysecret
+##
+imagePullSecrets: []
## @section ShardingSphere-Proxy ServerConfiguration parameters
## NOTE: If you use the sub-charts to deploy Zookeeper, the server-lists field must be "{{ printf \"%s-zookeeper.%s:2181\" .Release.Name .Release.Namespace }}",
## otherwise please fill in the correct zookeeper address
@@ -238,7 +251,7 @@ serverConfig:
##
authority:
privilege:
- type: ALL_PRIVILEGES_PERMITTED
+ type: ALL_PERMITTED
users:
- password: root
user: root@%
@@ -251,10 +264,8 @@ serverConfig:
## @param serverConfig.mode.repository.props.retryIntervalMilliseconds Milliseconds of retry interval
## @param serverConfig.mode.repository.props.timeToLiveSeconds Seconds of ephemeral data live
## @param serverConfig.mode.repository.type Type of persist repository. Now only support ZooKeeper
- ## @param serverConfig.mode.overwrite Whether overwrite persistent configuration with local configuration
- ##
+ ## @param serverConfig.props.proxy-frontend-database-protocol-type Default startup protocol
mode:
- overwrite: true
repository:
props:
maxRetries: 3
@@ -278,7 +289,7 @@ zookeeper:
enabled: true
## @param zookeeper.replicaCount Number of ZooKeeper nodes
##
- replicaCount: 3
+ replicaCount: 1
## ZooKeeper Persistence parameters
## ref: https://kubernetes.io/docs/user-guide/persistent-volumes/
## @param zookeeper.persistence.enabled Enable persistence on ZooKeeper using PVC(s)
diff --git a/docs/shardingsphere-helm-charts.md b/docs/shardingsphere-helm-charts.md
index 8279434..026aa76 100644
--- a/docs/shardingsphere-helm-charts.md
+++ b/docs/shardingsphere-helm-charts.md
@@ -2,24 +2,24 @@
## Procedure
-### Online installation
+### Online Installation
-1. Add ShardingSphere-Proxy to the local helm repo:
+1. Add SharedingSphere-Proxy to the local Helm warehouse:
```shell
helm repo add shardingsphere https://apache.github.io/shardingsphere-on-cloud
helm repo update
```
-2. Install ShardingSphere-Proxy charts:
+2. Install ShardingSphere-Proxy Charts:
```shell
-helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy-charts --version 0.1.0
+helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy-charts
```
-### Source installation
+### Source Code Installation
-1. Charts will be installed with default configuration if the following commands are executed:
+1. Charts can be configured and installed by default using the following command:
```shell
cd charts/apache-shardingsphere-proxy-charts/charts/governance
@@ -29,27 +29,34 @@ helm dependency build
cd ..
helm install shardingsphere-proxy apache-shardingsphere-proxy-charts
```
-Note: Please refer to the configuration items description below for more details.
-2. Execute `helm list` to acquire all installed releases.
+Note: Please refer to the configuration description below for details.
-### Uninstall
+2. Execute `helm list` to get the list of all installed releases.
-1. Delete all release records by default, add `--keep-history` to keep them.
+### Uninstallation
+
+1. By default, all publishing records are deleted and can be retained by adding '-- keep history'.
```shell
helm uninstall shardingsphere-proxy
```
-## Parameters
+## Parameter Description
+
+### Name parameters
+
+| Name | Description | Value |
+|-------------------|------------------------------------------------------------------------------------------------------------|-------------------------------|
+| `nameOverride ` | nameOverride String to partially override common.names.fullname template (will maintain the release name) | `apache-shardingsphere-proxy` |
-### Governance-Node parameters
+### Governance Node Parameters
| Name | Description | Value |
| -------------------- | ----------------------------------------------------- | ------ |
| `governance.enabled` | Switch to enable or disable the governance helm chart | `true` |
-### Governance-Node ZooKeeper parameters
+### ZooKeeper Parameters of Governance Node
| Name | Description | Value |
| ------------------------------------------------ | ---------------------------------------------------- | ------------------- |
@@ -63,7 +70,7 @@ helm uninstall shardingsphere-proxy
| `governance.zookeeper.resources.requests.memory` | The requested memory for the ZooKeeper containers | `256Mi` |
| `governance.zookeeper.resources.requests.cpu` | The requested cpu for the ZooKeeper containers | `250m` |
-### Compute-Node ShardingSphere-Proxy parameters
+### ShardingSphere-Proxy Parameters of Compute Node
| Name | Description | Value |
| ----------------------------------- | ------------------------------------------------------------ |-------------------------------|
@@ -81,28 +88,12 @@ helm uninstall shardingsphere-proxy
| `compute.startPort` | ShardingSphere-Proxy start port | `3307` |
| `compute.serverConfig` | Server Configuration file for ShardingSphere-Proxy | `""` |
-## Sample
-
-values.yaml
-
-```PlainText
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
+## Example
+```yaml
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+nameOverride: apache-shardingsphere-proxy
## @section Governance-Node parameters
## @param governance.enabled Switch to enable or disable the governance helm chart
##
@@ -155,7 +146,7 @@ compute:
pullPolicy: IfNotPresent
## Overrides the image tag whose default is the chart appVersion.
##
- tag: "5.2.0"
+ tag: "5.2.1"
## @param compute.imagePullSecrets Specify docker-registry secret names as an array
## e.g：
## imagePullSecrets:
@@ -190,7 +181,7 @@ compute:
## @param compute.mysqlConnector.version MySQL connector version
##
mysqlConnector:
- version: "5.1.49"
+ version: "5.1.43"
## @param compute.startPort ShardingSphere-Proxy start port
## ShardingSphere-Proxy start port
## ref: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/docker/
@@ -214,10 +205,10 @@ compute:
##
authority:
privilege:
- type: ALL_PRIVILEGES_PERMITTED
+ type: ALL_PERMITTED
users:
- - password: root
- user: root@%
+ - password: root
+ user: root@%
## @section Compute-Node ShardingSphere-Proxy ServerConfiguration mode Configuration parameters
## @param compute.serverConfig.mode.type Type of mode configuration. Now only support Cluster mode
## @param compute.serverConfig.mode.repository.props.namespace Namespace of registry center
@@ -227,7 +218,6 @@ compute:
## @param compute.serverConfig.mode.repository.props.retryIntervalMilliseconds Milliseconds of retry interval
## @param compute.serverConfig.mode.repository.props.timeToLiveSeconds Seconds of ephemeral data live
## @param compute.serverConfig.mode.repository.type Type of persist repository. Now only support ZooKeeper
- ## @param compute.serverConfig.mode.overwrite Whether overwrite persistent configuration with local configuration
##
mode:
type: Cluster
@@ -240,5 +230,9 @@ compute:
retryIntervalMilliseconds: 500
server-lists: "{{ printf \"%s-zookeeper.%s:2181\" .Release.Name .Release.Namespace }}"
timeToLiveSeconds: 60
- overwrite: true
-`
+ ## @param compute.serverConfig.props.proxy-frontend-database-protocol-type proxy frontend database protocol type. Only support: PostgreSQL,openGauss,MariaDB,MySQL
+ ##
+ props:
+ proxy-frontend-database-protocol-type: MySQL
+```
+
diff --git a/docs/shardingsphere-operator.md b/docs/shardingsphere-operator.md
index e236489..a297946 100644
--- a/docs/shardingsphere-operator.md
+++ b/docs/shardingsphere-operator.md
@@ -2,18 +2,19 @@
## Install ShardingSphere-Operator
-Configuration [below](#shardingsphere-operator-parameters) configuration content, configuration file location apache-shardingsphere-operator-charts/values.yaml
-run
+The following configuration content and configuration file directory are: apache-shardingsphere-operator-charts/values.yaml.
+
+### Online Installation
-### Online Install
```shell
-kubectl create ns shardingsphere-operator
-helm repo add shardingsphere https://apache.github.io/shardingsphere-on-cloud
-helm repo update
-helm install shardingsphere-operator shardingsphere/apache-shardingsphere-operator-charts --version 0.1.0 -n shardingsphere-operator
+ kubectl create ns shardingsphere-operator
+ helm repo add shardingsphere https://apache.github.io/shardingsphere-on-cloud
+ helm repo update
+ helm install shardingsphere-operator shardingsphere/apache-shardingsphere-operator-charts --version 0.1.0 -n shardingsphere-operator
```
-### Source Code Install
+### Source Code Installation
+
```shell
kubectl create ns shardingsphere-operator
cd charts/apache-shardingsphere-operator-charts/
@@ -22,12 +23,12 @@ cd ../
helm install shardingsphere-operator apache-shardingsphere-operator-charts -n shardingsphere-operator
```
-## Install ShardingSphere-Proxy cluster
+## ShardingSphere-Proxy Cluster Installation
+
+The following configuration content and configuration file directory are: apache-shardingsphere-operator-cluster-charts/values.yaml.
-Configuration [below](#shardingsphere-proxy-cluster-parameters) configuration content, configuration file location apache-shardingsphere-operator-cluster-charts/values.yaml
-run
+### Online Installation
-## Online Install
```shell
kubectl create ns shardingsphere
helm repo add shardingsphere https://apache.github.io/shardingsphere-on-cloud
@@ -35,7 +36,8 @@ helm repo update
helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluster-charts --version 0.1.0 -n shardingsphere
```
-### Source Code Install
+### Source Code Installation
+
```shell
kubectl create ns shardingsphere
cd charts/apache-shardingsphere-operator-cluster-charts
@@ -44,62 +46,63 @@ cd ../
helm install shardingsphere apache-shardingsphere-operator-cluster-charts -n shardingsphere
```
-## Online Install ShardingSphere-Proxy cluster && ShardingSphere-Operator
+## Online Install ShardingSphere-Proxy Cluster and ShardingSphere-Operator
+
```shell
helm repo add shardingsphere https://apache.github.io/shardingsphere-on-cloud
kubectl create ns shardingsphere-operator
-helm install shardingsphere-operator shardingsphere/apache-shardingsphere-operator-charts --version 0.1.0 -n shardingsphere-operator
+helm install shardingsphere-operator shardingsphere/apache-shardingsphere-operator-charts --version 0.1.0
kubectl create ns shardingsphere
-helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluster-charts --version 0.1.0 -n shardingsphere
+helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluster-charts --version 0.1.0
```
-## Parameters
-### ShardingSphere Operator Parameters
+## Parameters
-| Name | Description | Value |
-| ------------------------ | ------------------------------------------- | ------------------------- |
-| `replicaCount` | operator replica count | `2` |
-| `image.repository` | operator image name | `sahrdingsphere-operator` |
-| `image.pullPolicy` | image pull policy | `IfNotPresent` |
-| `image.tag` | image tag | `0.0.1` |
-| `imagePullSecrets` | image pull secret of private repository | `[]` |
-| `resources` | operator Resources required by the operator | `{}` |
-| `webhook.port` | operator webhook boot port | `9443` |
-| `health.healthProbePort` | operator health check port | `8081` |
+### ShardingSphere Operator Parameters
+| Name | Description | Value |
+|--------------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------|
+| `nameOverride` | nameOverride String to partially override common.names.fullname template (will maintain the release name) | `apache-shardingsphere-operator` |
+| `replicaCount` | operator replica count | `2` |
+| `image.repository` | operator image name | `sahrdingsphere-operator` |
+| `image.pullPolicy` | image pull policy | `IfNotPresent` |
+| `image.tag` | image tag | `0.0.1` |
+| `imagePullSecrets` | image pull secret of private repository | `[]` |
+| `resources` | operator Resources required by the operator | `{}` |
+| `webhook.port` | operator webhook boot port | `9443` |
+| `health.healthProbePort` | operator health check port | `8081` |
### ShardingSphere-Proxy Cluster Parameters
-| Name | Description | Value |
-| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| `replicaCount` | ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect | `3` |
-| `proxyVersion` | ShardingSphere-Proxy cluster version | `5.2.0` |
-| `automaticScaling.enable` | ShardingSphere-Proxy Whether the ShardingSphere-Proxy cluster has auto-scaling enabled | `false` |
-| `automaticScaling.scaleUpWindows` | ShardingSphere-Proxy automatically scales the stable window | `30` |
-| `automaticScaling.scaleDownWindows` | ShardingSphere-Proxy automatically shrinks the stabilized window | `30` |
-| `automaticScaling.target` | ShardingSphere-Proxy auto-scaling threshold, the value is a percentage, note: at this stage, only cpu is supported as a metric for scaling | `20` |
-| `automaticScaling.maxInstance` | ShardingSphere-Proxy maximum number of scaled-out replicas | `4` |
-| `automaticScaling.minInstance` | ShardingSphere-Proxy has a minimum number of boot replicas, and the shrinkage will not be less than this number of replicas | `1` |
-| `resources` | ShardingSphere-Proxy starts the requirement resource, and after opening automaticScaling, the resource of the request multiplied by the percentage of target is used to trigger the scaling action | `{}` |
-| `service.type` | ShardingSphere-Proxy external exposure mode | `ClusterIP` |
-| `service.port` | ShardingSphere-Proxy exposes port | `3307` |
-| `startPort` | ShardingSphere-Proxy boot port | `3307` |
-| `mySQLDriver.version` | ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty | `5.1.47` |
-
-
-### Compute-Node ShardingSphere-Proxy ServerConfiguration Authority Parameters
-
-| Name | Description | Value |
-| ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
-| `serverConfig.authority.privilege.type` | authority provider for storage node, the default value is ALL_PERMITTED | `ALL_PRIVILEGES_PERMITTED` |
-| `serverConfig.authority.users[0].password` | Password for compute node. | `root` |
-| `serverConfig.authority.users[0].user` | Username,authorized host for compute node. Format: <username>@<hostname> hostname is % or empty string means do not care about authorized host | `root@%` |
-
-
-### Compute-Node ShardingSphere-Proxy ServerConfiguration Mode Configuration Parameters
+| Name | Description | Value |
+|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
+| `nameOverride` | nameOverride String to partially override common.names.fullname template (will maintain the release name) | `apache-shardingsphere-operator-cluster` |
+| `replicaCount` | ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect | `3` |
+| `proxyVersion` | ShardingSphere-Proxy cluster version | `5.2.0` |
+| `automaticScaling.enable` | ShardingSphere-Proxy Whether the ShardingSphere-Proxy cluster has auto-scaling enabled | `false` |
+| `automaticScaling.scaleUpWindows` | ShardingSphere-Proxy automatically scales the stable window | `30` |
+| `automaticScaling.scaleDownWindows` | ShardingSphere-Proxy automatically shrinks the stabilized window | `30` |
+| `automaticScaling.target` | ShardingSphere-Proxy auto-scaling threshold, the value is a percentage, note: at this stage, only cpu is supported as a metric for scaling | `20` |
+| `automaticScaling.maxInstance` | ShardingSphere-Proxy maximum number of scaled-out replicas | `4` |
+| `automaticScaling.minInstance` | ShardingSphere-Proxy has a minimum number of boot replicas, and the shrinkage will not be less than this number of replicas | `1` |
+| `resources` | ShardingSphere-Proxy starts the requirement resource, and after opening automaticScaling, the resource of the request multiplied by the percentage of target is used to trigger the scaling action | `{}` |
+| `service.type` | ShardingSphere-Proxy external exposure mode | `ClusterIP` |
+| `service.port` | ShardingSphere-Proxy exposes port | `3307` |
+| `startPort` | ShardingSphere-Proxy boot port | `3307` |
+| `mySQLDriver.version` | ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty | `5.1.47` |
+
+### ShardingSphere-Proxy ServerConfig Authority Related Parameters of Compute Node
+
+| Name | Description | Value |
+|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
+| `serverConfig.authority.privilege.type` | authority provider for storage node, the default value is ALL_PERMITTED | `ALL_PERMITTED` |
+| `serverConfig.authority.users[0].password` | Password for compute node. | `root` |
+| `serverConfig.authority.users[0].user` | Username,authorized host for compute node. Format: <username>@<hostname> hostname is % or empty string means do not care about authorized host | `root@%` |
+
+### ShardingSphere-Proxy ServerConfig Mode Related Paraters of Compute Node
| Name | Description | Value |
-| ----------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+|-------------------------------------------------------------------|---------------------------------------------------------------------|------------------------------------------------------------------------|
| `serverConfig.mode.type` | Type of mode configuration. Now only support Cluster mode | `Cluster` |
| `serverConfig.mode.repository.props.namespace` | Namespace of registry center | `governance_ds` |
| `serverConfig.mode.repository.props.server-lists` | Server lists of registry center | `{{ printf "%s-zookeeper.%s:2181" .Release.Name .Release.Namespace }}` |
@@ -111,11 +114,10 @@ helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluste
| `serverConfig.mode.overwrite` | Whether overwrite persistent configuration with local configuration | `true` |
| `serverConfig.props.proxy-frontend-database-protocol-type` | Default startup protocol | `MySQL` |
-
### ZooKeeper Chart Parameters
| Name | Description | Value |
-| ------------------------------------ | ---------------------------------------------------- | ------------------- |
+|--------------------------------------|------------------------------------------------------|---------------------|
| `zookeeper.enabled` | Switch to enable or disable the ZooKeeper helm chart | `true` |
| `zookeeper.replicaCount` | Number of ZooKeeper nodes | `1` |
| `zookeeper.persistence.enabled` | Enable persistence on ZooKeeper using PVC(s) | `false` |
@@ -123,26 +125,29 @@ helm install shardingsphere shardingsphere/apache-shardingsphere-operator-cluste
| `zookeeper.persistence.accessModes` | Persistent Volume access modes | `["ReadWriteOnce"]` |
| `zookeeper.persistence.size` | Persistent Volume size | `8Gi` |
-
-## Configuration Example
+## Examples
apache-shardingsphere-operator-charts/values.yaml
```yaml
-## @section ShardingSphere-Proxy operator parameters
-## @param replicaCount operator replica count
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+##
+nameOverride: apache-shardingsphere-operator
+## @section ShardingSphere operator parameters
+## @param replicaCount operator replica count
##
replicaCount: 2
image:
## @param image.repository operator image name
##
- repository: "sahrdingsphere-operator"
+ repository: "ghcr.io/apache/shardingsphere-on-cloud/apache-shardingsphere-operator"
## @param image.pullPolicy image pull policy
##
pullPolicy: IfNotPresent
## @param image.tag image tag
##
- tag: "0.0.1"
+ tag: "0.1.0"
## @param imagePullSecrets image pull secret of private repository
## e.g:
## imagePullSecrets:
@@ -166,17 +171,22 @@ webhook:
##
health:
healthProbePort: 8081
+
```
apache-shardingsphere-operator-cluster-charts/values.yaml
```yaml
-# @section ShardingSphere-Proxy cluster parameters
+## @section Name parameters
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+##
+nameOverride: apache-shardingsphere-operator-cluster
+## @section ShardingSphere-Proxy cluster parameters
## @param replicaCount ShardingSphere-Proxy cluster starts the number of replicas, Note: After you enable automaticScaling, this parameter will no longer take effect
## @param proxyVersion ShardingSphere-Proxy cluster version
##
replicaCount: "3"
-proxyVersion: "5.2.0"
+proxyVersion: "5.2.1"
## @param automaticScaling.enable ShardingSphere-Proxy Whether the ShardingSphere-Proxy cluster has auto-scaling enabled
## @param automaticScaling.scaleUpWindows ShardingSphere-Proxy automatically scales the stable window
## @param automaticScaling.scaleDownWindows ShardingSphere-Proxy automatically shrinks the stabilized window
@@ -199,11 +209,7 @@ automaticScaling:
## requests:
## cpu: 2
##
-resources:
- limits:
- cpu: '2'
- requests:
- cpu: '1'
+resources: {}
## @param service.type ShardingSphere-Proxy external exposure mode
## @param service.port ShardingSphere-Proxy exposes port
##
@@ -216,7 +222,13 @@ startPort: 3307
## @param mySQLDriver.version ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty
##
mySQLDriver:
- version: "5.1.47"
+ version: "5.1.43"
+## @param imagePullSecrets ShardingSphere-Proxy pull private image repository key
+## e.g:
+## imagePullSecrets:
+## - name: mysecret
+##
+imagePullSecrets: []
## @section ShardingSphere-Proxy ServerConfiguration parameters
## NOTE: If you use the sub-charts to deploy Zookeeper, the server-lists field must be "{{ printf \"%s-zookeeper.%s:2181\" .Release.Name .Release.Namespace }}",
## otherwise please fill in the correct zookeeper address
@@ -234,7 +246,7 @@ serverConfig:
##
authority:
privilege:
- type: ALL_PRIVILEGES_PERMITTED
+ type: ALL_PERMITTED
users:
- password: root
user: root@%
@@ -247,10 +259,8 @@ serverConfig:
## @param serverConfig.mode.repository.props.retryIntervalMilliseconds Milliseconds of retry interval
## @param serverConfig.mode.repository.props.timeToLiveSeconds Seconds of ephemeral data live
## @param serverConfig.mode.repository.type Type of persist repository. Now only support ZooKeeper
- ## @param serverConfig.mode.overwrite Whether overwrite persistent configuration with local configuration
- ##
+ ## @param serverConfig.props.proxy-frontend-database-protocol-type Default startup protocol
mode:
- overwrite: true
repository:
props:
maxRetries: 3
@@ -274,7 +284,7 @@ zookeeper:
enabled: true
## @param zookeeper.replicaCount Number of ZooKeeper nodes
##
- replicaCount: 3
+ replicaCount: 1
## ZooKeeper Persistence parameters
## ref: https://kubernetes.io/docs/user-guide/persistent-volumes/
## @param zookeeper.persistence.enabled Enable persistence on ZooKeeper using PVC(s)
@@ -290,8 +300,6 @@ zookeeper:
size: 8Gi
```
-
-
## Clean
```shell