You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by yi...@apache.org on 2023/04/24 00:29:32 UTC
[doris] branch master updated: [typo](docs)Optimize the installation And deployment directory structure (#18966)
This is an automated email from the ASF dual-hosted git repository.
yiguolei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris.git
The following commit(s) were added to refs/heads/master by this push:
new 27b8227cb5 [typo](docs)Optimize the installation And deployment directory structure (#18966)
27b8227cb5 is described below
commit 27b8227cb53f92089d3d6f6ec97b5a4134b1b801
Author: yongkang.zhong <zh...@qq.com>
AuthorDate: Mon Apr 24 08:29:24 2023 +0800
[typo](docs)Optimize the installation And deployment directory structure (#18966)
---
docs/dev.json | 6 +++---
docs/en/community/developer-guide/docker-dev.md | 2 +-
.../docs/admin-manual/cluster-management/fqdn.md | 2 +-
.../maint-monitor/metadata-operation.md | 2 +-
docs/en/docs/benchmark/tpch.md | 2 +-
docs/en/docs/faq/install-faq.md | 2 +-
.../construct-docker/construct-docker-image.md | 2 +-
.../install/{construct-docker => }/k8s-deploy.md | 4 ++--
.../{compilation.md => compilation-general.md} | 2 +-
.../{install-deploy.md => standard-deployment.md} | 2 +-
docs/sidebars.json | 22 +++++++++++-----------
docs/zh-CN/community/developer-guide/docker-dev.md | 2 +-
.../docs/admin-manual/cluster-management/fqdn.md | 2 +-
.../maint-monitor/metadata-operation.md | 2 +-
docs/zh-CN/docs/benchmark/ssb.md | 2 +-
docs/zh-CN/docs/benchmark/tpch.md | 2 +-
docs/zh-CN/docs/data-table/data-partition.md | 2 +-
docs/zh-CN/docs/faq/install-faq.md | 2 +-
.../construct-docker/construct-docker-image.md | 2 +-
.../install/{construct-docker => }/k8s-deploy.md | 6 +++---
.../{compilation.md => compilation-general.md} | 2 +-
.../{install-deploy.md => standard-deployment.md} | 4 ++--
22 files changed, 38 insertions(+), 38 deletions(-)
diff --git a/docs/dev.json b/docs/dev.json
index 5fb92fe067..a588fd99b7 100644
--- a/docs/dev.json
+++ b/docs/dev.json
@@ -15,11 +15,11 @@
"message": "安装部署",
"description": "The label for category Install And Deploy in sidebar docs"
},
- "sidebar.docs.category.Construct Docker": {
- "message": "构建 Docker 集群",
+ "sidebar.docs.category.Docker Deployment": {
+ "message": "Docker 部署",
"description": "Make docker image and quickly start Doris's Docker cluster"
},
- "sidebar.docs.category.Compile": {
+ "sidebar.docs.category.Source Code Compilation": {
"message": "源码编译",
"description": "The label for category Compile in sidebar docs"
},
diff --git a/docs/en/community/developer-guide/docker-dev.md b/docs/en/community/developer-guide/docker-dev.md
index 19fa1e0350..57c449ec17 100644
--- a/docs/en/community/developer-guide/docker-dev.md
+++ b/docs/en/community/developer-guide/docker-dev.md
@@ -90,7 +90,7 @@ docker build -t doris .
run image
-note! [problems with mounting](../../docs/install/source-install/compilation.md)
+note! [problems with mounting](../../docs/install/source-install/compilation-general.md)
> See the link above: It is recommended to run the image by mounting the local Doris source code directory as a volume .....
diff --git a/docs/en/docs/admin-manual/cluster-management/fqdn.md b/docs/en/docs/admin-manual/cluster-management/fqdn.md
index cbd8e19be5..4abd898a66 100644
--- a/docs/en/docs/admin-manual/cluster-management/fqdn.md
+++ b/docs/en/docs/admin-manual/cluster-management/fqdn.md
@@ -46,7 +46,7 @@ After Doris supports FQDN, you can directly specify the domain name when adding
### Deployment of Doris for K8S
After an accidental restart of a pod, the K8S cannot ensure that the pod's IP address does not change, but it can ensure that the domain name remains unchanged. Based on this feature, when Doris starts fqdn, it can ensure that the pod can still provide services normally after an accidental restart.
-For the method of deploying Doris on the K8S, please refer to [K8s Deployment Doris](../../install/construct-docker/k8s-deploy.md)
+For the method of deploying Doris on the K8S, please refer to [K8s Deployment Doris](../../install/k8s-deploy.md)
### Server switching network card
diff --git a/docs/en/docs/admin-manual/maint-monitor/metadata-operation.md b/docs/en/docs/admin-manual/maint-monitor/metadata-operation.md
index 74e721804b..e783985f83 100644
--- a/docs/en/docs/admin-manual/maint-monitor/metadata-operation.md
+++ b/docs/en/docs/admin-manual/maint-monitor/metadata-operation.md
@@ -345,7 +345,7 @@ The third level can display the value information of the specified key.
## Best Practices
-The deployment recommendation of FE is described in the Installation and [Deployment Document](../../install/install-deploy.md). Here are some supplements.
+The deployment recommendation of FE is described in the Installation and [Deployment Document](../../install/standard-deployment.md). Here are some supplements.
* **If you don't know the operation logic of FE metadata very well, or you don't have enough experience in the operation and maintenance of FE metadata, we strongly recommend that only one FOLLOWER-type FE be deployed as MASTER in practice, and the other FEs are OBSERVER, which can reduce many complex operation and maintenance problems.** Don't worry too much about the failure of MASTER single point to write metadata. First, if you configure it properly, FE as a java process is very diff [...]
diff --git a/docs/en/docs/benchmark/tpch.md b/docs/en/docs/benchmark/tpch.md
index 4b4ff5a6c9..b3a73f55e9 100644
--- a/docs/en/docs/benchmark/tpch.md
+++ b/docs/en/docs/benchmark/tpch.md
@@ -124,7 +124,7 @@ Here we use Apache Doris 1.2.0-rc01, Apache Doris 1.1.3 and Apache Doris 0.15.0
## 6. Environmental Preparation
-Please refer to the [official document](../install/install-deploy.md) to install and deploy Doris to obtain a normal running Doris cluster (at least 1 FE 1 BE, 1 FE 3 BE is recommended).
+Please refer to the [official document](../install/standard-deployment.md) to install and deploy Doris to obtain a normal running Doris cluster (at least 1 FE 1 BE, 1 FE 3 BE is recommended).
## 7. Data Preparation
diff --git a/docs/en/docs/faq/install-faq.md b/docs/en/docs/faq/install-faq.md
index 22fec40f4c..af78496c78 100644
--- a/docs/en/docs/faq/install-faq.md
+++ b/docs/en/docs/faq/install-faq.md
@@ -267,7 +267,7 @@ This is a bug in bdbje that has not yet been resolved. In this case, you can onl
### Q12. Doris compile and install JDK version incompatibility problem
-When compiling Doris using Docker, start FE after compiling and installing, and the exception message `java.lang.Suchmethoderror: java.nio.ByteBuffer.limit (I)Ljava/nio/ByteBuffer;` appears, this is because the default in Docker It is JDK 11. If your installation environment is using JDK8, you need to switch the JDK environment to JDK8 in Docker. For the specific switching method, please refer to [Compile Documentation](../install/source-install/compilation.md)
+When compiling Doris using Docker, start FE after compiling and installing, and the exception message `java.lang.Suchmethoderror: java.nio.ByteBuffer.limit (I)Ljava/nio/ByteBuffer;` appears, this is because the default in Docker It is JDK 11. If your installation environment is using JDK8, you need to switch the JDK environment to JDK8 in Docker. For the specific switching method, please refer to [Compile Documentation](../install/source-install/compilation-general.md)
### Q13. Error starting FE or unit test locally Cannot find external parser table action_table.dat
Run the following command
diff --git a/docs/en/docs/install/construct-docker/construct-docker-image.md b/docs/en/docs/install/construct-docker/construct-docker-image.md
index 0260fe63d9..341785d162 100644
--- a/docs/en/docs/install/construct-docker/construct-docker-image.md
+++ b/docs/en/docs/install/construct-docker/construct-docker-image.md
@@ -73,7 +73,7 @@ Method 1 can produce a smaller Docker image, but if the docker build process fai
### Prepare Binary Package
-Please noted that if you have a need for custom development, you need to modify the source code, [compile](../source-install/compilation.md) and package it, and then place it in the build directory.
+Please noted that if you have a need for custom development, you need to modify the source code, [compile](../source-install/compilation-general.md) and package it, and then place it in the build directory.
If you have no such needs, you can just [download](https://doris.apache.org/download) the binary package from the official website.
### Steps
diff --git a/docs/en/docs/install/construct-docker/k8s-deploy.md b/docs/en/docs/install/k8s-deploy.md
similarity index 96%
rename from docs/en/docs/install/construct-docker/k8s-deploy.md
rename to docs/en/docs/install/k8s-deploy.md
index 259419265d..f6869c8983 100644
--- a/docs/en/docs/install/construct-docker/k8s-deploy.md
+++ b/docs/en/docs/install/k8s-deploy.md
@@ -1,6 +1,6 @@
---
{
-"title": "K8s Deployment Doris",
+"title": "Kubernetes Deployment",
"language": "en"
}
---
@@ -32,7 +32,7 @@ under the License.
- Installation k8s
- Build or download a Doris image
- - Building an image [Doris Docker Quickly build a development environment](./docker-dev)
+ - Building an image [Build Docker Image](./construct-docker/construct-docker-image)
- Download Image https://hub.docker.com/r/apache/doris/tags
- Create or download the yml file for Doris on k8s
- https://github.com/apache/doris/blob/master/docker/runtime/k8s/doris_follower.yml
diff --git a/docs/en/docs/install/source-install/compilation.md b/docs/en/docs/install/source-install/compilation-general.md
similarity index 99%
rename from docs/en/docs/install/source-install/compilation.md
rename to docs/en/docs/install/source-install/compilation-general.md
index 7d4edbb553..5d01f20da2 100644
--- a/docs/en/docs/install/source-install/compilation.md
+++ b/docs/en/docs/install/source-install/compilation-general.md
@@ -1,6 +1,6 @@
---
{
- "title": "Compilation",
+ "title": "General Compilation",
"language": "en"
}
---
diff --git a/docs/en/docs/install/install-deploy.md b/docs/en/docs/install/standard-deployment.md
similarity index 99%
rename from docs/en/docs/install/install-deploy.md
rename to docs/en/docs/install/standard-deployment.md
index fac5a1f550..635aae8b59 100644
--- a/docs/en/docs/install/install-deploy.md
+++ b/docs/en/docs/install/standard-deployment.md
@@ -1,6 +1,6 @@
---
{
- "title": "Installation and Deployment",
+ "title": "Standard deployment",
"language": "en"
}
---
diff --git a/docs/sidebars.json b/docs/sidebars.json
index e005e5440d..2e13a75225 100644
--- a/docs/sidebars.json
+++ b/docs/sidebars.json
@@ -18,25 +18,25 @@
"type": "category",
"label": "Install And Deploy",
"items": [
- "install/install-deploy",
+ "install/standard-deployment",
{
"type": "category",
- "label": "Compile",
+ "label": "Docker Deployment",
"items": [
- "install/source-install/compilation",
- "install/source-install/compilation-with-ldb-toolchain",
- "install/source-install/compilation-arm",
- "install/source-install/compilation-win",
- "install/source-install/compilation-mac"
+ "install/construct-docker/construct-docker-image",
+ "install/construct-docker/run-docker-cluster"
]
},
+ "install/k8s-deploy",
{
"type": "category",
- "label": "Construct Docker",
+ "label": "Source Code Compilation",
"items": [
- "install/construct-docker/construct-docker-image",
- "install/construct-docker/run-docker-cluster",
- "install/construct-docker/k8s-deploy"
+ "install/source-install/compilation-general",
+ "install/source-install/compilation-with-ldb-toolchain",
+ "install/source-install/compilation-arm",
+ "install/source-install/compilation-win",
+ "install/source-install/compilation-mac"
]
}
]
diff --git a/docs/zh-CN/community/developer-guide/docker-dev.md b/docs/zh-CN/community/developer-guide/docker-dev.md
index b2c40c5e65..17d47cab65 100644
--- a/docs/zh-CN/community/developer-guide/docker-dev.md
+++ b/docs/zh-CN/community/developer-guide/docker-dev.md
@@ -90,7 +90,7 @@ docker build -t doris .
运行镜像
-此处按需注意 [挂载的问题](../../docs/install/source-install/compilation.md)
+此处按需注意 [挂载的问题](../../docs/install/source-install/compilation-general.md)
> 见链接中：建议以挂载本地 Doris 源码目录的方式运行镜像 .....
diff --git a/docs/zh-CN/docs/admin-manual/cluster-management/fqdn.md b/docs/zh-CN/docs/admin-manual/cluster-management/fqdn.md
index b95c8b0291..03c07f769e 100644
--- a/docs/zh-CN/docs/admin-manual/cluster-management/fqdn.md
+++ b/docs/zh-CN/docs/admin-manual/cluster-management/fqdn.md
@@ -47,7 +47,7 @@ Doris支持FQDN之后，添加各类节点时可以直接指定域名，例如
pod意外重启后，k8s不能保证pod的ip不发生变化，但是能保证域名不变，基于这一特性，doris开启fqdn时，能保证pod意外重启后，还能正常提供服务。
-k8s部署doris的方法请参考[K8s部署doris](../../install/construct-docker/k8s-deploy.md)
+k8s部署doris的方法请参考[K8s部署doris](../../install/k8s-deploy.md)
### 服务器切换网卡
diff --git a/docs/zh-CN/docs/admin-manual/maint-monitor/metadata-operation.md b/docs/zh-CN/docs/admin-manual/maint-monitor/metadata-operation.md
index ff2490f86a..63dd80b0e8 100644
--- a/docs/zh-CN/docs/admin-manual/maint-monitor/metadata-operation.md
+++ b/docs/zh-CN/docs/admin-manual/maint-monitor/metadata-operation.md
@@ -349,7 +349,7 @@ mysql> show proc "/bdbje/110589/114861";
## 最佳实践
-FE 的部署推荐，在 [安装与部署文档](../../install/install-deploy.md) 中有介绍，这里再做一些补充。
+FE 的部署推荐，在 [安装与部署文档](../../install/standard-deployment.md) 中有介绍，这里再做一些补充。
* **如果你并不十分了解 FE 元数据的运行逻辑，或者没有足够 FE 元数据的运维经验，我们强烈建议在实际使用中，只部署一个 FOLLOWER 类型的 FE 作为 MASTER，其余 FE 都是 OBSERVER，这样可以减少很多复杂的运维问题！** 不用过于担心 MASTER 单点故障导致无法进行元数据写操作。首先，如果你配置合理，FE 作为 java 进程很难挂掉。其次，如果 MASTER 磁盘损坏（概率非常低），我们也可以用 OBSERVER 上的元数据，通过 `故障恢复` 的方式手动恢复。
diff --git a/docs/zh-CN/docs/benchmark/ssb.md b/docs/zh-CN/docs/benchmark/ssb.md
index e8b51a97e5..a78d3d7066 100644
--- a/docs/zh-CN/docs/benchmark/ssb.md
+++ b/docs/zh-CN/docs/benchmark/ssb.md
@@ -130,7 +130,7 @@ under the License.
## 6. 环境准备
-请先参照 [官方文档](../install/install-deploy.md) 进行 Apache Doris 的安装部署，以获得一个正常运行中的 Doris 集群（至少包含 1 FE 1 BE，推荐 1 FE 3 BE）。
+请先参照 [官方文档](../install/standard-deployment.md) 进行 Apache Doris 的安装部署，以获得一个正常运行中的 Doris 集群（至少包含 1 FE 1 BE，推荐 1 FE 3 BE）。
以下文档中涉及的脚本都存放在 Apache Doris 代码库：[ssb-tools](https://github.com/apache/doris/tree/master/tools/ssb-tools)
diff --git a/docs/zh-CN/docs/benchmark/tpch.md b/docs/zh-CN/docs/benchmark/tpch.md
index 6bf1687256..e0a5cf3ca6 100644
--- a/docs/zh-CN/docs/benchmark/tpch.md
+++ b/docs/zh-CN/docs/benchmark/tpch.md
@@ -125,7 +125,7 @@ TPCH 22 个测试查询语句 ： [TPCH-Query-SQL](https://github.com/apache/dor
## 6. 环境准备
-请先参照 [官方文档](../install/install-deploy.md) 进行 Doris 的安装部署，以获得一个正常运行中的 Doris 集群（至少包含 1 FE 1 BE，推荐 1 FE 3 BE）。
+请先参照 [官方文档](../install/standard-deployment.md) 进行 Doris 的安装部署，以获得一个正常运行中的 Doris 集群（至少包含 1 FE 1 BE，推荐 1 FE 3 BE）。
## 7. 数据准备
diff --git a/docs/zh-CN/docs/data-table/data-partition.md b/docs/zh-CN/docs/data-table/data-partition.md
index 79b56234db..e521202b8c 100644
--- a/docs/zh-CN/docs/data-table/data-partition.md
+++ b/docs/zh-CN/docs/data-table/data-partition.md
@@ -410,7 +410,7 @@ Doris 支持两层的数据划分。第一层是 Partition，支持 Range 和 Li
- 在 fe.log 中，查找对应时间点的 `Failed to create partition` 日志。在该日志中，会出现一系列类似 `{10001-10010}` 字样的数字对。数字对的第一个数字表示 Backend ID，第二个数字表示 Tablet ID。如上这个数字对，表示 ID 为 10001 的 Backend 上，创建 ID 为 10010 的 Tablet 失败了。
- 前往对应 Backend 的 be.INFO 日志，查找对应时间段内，tablet id 相关的日志，可以找到错误信息。
- 以下罗列一些常见的 tablet 创建失败错误，包括但不限于：
- - BE 没有收到相关 task，此时无法在 be.INFO 中找到 tablet id 相关日志或者 BE 创建成功，但汇报失败。以上问题，请参阅 [安装与部署](../install/install-deploy.md) 检查 FE 和 BE 的连通性。
+ - BE 没有收到相关 task，此时无法在 be.INFO 中找到 tablet id 相关日志或者 BE 创建成功，但汇报失败。以上问题，请参阅 [安装与部署](../install/standard-deployment.md) 检查 FE 和 BE 的连通性。
- 预分配内存失败。可能是表中一行的字节长度超过了 100KB。
- `Too many open files`。打开的文件句柄数超过了 Linux 系统限制。需修改 Linux 系统的句柄数限制。
diff --git a/docs/zh-CN/docs/faq/install-faq.md b/docs/zh-CN/docs/faq/install-faq.md
index 9ef14a3a73..4dca37ae39 100644
--- a/docs/zh-CN/docs/faq/install-faq.md
+++ b/docs/zh-CN/docs/faq/install-faq.md
@@ -267,7 +267,7 @@ http {
### Q12. Doris编译安装JDK版本不兼容问题
-在自己使用 Docker 编译 Doris 的时候，编译完成安装以后启动FE，出现 `java.lang.Suchmethoderror: java.nio. ByteBuffer. limit (I)Ljava/nio/ByteBuffer;` 异常信息，这是因为Docker里默认是JDK 11，如果你的安装环境是使用JDK8 ，需要在 Docker 里 JDK 环境切换成 JDK8，具体切换方法参照[编译文档](../install/source-install/compilation.md)
+在自己使用 Docker 编译 Doris 的时候，编译完成安装以后启动FE，出现 `java.lang.Suchmethoderror: java.nio. ByteBuffer. limit (I)Ljava/nio/ByteBuffer;` 异常信息，这是因为Docker里默认是JDK 11，如果你的安装环境是使用JDK8 ，需要在 Docker 里 JDK 环境切换成 JDK8，具体切换方法参照[编译文档](../install/source-install/compilation-general.md)
### Q13. 本地启动 FE 或者启动单元测试报错 Cannot find external parser table action_table.dat
执行如下命令
diff --git a/docs/zh-CN/docs/install/construct-docker/construct-docker-image.md b/docs/zh-CN/docs/install/construct-docker/construct-docker-image.md
index 8759f275d1..332ea35de5 100644
--- a/docs/zh-CN/docs/install/construct-docker/construct-docker-image.md
+++ b/docs/zh-CN/docs/install/construct-docker/construct-docker-image.md
@@ -74,7 +74,7 @@ Dockerfile 脚本编写需要注意以下几点：
### 准备二进制包
-需要注意的是，如有定制化开发需求，则需要自己修改源码后进行[编译](../source-install/compilation.md)打包，然后放置至构建目录即可。
+需要注意的是，如有定制化开发需求，则需要自己修改源码后进行[编译](../source-install/compilation-general.md)打包，然后放置至构建目录即可。
若无特殊需求，直接[下载](https://doris.apache.org/zh-CN/download)官网提供的二进制包即可。
diff --git a/docs/zh-CN/docs/install/construct-docker/k8s-deploy.md b/docs/zh-CN/docs/install/k8s-deploy.md
similarity index 95%
rename from docs/zh-CN/docs/install/construct-docker/k8s-deploy.md
rename to docs/zh-CN/docs/install/k8s-deploy.md
index 0ed5a53030..b7d88a35b3 100644
--- a/docs/zh-CN/docs/install/construct-docker/k8s-deploy.md
+++ b/docs/zh-CN/docs/install/k8s-deploy.md
@@ -1,7 +1,7 @@
---
{
-"title": "K8s部署doris",
-"language": "zh-CN"
+ "title": "Kubernetes 部署",
+ "language": "zh-CN"
}
---
@@ -32,7 +32,7 @@ under the License.
- 安装 k8s
- 构建或下载doris镜像
- - 构建镜像 [Doris Docker 快速搭建开发环境](./docker-dev)
+ - 构建镜像 [构建 Docker Image](./construct-docker/construct-docker-image)
- 下载镜像 https://hub.docker.com/r/apache/doris/tags
- 创建或下载doris on k8s的yml文件
- https://github.com/apache/doris/blob/master/docker/runtime/k8s/doris_follower.yml
diff --git a/docs/zh-CN/docs/install/source-install/compilation.md b/docs/zh-CN/docs/install/source-install/compilation-general.md
similarity index 99%
rename from docs/zh-CN/docs/install/source-install/compilation.md
rename to docs/zh-CN/docs/install/source-install/compilation-general.md
index d28a9da9cd..282e63c33e 100644
--- a/docs/zh-CN/docs/install/source-install/compilation.md
+++ b/docs/zh-CN/docs/install/source-install/compilation-general.md
@@ -1,6 +1,6 @@
---
{
- "title": "Doris编译",
+ "title": "通用编译",
"language": "zh-CN"
}
---
diff --git a/docs/zh-CN/docs/install/install-deploy.md b/docs/zh-CN/docs/install/standard-deployment.md
similarity index 99%
rename from docs/zh-CN/docs/install/install-deploy.md
rename to docs/zh-CN/docs/install/standard-deployment.md
index dca406b202..2e0e0d71ab 100644
--- a/docs/zh-CN/docs/install/install-deploy.md
+++ b/docs/zh-CN/docs/install/standard-deployment.md
@@ -1,6 +1,6 @@
---
{
- "title": "安装与部署",
+ "title": "标准部署",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 安装与部署
+# 标准部署
该文档主要介绍了部署 Doris 所需软硬件环境、建议的部署方式、集群扩容缩容，以及集群搭建到运行过程中的常见问题。
在阅读本文档前，请先根据编译文档编译 Doris。
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org