使用 Helm

背景信息

使用 Helm 在 Kubernetes 集群中引导 ShardingSphere-Proxy 实例进行安装。关于 ShardingSphere Helm Charts 的更多内容可以参考：ShardingSphere-on-Cloud 子项目。

前提条件

  • kubernetes 1.18+
  • kubectl
  • helm 3.3.0+
  • 可以动态申请 PV(Persistent Volumes) 的 StorageClass 用于持久化数据。（可选）

操作步骤

在线安装

  1. 将 ShardingSphere-Proxy 添加到 Helm 本地仓库：
  1. helm repo add shardingsphere https://shardingsphere.apache.org/charts
  1. 以 ShardingSphere-Proxy 命名安装 charts：
  1. helm install shardingsphere-proxy shardingsphere/shardingsphere-proxy

源码安装

  1. 执行下述命令以执行默认配置进行安装。
  1.  git clone https://github.com/apache/shardingsphere-on-cloud.git
  2.  cd charts/shardingsphere-proxy/charts/governance
  3.  helm dependency build 
  4.  cd ../..
  5.  helm dependency build 
  6.  cd ..
  7.  helm install shardingsphere-proxy shardingsphere-proxy

说明：

  1. 其他的配置详见下方的配置列表。
  2. 执行 helm list 获取所有安装的 release。

卸载

  1. 默认删除所有发布记录，增加 --keep-history 参数保留发布记录。
  1. helm uninstall shardingsphere-proxy

参数解释

治理节点配置项

配置项描述值
governance.enabled用来切换是否使用治理节点的 charttrue

治理节点 ZooKeeper 配置项

配置项描述值
governance.zookeeper.enabled用来切换是否使用 ZooKeeper 的 charttrue
governance.zookeeper.replicaCountZooKeeper 节点数量1
governance.zookeeper.persistence.enabled标识 ZooKeeper 是否使用持久卷申领 (PersistentVolumeClaim) 用来申请持久卷（PersistentVolume）false
governance.zookeeper.persistence.storageClass持久卷（PersistentVolume）的存储类 (StorageClass)“”
governance.zookeeper.persistence.accessModes持久卷（PersistentVolume）的访问模式[“ReadWriteOnce”]
governance.zookeeper.persistence.size持久卷（PersistentVolume） 大小8Gi
governance.zookeeper.resources.limitsZooKeeper 容器的资源限制{}
governance.zookeeper.resources.requests.memoryZooKeeper 容器申请的内存256Mi
governance.zookeeper.resources.requests.cpuZooKeeper 容器申请的 cpu 核数250m

计算节点 ShardingSphere-Proxy 配置项

配置项描述值
compute.image.repositoryShardingSphere-Proxy 的镜像名apache/shardingsphere-proxy
compute.image.pullPolicyShardingSphere-Proxy 镜像拉取策略IfNotPresent
compute.image.tagShardingSphere-Proxy 镜像标签5.1.2
compute.imagePullSecrets拉取私有仓库的凭证[]
compute.resources.limitsShardingSphere-Proxy 容器的资源限制{}
compute.resources.requests.memoryShardingSphere-Proxy 容器申请的内存2Gi
compute.resources.requests.cpuShardingSphere-Proxy 容器申请的 cpu 核数200m
compute.replicasShardingSphere-Proxy 节点个数3
compute.service.typeShardingSphere-Proxy 网络模式ClusterIP
compute.service.portShardingSphere-Proxy 暴露端口3307
compute.mysqlConnector.versionMySQL 驱动版本5.1.49
compute.startPortShardingSphere-Proxy 启动端口3307
compute.serverConfigShardingSphere-Proxy 模式配置文件“”

