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 2021/06/18 05:35:51 UTC
[shardingsphere] branch master updated: Update documents about
docker (#10853)
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 fc1985d Update documents about docker (#10853)
fc1985d is described below
commit fc1985dc14020405510540d0821d7056255344e0
Author: 吴伟杰 <wu...@apache.org>
AuthorDate: Fri Jun 18 13:35:21 2021 +0800
Update documents about docker (#10853)
---
.../user-manual/shardingsphere-proxy/docker.cn.md | 10 +++++-----
.../user-manual/shardingsphere-proxy/docker.en.md | 16 ++++++++--------
.../user-manual/shardingsphere-proxy/usage/startup.en.md | 2 +-
3 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/docker.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/docker.cn.md
index d559f1d..3e0a9ee 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/docker.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/docker.cn.md
@@ -34,7 +34,7 @@ docker run -d -v /${your_work_dir}/conf:/opt/shardingsphere-proxy/conf -e PORT=3
**说明**
* 可以自定义端口 `3308` 和 `13308`。`3308` 表示 docker 容器端口, `13308` 表示宿主机端口。
-* 必须挂载配置路径到 /opt/shardingsphere-proxy/conf。
+* 必须挂载配置路径到 `/opt/shardingsphere-proxy/conf`。
```bash
docker run -d -v /${your_work_dir}/conf:/opt/shardingsphere-proxy/conf -e JVM_OPTS="-Djava.awt.headless=true" -e PORT=3308 -p13308:3308 apache/shardingsphere-proxy:latest
@@ -50,7 +50,7 @@ docker run -d -v /${your_work_dir}/conf:/opt/shardingsphere-proxy/conf -v /${you
**说明**
-* 如需使用外部 jar 包,可将其所在目录挂载到 /opt/shardingsphere-proxy/ext-lib。
+* 如需使用外部 jar 包,可将其所在目录挂载到 `/opt/shardingsphere-proxy/ext-lib`。
## 访问 ShardingSphere-Proxy
@@ -68,12 +68,12 @@ psql -U ${your_user_name} -h ${your_host} -p 13308
问题2:启动时报无法连接到数据库错误?
-回答:请确保 /${your_work_dir}/conf/config-xxx.yaml 配置文件中指定的 PostgreSQL 数据库的 IP 可以被 Docker 容器内部访问到。
+回答:请确保 `/${your_work_dir}/conf/config-xxx.yaml` 配置文件中指定的 PostgreSQL 数据库的 IP 可以被 Docker 容器内部访问到。
问题3:如何使用后端数据库为 MySQL 的 ShardingSphere-Proxy?
-回答:将 `mysql-connector.jar` 所在目录挂载到 /opt/shardingsphere-proxy/ext-lib。
+回答:将 `mysql-connector.jar` 所在目录挂载到 `/opt/shardingsphere-proxy/ext-lib`。
问题4:如何使用自定义分片算法?
-回答:实现对应的分片算法接口,将编译出的分片算法 jar 所在目录挂载到 /opt/shardingsphere-proxy/ext-lib。
+回答:实现对应的分片算法接口,将编译出的分片算法 jar 所在目录挂载到 `/opt/shardingsphere-proxy/ext-lib`。
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/docker.en.md b/docs/document/content/user-manual/shardingsphere-proxy/docker.en.md
index d4faaf9..44c3915 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/docker.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/docker.en.md
@@ -1,16 +1,16 @@
+++
pre = "<b>4.2.3. </b>"
-title = "Docker Clone"
+title = "Docker Image"
weight = 3
+++
-## Pull Official Docker Clone
+## Pull Official Docker Image
```bash
docker pull apache/shardingsphere-proxy
```
-## Build Docker Clone Manually (Optional)
+## Build Docker Image Manually (Optional)
```bash
git clone https://github.com/apache/shardingsphere
@@ -34,7 +34,7 @@ docker run -d -v /${your_work_dir}/conf:/opt/shardingsphere-proxy/conf -e PORT=3
**Notice**
* You can define port `3308` and `13308` by yourself. `3308` refers to docker port; `13308` refers to the host port.
-* You have to volume conf dir to /opt/shardingsphere-proxy/conf.
+* You have to volume conf dir to `/opt/shardingsphere-proxy/conf`.
```bash
docker run -d -v /${your_work_dir}/conf:/opt/shardingsphere-proxy/conf -e JVM_OPTS="-Djava.awt.headless=true" -e PORT=3308 -p13308:3308 apache/shardingsphere-proxy:latest
@@ -64,16 +64,16 @@ psql -U ${your_user_name} -h ${your_host} -p 13308
Question 1: there is I/O exception (`java.io.IOException`) when process request to `{}->unix://localhost:80: Connection` is refused.
-Answer: before building clone, please make sure docker daemon thread is running.
+Answer: before building image, please make sure docker daemon thread is running.
Question 2: there is error report of being unable to connect to the database.
-Answer: please make sure designated PostgreSQL IP in `/${your_work_dir}/conf/config-xxx.yaml` configuration is accessible to Docker container.
+Answer: please make sure the designated PostgreSQL's IP in `/${your_work_dir}/conf/config-xxx.yaml` configuration is accessible to Docker container.
Question 3:How to start ShardingProxy whose backend databases are MySQL.
-Answer:Volume the directory where `mysql-connector.jar` stores to /opt/shardingsphere-proxy/ext-lib.
+Answer:Volume the directory where `mysql-connector.jar` stores to `/opt/shardingsphere-proxy/ext-lib`.
Question 4:How to import user-defined sharding strategy?
-Answer: Volume the directory where `shardingsphere-strategy.jar` stores to /opt/shardingsphere-proxy/ext-lib.
+Answer: Volume the directory where `shardingsphere-strategy.jar` stores to `/opt/shardingsphere-proxy/ext-lib`.
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/usage/startup.en.md b/docs/document/content/user-manual/shardingsphere-proxy/usage/startup.en.md
index e52cc7d..c1f11ba 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/usage/startup.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/usage/startup.en.md
@@ -6,7 +6,7 @@ weight = 1
## Startup Steps
1. Download the latest version of ShardingSphere-Proxy.
-1. If users use docker, they can implement `docker pull shardingsphere/shardingsphere-proxy` to get the clone. Please refer to [Docker Clone](/en/user-manual/shardingsphere-proxy/docker/) for more details.
+1. If users use docker, they can execute `docker pull shardingsphere/shardingsphere-proxy` to get the image. Please refer to [Docker Image](/en/user-manual/shardingsphere-proxy/docker/) for more details.
1. After the decompression, revise `conf/server.yaml` and documents begin with `config-` prefix, `conf/config-xxx.yaml` for example, to configure sharding rules and replica query rules. Please refer to [Configuration Manual](/en/user-manual/shardingsphere-proxy/configuration/) for the configuration method.
1. Please run `bin/start.sh` for Linux operating system; run `bin/start.bat` for Windows operating system to start ShardingSphere-Proxy. To configure start port and document location, please refer to [Quick Start](/en/quick-start/shardingsphere-proxy-quick-start/).