This is an automated email from the ASF dual-hosted git repository. duanzhengqiang pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/shardingsphere-on-cloud.git
commit e31519f242f6caa4792abef9524a1c3dfa18989e Author: windghoul <[email protected]> AuthorDate: Wed Jul 20 11:16:03 2022 +0800 feat(doc): add annotation for helm values.yaml --- charts/shardingsphere-cluster/values.yaml | 50 ++++++++++++++++++++---------- charts/shardingsphere-operator/values.yaml | 41 +++++++++++++++++------- 2 files changed, 62 insertions(+), 29 deletions(-) diff --git a/charts/shardingsphere-cluster/values.yaml b/charts/shardingsphere-cluster/values.yaml index 29d14f6..1e9033c 100644 --- a/charts/shardingsphere-cluster/values.yaml +++ b/charts/shardingsphere-cluster/values.yaml @@ -1,16 +1,32 @@ +## +## Copyright © 2022，Beijing Sifei Software Technology Co., LTD. +## All Rights Reserved. +## +## Licensed 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 DBPlusEngine-Proxy cluster parameters -## @param replicaCount DBPlusEngine-Proxy 集群启动副本数，注意：在开启 automaticScaling 后，这个参数将不再生效 +# @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.1.2" -## @param automaticScaling.enable DBPlusEngine-Proxy 集群是否开启自动扩缩容 -## @param automaticScaling.scaleUpWindows DBPlusEngine-Proxy 自动扩容稳定窗口 -## @param automaticScaling.scaleDownWindows DBPlusEngine-Proxy 自动缩容稳定窗口 -## @param automaticScaling.target DBPlusEngine-Proxy 自动扩缩容阈值，数值为百分比，注意：现阶段暂时只支持 cpu 为指标进行扩缩容 -## @param automaticScaling.maxInstance DBPlusEngine-Proxy 最大扩容副本数 -## @param automaticScaling.minInstance DBPlusEngine-Proxy 最小启动副本数，缩容不会小于这个副本数 +## @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 +## @param 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 +## @param automaticScaling.maxInstance ShardingSphere-Proxy maximum number of scaled-out replicas +## @param automaticScaling.minInstance ShardingSphere-Proxy has a minimum number of boot replicas, and the shrinkage will not be less than this number of replicas ## automaticScaling: enable: false @@ -19,7 +35,7 @@ automaticScaling: target: 20 maxInstance: 4 minInstance: 1 -## @param resources DBPlusEngine-Proxy 启动需求资源，在开启automaticScaling 后，以 request 的资源乘以 target 的百分比为触发扩缩容动作的实际使用率 +## @param 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 ## e.g: ## resources: ## limits: @@ -32,20 +48,20 @@ resources: cpu: '2' requests: cpu: '1' -## @param service.type DBPlusEngine-Proxy 对外暴露方式 -## @param service.port DBPlusEngine-Proxy 对外暴露端口 +## @param service.type ShardingSphere-Proxy external exposure mode +## @param service.port ShardingSphere-Proxy exposes port ## service: type: ClusterIP port: 3307 -## @param startPort DBPlusEngine-Proxy 启动端口 +## @param startPort ShardingSphere-Proxy boot port ## startPort: 3307 -## @param mySQLDriver.version DBPlusEngine-Proxy mysql 驱动版本，如果为空，将不下载驱动 +## @param mySQLDriver.version ShardingSphere-Proxy The ShardingSphere-Proxy mysql driver version will not be downloaded if it is empty ## mySQLDriver: version: "5.1.47" -## @section DBPlusEngine-Proxy ServerConfiguration parameters +## @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 ## The server.yaml is auto-generated based on this parameter. @@ -54,7 +70,7 @@ mySQLDriver: ## ref: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/metadata-repository/ ## serverConfig: - ## @section Compute-Node DBPlusEngine-Proxy ServerConfiguration authority parameters + ## @section Compute-Node ShardingSphere-Proxy ServerConfiguration authority parameters ## NOTE: It is used to set up initial user to login compute node, and authority data of storage node. ## @param serverConfig.authority.privilege.type authority provider for storage node, the default value is ALL_PERMITTED ## @param serverConfig.authority.users[0].password Password for compute node. @@ -66,7 +82,7 @@ serverConfig: users: - password: root user: root@% - ## @section Compute-Node DBPlusEngine-Proxy ServerConfiguration mode Configuration parameters + ## @section Compute-Node ShardingSphere-Proxy ServerConfiguration mode Configuration parameters ## @param serverConfig.mode.type Type of mode configuration. Now only support Cluster mode ## @param serverConfig.mode.repository.props.namespace Namespace of registry center ## @param serverConfig.mode.repository.props.server-lists Server lists of registry center diff --git a/charts/shardingsphere-operator/values.yaml b/charts/shardingsphere-operator/values.yaml index 9b5ad5b..3b8997b 100644 --- a/charts/shardingsphere-operator/values.yaml +++ b/charts/shardingsphere-operator/values.yaml @@ -15,23 +15,40 @@ ## limitations under the License. ## +## @section ShardingSphere-Proxy operator parameters +## @param replicaCount operator replica count +## replicaCount: 2 - image: - repository: "uhub.service.ucloud.cn/sphere-ex/proxy-operator" + ## @param image.repository operator image name + ## + repository: "sahrdingsphere-operator" + ## @param image.pullPolicy image pull policy + ## pullPolicy: IfNotPresent - # Overrides the image tag whose default is the chart appVersion. + ## @param image.tag image tag + ## tag: "0.0.1" -imagePullSecrets: - - name: uhub -service: - type: ClusterIP - port: 80 -resources: - requests: - cpu: 100m - memory: 128Mi +## @param imagePullSecrets image pull secret of private repository +## e.g: +## imagePullSecrets: +## - name: mysecret +## +imagePullSecrets: [] +## @param resources operator Resources required by the operator +## e.g: +## resources: +## limits: +## cpu: 2 +## limits: +## cpu: 2 +## +resources: {} +## @param webhook.port operator webhook boot port +## webhook: port: 9443 +## @param health.healthProbePort operator health check port +## health: healthProbePort: 8081 \ No newline at end of file