配置示例

  1. #
  2. #  Licensed to the Apache Software Foundation (ASF) under one or more
  3. #  contributor license agreements.  See the NOTICE file distributed with
  4. #  this work for additional information regarding copyright ownership.
  5. #  The ASF licenses this file to You under the Apache License, Version 2.0
  6. #  (the "License"); you may not use this file except in compliance with
  7. #  the License.  You may obtain a copy of the License at
  8. #
  9. #      http://www.apache.org/licenses/LICENSE-2.0
  10. #
  11. #  Unless required by applicable law or agreed to in writing, software
  12. #  distributed under the License is distributed on an "AS IS" BASIS,
  13. #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. #  See the License for the specific language governing permissions and
  15. #  limitations under the License.
  16. #
  18. ## @section Governance-Node parameters
  19. ## @param governance.enabled Switch to enable or disable the governance helm chart
  20. ##
  21. governance:
  22.   enabled: true
  23.   ## @section Governance-Node ZooKeeper parameters
  24.   zookeeper:
  25.     ## @param governance.zookeeper.enabled Switch to enable or disable the ZooKeeper helm chart
  26.     ##
  27.     enabled: true
  28.     ## @param governance.zookeeper.replicaCount Number of ZooKeeper nodes
  29.     ##
  30.     replicaCount: 1
  31.     ## ZooKeeper Persistence parameters
  32.     ## ref: https://kubernetes.io/docs/user-guide/persistent-volumes/
  33.     ## @param governance.zookeeper.persistence.enabled Enable persistence on ZooKeeper using PVC(s)
  34.     ## @param governance.zookeeper.persistence.storageClass Persistent Volume storage class
  35.     ## @param governance.zookeeper.persistence.accessModes Persistent Volume access modes
  36.     ## @param governance.zookeeper.persistence.size Persistent Volume size
  37.     ##
  38.     persistence:
  39.       enabled: false
  40.       storageClass: ""
  41.       accessModes:
  42.         - ReadWriteOnce
  43.       size: 8Gi
  44.     ## ZooKeeper's resource requests and limits
  45.     ## ref: https://kubernetes.io/docs/user-guide/compute-resources/
  46.     ## @param governance.zookeeper.resources.limits The resources limits for the ZooKeeper containers
  47.     ## @param governance.zookeeper.resources.requests.memory The requested memory for the ZooKeeper containers
  48.     ## @param governance.zookeeper.resources.requests.cpu The requested cpu for the ZooKeeper containers
  49.     ##
  50.     resources:
  51.       limits: {}
  52.       requests:
  53.         memory: 256Mi
  54.         cpu: 250m
  56. ## @section Compute-Node parameters
  57. ## 
  58. compute:
  59.   ## @section Compute-Node ShardingSphere-Proxy parameters
  60.   ## ref: https://kubernetes.io/docs/concepts/containers/images/
  61.   ## @param compute.image.repository Image name of ShardingSphere-Proxy.
  62.   ## @param compute.image.pullPolicy The policy for pulling ShardingSphere-Proxy image
  63.   ## @param compute.image.tag ShardingSphere-Proxy image tag
  64.   ##
  65.   image:
  66.     repository: "apache/shardingsphere-proxy"
  67.     pullPolicy: IfNotPresent
  68.     ## Overrides the image tag whose default is the chart appVersion.
  69.     ##
  70.     tag: "5.1.2"
  71.   ## @param compute.imagePullSecrets Specify docker-registry secret names as an array
  72.   ## e.g：
  73.   ## imagePullSecrets:
  74.   ##   - name: myRegistryKeySecretName
  75.   ##
  76.   imagePullSecrets: []
  77.   ## ShardingSphere-Proxy resource requests and limits
  78.   ## ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  79.   ## @param compute.resources.limits The resources limits for the ShardingSphere-Proxy containers
  80.   ## @param compute.resources.requests.memory The requested memory for the ShardingSphere-Proxy containers
  81.   ## @param compute.resources.requests.cpu The requested cpu for the ShardingSphere-Proxy containers
  82.   ##
  83.   resources:
  84.     limits: {}
  85.     requests:
  86.       memory: 2Gi
  87.       cpu: 200m
  88.   ## ShardingSphere-Proxy Deployment Configuration
  89.   ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
  90.   ## ref: https://kubernetes.io/docs/concepts/services-networking/service/
  91.   ## @param compute.replicas Number of cluster replicas
  92.   ##
  93.   replicas: 3
  94.   ## @param compute.service.type ShardingSphere-Proxy network mode
  95.   ## @param compute.service.port ShardingSphere-Proxy expose port
  96.   ##
  97.   service:
  98.     type: ClusterIP
  99.     port: 3307
  100.   ## MySQL connector Configuration
  101.   ## ref: https://shardingsphere.apache.org/document/current/en/quick-start/shardingsphere-proxy-quick-start/
  102.   ## @param compute.mysqlConnector.version MySQL connector version
  103.   ##
  104.   mysqlConnector:
  105.     version: "5.1.49"
  106.   ## @param compute.startPort ShardingSphere-Proxy start port
  107.   ## ShardingSphere-Proxy start port
  108.   ## ref: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/docker/
  109.   ##
  110.   startPort: 3307
  111.   ## @section Compute-Node ShardingSphere-Proxy ServerConfiguration parameters
  112.   ## 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 }}",
  113.   ## otherwise please fill in the correct zookeeper address
  114.   ## The global.yaml is auto-generated based on this parameter.
  115.   ## If it is empty, the global.yaml is also empty.
  116.   ## ref: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/yaml-config/mode/
  117.   ## ref: https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/metadata-repository/
  118.   ##
  119.   serverConfig:
  120.     ## @section Compute-Node ShardingSphere-Proxy ServerConfiguration authority parameters
  121.     ## NOTE: It is used to set up initial user to login compute node, and authority data of storage node.
  122.     ## ref: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/yaml-config/authentication/
  123.     ## @param compute.serverConfig.authority.privilege.type authority provider for storage node, the default value is ALL_PERMITTED
  124.     ## @param compute.serverConfig.authority.users[0].password Password for compute node.
  125.     ## @param compute.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
  126.     ##
  127.     authority:
  128.       privilege:
  129.         type: ALL_PRIVILEGES_PERMITTED
  130.       users:
  131.       - password: root
  132.         user: root@%
  133.     ## @section Compute-Node ShardingSphere-Proxy ServerConfiguration mode Configuration parameters
  134.     ## @param compute.serverConfig.mode.type Type of mode configuration. Now only support Cluster mode
  135.     ## @param compute.serverConfig.mode.repository.props.namespace Namespace of registry center
  136.     ## @param compute.serverConfig.mode.repository.props.server-lists Server lists of registry center
  137.     ## @param compute.serverConfig.mode.repository.props.maxRetries Max retries of client connection
  138.     ## @param compute.serverConfig.mode.repository.props.operationTimeoutMilliseconds Milliseconds of operation timeout
  139.     ## @param compute.serverConfig.mode.repository.props.retryIntervalMilliseconds Milliseconds of retry interval
  140.     ## @param compute.serverConfig.mode.repository.props.timeToLiveSeconds Seconds of ephemeral data live
  141.     ## @param compute.serverConfig.mode.repository.type Type of persist repository. Now only support ZooKeeper
  142.     ## @param compute.serverConfig.mode.overwrite Whether overwrite persistent configuration with local configuration
  143.     ##
  144.     mode:
  145.       type: Cluster
  146.       repository:
  147.         type: ZooKeeper
  148.         props:
  149.           maxRetries: 3
  150.           namespace: governance_ds
  151.           operationTimeoutMilliseconds: 5000
  152.           retryIntervalMilliseconds: 500
  153.           server-lists: "{{ printf \"%s-zookeeper.%s:2181\" .Release.Name .Release.Namespace }}"
  154.           timeToLiveSeconds: 60
  155.       overwrite: true