This is an automated email from the ASF dual-hosted git repository.
jiafengzheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new a71c0f62712 doc_upgrade (#96)
a71c0f62712 is described below
commit a71c0f62712db13fd99c9b711b18835153fe18f0
Author: catpineapple <42031973+catpineap...@users.noreply.github.com>
AuthorDate: Tue Sep 13 19:36:27 2022 +0800
doc_upgrade (#96)
---
docs/admin-manual/cluster-management/upgrade.md | 28 +++++++++++++++++++--
.../maint-monitor/metadata-operation.md | 2 +-
.../admin-manual/cluster-management/upgrade.md | 29 +++++++++++++++++++---
.../maint-monitor/metadata-operation.md | 2 +-
4 files changed, 54 insertions(+), 7 deletions(-)
diff --git a/docs/admin-manual/cluster-management/upgrade.md
b/docs/admin-manual/cluster-management/upgrade.md
index 450867bcca9..36919592982 100644
--- a/docs/admin-manual/cluster-management/upgrade.md
+++ b/docs/admin-manual/cluster-management/upgrade.md
@@ -56,6 +56,24 @@ Doris can upgrade smoothly by rolling upgrades. The
following steps are recommen
2. **important! ! Metadata needs to be backed up before upgrading(The entire
directory needs to be backed up)! !**
+ Let's assume that the path of `meta_dir` specified in fe.conf is
`path/to/doris-meta`. In a normal Doris cluster, the directory structure of
metadata should be as follows:
+
+ ```
+ /path/to/doris-meta/
+ |-- bdb/
+ | |-- 00000000.jdb
+ | |-- je.config.csv
+ | |-- je.info.0
+ | |-- je.info.0.lck
+ | |-- je.lck
+ | `-- je.stat.csv
+ `-- image/
+ |-- ROLE
+ |-- VERSION
+ `-- image.xxxx
+ ```
+ The metadata directory to be backed up is `doris-meta/`
+
## Test the correctness of BE upgrade
1. Arbitrarily select a BE node and deploy the latest doris_be binary file.
@@ -79,13 +97,13 @@ Doris can upgrade smoothly by rolling upgrades. The
following steps are recommen
## Upgrade preparation
1. After data validation, the new version of BE and FE binary files are
distributed to their respective directories.
-2. Usually small version upgrade, BE only needs to upgrade doris_be; FE only
needs to upgrade palo-fe.jar. If it is a large version upgrade, you may need to
upgrade other files (including but not limited to bin / lib / etc.) If you are
not sure whether you need to replace other files, it is recommended to replace
all of them.
+2. Usually small version upgrade, BE only needs to upgrade doris_be; FE only
needs to upgrade doris-fe.jar(which was doris-fe.jar in previous versions). If
it is a large version upgrade, you may need to upgrade other files (including
but not limited to bin / , lib / etc.) If you are not sure whether you need to
replace other files, it is recommended to replace all of them.
## rolling upgrade
1. Confirm that the new version of the file is deployed. Restart FE and BE
instances one by one.
2. It is suggested that BE be restarted one by one and FE be restarted one by
one. Because Doris usually guarantees backward compatibility between FE and BE,
that is, the old version of FE can access the new version of BE. However, the
old version of BE may not be supported to access the new version of FE.
-3. It is recommended to restart the next instance after confirming the
previous instance started successfully. Refer to the Installation Deployment
Document for the identification of successful instance startup.
+3. It is recommended to restart the next instance after confirming the
previous instance started successfully. Refer to the [Installation Deployment
Document](../../install/install-deploy.md) for the identification of successful
instance startup.
## About version rollback
Because the database is a stateful service, Doris cannot support version
rollback (version downgrade) in most cases. In some cases, the rollback of the
3-bit or 4-bit version can be supported, but the rollback of the 2-bit version
will not be supported.
@@ -93,3 +111,9 @@ Because the database is a stateful service, Doris cannot
support version rollbac
Therefore, it is recommended to upgrade some nodes and observe the business
operation (gray upgrade) to reduce the upgrade risk.
**Illegal rollback operation may cause data loss and damage.**
+
+## Documentation
+1. [Doris metadata design
document](../../../community/design/metadata-design.md)
+2. [Metadata Operations and
Maintenance](../../admin-manual/maint-monitor/metadata-operation.md)
+3. [Data replica
management](../../admin-manual/maint-monitor/tablet-repair-and-balance.md)
+4. [Installation Deployment Document](../../install/install-deploy.md)
diff --git a/docs/admin-manual/maint-monitor/metadata-operation.md
b/docs/admin-manual/maint-monitor/metadata-operation.md
index db047000b1e..7761d753a9a 100644
--- a/docs/admin-manual/maint-monitor/metadata-operation.md
+++ b/docs/admin-manual/maint-monitor/metadata-operation.md
@@ -28,7 +28,7 @@ under the License.
This document focuses on how to manage Doris metadata in a real production
environment. It includes the proposed deployment of FE nodes, some commonly
used operational methods, and common error resolution methods.
-For the time being, read the [Doris metadata design
document](../../design/metadata-design.md) to understand how Doris metadata
works.
+For the time being, read the [Doris metadata design
document](../../../community/design/metadata-design.md) to understand how Doris
metadata works.
## Important tips
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/cluster-management/upgrade.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/cluster-management/upgrade.md
index 6dbfe7d5a61..a89714b23d0 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/cluster-management/upgrade.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/cluster-management/upgrade.md
@@ -33,7 +33,7 @@ Doris 可以通过滚动升级的方式，平滑进行升级。建议按照以
> **注：**
>
> 1. Doris不支持跨两位版本号进行升级，例如：不能从0.13直接升级到0.15，只能通过0.13.x -> 0.14.x ->
> 0.15.x，三位版本号可以跨版本升级，比如从0.13.15可以直接升级到0.14.13.1，不必一定要升级0.14.7 或者 0.14.12.1这种版本
-> 1. 以下方式均建立在高可用部署的情况下。即数据 3 副本，FE 高可用情况下。
+> 2. 以下方式均建立在高可用部署的情况下。即数据 3 副本，FE 高可用情况下。
## 前置工作
@@ -56,6 +56,23 @@ Doris 可以通过滚动升级的方式，平滑进行升级。建议按照以
2. **重要！！在升级之前需要备份元数据（整个目录都需要备份）！！**
+ 如果在 fe.conf 中指定的 `meta_dir`（元数据）的路径为 `/path/to/doris-meta`。那么一个正常运行中的
Doris 集群，元数据的目录结构应该如下：
+ ```
+ /path/to/doris-meta/
+ |-- bdb/
+ | |-- 00000000.jdb
+ | |-- je.config.csv
+ | |-- je.info.0
+ | |-- je.info.0.lck
+ | |-- je.lck
+ | `-- je.stat.csv
+ `-- image/
+ |-- ROLE
+ |-- VERSION
+ `-- image.xxxx
+ ```
+ 需要备份的元数据目录为 `doris-meta/`
+
## 测试 BE 升级正确性
1. 任意选择一个 BE 节点，部署最新的 doris_be 二进制文件。
@@ -79,16 +96,22 @@ Doris 可以通过滚动升级的方式，平滑进行升级。建议按照以
## 升级准备
1. 在完成数据正确性验证后，将 BE 和 FE 新版本的二进制文件分发到各自目录下。
-2. 通常小版本升级，BE 只需升级 doris_be；而 FE 只需升级 palo-fe.jar。如果是大版本升级，则可能需要升级其他文件（包括但不限于
bin/ lib/ 等等）如果你不清楚是否需要替换其他文件，建议全部替换。
+2. 通常小版本升级，BE 只需升级 doris_be；而 FE 只需升级
doris-fe.jar（旧版本为palo-fe.jar）。如果是大版本升级，则可能需要升级其他文件（包括但不限于 bin/ 、lib/
等等）如果你不清楚是否需要替换其他文件，建议全部替换。
## 滚动升级
1. 确认新版本的文件部署完成后。逐台重启 FE 和 BE 实例即可。
2. 建议逐台重启 BE 后，再逐台重启 FE。因为通常 Doris 保证 FE 到 BE 的向后兼容性，即老版本的 FE 可以访问新版本的
BE。但可能不支持老版本的 BE 访问新版本的 FE。
-3. 建议确认前一个实例启动成功后，再重启下一个实例。实例启动成功的标识，请参阅安装部署文档。
+3.
建议确认前一个实例启动成功后，再重启下一个实例。实例启动成功的标识，请参阅[安装部署文档](../../install/install-deploy.md)。
## 关于版本回滚
因为数据库是一个有状态的服务，所以在大多数情况下，Doris 无法支持版本回滚（版本降级）。在某些情况下，可以支持 3 位或 4 位版本的回滚，但不会支持
2 位版本的回滚。
所以建议通过先升级部分节点并观察业务运行情况的方式（灰度升级）来降低升级风险。
**非法的回滚操作可能导致数据丢失和损坏。**
+
+## 升级中涉及到内容的介绍文档
+1. [Doris
元数据设计文档](../../../../docusaurus-plugin-content-docs-community/current/design/metadata-design.md)
+2. [元数据运维](../../admin-manual/maint-monitor/metadata-operation.md)
+3. [数据副本管理](../../admin-manual/maint-monitor/tablet-repair-and-balance.md)
+4. [安装部署文档](../../install/install-deploy.md)
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/maint-monitor/metadata-operation.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/maint-monitor/metadata-operation.md
index f0008a781a6..68279c85064 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/maint-monitor/metadata-operation.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/maint-monitor/metadata-operation.md
@@ -28,7 +28,7 @@ under the License.
本文档主要介绍在实际生产环境中，如何对 Doris 的元数据进行管理。包括 FE 节点建议的部署方式、一些常用的操作方法、以及常见错误的解决方法。
-在阅读本文当前，请先阅读 [Doris 元数据设计文档](../../design/metadata-design.md) 了解 Doris
元数据的工作原理。
+在阅读本文当前，请先阅读 [Doris
元数据设计文档](../../../../docusaurus-plugin-content-docs-community/current/design/metadata-design.md)
了解 Doris 元数据的工作原理。
## 重要提示
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
