KassieZ commented on code in PR #1692: URL: https://github.com/apache/doris-website/pull/1692#discussion_r1900508489
########## i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md: ########## @@ -25,251 +25,263 @@ specific language governing permissions and limitations under the License. --> -这个简短的指南将告诉你如何下载 Apache Doris 最新稳定版本，在单节点上安装并运行它，包括创建数据库、数据表、导入数据及查询等。 + :::caution 警告： -## 环境准备 +快速部署**仅适用于本地开发**。请勿将该种部署方式用于生产环境： -- 选择一个 x86-64 上的主流 Linux 环境，推荐 CentOS 7.1 或者 Ubuntu 16.04 以上版本。更多运行环境请参考安装部署部分。 +1. 使用 Docker 方式快速部署，当 Docker 实例销毁时，相应的数据也会释放。 -- Java 8 运行环境（非 Oracle JDK 商业授权用户，建议使用免费的 Oracle JDK 8u202，[立即下载](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox)）。 +2. 通过手动部署单副本 Doris 实例，不具有数据多副本存储能力，单台机器宕机可能会造成数据丢失。 -- 建议在 Linux 上新建一个 Doris 用户。请避免使用 Root 用户，以防对操作系统误操作。 - -## 下载二进制包 +3. 本示例中的建表均为单副本，在生产中请使用多副本存储数据。 +::: -从 doris.apache.org 下载相应的 Apache Doris 安装包，并且解压。 +## 使用 Docker 快速部署【TAB-1】 + +### 第 1 步：创建 docker-compose.yaml 文件 + +复制以下内容到 docker-compose.yaml，替换 DORIS_QUICK_START_VERSION 参数为指定版本，如 `2.1.7`。 + +```plain text +version: "3" + services: + fe: + image:apache/doris:${DORIS_QUICK_START_VERSION} + hostname:fe + networks_mode: host + ports: + -"8030:8030" + -"9030:9030" + environment: + -FE_MASTER_IP="127.0.0.1" + -FE_CURRENT_IP="127.0.0.1" + -FE_MASTER_PORT="9010" + -FE_CURRENT_PORT="9010" + be: + image:apache/doris:${DORIS_QUICK_START_VERSION} + hostname:be + networks_mode: host Review Comment: networks_mode should be network_mode ? ########## i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md: ########## @@ -25,251 +25,263 @@ specific language governing permissions and limitations under the License. --> -这个简短的指南将告诉你如何下载 Apache Doris 最新稳定版本，在单节点上安装并运行它，包括创建数据库、数据表、导入数据及查询等。 + :::caution 警告： -## 环境准备 +快速部署**仅适用于本地开发**。请勿将该种部署方式用于生产环境： -- 选择一个 x86-64 上的主流 Linux 环境，推荐 CentOS 7.1 或者 Ubuntu 16.04 以上版本。更多运行环境请参考安装部署部分。 +1. 使用 Docker 方式快速部署，当 Docker 实例销毁时，相应的数据也会释放。 -- Java 8 运行环境（非 Oracle JDK 商业授权用户，建议使用免费的 Oracle JDK 8u202，[立即下载](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox)）。 +2. 通过手动部署单副本 Doris 实例，不具有数据多副本存储能力，单台机器宕机可能会造成数据丢失。 -- 建议在 Linux 上新建一个 Doris 用户。请避免使用 Root 用户，以防对操作系统误操作。 - -## 下载二进制包 +3. 本示例中的建表均为单副本，在生产中请使用多副本存储数据。 +::: -从 doris.apache.org 下载相应的 Apache Doris 安装包，并且解压。 +## 使用 Docker 快速部署【TAB-1】 + +### 第 1 步：创建 docker-compose.yaml 文件 + +复制以下内容到 docker-compose.yaml，替换 DORIS_QUICK_START_VERSION 参数为指定版本，如 `2.1.7`。 + +```plain text +version: "3" + services: + fe: + image:apache/doris:${DORIS_QUICK_START_VERSION} Review Comment: In the docker-compose.yaml file, consistent indentation is required. in this example, the indentation is inconsistent, such as the indentation for `image:` and `hostname:`. ########## i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md: ########## @@ -25,251 +25,263 @@ specific language governing permissions and limitations under the License. --> -这个简短的指南将告诉你如何下载 Apache Doris 最新稳定版本，在单节点上安装并运行它，包括创建数据库、数据表、导入数据及查询等。 + :::caution 警告： -## 环境准备 +快速部署**仅适用于本地开发**。请勿将该种部署方式用于生产环境： -- 选择一个 x86-64 上的主流 Linux 环境，推荐 CentOS 7.1 或者 Ubuntu 16.04 以上版本。更多运行环境请参考安装部署部分。 +1. 使用 Docker 方式快速部署，当 Docker 实例销毁时，相应的数据也会释放。 -- Java 8 运行环境（非 Oracle JDK 商业授权用户，建议使用免费的 Oracle JDK 8u202，[立即下载](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox)）。 +2. 通过手动部署单副本 Doris 实例，不具有数据多副本存储能力，单台机器宕机可能会造成数据丢失。 -- 建议在 Linux 上新建一个 Doris 用户。请避免使用 Root 用户，以防对操作系统误操作。 - -## 下载二进制包 +3. 本示例中的建表均为单副本，在生产中请使用多副本存储数据。 +::: -从 doris.apache.org 下载相应的 Apache Doris 安装包，并且解压。 +## 使用 Docker 快速部署【TAB-1】 + +### 第 1 步：创建 docker-compose.yaml 文件 + +复制以下内容到 docker-compose.yaml，替换 DORIS_QUICK_START_VERSION 参数为指定版本，如 `2.1.7`。 + +```plain text Review Comment: using ```text or ```plain text ########## i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md: ########## @@ -25,251 +25,263 @@ specific language governing permissions and limitations under the License. --> -这个简短的指南将告诉你如何下载 Apache Doris 最新稳定版本，在单节点上安装并运行它，包括创建数据库、数据表、导入数据及查询等。 + :::caution 警告： -## 环境准备 +快速部署**仅适用于本地开发**。请勿将该种部署方式用于生产环境： -- 选择一个 x86-64 上的主流 Linux 环境，推荐 CentOS 7.1 或者 Ubuntu 16.04 以上版本。更多运行环境请参考安装部署部分。 +1. 使用 Docker 方式快速部署，当 Docker 实例销毁时，相应的数据也会释放。 -- Java 8 运行环境（非 Oracle JDK 商业授权用户，建议使用免费的 Oracle JDK 8u202，[立即下载](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox)）。 +2. 通过手动部署单副本 Doris 实例，不具有数据多副本存储能力，单台机器宕机可能会造成数据丢失。 -- 建议在 Linux 上新建一个 Doris 用户。请避免使用 Root 用户，以防对操作系统误操作。 - -## 下载二进制包 +3. 本示例中的建表均为单副本，在生产中请使用多副本存储数据。 +::: -从 doris.apache.org 下载相应的 Apache Doris 安装包，并且解压。 +## 使用 Docker 快速部署【TAB-1】 + +### 第 1 步：创建 docker-compose.yaml 文件 + +复制以下内容到 docker-compose.yaml，替换 DORIS_QUICK_START_VERSION 参数为指定版本，如 `2.1.7`。 + +```plain text +version: "3" + services: + fe: + image:apache/doris:${DORIS_QUICK_START_VERSION} + hostname:fe + networks_mode: host + ports: + -"8030:8030" + -"9030:9030" + environment: + -FE_MASTER_IP="127.0.0.1" + -FE_CURRENT_IP="127.0.0.1" + -FE_MASTER_PORT="9010" + -FE_CURRENT_PORT="9010" + be: + image:apache/doris:${DORIS_QUICK_START_VERSION} + hostname:be + networks_mode: host + ports: + -"8040:8040" + environment: + -FE_MASTER_IP="127.0.0.1" + -BE_IP="127.0.0.1" + -BE_PORT="9050" + depends_on: + -fe +``` -```shell -# 下载 Apache Doris 二进制安装包 -server1:~ doris$ wget https://apache-doris-releases.oss-accelerate.aliyuncs.com/apache-doris-2.0.12-bin-x64.tar.gz +### 第 2 步：启动集群 -# 解压安装包 -server1:~ doris$ tar zxf apache-doris-2.0.12-bin-x64.tar.gz +使用 docker-compose 命令启动集群 -# 目录重命名为更为简单的 apache-doris -server1:~ doris$ mv apache-doris-2.0.12-bin-x64 apache-doris +```plain text +docker-compose -f ./docker-compose.yaml up -d ``` -## 安装 Doris +### 第 3 步：使用 MySQL 客户端连接集群，并检查集群状态 -### 配置 FE +```sql +## 检查 FE 状态，确定 Join 与 Alive 列都为 true +mysql -uroot -P9030 -h127.0.0.1 -e 'SELECT `host`, `join`, `alive` FROM frontends()' ++-----------+------+-------+ +| host | join | alive | ++-----------+------+-------+ +| 127.0.0.1 | true | true | ++-----------+------+-------+ + +## 检查 BE 状态，确定 Alive 列为 true +mysql -uroot -P9030 -h127.0.0.1 -e 'SELECT `host`, `alive` FROM backends()' ++-----------+-------+ +| host | alive | ++-----------+-------+ +| 127.0.0.1 | 1 | ++-----------+-------+ -FE 的配置文件为 `apache-doris/fe/conf/fe.conf`。下面是一些需要关注的核心配置。除了 JAVA_HOME, 需要手动增加，并且指向你的 JDK8 运行环境。其它配置，可以使用默认值，即可支持单机快速体验。 +``` -```Plain -# 增加 JAVA_HOME 配置，指向 JDK8 的运行环境。假如我们 JDK8 位于 /home/doris/jdk8, 则设置如下 -JAVA_HOME=/home/doris/jdk8 -# FE 监听 IP 的 CIDR 网段。默认设置为空，有 Apache Doris 启动时自动选择一个可用网段。如有多个网段，需要指定一个网段，可以类似设置 priority_networks=192.168.0.0/24 -# priority_networks = -# FE 元数据存放的目录，默认是在 DORIS_HOME 下的 doris-meta 目录。已经创建，可以更改为你的元数据存储路径。 -# meta_dir = ${DORIS_HOME}/doris-meta -``` +## 本地快速部署 -### 启动 FE +::: info 环境建议： -在 apache-doris/fe 下，运行下面命令启动 FE。 +* 选择一个 AMD/ARM 上的主流 Linux 环境，推荐 CentOS 7.1 或者 Ubuntu 16.04 以上版本。更多运行环境请参考安装部署部分。 -```shell -# 将 FE 启动成后台运行模式，这样确保退出终端后，进程依旧运行。 -server1:apache-doris/fe doris$ ./bin/start_fe.sh --daemon -``` +* Java 8 运行环境（非 Oracle JDK 商业授权用户，建议使用免费的 Oracle JDK 8u300 以后版本，[立即下载](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox))。 -### 配置 BE +* 建议在 Linux 上新建一个 Doris 用户。请避免使用 Root 用户，以防对操作系统误操作。 -BE 的配置文件为 `apache-doris/be/conf/be.conf`。下面是一些需要关注的核心配置。除了 JAVA_HOME, 需要手动增加，并且指向你的 JDK8 运行环境。其它配置，可以使用默认值，即可支持我们的快速体验。 +::: -```Plain -# 增加 JAVA_HOME 配置，指向 JDK8 的运行环境。假如我们 JDK8 位于 /home/doris/jdk8, 则设置如下 -JAVA_HOME=/home/doris/jdk8 +### 第 1 步：下载二进制包 -# BE 监听 IP 的 CIDR 网段。默认设置为空，有 Apache Doris 启动时自动选择一个可用网段。如有多个网段，需要指定一个网段，可以类似设置 priority_networks=192.168.0.0/24 -# priority_networks = +从 Apache Doris 网站上[下载](https://doris.apache.org/zh-CN/download)相应的二进制安装包，并解压。 -# BE 数据存放的目录，默认是在 DORIS_HOME 下的 storage 下，默认已经创建，可以更改为你的数据存储路径 -# storage_root_path = ${DORIS_HOME}/storage -``` +### 第 2 步：修改环境变量 -### 启动 BE +1. 修改系统最大打开文件句柄数 -在 apache-doris/be 下，运行下面命令启动 BE。 + 通过以下命令可以调整最大文件句柄数。在调整后，需要重启会话以生效配置： -```shell -# 将 BE 启动成后台运行模式，这样确保退出终端后，进程依旧运行。 -server1:apache-doris/be doris$ ./bin/start_be.sh --daemon -``` + ```sql + vi /etc/security/limits.conf + * soft nofile 1000000 + * hard nofile 1000000 + ``` -### 连接 Apache Doris FE +2. 修改虚拟内存区域 -通过 MySQL 客户端来连接 Apache Doris FE，下载免安装的 [MySQL 客户端](https://dev.mysql.com/downloads/mysql/)。 + 通过以下命令可以永久修改虚拟内存区域至少为 2000000，并立即生效： -解压刚才下载的 MySQL 客户端，在 `bin/` 目录下可以找到 `mysql` 命令行工具。然后执行下面的命令连接 Apache Doris。 + ```bash + cat >> /etc/sysctl.conf << EOF + vm.max_map_count = 2000000 + EOF -```shell -mysql -uroot -P9030 -h127.0.0.1 -``` + Take effect immediately + sysctl -p + ``` -:::caution 注意 +### 第 3 步：安装 FE -- 这里使用的 Root 用户是 Apache Doris 内置的超级管理员用户，具体的用户权限查看 [认证和鉴权](../admin-manual/auth/authentication-and-authorization.md) -- -P：这里是我们连接 Apache Doris 的查询端口，默认端口是 9030，对应的是 fe.conf 里的 `query_port` -- -h：这里是我们连接的 FE IP 地址，如果你的客户端和 FE 安装在同一个节点可以使用 127.0.0.1。 +1. 配置 FE -::: + 修改 FE 配置文件 `apache-doris/fe/conf/fe.conf` 的以下内容： -### 将 BE 节点添加到集群 + ```sql + ## 指定 Java 环境 + JAVA_HOME=/home/doris/jdk -在 MySQL 客户端执行类似下面的 SQL，将 BE 添加到集群中 + # 指定 FE 监听 IP 的 CIDR 网段 + priority_networks=127.0.0.1/32 + ``` -```sql - ALTER SYSTEM ADD BACKEND "be_host_ip:heartbeat_service_port"; -``` +2. 启动 FE -:::caution 注意 + 通过 start\_fe.sh 脚本运行 FE 进程： -1. be_host_ip：要添加 BE 的 IP 地址 + ```sql + apache-doris/fe/bin/start_fe.sh --daemon + ``` -2. heartbeat_service_port：要添加 BE 的心跳上报端口，可以查看 `be.conf` 里的 `heartbeat_service_port`，默认是 `9050`。 +3. 检查 FE 状态 -3. 通过 show backends 语句可以查看新添加的 BE 节点。 + 使用 MySQL 客户端连接集群，并检查集群状态： -::: + ```sql + ## 检查 FE 状态，确定 Join 与 Alive 列都为 true + mysql -uroot -P9030 -h127.0.0.1 -e "show frontends;" + +-----------------------------------------+-----------+-------------+----------+-----------+---------+----------+----------+-----------+------+-------+-------------------+---------------------+----------+--------+-------------------------+------------------+ + | Name | Host | EditLogPort | HttpPort | QueryPort | RpcPort | Role | IsMaster | ClusterId | Join | Alive | ReplayedJournalId | LastHeartbeat | IsHelper | ErrMsg | Version | CurrentConnected | + +-----------------------------------------+-----------+-------------+----------+-----------+---------+----------+----------+-----------+------+-------+-------------------+---------------------+----------+--------+-------------------------+------------------+ + | fe_9d0169c5_b01f_478c_96ab_7c4e8602ec57 | 127.0.0.1 | 9010 | 8030 | 9030 | 9020 | FOLLOWER | true | 656872880 | true | true | 276 | 2024-07-28 18:07:39 | true | | doris-2.0.12-2971efd194 | Yes | + +-----------------------------------------+-----------+-------------+----------+-----------+---------+----------+----------+-----------+------+-------+-------------------+---------------------+----------+--------+-------------------------+------------------+ + ``` -### 修改 Root 用户和 Admin 用户的密码 +### 第 4 步：安装 BE -在 MySQL 客户端，执行类似下面的 SQL，为 Root 用户和 Admin 用户设置新密码 +1. 配置 BE -```sql -mysql> SET PASSWORD FOR 'root' = PASSWORD('doris-root-password'); -Query OK, 0 rows affected (0.01 sec) - -mysql> SET PASSWORD FOR 'admin' = PASSWORD('doris-admin-password'); -Query OK, 0 rows affected (0.00 sec) -``` + 修改 BE 配置文件 `apache-doris/be/conf/be.conf` 的以下内容： -:::tip -Root 用户和 Admin 用户的区别 + ```sql + ## 指定 Java 环境 + JAVA_HOME=/home/doris/jdk -Root 用户和 Admin 用户都属于 Apache Doris 安装完默认存在的 2 个账户。其中 Root 用户拥有整个集群的超级权限，可以对集群完成各种管理操作，比如添加节点，去除节点。Admin 用户没有管理权限，是集群中的 Superuser，拥有除集群管理相关以外的所有权限。建议只有在需要对集群进行运维管理超级权限时才使用 Root 权限。 -::: + # 指定 FE 监听 IP 的 CIDR 网段 + priority_networks=127.0.0.1/32 + ``` -## 建库建表 +2. 启动 BE -### 连接 Apache Doris + 通过以下命令启动 BE 进程： -使用 Admin 账户连接 Apache Doris FE。 + ```sql + apache-doris/fe/bin/start_be.sh --daemon Review Comment: 启动 BE，但是脚本路径是 FE ，是否正确 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
