You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2022/06/28 13:59:27 UTC
[shardingsphere] branch master updated: Update readme for chart (#18668)
This is an automated email from the ASF dual-hosted git repository.
zhaojinchao 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 f6b2d4602bc Update readme for chart (#18668)
f6b2d4602bc is described below
commit f6b2d4602bc54e286d30137310e4d4c2c551afec
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Tue Jun 28 21:59:21 2022 +0800
Update readme for chart (#18668)
---
shardingsphere-charts/README.md | 135 +------------------------------------
shardingsphere-charts/README_ZH.md | 134 +-----------------------------------
2 files changed, 2 insertions(+), 267 deletions(-)
diff --git a/shardingsphere-charts/README.md b/shardingsphere-charts/README.md
index 6be9f287f0a..998a094f5c3 100644
--- a/shardingsphere-charts/README.md
+++ b/shardingsphere-charts/README.md
@@ -1,136 +1,3 @@
# Use Helm
-Use [Helm](https://helm.sh/) to provide guidance for the installation of ShardingSphere-Proxy instance in Kubernetes cluster.
-
-## Quick Start
-
-Attention: The following installation method will start ShardingSphere-Proxy with the default server.yaml configuration
-
-```shell
-helm repo add shardingsphere https://shardingsphere.apache.org/charts
-helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy
-```
-
-## Step By Step
-
-### Requirements
-
-1. Kubernetes 1.18+
-1. kubectl
-1. Helm 3.2.0+
-
-Use StorageClass to allow dynamic provisioning of Persistent Volumes (PV) for data persistent (optional).
-
-### Install
-
-#### Online installation
-
-Add ShardingSphere-Proxy to the local helm repo:
-
-```shell
-helm repo add shardingsphere https://shardingsphere.apache.org/charts
-```
-
-Install ShardingSphere-Proxy charts:
-Attention: The following installation method will start ShardingSphere-Proxy with the default server.yaml configuration
-
-```shell
-helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy
-```
-
-To modify the configuration:
-
-```shell
-helm pull shardingsphere/apache-shardingsphere-proxy
-tar -zxvf apache-shardingsphere-proxy-1.1.0-chart.tgz
-# Modify the serverConfig section in apache-shardingsphere-proxy/values.yaml
-helm install shardingsphere-proxy apache-shardingsphere-proxy
-```
-
-#### Source installation
-
-```shell
-cd apache-shardingsphere-proxy/charts/governance
-helm dependency build
-cd ../..
-helm dependency build
-cd ..
-helm install shardingsphere-proxy apache-shardingsphere-proxy
-```
-
-Charts will be installed with default configuration if above commands executed.
-Please refer configuration items description below to get more details.
-Execute `helm list` to acquire all installed releases.
-
-### Uninstall
-
-```shell
-helm uninstall shardingsphere-proxy
-```
-
-Delete all release records by default, add `--keep-history` to keep them.
-
-## Parameters
-
-### Governance-Node parameters
-
-| Name | Description | Value |
-| -------------------- | ----------------------------------------------------- | ------ |
-| `governance.enabled` | Switch to enable or disable the governance helm chart | `true` |
-
-
-### Governance-Node ZooKeeper parameters
-
-| Name | Description | Value |
-| ------------------------------------------------ | ---------------------------------------------------- | ------------------- |
-| `governance.zookeeper.enabled` | Switch to enable or disable the ZooKeeper helm chart | `true` |
-| `governance.zookeeper.replicaCount` | Number of ZooKeeper nodes | `1` |
-| `governance.zookeeper.persistence.enabled` | Enable persistence on ZooKeeper using PVC(s) | `false` |
-| `governance.zookeeper.persistence.storageClass` | Persistent Volume storage class | `""` |
-| `governance.zookeeper.persistence.accessModes` | Persistent Volume access modes | `["ReadWriteOnce"]` |
-| `governance.zookeeper.persistence.size` | Persistent Volume size | `8Gi` |
-| `governance.zookeeper.resources.limits` | The resources limits for the ZooKeeper containers | `{}` |
-| `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
-
-| 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 | `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` |
-| `compute.service.port` | ShardingSphere-Proxy expose port | `3307` |
-| `compute.mysqlConnector.version` | MySQL connector version | `5.1.49` |
-| `compute.startPort` | ShardingSphere-Proxy start port | `3307` |
-
-
-### Compute-Node ShardingSphere-Proxy ServerConfiguration authority parameters
-
-| Name | Description | Value |
-| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
-| `compute.serverConfig.authority.privilege.type` | authority provider for storage node, the default value is ALL_PERMITTED | `ALL_PRIVILEGES_PERMITTED` |
-| `compute.serverConfig.authority.users[0].password` | Password for compute node. | `root` |
-| `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 | `root@%` |
-
-
-### Compute-Node ShardingSphere-Proxy ServerConfiguration mode Configuration parameters
-
-| Name | Description | Value |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------- |
-| `compute.serverConfig.mode.type` | Type of mode configuration. Now only support Cluster mode | `Cluster` |
-| `compute.serverConfig.mode.repository.props.namespace` | Namespace of registry center | `governance_ds` |
-| `compute.serverConfig.mode.repository.props.server-lists` | Server lists of registry center | `{{ printf "%s-zookeeper.%s:2181" .Release.Name .Release.Namespace }}` |
-| `compute.serverConfig.mode.repository.props.maxRetries` | Max retries of client connection | `3` |
-| `compute.serverConfig.mode.repository.props.operationTimeoutMilliseconds` | Milliseconds of operation timeout | `5000` |
-| `compute.serverConfig.mode.repository.props.retryIntervalMilliseconds` | Milliseconds of retry interval | `500` |
-| `compute.serverConfig.mode.repository.props.timeToLiveSeconds` | Seconds of ephemeral data live | `60` |
-| `compute.serverConfig.mode.repository.type` | Type of persist repository. Now only support ZooKeeper | `ZooKeeper` |
-| `compute.serverConfig.mode.overwrite` | Whether overwrite persistent configuration with local configuration | `true` |
+Please read the [document](https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/helm/)
diff --git a/shardingsphere-charts/README_ZH.md b/shardingsphere-charts/README_ZH.md
index 59e0a352e94..8573348aa9e 100644
--- a/shardingsphere-charts/README_ZH.md
+++ b/shardingsphere-charts/README_ZH.md
@@ -1,135 +1,3 @@
# 使用 Helm
-使用 [Helm](https://helm.sh/) 在 Kubernetes 集群中引导 ShardingSphere-Proxy 实例进行安装。
-
-## 快速入门
-
-注意️：以下安装方式将使用默认的 server.yaml 配置启动 ShardingSphere-Proxy
-
-```shell
-helm repo add shardingsphere https://shardingsphere.apache.org/charts
-helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy
-```
-
-## 操作步骤
-
-### 必要条件
-
-1. kubernetes 1.18+
-1. kubectl
-1. helm 3.2.0+
-
-可以动态申请 PV(Persistent Volumes) 的 StorageClass (可选)。
-
-### 安装
-
-#### 在线安装
-
-将 ShardingSphere-Proxy 添加到 Helm 本地仓库：
-
-```shell
-helm repo add shardingsphere https://shardingsphere.apache.org/charts
-```
-
-以 ShardingSphere-Proxy 命名安装 charts：
-注意️：以下安装方式将使用默认的 server.yaml 配置启动 ShardingSphere-Proxy
-
-```shell
-helm install shardingsphere-proxy shardingsphere/apache-shardingsphere-proxy
-```
-
-如需修改配置，请执行以下操作:
-
-```shell
-helm pull shardingsphere/apache-shardingsphere-proxy
-tar -zxvf apache-shardingsphere-proxy-1.1.0-chart.tgz
-# 修改 apache-shardingsphere-proxy/values.yaml 中 serverConfig 部分
-helm install shardingsphere-proxy apache-shardingsphere-proxy
-```
-
-#### 源码安装
-
-```shell
-cd apache-shardingsphere-proxy/charts/governance
-helm dependency build
-cd ../..
-helm dependency build
-cd ..
-helm install shardingsphere-proxy apache-shardingsphere-proxy
-```
-
-执行上述命令以执行默认配置进行安装。
-其他的配置详见下方的配置列表。
-执行 `helm list` 获取所有安装的 release。
-
-### 卸载
-
-```shell
-helm uninstall shardingsphere-proxy
-```
-
-默认删除所有发布记录，增加 `--keep-history` 参数保留发布记录。
-
-## 配置项
-
-### 治理节点配置项
-
-| 配置项 | 描述 | 值 |
-|----------------------|---------------------|--------|
-| `governance.enabled` | 用来切换是否使用治理节点的 chart | `true` |
-
-
-### 治理节点 ZooKeeper 配置项
-
-| 配置项 | 描述 | 值 |
-|--------------------------------------------------|---------------------------------------------------------------------------|---------------------|
-| `governance.zookeeper.enabled` | 用来切换是否使用 ZooKeeper 的 chart | `true` |
-| `governance.zookeeper.replicaCount` | ZooKeeper 节点数量 | `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.limits` | ZooKeeper 容器的资源限制 | `{}` |
-| `governance.zookeeper.resources.requests.memory` | ZooKeeper 容器申请的内存 | `256Mi` |
-| `governance.zookeeper.resources.requests.cpu` | ZooKeeper 容器申请的 cpu 核数 | `250m` |
-
-
-### 计算节点 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 容器申请的内存 | `2Gi` |
-| `compute.resources.requests.cpu` | ShardingSphere-Proxy 容器申请的 cpu 核数 | `200m` |
-| `compute.replicas` | ShardingSphere-Proxy 节点个数 | `3` |
-| `compute.service.type` | ShardingSphere-Proxy 网络模式 | `ClusterIP` |
-| `compute.service.port` | ShardingSphere-Proxy 暴露端口 | `3307` |
-| `compute.mysqlConnector.version` | MySQL 驱动版本 | `5.1.49` |
-| `compute.startPort` | ShardingSphere-Proxy 启动端口 | `3307` |
-
-### 计算节点 ShardingSphere-Proxy Server配置 权限配置项
-
-| Name | Description | Value |
-| -------------------------------------------------- |---------------------------------------------------------------------------| -------------------------- |
-| `compute.serverConfig.authority.privilege.type` | 存储节点数据授权的权限提供者类型，缺省值为 ALL_PERMITTED | `ALL_PRIVILEGES_PERMITTED` |
-| `compute.serverConfig.authority.users[0].password` | 用于登录计算节点的密码 | `root` |
-| `compute.serverConfig.authority.users[0].user` | 用于登录计算节点的用户名，授权主机。格式: <username>@<hostname> hostname 为 % 或空字符串表示不限制授权主机 | `root@%` |
-
-
-### 计算节点 ShardingSphere-Proxy Server配置 模式配置项
-
-| Name | Description | Value |
-| ------------------------------------------------------------------------- |---------------------------| --------------------------------------------------------------------- |
-| `compute.serverConfig.mode.type` | 运行模式类型。 现阶段仅支持 Cluster 模式 | `Cluster` |
-| `compute.serverConfig.mode.repository.props.namespace` | 注册中心命名空间 | `governance_ds` |
-| `compute.serverConfig.mode.repository.props.server-lists` | 注册中心连接地址 | `{{ printf "%s-zookeeper.%s:2181" .Release.Name .Release.Namespace }}` |
-| `compute.serverConfig.mode.repository.props.maxRetries` | 客户端连接最大重试次数 | `3` |
-| `compute.serverConfig.mode.repository.props.operationTimeoutMilliseconds` | 客户端操作超时的毫秒数 | `5000` |
-| `compute.serverConfig.mode.repository.props.retryIntervalMilliseconds` | 重试间隔毫秒数 | `500` |
-| `compute.serverConfig.mode.repository.props.timeToLiveSeconds` | 临时数据失效的秒数 | `60` |
-| `compute.serverConfig.mode.repository.type` | 持久化仓库类型。 现阶段仅支持 ZooKeeper | `ZooKeeper` |
-| `compute.serverConfig.mode.overwrite` | 是否使用本地配置覆盖持久化配置 | `true` |
+请阅读[使用文档](https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-proxy/startup/helm/)