From f41b6a5fc3dc4a09dc08e095c16d7b838fc66c2e Mon Sep 17 00:00:00 2001 From: Mingyu Chen Date: Mon, 9 Oct 2023 09:50:31 +0800 Subject: [PATCH] [minor](doc) update the doc for docker env and custom_lib dir (#25088) 1. Update the doc for `apache/doris:build-env-for-2.0` 2. Update the doc for `custom_dir` --- bin/start_be.sh | 2 +- bin/start_fe.sh | 2 +- docs/en/docs/admin-manual/cluster-management/upgrade.md | 4 ++++ docs/en/docs/install/source-install/compilation-general.md | 6 ++++-- docs/zh-CN/docs/admin-manual/cluster-management/upgrade.md | 4 ++++ .../docs/install/source-install/compilation-general.md | 6 ++++-- 6 files changed, 18 insertions(+), 6 deletions(-) diff --git a/bin/start_be.sh b/bin/start_be.sh index 9b102077dc..15e26912ac 100755 --- a/bin/start_be.sh +++ b/bin/start_be.sh @@ -118,7 +118,7 @@ if [[ -d "${DORIS_HOME}/lib/hadoop_hdfs/" ]]; then done fi -# add custome_libs to CLASSPATH +# add custom_libs to CLASSPATH if [[ -d "${DORIS_HOME}/custom_lib" ]]; then for f in "${DORIS_HOME}/custom_lib"/*.jar; do DORIS_CLASSPATH="${DORIS_CLASSPATH}:${f}" diff --git a/bin/start_fe.sh b/bin/start_fe.sh index 1d294ef5e8..cd2c5456ff 100755 --- a/bin/start_fe.sh +++ b/bin/start_fe.sh @@ -201,7 +201,7 @@ for f in "${DORIS_HOME}/lib"/*.jar; do CLASSPATH="${f}:${CLASSPATH}" done -# add custome_libs to CLASSPATH +# add custom_libs to CLASSPATH if [[ -d "${DORIS_HOME}/custom_lib" ]]; then for f in "${DORIS_HOME}/custom_lib"/*.jar; do CLASSPATH="${f}:${CLASSPATH}" diff --git a/docs/en/docs/admin-manual/cluster-management/upgrade.md b/docs/en/docs/admin-manual/cluster-management/upgrade.md index 72bbcfa67f..dc42b4c8ba 100644 --- a/docs/en/docs/admin-manual/cluster-management/upgrade.md +++ b/docs/en/docs/admin-manual/cluster-management/upgrade.md @@ -213,6 +213,10 @@ Upgrade BE first, then FE Generally speaking, Doris only needs to upgrade `/bin` and `/lib` under the FE directory and `/bin` and `/lib` under the BE directory +In versions 2.0.2 and later, the `custom_lib/` directory is added to the FE and BE deployment paths (if not, it can be created manually). The `custom_lib/` directory is used to store some user-defined third-party jar packages, such as `hadoop-lzo-*.jar`, `orai18n.jar`, etc. + +This directory does not need to be replaced during upgrade. + However, when a major version is upgraded, new features may be added or old functions refactored. These modifications may require **replace/add** more directories during the upgrade to ensure the availability of all new features. Please Carefully pay attention to the Release-Note of this version when upgrading the version to avoid upgrade failures ::: diff --git a/docs/en/docs/install/source-install/compilation-general.md b/docs/en/docs/install/source-install/compilation-general.md index 4dbc486b85..6311377207 100644 --- a/docs/en/docs/install/source-install/compilation-general.md +++ b/docs/en/docs/install/source-install/compilation-general.md @@ -61,8 +61,10 @@ This topic is about how to compile Doris from source. | apache/doris:build-env-for-1.1.0| | 1.1.0 | | apache/doris:build-env-for-1.2| | 1.1.x, 1.2.x | | apache/doris:build-env-for-1.2-no-avx2| | 1.1.x, 1.2.x | -| apache/doris:build-env-ldb-toolchain-latest | | trunk | -| apache/doris:build-env-ldb-toolchain-no-avx2-latest | | trunk | +| apache/doris:build-env-for-2.0| | 2.0.x | +| apache/doris:build-env-for-2.0-no-avx2| | 2.0.x | +| apache/doris:build-env-ldb-toolchain-latest | | master | +| apache/doris:build-env-ldb-toolchain-no-avx2-latest | | mater | **Note**: diff --git a/docs/zh-CN/docs/admin-manual/cluster-management/upgrade.md b/docs/zh-CN/docs/admin-manual/cluster-management/upgrade.md index 454f57cb7b..88fca9b291 100644 --- a/docs/zh-CN/docs/admin-manual/cluster-management/upgrade.md +++ b/docs/zh-CN/docs/admin-manual/cluster-management/upgrade.md @@ -211,6 +211,10 @@ admin set frontend config("disable_tablet_scheduler" = "true"); 一般而言，Doris 只需要升级 FE 目录下的 `/bin` 和 `/lib` 以及 BE 目录下的 `/bin` 和 `/lib` +在 2.0.2 及之后的版本，FE 和 BE 部署路径下新增了 `custom_lib/` 目录（如没有可以手动创建）。`custom_lib/` 目录用于存放一些用户自定义的第三方 jar 包，如 `hadoop-lzo-*.jar`，`orai18n.jar` 等。 + +这个目录在升级时不需要替换。 + 但是在大版本升级时，可能会有新的特性增加或者老功能的重构，这些修改可能会需要升级时**替换/新增**更多的目录来保证所有新功能的可用性，请大版本升级时仔细关注该版本的 Release-Note，以免出现升级故障 ::: diff --git a/docs/zh-CN/docs/install/source-install/compilation-general.md b/docs/zh-CN/docs/install/source-install/compilation-general.md index 2e19936ece..64ab710fa5 100644 --- a/docs/zh-CN/docs/install/source-install/compilation-general.md +++ b/docs/zh-CN/docs/install/source-install/compilation-general.md @@ -60,8 +60,10 @@ under the License. | apache/doris:build-env-for-1.1.0| | 1.1.0 | | apache/doris:build-env-for-1.2| | 1.1.x, 1.2.x | | apache/doris:build-env-for-1.2-no-avx2| | 1.1.x, 1.2.x | -| apache/doris:build-env-ldb-toolchain-latest | | trunk | -| apache/doris:build-env-ldb-toolchain-no-avx2-latest | | trunk | +| apache/doris:build-env-for-2.0| | 2.0.x | +| apache/doris:build-env-for-2.0-no-avx2| | 2.0.x | +| apache/doris:build-env-ldb-toolchain-latest | | master | +| apache/doris:build-env-ldb-toolchain-no-avx2-latest | | mater | **注意**：