This is an automated email from the ASF dual-hosted git repository.
kassiez 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 0e621f65bd Update quick-start.md (#1692)
0e621f65bd is described below
commit 0e621f65bd6fe9934f2f40389f2b900124053077
Author: wangtianyi2004 <[email protected]>
AuthorDate: Mon Jan 6 16:38:58 2025 +0800
Update quick-start.md (#1692)
## Versions
- [ ] dev
- [ ] 3.0
- [ ] 2.1
- [ ] 2.0
## Languages
- [ ] Chinese
- [ ] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---------
Co-authored-by: KassieZ <[email protected]>
---
docs/gettingStarted/quick-start.md | 363 +++++++++++----------
.../current/gettingStarted/quick-start.md | 352 ++++++++++----------
.../version-2.1/gettingStarted/quick-start.md | 352 ++++++++++----------
.../version-3.0/gettingStarted/quick-start.md | 352 ++++++++++----------
.../version-2.1/gettingStarted/quick-start.md | 363 +++++++++++----------
.../version-3.0/gettingStarted/quick-start.md | 363 +++++++++++----------
6 files changed, 1104 insertions(+), 1041 deletions(-)
diff --git a/docs/gettingStarted/quick-start.md
b/docs/gettingStarted/quick-start.md
index d932ba252b..80f40d7124 100644
--- a/docs/gettingStarted/quick-start.md
+++ b/docs/gettingStarted/quick-start.md
@@ -3,6 +3,7 @@
"title": "Quick Start",
"language": "en"
}
+
---
<!--
@@ -24,241 +25,257 @@ specific language governing permissions and limitations
under the License.
-->
-# Quick Start
+:::caution Warning:
+
+Quick deployment **is only suitable for local development**. Do not use this
deployment method in production environments:
-This guide is about how to download the latest stable version of Apache Doris,
install it on a single node, and get it running, including steps for creating a
database, data tables, importing data, and performing queries.
+1. When deploying quickly using Docker, data will be released when the Docker
instance is destroyed.
-## Environment requirements
+2. Deploying a single-instance Doris manually does not have data replication
capability, and a single machine failure may result in data loss.
-- A mainstream Linux x86-64 environment. CentOS 7.1 or Ubuntu 16.04 or later
versions are recommended. See the "Install and Deploy" section of the doc for
guides on more environments.
-- Install Java 8 runtime environment. (If you are not an Oracle JDK commercial
license user, we suggest using the free Oracle JDK 8u202. [Download
now](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox).)
-- It is recommended to create a new user for Apache Doris on Linux (avoid
using the root user to prevent accidental operations on the operating system).
+3. The tables created in this example are single-instance. In production,
please use multi-replica storage for data.
+:::
+
+## Use Docker for Quick Deployment
+
+### Step 1: Create the docker-compose.yaml File
+
+Copy the following content into the docker-compose.yaml file, and replace the
`DORIS_QUICK_START_VERSION` parameter with the specified version, such as
`3.0.1`.
+
+```text
+version: "3"
+services:
+ fe:
+ image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: fe
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - FE_ID=1
+ network_mode: host
+ be:
+ image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: be
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - BE_ADDR=127.0.0.1:9050
+ depends_on:
+ - fe
+ network_mode: host
+```
-## Download binary package
+### Step 2：Start Cluster
-Download the Apache Doris installation package from doris.apache.org and
proceed with the following steps.
+Start the cluster using the docker-compose command.
```shell
-# Download the binary installation package of Apache Doris
-server1:~ doris$ wget
https://apache-doris-releases.oss-accelerate.aliyuncs.com/apache-doris-2.0.3-bin-x64.tar.gz
+docker-compose -f ./docker-compose.yaml up -d
+```
-# Extract the installation package
-server1:~ doris$ tar zxf apache-doris-2.0.3-bin-x64.tar.gz
+### Step 3: Connect to the cluster using MySQL client and check the cluster
status
+
+```sql
+## Check the FE status to ensure that both the Join and Alive columns are true.
+mysql -uroot -P9030 -h127.0.0.1 -e 'SELECT `host`, `join`, `alive` FROM
frontends()'
++-----------+------+-------+
+| host | join | alive |
++-----------+------+-------+
+| 127.0.0.1 | true | true |
++-----------+------+-------+
+
+## Check the BE status to ensure that the Alive column is true.
+mysql -uroot -P9030 -h127.0.0.1 -e 'SELECT `host`, `alive` FROM backends()'
++-----------+-------+
+| host | alive |
++-----------+-------+
+| 127.0.0.1 | 1 |
++-----------+-------+
-# Rename the directory to apache-doris for simplicity
-server1:~ doris$ mv apache-doris-2.0.3-bin-x64 apache-doris
```
-## Install Apache Doris
-### Configure FE
-Go to the `apache-doris/fe/conf/fe.conf` file for FE configuration. Below are
some key configurations to pay attention to. Add JAVA_HOME manually and point
it to your JDK8 runtime environment. For other configurations, you can go with
the default values for a quick single-machine experience.
+## Local Quick Deployment
-```Shell
-# Add JAVA_HOME and point it to your JDK8 runtime environment. Suppose your
JDK8 is at /home/doris/jdk8, set it as follows:
-JAVA_HOME=/home/doris/jdk8
+:::info Environment Recommendations:
-# The CIDR network segment of FE listening IP is empty by default. When
started, Apache Doris will automatically select an available network segment.
If you need to specify a segment, you can set priority_networks=192.168.0.0/24,
for example.
-# priority_networks =
+* Choose a mainstream Linux environment on AMD/ARM, preferably CentOS 7.1 or
Ubuntu 16.04 and above. For more supported environments, refer to the
installation and deployment section.
-# By default, FE metadata is stored in the doris-meta directory under
DORIS_HOME. It is created already. You can change it to your specified path.
-# meta_dir = ${DORIS_HOME}/doris-meta
-```
+* Java 8 runtime environment (for non-Oracle JDK commercial license users, it
is recommended to use the free Oracle JDK 8u300 or later versions, [Download
Now](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox)).
-### Start FE
+* It is recommended to create a new Doris user on Linux. Avoid using the root
user to prevent accidental system operation errors.
-Run the following command under apache-doris/fe to start FE.
+:::
-```shell
-# Start FE in the background to ensure that the process continues running even
after exiting the terminal.
-server1:apache-doris/fe doris$ ./bin/start_fe.sh --daemon
-```
+### Step 1: Download the Binary Package
-### Configure BE
+Download the corresponding binary installation package from the Apache Doris
website [here](https://doris.apache.org/en-us/download), and extract it.
-Go to the `apache-doris/be/conf/be.conf` file for BE configuration. Below are
some key configurations to pay attention to. Add JAVA_HOME manually and point
it to your JDK8 runtime environment. For other configurations, you can go with
the default values for a quick single-machine experience.
+### Step 2: Modify the Environment Variables
-```Shell
-# Add JAVA_HOME and point it to your JDK8 runtime environment. Suppose your
JDK8 is at /home/doris/jdk8, set it as follows:
-JAVA_HOME=/home/doris/jdk8
+1. Modify the system's maximum open file descriptor limit
-# The CIDR network segment of BE listening IP is empty by default. When
started, Doris will automatically select an available network segment. If you
need to specify a segment, you can set priority_networks=192.168.0.0/24, for
example.
-# priority_networks =
+ Use the following command to adjust the maximum file descriptor limit.
After making this change, you need to restart the session to apply the
configuration:
-# By default, BE data is stored in the storage directory under DORIS_HOME. It
is created already. You can change it to your specified path.
-# storage_root_path = ${DORIS_HOME}/storage
-```
-### Start BE
-Run the following command under apache-doris/be to start BE.
+ ```sql
+ vi /etc/security/limits.conf
+ * soft nofile 1000000
+ * hard nofile 1000000
+ ```
-```shell
-# Start BE in the background to ensure that the process continues running even
after exiting the terminal.
-server1:apache-doris/be doris$ ./bin/start_be.sh --daemon
-```
+2. Modify Virtual Memory Area
-### Connect to Doris FE
+ Use the following command to permanently modify the virtual memory area to
at least 2000000, and apply the change immediately:
-Download the [portable MySQL client](https://dev.mysql.com/downloads/mysql/)
to connect to Doris FE.
+ ```bash
+ cat >> /etc/sysctl.conf << EOF
+ vm.max_map_count = 2000000
+ EOF
-Unpack the client, find the `mysql` command-line tool in the `bin/` directory.
Then execute the following command to connect to Apache Doris.
+ Take effect immediately
+ sysctl -p
+ ```
-```shell
-mysql -uroot -P9030 -h127.0.0.1
-```
+### Step 3: Install FE
-Note:
+1. Configure FE
-- The root user here is the built-in super admin user of Apache Doris. See
[Authentication and
Authorization](../admin-manual/auth/authentication-and-authorization.md) for
more information.
-- -P: This specifies the query port that is connected to. The default port is
9030. It corresponds to the `query_port`setting in fe.conf.
-- -h: This specifies the IP address of the FE that is connected to. If your
client and FE are installed on the same node, you can use 127.0.0.1.
+ Modify the following contents in the FE configuration file
`apache-doris/fe/conf/fe.conf`:
-### Add BE nodes to cluster
+ ```sql
+ ## Specify Java environment
+ JAVA_HOME=/home/doris/jdk
-An example SQL to execute in the MySQL client to add BE nodes to the cluster:
+ ## Specify the CIDR block for FE listening IP
+ priority_networks=127.0.0.1/32
+ ```
-```SQL
- ALTER SYSTEM ADD BACKEND "be_host_ip:heartbeat_service_port";
-```
+2. Start FE
-Note:
+ Run the FE process by executing the start_fe.sh script:
-1. be_host_ip: the IP address of the BE node to be added
-2. heartbeat_service_port: the heartbeat reporting port of the BE node to be
added, which can be found in `be.conf`under `heartbeat_service_port`, set as
`9050` by default
-3. You can use the "show backends" statement to view the newly added BE nodes.
+ ```sql
+ apache-doris/fe/bin/start_fe.sh --daemon
+ ```
-### Modify passwords for root and admin
+3. Check FE Status
-Example SQLs to execute in the MySQL client to set new passwords for root and
admin users:
+ Connect to the cluster using MySQL client and check the cluster status:
-```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)
-```
+ ```sql
+ ## Check FE Status to ensure that both the Join and Alive columns are 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 |
+
+-----------------------------------------+-----------+-------------+----------+-----------+---------+----------+----------+-----------+------+-------+-------------------+---------------------+----------+--------+-------------------------+------------------+
+ ```
-:::tip
-Difference between root and admin users
+### Step 4: Install BE
-The root and admin users are two default accounts that are automatically
created after Doris installation. The root user has superuser privileges for
the entire cluster and can perform various management operations, such as
adding or removing nodes. The admin user does not have administrative
privileges but is a superuser within the cluster, possessing all permissions
except those related to cluster management. It is recommended to use the root
privileges only when necessary for cluster [...]
-:::
+1. Configure BE
-## Create database and table
+ Modify the following contents in the BE configuration file
`apache-doris/be/conf/be.conf`:
-### Connect to Apache Doris
+ ```sql
+ ## Specify Java environment
+ JAVA_HOME=/home/doris/jdk
-Use admin account to connect to Apache Doris FE.
+ ## Specify the CIDR block for BE's listening IP
+ priority_networks=127.0.0.1/32
+ ```
-```shell
-mysql -uadmin -P9030 -h127.0.0.1
-```
+2. Start BE
-:::tip
-If the MySQL client connecting to 127.0.0.1 is on the same machine as FE, no
password will be required.
-:::
+ Start the BE process with the following command:
-### Create database and table
-
-```SQL
-create database demo;
-
-use demo;
-create table mytable
-(
- k1 TINYINT,
- k2 DECIMAL(10, 2) DEFAULT "10.05",
- k3 CHAR(10) COMMENT "string column",
- k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
-)
-COMMENT "my first table"
-DISTRIBUTED BY HASH(k1) BUCKETS 1
-PROPERTIES ('replication_num' = '1');
-```
+ ```sql
+ apache-doris/fe/bin/start_be.sh --daemon
+ ```
-### Ingest data
+3. Register BE Node in the Cluster
-Save the following example data to the local "data.csv" file:
+ Connect to the cluster using MySQL client:
-```Plaintext
-1,0.14,a1,20
-2,1.04,b2,21
-3,3.14,c3,22
-4,4.35,d4,23
-```
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
-Load the data from "data.csv" into the newly created table using the Stream
Load method.
+ Use the ADD BACKEND command to register the BE node:
-```shell
-curl --location-trusted -u admin:admin_password -T data.csv -H
"column_separator:," http://127.0.0.1:8030/api/demo/mytable/_stream_load
-```
+ ```sql
+ ALTER SYSTEM ADD BACKEND "127.0.0.1:9050";
+ ```
-- -T data.csv: data file name
-- -u admin:admin_password: admin account and password
-- 127.0.0.1:8030: IP and http_port of FE
+4. Check BE Status
-Once it is executed successfully, a message like the following will be
returned:
+ Connect to the cluster using MySQL client and check the cluster status:
-```shell
-{
- "TxnId": 30,
- "Label": "a56d2861-303a-4b50-9907-238fea904363",
- "Comment": "",
- "TwoPhaseCommit": "false",
- "Status": "Success",
- "Message": "OK",
- "NumberTotalRows": 4,
- "NumberLoadedRows": 4,
- "NumberFilteredRows": 0,
- "NumberUnselectedRows": 0,
- "LoadBytes": 52,
- "LoadTimeMs": 206,
- "BeginTxnTimeMs": 13,
- "StreamLoadPutTimeMs": 141,
- "ReadDataTimeMs": 0,
- "WriteDataTimeMs": 7,
- "CommitAndPublishTimeMs": 42
-}
-```
+ ```sql
+ ## Check BE Status to ensure that the Alive column is true
+ mysql -uroot -P9030 -h127.0.0.1 -e "show backends;"
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | BackendId | Host | HeartbeatPort | BePort | HttpPort | BrpcPort |
LastStartTime | LastHeartbeat | Alive | SystemDecommissioned |
TabletNum | DataUsedCapacity | TrashUsedCapcacity | AvailCapacity |
TotalCapacity | UsedPct | MaxDiskUsedPct | RemoteUsedCapacity | Tag
| ErrMsg | Version | Status
| HeartbeatFailureCou [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | 10156 | 127.0.0.1 | 9050 | 9060 | 8040 | 8060 |
2024-07-28 17:59:14 | 2024-07-28 18:08:24 | true | false | 14
| 0.000 | 0.000 | 8.342 GB | 19.560 GB |
57.35 % | 57.35 % | 0.000 | {"location" : "default"} |
| doris-2.0.12-2971efd194 | {"lastSuccessReportTabletsTime":"2024-07-28
18:08:14","lastStreamLoadTime":-1,"isQueryDisabled":false,"isLoadDisabled":false}
| 0 [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ ```
-- `NumberLoadedRows`: the number of rows that have been loaded
-- `NumberTotalRows`: the total number of rows to be loaded
-- `Status`: "Success" means data has been loaded successfully.
-
-### Query data
-
-Execute the following SQL in the MySQL client to query the loaded data:
-
-```SQL
-mysql> select * from mytable;
-+------+------+------+------+
-| k1 | k2 | k3 | k4 |
-+------+------+------+------+
-| 1 | 0.14 | a1 | 20 |
-| 2 | 1.04 | b2 | 21 |
-| 3 | 3.14 | c3 | 22 |
-| 4 | 4.35 | d4 | 23 |
-+------+------+------+------+
-4 rows in set (0.01 sec)
-```
+## Run Queries
-## Stop Apache Doris
+1. Connect to the cluster using MySQL client:
-### Stop FE
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
+
+2. Create database and test table:
+
+ ```sql
+ create database demo;
+
+ use demo;
+ create table mytable
+ (
+ k1 TINYINT,
+ k2 DECIMAL(10, 2) DEFAULT "10.05",
+ k3 CHAR(10) COMMENT "string column",
+ k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
+ )
+ COMMENT "my first table"
+ DISTRIBUTED BY HASH(k1) BUCKETS 1;
+ ```
+
+3. Import test data:
+
+ Insert test data using the Insert Into statement
+
+ ```sql
+ insert into mytable values
+ (1,0.14,'a1',20),
+ (2,1.04,'b2',21),
+ (3,3.14,'c3',22),
+ (4,4.35,'d4',23);
+ ```
+
+4. Execute the following SQL query in the MySQL client to view the imported
data:
+
+ ```sql
+ MySQL [demo]> select * from demo.mytable;
+ +------+------+------+------+
+ | k1 | k2 | k3 | k4 |
+ +------+------+------+------+
+ | 1 | 0.14 | a1 | 20 |
+ | 2 | 1.04 | b2 | 21 |
+ | 3 | 3.14 | c3 | 22 |
+ | 4 | 4.35 | d4 | 23 |
+ +------+------+------+------+
+ 4 rows in set (0.10 sec)
+ ```
-Execute the following command under apache-doris/fe to stop FE.
-```shell
-server1:apache-doris/fe doris$ ./bin/stop_fe.sh
-```
-### Stop BE
-Execute the following command under apache-doris/be to stop BE.
-```shell
-server1:apache-doris/be doris$ ./bin/stop_be.sh
-```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md
index 03cde3f085..d8b2476883 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md
@@ -25,251 +25,255 @@ 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 用户，以防对操作系统误操作。
-
-## 下载二进制包
-
-从 doris.apache.org 下载相应的 Apache Doris 安装包，并且解压。
-
-```shell
-# 下载 Apache Doris 二进制安装包
-server1:~ doris$ wget
https://apache-doris-releases.oss-accelerate.aliyuncs.com/apache-doris-2.0.12-bin-x64.tar.gz
-
-# 解压安装包
-server1:~ doris$ tar zxf apache-doris-2.0.12-bin-x64.tar.gz
+3. 本示例中的建表均为单副本，在生产中请使用多副本存储数据。
+:::
-# 目录重命名为更为简单的 apache-doris
-server1:~ doris$ mv apache-doris-2.0.12-bin-x64 apache-doris
+## 使用 Docker 快速部署
+
+### 第 1 步：创建 docker-compose.yaml 文件
+
+复制以下内容到 docker-compose.yaml，替换 DORIS_QUICK_START_VERSION 参数为指定版本，如 `3.0.1`。
+
+```text
+version: "3"
+services:
+ fe:
+ image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: fe
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - FE_ID=1
+ network_mode: host
+ be:
+ image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: be
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - BE_ADDR=127.0.0.1:9050
+ depends_on:
+ - fe
+ network_mode: host
```
-## 安装 Doris
+### 第 2 步：启动集群
-### 配置 FE
+使用 docker-compose 命令启动集群
-FE 的配置文件为 `apache-doris/fe/conf/fe.conf`。下面是一些需要关注的核心配置。除了 JAVA_HOME,
需要手动增加，并且指向你的 JDK8 运行环境。其它配置，可以使用默认值，即可支持单机快速体验。
+```shell
+docker-compose -f ./docker-compose.yaml up -d
+```
-```Plain
-# 增加 JAVA_HOME 配置，指向 JDK8 的运行环境。假如我们 JDK8 位于 /home/doris/jdk8, 则设置如下
-JAVA_HOME=/home/doris/jdk8
+### 第 3 步：使用 MySQL 客户端连接集群，并检查集群状态
-# FE 监听 IP 的 CIDR 网段。默认设置为空，有 Apache Doris
启动时自动选择一个可用网段。如有多个网段，需要指定一个网段，可以类似设置 priority_networks=192.168.0.0/24
-# priority_networks =
+```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 元数据存放的目录，默认是在 DORIS_HOME 下的 doris-meta 目录。已经创建，可以更改为你的元数据存储路径。
-# meta_dir = ${DORIS_HOME}/doris-meta
```
-### 启动 FE
-在 apache-doris/fe 下，运行下面命令启动 FE。
-```shell
-# 将 FE 启动成后台运行模式，这样确保退出终端后，进程依旧运行。
-server1:apache-doris/fe doris$ ./bin/start_fe.sh --daemon
-```
+## 本地快速部署
-### 配置 BE
+:::info 环境建议：
-BE 的配置文件为 `apache-doris/be/conf/be.conf`。下面是一些需要关注的核心配置。除了 JAVA_HOME,
需要手动增加，并且指向你的 JDK8 运行环境。其它配置，可以使用默认值，即可支持我们的快速体验。
+* 选择一个 AMD/ARM 上的主流 Linux 环境，推荐 CentOS 7.1 或者 Ubuntu 16.04
以上版本。更多运行环境请参考安装部署部分。
-```Plain
-# 增加 JAVA_HOME 配置，指向 JDK8 的运行环境。假如我们 JDK8 位于 /home/doris/jdk8, 则设置如下
-JAVA_HOME=/home/doris/jdk8
+* Java 8 运行环境（非 Oracle JDK 商业授权用户，建议使用免费的 Oracle JDK 8u300
以后版本，[立即下载](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox))。
-# BE 监听 IP 的 CIDR 网段。默认设置为空，有 Apache Doris
启动时自动选择一个可用网段。如有多个网段，需要指定一个网段，可以类似设置 priority_networks=192.168.0.0/24
-# priority_networks =
+* 建议在 Linux 上新建一个 Doris 用户。请避免使用 Root 用户，以防对操作系统误操作。
-# BE 数据存放的目录，默认是在 DORIS_HOME 下的 storage 下，默认已经创建，可以更改为你的数据存储路径
-# storage_root_path = ${DORIS_HOME}/storage
-```
+:::
-### 启动 BE
+### 第 1 步：下载二进制包
-在 apache-doris/be 下，运行下面命令启动 BE。
+从 Apache Doris 网站上[下载](https://doris.apache.org/zh-CN/download)相应的二进制安装包，并解压。
-```shell
-# 将 BE 启动成后台运行模式，这样确保退出终端后，进程依旧运行。
-server1:apache-doris/be doris$ ./bin/start_be.sh --daemon
-```
+### 第 2 步：修改环境变量
-### 连接 Apache Doris FE
+1. 修改系统最大打开文件句柄数
-通过 MySQL 客户端来连接 Apache Doris FE，下载免安装的 [MySQL
客户端](https://dev.mysql.com/downloads/mysql/)。
+ 通过以下命令可以调整最大文件句柄数。在调整后，需要重启会话以生效配置：
-解压刚才下载的 MySQL 客户端，在 `bin/` 目录下可以找到 `mysql` 命令行工具。然后执行下面的命令连接 Apache Doris。
+ ```sql
+ vi /etc/security/limits.conf
+ * soft nofile 1000000
+ * hard nofile 1000000
+ ```
-```shell
-mysql -uroot -P9030 -h127.0.0.1
-```
+2. 修改虚拟内存区域
-:::caution 注意
+ 通过以下命令可以永久修改虚拟内存区域至少为 2000000，并立即生效：
-- 这里使用的 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。
+ ```bash
+ cat >> /etc/sysctl.conf << EOF
+ vm.max_map_count = 2000000
+ EOF
-:::
+ Take effect immediately
+ sysctl -p
+ ```
-### 将 BE 节点添加到集群
+### 第 3 步：安装 FE
-在 MySQL 客户端执行类似下面的 SQL，将 BE 添加到集群中
+1. 配置 FE
-```sql
- ALTER SYSTEM ADD BACKEND "be_host_ip:heartbeat_service_port";
-```
+ 修改 FE 配置文件 `apache-doris/fe/conf/fe.conf` 的以下内容：
-:::caution 注意
+ ```sql
+ ## 指定 Java 环境
+ JAVA_HOME=/home/doris/jdk
-1. be_host_ip：要添加 BE 的 IP 地址
+ # 指定 FE 监听 IP 的 CIDR 网段
+ priority_networks=127.0.0.1/32
+ ```
-2. heartbeat_service_port：要添加 BE 的心跳上报端口，可以查看 `be.conf` 里的
`heartbeat_service_port`，默认是 `9050`。
+2. 启动 FE
-3. 通过 show backends 语句可以查看新添加的 BE 节点。
+ 通过 start_fe.sh 脚本运行 FE 进程：
-:::
+ ```sql
+ apache-doris/fe/bin/start_fe.sh --daemon
+ ```
-### 修改 Root 用户和 Admin 用户的密码
+3. 检查 FE 状态
-在 MySQL 客户端，执行类似下面的 SQL，为 Root 用户和 Admin 用户设置新密码
+ 使用 MySQL 客户端连接集群，并检查集群状态：
-```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)
-```
+ ```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 |
+
+-----------------------------------------+-----------+-------------+----------+-----------+---------+----------+----------+-----------+------+-------+-------------------+---------------------+----------+--------+-------------------------+------------------+
+ ```
-:::tip
-Root 用户和 Admin 用户的区别
+### 第 4 步：安装 BE
-Root 用户和 Admin 用户都属于 Apache Doris 安装完默认存在的 2 个账户。其中 Root
用户拥有整个集群的超级权限，可以对集群完成各种管理操作，比如添加节点，去除节点。Admin 用户没有管理权限，是集群中的
Superuser，拥有除集群管理相关以外的所有权限。建议只有在需要对集群进行运维管理超级权限时才使用 Root 权限。
-:::
+1. 配置 BE
-## 建库建表
+ 修改 BE 配置文件 `apache-doris/be/conf/be.conf` 的以下内容：
-### 连接 Apache Doris
+ ```sql
+ ## 指定 Java 环境
+ JAVA_HOME=/home/doris/jdk
-使用 Admin 账户连接 Apache Doris FE。
+ # 指定 FE 监听 IP 的 CIDR 网段
+ priority_networks=127.0.0.1/32
+ ```
-```shell
-mysql -uadmin -P9030 -h127.0.0.1
-```
+2. 启动 BE
-:::tip
-如果是在 FE 的同一台机器上的 MySQL 客户端连接 127.0.0.1, 不需要输入密码。
-:::
+ 通过以下命令启动 BE 进程：
-### 创建数据库和数据表
+ ```sql
+ apache-doris/fe/bin/start_be.sh --daemon
+ ```
-```sql
-create database demo;
-
-use demo;
-create table mytable
-(
- k1 TINYINT,
- k2 DECIMAL(10, 2) DEFAULT "10.05",
- k3 CHAR(10) COMMENT "string column",
- k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
-)
-COMMENT "my first table"
-DISTRIBUTED BY HASH(k1) BUCKETS 1
-PROPERTIES ('replication_num' = '1');
-```
+3. 在集群中注册 BE 节点
-### 导入数据
+ 使用 MySQL 客户端连接集群：
-将以下示例数据，保存在本地的 data.csv：
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
-```Plaintext
-1,0.14,a1,20
-2,1.04,b2,21
-3,3.14,c3,22
-4,4.35,d4,23
-```
+ 使用 ADD BACKEND 命令注册 BE 节点：
-通过 Stream Load 方式将上面保存到文件中的数据导入到刚才创建的表里。
+ ```sql
+ ALTER SYSTEM ADD BACKEND "127.0.0.1:9050";
+ ```
-```shell
-curl --location-trusted -u admin:admin_password -T data.csv -H
"column_separator:," http://127.0.0.1:8030/api/demo/mytable/_stream_load
-```
+4. 检查 BE 状态
-- -T data.csv : 要导入的数据文件名
+ 使用 MySQL 客户端连接集群，并检查集群状态：
-- -u admin:admin_password : Admin 账户与密码
+ ```sql
+ ## 检查 BE 状态，确定 Alive 列为 true
+ mysql -uroot -P9030 -h127.0.0.1 -e "show backends;"
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | BackendId | Host | HeartbeatPort | BePort | HttpPort | BrpcPort |
LastStartTime | LastHeartbeat | Alive | SystemDecommissioned |
TabletNum | DataUsedCapacity | TrashUsedCapcacity | AvailCapacity |
TotalCapacity | UsedPct | MaxDiskUsedPct | RemoteUsedCapacity | Tag
| ErrMsg | Version | Status
| HeartbeatFailureCou [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | 10156 | 127.0.0.1 | 9050 | 9060 | 8040 | 8060 |
2024-07-28 17:59:14 | 2024-07-28 18:08:24 | true | false | 14
| 0.000 | 0.000 | 8.342 GB | 19.560 GB |
57.35 % | 57.35 % | 0.000 | {"location" : "default"} |
| doris-2.0.12-2971efd194 | {"lastSuccessReportTabletsTime":"2024-07-28
18:08:14","lastStreamLoadTime":-1,"isQueryDisabled":false,"isLoadDisabled":false}
| 0 [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ ```
-- 127.0.0.1:8030 : 分别是 FE 的 IP 和 http_port
+## 运行查询
-执行成功之后我们可以看到下面的返回信息：
+1. 使用 MySQL 客户端连接集群
-```shell
-{
- "TxnId": 30,
- "Label": "a56d2861-303a-4b50-9907-238fea904363",
- "Comment": "",
- "TwoPhaseCommit": "false",
- "Status": "Success",
- "Message": "OK",
- "NumberTotalRows": 4,
- "NumberLoadedRows": 4,
- "NumberFilteredRows": 0,
- "NumberUnselectedRows": 0,
- "LoadBytes": 52,
- "LoadTimeMs": 206,
- "BeginTxnTimeMs": 13,
- "StreamLoadPutTimeMs": 141,
- "ReadDataTimeMs": 0,
- "WriteDataTimeMs": 7,
- "CommitAndPublishTimeMs": 42
-}
-```
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
-- `NumberLoadedRows`: 表示已经导入的数据记录数
+2. 创建数据库与测试表
-- `NumberTotalRows`: 表示要导入的总数据量
+ ```sql
+ create database demo;
-- `Status`: Success 表示导入成功
+ use demo;
+ create table mytable
+ (
+ k1 TINYINT,
+ k2 DECIMAL(10, 2) DEFAULT "10.05",
+ k3 CHAR(10) COMMENT "string column",
+ k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
+ )
+ COMMENT "my first table"
+ DISTRIBUTED BY HASH(k1) BUCKETS 1;
+ ```
-### 查询数据
+3. 导入测试数据
-在 MySQL 客户端中，执行如下 SQL，可以查询到刚才导入的数据：
+ 使用 Insert Into 语句插入测试数据
-```sql
-mysql> select * from mytable;
-+------+------+------+------+
-| k1 | k2 | k3 | k4 |
-+------+------+------+------+
-| 1 | 0.14 | a1 | 20 |
-| 2 | 1.04 | b2 | 21 |
-| 3 | 3.14 | c3 | 22 |
-| 4 | 4.35 | d4 | 23 |
-+------+------+------+------+
-4 rows in set (0.01 sec)
-```
+ ```sql
+ insert into mytable values
+ (1,0.14,'a1',20),
+ (2,1.04,'b2',21),
+ (3,3.14,'c3',22),
+ (4,4.35,'d4',23);
+ ```
-## 停止 Apache Doris
+4. 在 MySQL 客户端中执行以下 SQL 语句可以查看到已导入的数据：
-### 停止 FE
+ ```sql
+ MySQL [demo]> select * from demo.mytable;
+ +------+------+------+------+
+ | k1 | k2 | k3 | k4 |
+ +------+------+------+------+
+ | 1 | 0.14 | a1 | 20 |
+ | 2 | 1.04 | b2 | 21 |
+ | 3 | 3.14 | c3 | 22 |
+ | 4 | 4.35 | d4 | 23 |
+ +------+------+------+------+
+ 4 rows in set (0.10 sec)
+ ```
-在 apache-doris/fe 下，运行下面命令停止 FE。
-```shell
-server1:apache-doris/fe doris$ ./bin/stop_fe.sh
-```
-### 停止 BE
-在 apache-doris/be 下，运行下面命令停止 BE。
-```shell
-server1:apache-doris/be doris$ ./bin/stop_be.sh
-```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/gettingStarted/quick-start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/gettingStarted/quick-start.md
index 03cde3f085..c88209e3fd 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/gettingStarted/quick-start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/gettingStarted/quick-start.md
@@ -25,251 +25,255 @@ 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 用户，以防对操作系统误操作。
-
-## 下载二进制包
-
-从 doris.apache.org 下载相应的 Apache Doris 安装包，并且解压。
-
-```shell
-# 下载 Apache Doris 二进制安装包
-server1:~ doris$ wget
https://apache-doris-releases.oss-accelerate.aliyuncs.com/apache-doris-2.0.12-bin-x64.tar.gz
-
-# 解压安装包
-server1:~ doris$ tar zxf apache-doris-2.0.12-bin-x64.tar.gz
+3. 本示例中的建表均为单副本，在生产中请使用多副本存储数据。
+:::
-# 目录重命名为更为简单的 apache-doris
-server1:~ doris$ mv apache-doris-2.0.12-bin-x64 apache-doris
+## 使用 Docker 快速部署
+
+### 第 1 步：创建 docker-compose.yaml 文件
+
+复制以下内容到 docker-compose.yaml，替换 DORIS_QUICK_START_VERSION 参数为指定版本，如 `2.1.7`。
+
+```text
+version: "3"
+services:
+ fe:
+ image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: fe
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - FE_ID=1
+ network_mode: host
+ be:
+ image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: be
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - BE_ADDR=127.0.0.1:9050
+ depends_on:
+ - fe
+ network_mode: host
```
-## 安装 Doris
+### 第 2 步：启动集群
-### 配置 FE
+使用 docker-compose 命令启动集群
-FE 的配置文件为 `apache-doris/fe/conf/fe.conf`。下面是一些需要关注的核心配置。除了 JAVA_HOME,
需要手动增加，并且指向你的 JDK8 运行环境。其它配置，可以使用默认值，即可支持单机快速体验。
+```shell
+docker-compose -f ./docker-compose.yaml up -d
+```
-```Plain
-# 增加 JAVA_HOME 配置，指向 JDK8 的运行环境。假如我们 JDK8 位于 /home/doris/jdk8, 则设置如下
-JAVA_HOME=/home/doris/jdk8
+### 第 3 步：使用 MySQL 客户端连接集群，并检查集群状态
-# FE 监听 IP 的 CIDR 网段。默认设置为空，有 Apache Doris
启动时自动选择一个可用网段。如有多个网段，需要指定一个网段，可以类似设置 priority_networks=192.168.0.0/24
-# priority_networks =
+```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 元数据存放的目录，默认是在 DORIS_HOME 下的 doris-meta 目录。已经创建，可以更改为你的元数据存储路径。
-# meta_dir = ${DORIS_HOME}/doris-meta
```
-### 启动 FE
-在 apache-doris/fe 下，运行下面命令启动 FE。
-```shell
-# 将 FE 启动成后台运行模式，这样确保退出终端后，进程依旧运行。
-server1:apache-doris/fe doris$ ./bin/start_fe.sh --daemon
-```
+## 本地快速部署
-### 配置 BE
+:::info 环境建议：
-BE 的配置文件为 `apache-doris/be/conf/be.conf`。下面是一些需要关注的核心配置。除了 JAVA_HOME,
需要手动增加，并且指向你的 JDK8 运行环境。其它配置，可以使用默认值，即可支持我们的快速体验。
+* 选择一个 AMD/ARM 上的主流 Linux 环境，推荐 CentOS 7.1 或者 Ubuntu 16.04
以上版本。更多运行环境请参考安装部署部分。
-```Plain
-# 增加 JAVA_HOME 配置，指向 JDK8 的运行环境。假如我们 JDK8 位于 /home/doris/jdk8, 则设置如下
-JAVA_HOME=/home/doris/jdk8
+* Java 8 运行环境（非 Oracle JDK 商业授权用户，建议使用免费的 Oracle JDK 8u300
以后版本，[立即下载](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox))。
-# BE 监听 IP 的 CIDR 网段。默认设置为空，有 Apache Doris
启动时自动选择一个可用网段。如有多个网段，需要指定一个网段，可以类似设置 priority_networks=192.168.0.0/24
-# priority_networks =
+* 建议在 Linux 上新建一个 Doris 用户。请避免使用 Root 用户，以防对操作系统误操作。
-# BE 数据存放的目录，默认是在 DORIS_HOME 下的 storage 下，默认已经创建，可以更改为你的数据存储路径
-# storage_root_path = ${DORIS_HOME}/storage
-```
+:::
-### 启动 BE
+### 第 1 步：下载二进制包
-在 apache-doris/be 下，运行下面命令启动 BE。
+从 Apache Doris 网站上[下载](https://doris.apache.org/zh-CN/download)相应的二进制安装包，并解压。
-```shell
-# 将 BE 启动成后台运行模式，这样确保退出终端后，进程依旧运行。
-server1:apache-doris/be doris$ ./bin/start_be.sh --daemon
-```
+### 第 2 步：修改环境变量
-### 连接 Apache Doris FE
+1. 修改系统最大打开文件句柄数
-通过 MySQL 客户端来连接 Apache Doris FE，下载免安装的 [MySQL
客户端](https://dev.mysql.com/downloads/mysql/)。
+ 通过以下命令可以调整最大文件句柄数。在调整后，需要重启会话以生效配置：
-解压刚才下载的 MySQL 客户端，在 `bin/` 目录下可以找到 `mysql` 命令行工具。然后执行下面的命令连接 Apache Doris。
+ ```sql
+ vi /etc/security/limits.conf
+ * soft nofile 1000000
+ * hard nofile 1000000
+ ```
-```shell
-mysql -uroot -P9030 -h127.0.0.1
-```
+2. 修改虚拟内存区域
-:::caution 注意
+ 通过以下命令可以永久修改虚拟内存区域至少为 2000000，并立即生效：
-- 这里使用的 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。
+ ```bash
+ cat >> /etc/sysctl.conf << EOF
+ vm.max_map_count = 2000000
+ EOF
-:::
+ Take effect immediately
+ sysctl -p
+ ```
-### 将 BE 节点添加到集群
+### 第 3 步：安装 FE
-在 MySQL 客户端执行类似下面的 SQL，将 BE 添加到集群中
+1. 配置 FE
-```sql
- ALTER SYSTEM ADD BACKEND "be_host_ip:heartbeat_service_port";
-```
+ 修改 FE 配置文件 `apache-doris/fe/conf/fe.conf` 的以下内容：
-:::caution 注意
+ ```sql
+ ## 指定 Java 环境
+ JAVA_HOME=/home/doris/jdk
-1. be_host_ip：要添加 BE 的 IP 地址
+ # 指定 FE 监听 IP 的 CIDR 网段
+ priority_networks=127.0.0.1/32
+ ```
-2. heartbeat_service_port：要添加 BE 的心跳上报端口，可以查看 `be.conf` 里的
`heartbeat_service_port`，默认是 `9050`。
+2. 启动 FE
-3. 通过 show backends 语句可以查看新添加的 BE 节点。
+ 通过 start\_fe.sh 脚本运行 FE 进程：
-:::
+ ```sql
+ apache-doris/fe/bin/start_fe.sh --daemon
+ ```
-### 修改 Root 用户和 Admin 用户的密码
+3. 检查 FE 状态
-在 MySQL 客户端，执行类似下面的 SQL，为 Root 用户和 Admin 用户设置新密码
+ 使用 MySQL 客户端连接集群，并检查集群状态：
-```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)
-```
+ ```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 |
+
+-----------------------------------------+-----------+-------------+----------+-----------+---------+----------+----------+-----------+------+-------+-------------------+---------------------+----------+--------+-------------------------+------------------+
+ ```
-:::tip
-Root 用户和 Admin 用户的区别
+### 第 4 步：安装 BE
-Root 用户和 Admin 用户都属于 Apache Doris 安装完默认存在的 2 个账户。其中 Root
用户拥有整个集群的超级权限，可以对集群完成各种管理操作，比如添加节点，去除节点。Admin 用户没有管理权限，是集群中的
Superuser，拥有除集群管理相关以外的所有权限。建议只有在需要对集群进行运维管理超级权限时才使用 Root 权限。
-:::
+1. 配置 BE
-## 建库建表
+ 修改 BE 配置文件 `apache-doris/be/conf/be.conf` 的以下内容：
-### 连接 Apache Doris
+ ```sql
+ ## 指定 Java 环境
+ JAVA_HOME=/home/doris/jdk
-使用 Admin 账户连接 Apache Doris FE。
+ # 指定 FE 监听 IP 的 CIDR 网段
+ priority_networks=127.0.0.1/32
+ ```
-```shell
-mysql -uadmin -P9030 -h127.0.0.1
-```
+2. 启动 BE
-:::tip
-如果是在 FE 的同一台机器上的 MySQL 客户端连接 127.0.0.1, 不需要输入密码。
-:::
+ 通过以下命令启动 BE 进程：
-### 创建数据库和数据表
+ ```sql
+ apache-doris/fe/bin/start_be.sh --daemon
+ ```
-```sql
-create database demo;
-
-use demo;
-create table mytable
-(
- k1 TINYINT,
- k2 DECIMAL(10, 2) DEFAULT "10.05",
- k3 CHAR(10) COMMENT "string column",
- k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
-)
-COMMENT "my first table"
-DISTRIBUTED BY HASH(k1) BUCKETS 1
-PROPERTIES ('replication_num' = '1');
-```
+3. 在集群中注册 BE 节点
-### 导入数据
+ 使用 MySQL 客户端连接集群：
-将以下示例数据，保存在本地的 data.csv：
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
-```Plaintext
-1,0.14,a1,20
-2,1.04,b2,21
-3,3.14,c3,22
-4,4.35,d4,23
-```
+ 使用 ADD BACKEND 命令注册 BE 节点：
-通过 Stream Load 方式将上面保存到文件中的数据导入到刚才创建的表里。
+ ```sql
+ ALTER SYSTEM ADD BACKEND "127.0.0.1:9050";
+ ```
-```shell
-curl --location-trusted -u admin:admin_password -T data.csv -H
"column_separator:," http://127.0.0.1:8030/api/demo/mytable/_stream_load
-```
+4. 检查 BE 状态
-- -T data.csv : 要导入的数据文件名
+ 使用 MySQL 客户端连接集群，并检查集群状态：
-- -u admin:admin_password : Admin 账户与密码
+ ```sql
+ ## 检查 BE 状态，确定 Alive 列为 true
+ mysql -uroot -P9030 -h127.0.0.1 -e "show backends;"
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | BackendId | Host | HeartbeatPort | BePort | HttpPort | BrpcPort |
LastStartTime | LastHeartbeat | Alive | SystemDecommissioned |
TabletNum | DataUsedCapacity | TrashUsedCapcacity | AvailCapacity |
TotalCapacity | UsedPct | MaxDiskUsedPct | RemoteUsedCapacity | Tag
| ErrMsg | Version | Status
| HeartbeatFailureCou [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | 10156 | 127.0.0.1 | 9050 | 9060 | 8040 | 8060 |
2024-07-28 17:59:14 | 2024-07-28 18:08:24 | true | false | 14
| 0.000 | 0.000 | 8.342 GB | 19.560 GB |
57.35 % | 57.35 % | 0.000 | {"location" : "default"} |
| doris-2.0.12-2971efd194 | {"lastSuccessReportTabletsTime":"2024-07-28
18:08:14","lastStreamLoadTime":-1,"isQueryDisabled":false,"isLoadDisabled":false}
| 0 [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ ```
-- 127.0.0.1:8030 : 分别是 FE 的 IP 和 http_port
+## 运行查询
-执行成功之后我们可以看到下面的返回信息：
+1. 使用 MySQL 客户端连接集群
-```shell
-{
- "TxnId": 30,
- "Label": "a56d2861-303a-4b50-9907-238fea904363",
- "Comment": "",
- "TwoPhaseCommit": "false",
- "Status": "Success",
- "Message": "OK",
- "NumberTotalRows": 4,
- "NumberLoadedRows": 4,
- "NumberFilteredRows": 0,
- "NumberUnselectedRows": 0,
- "LoadBytes": 52,
- "LoadTimeMs": 206,
- "BeginTxnTimeMs": 13,
- "StreamLoadPutTimeMs": 141,
- "ReadDataTimeMs": 0,
- "WriteDataTimeMs": 7,
- "CommitAndPublishTimeMs": 42
-}
-```
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
-- `NumberLoadedRows`: 表示已经导入的数据记录数
+2. 创建数据库与测试表
-- `NumberTotalRows`: 表示要导入的总数据量
+ ```sql
+ create database demo;
-- `Status`: Success 表示导入成功
+ use demo;
+ create table mytable
+ (
+ k1 TINYINT,
+ k2 DECIMAL(10, 2) DEFAULT "10.05",
+ k3 CHAR(10) COMMENT "string column",
+ k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
+ )
+ COMMENT "my first table"
+ DISTRIBUTED BY HASH(k1) BUCKETS 1;
+ ```
-### 查询数据
+3. 导入测试数据
-在 MySQL 客户端中，执行如下 SQL，可以查询到刚才导入的数据：
+ 使用 Insert Into 语句插入测试数据
-```sql
-mysql> select * from mytable;
-+------+------+------+------+
-| k1 | k2 | k3 | k4 |
-+------+------+------+------+
-| 1 | 0.14 | a1 | 20 |
-| 2 | 1.04 | b2 | 21 |
-| 3 | 3.14 | c3 | 22 |
-| 4 | 4.35 | d4 | 23 |
-+------+------+------+------+
-4 rows in set (0.01 sec)
-```
+ ```sql
+ insert into mytable values
+ (1,0.14,'a1',20),
+ (2,1.04,'b2',21),
+ (3,3.14,'c3',22),
+ (4,4.35,'d4',23);
+ ```
-## 停止 Apache Doris
+4. 在 MySQL 客户端中执行以下 SQL 语句可以查看到已导入的数据：
-### 停止 FE
+ ```sql
+ MySQL [demo]> select * from demo.mytable;
+ +------+------+------+------+
+ | k1 | k2 | k3 | k4 |
+ +------+------+------+------+
+ | 1 | 0.14 | a1 | 20 |
+ | 2 | 1.04 | b2 | 21 |
+ | 3 | 3.14 | c3 | 22 |
+ | 4 | 4.35 | d4 | 23 |
+ +------+------+------+------+
+ 4 rows in set (0.10 sec)
+ ```
-在 apache-doris/fe 下，运行下面命令停止 FE。
-```shell
-server1:apache-doris/fe doris$ ./bin/stop_fe.sh
-```
-### 停止 BE
-在 apache-doris/be 下，运行下面命令停止 BE。
-```shell
-server1:apache-doris/be doris$ ./bin/stop_be.sh
-```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/gettingStarted/quick-start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/gettingStarted/quick-start.md
index 03cde3f085..fc62e3ca7f 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/gettingStarted/quick-start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/gettingStarted/quick-start.md
@@ -25,251 +25,255 @@ 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 用户，以防对操作系统误操作。
-
-## 下载二进制包
-
-从 doris.apache.org 下载相应的 Apache Doris 安装包，并且解压。
-
-```shell
-# 下载 Apache Doris 二进制安装包
-server1:~ doris$ wget
https://apache-doris-releases.oss-accelerate.aliyuncs.com/apache-doris-2.0.12-bin-x64.tar.gz
-
-# 解压安装包
-server1:~ doris$ tar zxf apache-doris-2.0.12-bin-x64.tar.gz
+3. 本示例中的建表均为单副本，在生产中请使用多副本存储数据。
+:::
-# 目录重命名为更为简单的 apache-doris
-server1:~ doris$ mv apache-doris-2.0.12-bin-x64 apache-doris
+## 使用 Docker 快速部署
+
+### 第 1 步：创建 docker-compose.yaml 文件
+
+复制以下内容到 docker-compose.yaml，替换 DORIS_QUICK_START_VERSION 参数为指定版本，如 `3.0.1`。
+
+```text
+version: "3"
+services:
+ fe:
+ image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: fe
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - FE_ID=1
+ network_mode: host
+ be:
+ image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: be
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - BE_ADDR=127.0.0.1:9050
+ depends_on:
+ - fe
+ network_mode: host
```
-## 安装 Doris
+### 第 2 步：启动集群
-### 配置 FE
+使用 docker-compose 命令启动集群
-FE 的配置文件为 `apache-doris/fe/conf/fe.conf`。下面是一些需要关注的核心配置。除了 JAVA_HOME,
需要手动增加，并且指向你的 JDK8 运行环境。其它配置，可以使用默认值，即可支持单机快速体验。
+```shell
+docker-compose -f ./docker-compose.yaml up -d
+```
-```Plain
-# 增加 JAVA_HOME 配置，指向 JDK8 的运行环境。假如我们 JDK8 位于 /home/doris/jdk8, 则设置如下
-JAVA_HOME=/home/doris/jdk8
+### 第 3 步：使用 MySQL 客户端连接集群，并检查集群状态
-# FE 监听 IP 的 CIDR 网段。默认设置为空，有 Apache Doris
启动时自动选择一个可用网段。如有多个网段，需要指定一个网段，可以类似设置 priority_networks=192.168.0.0/24
-# priority_networks =
+```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 元数据存放的目录，默认是在 DORIS_HOME 下的 doris-meta 目录。已经创建，可以更改为你的元数据存储路径。
-# meta_dir = ${DORIS_HOME}/doris-meta
```
-### 启动 FE
-在 apache-doris/fe 下，运行下面命令启动 FE。
-```shell
-# 将 FE 启动成后台运行模式，这样确保退出终端后，进程依旧运行。
-server1:apache-doris/fe doris$ ./bin/start_fe.sh --daemon
-```
+## 本地快速部署
-### 配置 BE
+:::info 环境建议：
-BE 的配置文件为 `apache-doris/be/conf/be.conf`。下面是一些需要关注的核心配置。除了 JAVA_HOME,
需要手动增加，并且指向你的 JDK8 运行环境。其它配置，可以使用默认值，即可支持我们的快速体验。
+* 选择一个 AMD/ARM 上的主流 Linux 环境，推荐 CentOS 7.1 或者 Ubuntu 16.04
以上版本。更多运行环境请参考安装部署部分。
-```Plain
-# 增加 JAVA_HOME 配置，指向 JDK8 的运行环境。假如我们 JDK8 位于 /home/doris/jdk8, 则设置如下
-JAVA_HOME=/home/doris/jdk8
+* Java 8 运行环境（非 Oracle JDK 商业授权用户，建议使用免费的 Oracle JDK 8u300
以后版本，[立即下载](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox))。
-# BE 监听 IP 的 CIDR 网段。默认设置为空，有 Apache Doris
启动时自动选择一个可用网段。如有多个网段，需要指定一个网段，可以类似设置 priority_networks=192.168.0.0/24
-# priority_networks =
+* 建议在 Linux 上新建一个 Doris 用户。请避免使用 Root 用户，以防对操作系统误操作。
-# BE 数据存放的目录，默认是在 DORIS_HOME 下的 storage 下，默认已经创建，可以更改为你的数据存储路径
-# storage_root_path = ${DORIS_HOME}/storage
-```
+:::
-### 启动 BE
+### 第 1 步：下载二进制包
-在 apache-doris/be 下，运行下面命令启动 BE。
+从 Apache Doris 网站上[下载](https://doris.apache.org/zh-CN/download)相应的二进制安装包，并解压。
-```shell
-# 将 BE 启动成后台运行模式，这样确保退出终端后，进程依旧运行。
-server1:apache-doris/be doris$ ./bin/start_be.sh --daemon
-```
+### 第 2 步：修改环境变量
-### 连接 Apache Doris FE
+1. 修改系统最大打开文件句柄数
-通过 MySQL 客户端来连接 Apache Doris FE，下载免安装的 [MySQL
客户端](https://dev.mysql.com/downloads/mysql/)。
+ 通过以下命令可以调整最大文件句柄数。在调整后，需要重启会话以生效配置：
-解压刚才下载的 MySQL 客户端，在 `bin/` 目录下可以找到 `mysql` 命令行工具。然后执行下面的命令连接 Apache Doris。
+ ```sql
+ vi /etc/security/limits.conf
+ * soft nofile 1000000
+ * hard nofile 1000000
+ ```
-```shell
-mysql -uroot -P9030 -h127.0.0.1
-```
+2. 修改虚拟内存区域
-:::caution 注意
+ 通过以下命令可以永久修改虚拟内存区域至少为 2000000，并立即生效：
-- 这里使用的 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。
+ ```bash
+ cat >> /etc/sysctl.conf << EOF
+ vm.max_map_count = 2000000
+ EOF
-:::
+ Take effect immediately
+ sysctl -p
+ ```
-### 将 BE 节点添加到集群
+### 第 3 步：安装 FE
-在 MySQL 客户端执行类似下面的 SQL，将 BE 添加到集群中
+1. 配置 FE
-```sql
- ALTER SYSTEM ADD BACKEND "be_host_ip:heartbeat_service_port";
-```
+ 修改 FE 配置文件 `apache-doris/fe/conf/fe.conf` 的以下内容：
-:::caution 注意
+ ```sql
+ ## 指定 Java 环境
+ JAVA_HOME=/home/doris/jdk
-1. be_host_ip：要添加 BE 的 IP 地址
+ # 指定 FE 监听 IP 的 CIDR 网段
+ priority_networks=127.0.0.1/32
+ ```
-2. heartbeat_service_port：要添加 BE 的心跳上报端口，可以查看 `be.conf` 里的
`heartbeat_service_port`，默认是 `9050`。
+2. 启动 FE
-3. 通过 show backends 语句可以查看新添加的 BE 节点。
+ 通过 start\_fe.sh 脚本运行 FE 进程：
-:::
+ ```sql
+ apache-doris/fe/bin/start_fe.sh --daemon
+ ```
-### 修改 Root 用户和 Admin 用户的密码
+3. 检查 FE 状态
-在 MySQL 客户端，执行类似下面的 SQL，为 Root 用户和 Admin 用户设置新密码
+ 使用 MySQL 客户端连接集群，并检查集群状态：
-```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)
-```
+ ```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 |
+
+-----------------------------------------+-----------+-------------+----------+-----------+---------+----------+----------+-----------+------+-------+-------------------+---------------------+----------+--------+-------------------------+------------------+
+ ```
-:::tip
-Root 用户和 Admin 用户的区别
+### 第 4 步：安装 BE
-Root 用户和 Admin 用户都属于 Apache Doris 安装完默认存在的 2 个账户。其中 Root
用户拥有整个集群的超级权限，可以对集群完成各种管理操作，比如添加节点，去除节点。Admin 用户没有管理权限，是集群中的
Superuser，拥有除集群管理相关以外的所有权限。建议只有在需要对集群进行运维管理超级权限时才使用 Root 权限。
-:::
+1. 配置 BE
-## 建库建表
+ 修改 BE 配置文件 `apache-doris/be/conf/be.conf` 的以下内容：
-### 连接 Apache Doris
+ ```sql
+ ## 指定 Java 环境
+ JAVA_HOME=/home/doris/jdk
-使用 Admin 账户连接 Apache Doris FE。
+ # 指定 FE 监听 IP 的 CIDR 网段
+ priority_networks=127.0.0.1/32
+ ```
-```shell
-mysql -uadmin -P9030 -h127.0.0.1
-```
+2. 启动 BE
-:::tip
-如果是在 FE 的同一台机器上的 MySQL 客户端连接 127.0.0.1, 不需要输入密码。
-:::
+ 通过以下命令启动 BE 进程：
-### 创建数据库和数据表
+ ```sql
+ apache-doris/fe/bin/start_be.sh --daemon
+ ```
-```sql
-create database demo;
-
-use demo;
-create table mytable
-(
- k1 TINYINT,
- k2 DECIMAL(10, 2) DEFAULT "10.05",
- k3 CHAR(10) COMMENT "string column",
- k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
-)
-COMMENT "my first table"
-DISTRIBUTED BY HASH(k1) BUCKETS 1
-PROPERTIES ('replication_num' = '1');
-```
+3. 在集群中注册 BE 节点
-### 导入数据
+ 使用 MySQL 客户端连接集群：
-将以下示例数据，保存在本地的 data.csv：
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
-```Plaintext
-1,0.14,a1,20
-2,1.04,b2,21
-3,3.14,c3,22
-4,4.35,d4,23
-```
+ 使用 ADD BACKEND 命令注册 BE 节点：
-通过 Stream Load 方式将上面保存到文件中的数据导入到刚才创建的表里。
+ ```sql
+ ALTER SYSTEM ADD BACKEND "127.0.0.1:9050";
+ ```
-```shell
-curl --location-trusted -u admin:admin_password -T data.csv -H
"column_separator:," http://127.0.0.1:8030/api/demo/mytable/_stream_load
-```
+4. 检查 BE 状态
-- -T data.csv : 要导入的数据文件名
+ 使用 MySQL 客户端连接集群，并检查集群状态：
-- -u admin:admin_password : Admin 账户与密码
+ ```sql
+ ## 检查 BE 状态，确定 Alive 列为 true
+ mysql -uroot -P9030 -h127.0.0.1 -e "show backends;"
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | BackendId | Host | HeartbeatPort | BePort | HttpPort | BrpcPort |
LastStartTime | LastHeartbeat | Alive | SystemDecommissioned |
TabletNum | DataUsedCapacity | TrashUsedCapcacity | AvailCapacity |
TotalCapacity | UsedPct | MaxDiskUsedPct | RemoteUsedCapacity | Tag
| ErrMsg | Version | Status
| HeartbeatFailureCou [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | 10156 | 127.0.0.1 | 9050 | 9060 | 8040 | 8060 |
2024-07-28 17:59:14 | 2024-07-28 18:08:24 | true | false | 14
| 0.000 | 0.000 | 8.342 GB | 19.560 GB |
57.35 % | 57.35 % | 0.000 | {"location" : "default"} |
| doris-2.0.12-2971efd194 | {"lastSuccessReportTabletsTime":"2024-07-28
18:08:14","lastStreamLoadTime":-1,"isQueryDisabled":false,"isLoadDisabled":false}
| 0 [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ ```
-- 127.0.0.1:8030 : 分别是 FE 的 IP 和 http_port
+## 运行查询
-执行成功之后我们可以看到下面的返回信息：
+1. 使用 MySQL 客户端连接集群
-```shell
-{
- "TxnId": 30,
- "Label": "a56d2861-303a-4b50-9907-238fea904363",
- "Comment": "",
- "TwoPhaseCommit": "false",
- "Status": "Success",
- "Message": "OK",
- "NumberTotalRows": 4,
- "NumberLoadedRows": 4,
- "NumberFilteredRows": 0,
- "NumberUnselectedRows": 0,
- "LoadBytes": 52,
- "LoadTimeMs": 206,
- "BeginTxnTimeMs": 13,
- "StreamLoadPutTimeMs": 141,
- "ReadDataTimeMs": 0,
- "WriteDataTimeMs": 7,
- "CommitAndPublishTimeMs": 42
-}
-```
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
-- `NumberLoadedRows`: 表示已经导入的数据记录数
+2. 创建数据库与测试表
-- `NumberTotalRows`: 表示要导入的总数据量
+ ```sql
+ create database demo;
-- `Status`: Success 表示导入成功
+ use demo;
+ create table mytable
+ (
+ k1 TINYINT,
+ k2 DECIMAL(10, 2) DEFAULT "10.05",
+ k3 CHAR(10) COMMENT "string column",
+ k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
+ )
+ COMMENT "my first table"
+ DISTRIBUTED BY HASH(k1) BUCKETS 1;
+ ```
-### 查询数据
+3. 导入测试数据
-在 MySQL 客户端中，执行如下 SQL，可以查询到刚才导入的数据：
+ 使用 Insert Into 语句插入测试数据
-```sql
-mysql> select * from mytable;
-+------+------+------+------+
-| k1 | k2 | k3 | k4 |
-+------+------+------+------+
-| 1 | 0.14 | a1 | 20 |
-| 2 | 1.04 | b2 | 21 |
-| 3 | 3.14 | c3 | 22 |
-| 4 | 4.35 | d4 | 23 |
-+------+------+------+------+
-4 rows in set (0.01 sec)
-```
+ ```sql
+ insert into mytable values
+ (1,0.14,'a1',20),
+ (2,1.04,'b2',21),
+ (3,3.14,'c3',22),
+ (4,4.35,'d4',23);
+ ```
-## 停止 Apache Doris
+4. 在 MySQL 客户端中执行以下 SQL 语句可以查看到已导入的数据：
-### 停止 FE
+ ```sql
+ MySQL [demo]> select * from demo.mytable;
+ +------+------+------+------+
+ | k1 | k2 | k3 | k4 |
+ +------+------+------+------+
+ | 1 | 0.14 | a1 | 20 |
+ | 2 | 1.04 | b2 | 21 |
+ | 3 | 3.14 | c3 | 22 |
+ | 4 | 4.35 | d4 | 23 |
+ +------+------+------+------+
+ 4 rows in set (0.10 sec)
+ ```
-在 apache-doris/fe 下，运行下面命令停止 FE。
-```shell
-server1:apache-doris/fe doris$ ./bin/stop_fe.sh
-```
-### 停止 BE
-在 apache-doris/be 下，运行下面命令停止 BE。
-```shell
-server1:apache-doris/be doris$ ./bin/stop_be.sh
-```
diff --git a/versioned_docs/version-2.1/gettingStarted/quick-start.md
b/versioned_docs/version-2.1/gettingStarted/quick-start.md
index d932ba252b..6fd5d532b6 100644
--- a/versioned_docs/version-2.1/gettingStarted/quick-start.md
+++ b/versioned_docs/version-2.1/gettingStarted/quick-start.md
@@ -3,6 +3,7 @@
"title": "Quick Start",
"language": "en"
}
+
---
<!--
@@ -24,241 +25,257 @@ specific language governing permissions and limitations
under the License.
-->
-# Quick Start
+:::caution Warning:
+
+Quick deployment **is only suitable for local development**. Do not use this
deployment method in production environments:
-This guide is about how to download the latest stable version of Apache Doris,
install it on a single node, and get it running, including steps for creating a
database, data tables, importing data, and performing queries.
+1. When deploying quickly using Docker, data will be released when the Docker
instance is destroyed.
-## Environment requirements
+2. Deploying a single-instance Doris manually does not have data replication
capability, and a single machine failure may result in data loss.
-- A mainstream Linux x86-64 environment. CentOS 7.1 or Ubuntu 16.04 or later
versions are recommended. See the "Install and Deploy" section of the doc for
guides on more environments.
-- Install Java 8 runtime environment. (If you are not an Oracle JDK commercial
license user, we suggest using the free Oracle JDK 8u202. [Download
now](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox).)
-- It is recommended to create a new user for Apache Doris on Linux (avoid
using the root user to prevent accidental operations on the operating system).
+3. The tables created in this example are single-instance. In production,
please use multi-replica storage for data.
+:::
+
+## Use Docker for Quick Deployment
+
+### Step 1: Create the docker-compose.yaml File
+
+Copy the following content into the docker-compose.yaml file, and replace the
`DORIS_QUICK_START_VERSION` parameter with the specified version, such as
`2.1.7`.
+
+```text
+version: "3"
+services:
+ fe:
+ image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: fe
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - FE_ID=1
+ network_mode: host
+ be:
+ image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: be
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - BE_ADDR=127.0.0.1:9050
+ depends_on:
+ - fe
+ network_mode: host
+```
-## Download binary package
+### Step 2：Start Cluster
-Download the Apache Doris installation package from doris.apache.org and
proceed with the following steps.
+Start the cluster using the docker-compose command.
```shell
-# Download the binary installation package of Apache Doris
-server1:~ doris$ wget
https://apache-doris-releases.oss-accelerate.aliyuncs.com/apache-doris-2.0.3-bin-x64.tar.gz
+docker-compose -f ./docker-compose.yaml up -d
+```
-# Extract the installation package
-server1:~ doris$ tar zxf apache-doris-2.0.3-bin-x64.tar.gz
+### Step 3: Connect to the cluster using MySQL client and check the cluster
status
+
+```sql
+## Check the FE status to ensure that both the Join and Alive columns are true.
+mysql -uroot -P9030 -h127.0.0.1 -e 'SELECT `host`, `join`, `alive` FROM
frontends()'
++-----------+------+-------+
+| host | join | alive |
++-----------+------+-------+
+| 127.0.0.1 | true | true |
++-----------+------+-------+
+
+## Check the BE status to ensure that the Alive column is true.
+mysql -uroot -P9030 -h127.0.0.1 -e 'SELECT `host`, `alive` FROM backends()'
++-----------+-------+
+| host | alive |
++-----------+-------+
+| 127.0.0.1 | 1 |
++-----------+-------+
-# Rename the directory to apache-doris for simplicity
-server1:~ doris$ mv apache-doris-2.0.3-bin-x64 apache-doris
```
-## Install Apache Doris
-### Configure FE
-Go to the `apache-doris/fe/conf/fe.conf` file for FE configuration. Below are
some key configurations to pay attention to. Add JAVA_HOME manually and point
it to your JDK8 runtime environment. For other configurations, you can go with
the default values for a quick single-machine experience.
+## Local Quick Deployment
-```Shell
-# Add JAVA_HOME and point it to your JDK8 runtime environment. Suppose your
JDK8 is at /home/doris/jdk8, set it as follows:
-JAVA_HOME=/home/doris/jdk8
+:::info Environment Recommendations:
-# The CIDR network segment of FE listening IP is empty by default. When
started, Apache Doris will automatically select an available network segment.
If you need to specify a segment, you can set priority_networks=192.168.0.0/24,
for example.
-# priority_networks =
+* Choose a mainstream Linux environment on AMD/ARM, preferably CentOS 7.1 or
Ubuntu 16.04 and above. For more supported environments, refer to the
installation and deployment section.
-# By default, FE metadata is stored in the doris-meta directory under
DORIS_HOME. It is created already. You can change it to your specified path.
-# meta_dir = ${DORIS_HOME}/doris-meta
-```
+* Java 8 runtime environment (for non-Oracle JDK commercial license users, it
is recommended to use the free Oracle JDK 8u300 or later versions, [Download
Now](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox)).
-### Start FE
+* It is recommended to create a new Doris user on Linux. Avoid using the root
user to prevent accidental system operation errors.
-Run the following command under apache-doris/fe to start FE.
+:::
-```shell
-# Start FE in the background to ensure that the process continues running even
after exiting the terminal.
-server1:apache-doris/fe doris$ ./bin/start_fe.sh --daemon
-```
+### Step 1: Download the Binary Package
-### Configure BE
+Download the corresponding binary installation package from the Apache Doris
website [here](https://doris.apache.org/en-us/download), and extract it.
-Go to the `apache-doris/be/conf/be.conf` file for BE configuration. Below are
some key configurations to pay attention to. Add JAVA_HOME manually and point
it to your JDK8 runtime environment. For other configurations, you can go with
the default values for a quick single-machine experience.
+### Step 2: Modify the Environment Variables
-```Shell
-# Add JAVA_HOME and point it to your JDK8 runtime environment. Suppose your
JDK8 is at /home/doris/jdk8, set it as follows:
-JAVA_HOME=/home/doris/jdk8
+1. Modify the system's maximum open file descriptor limit
-# The CIDR network segment of BE listening IP is empty by default. When
started, Doris will automatically select an available network segment. If you
need to specify a segment, you can set priority_networks=192.168.0.0/24, for
example.
-# priority_networks =
+ Use the following command to adjust the maximum file descriptor limit.
After making this change, you need to restart the session to apply the
configuration:
-# By default, BE data is stored in the storage directory under DORIS_HOME. It
is created already. You can change it to your specified path.
-# storage_root_path = ${DORIS_HOME}/storage
-```
-### Start BE
-Run the following command under apache-doris/be to start BE.
+ ```sql
+ vi /etc/security/limits.conf
+ * soft nofile 1000000
+ * hard nofile 1000000
+ ```
-```shell
-# Start BE in the background to ensure that the process continues running even
after exiting the terminal.
-server1:apache-doris/be doris$ ./bin/start_be.sh --daemon
-```
+2. Modify Virtual Memory Area
-### Connect to Doris FE
+ Use the following command to permanently modify the virtual memory area to
at least 2000000, and apply the change immediately:
-Download the [portable MySQL client](https://dev.mysql.com/downloads/mysql/)
to connect to Doris FE.
+ ```bash
+ cat >> /etc/sysctl.conf << EOF
+ vm.max_map_count = 2000000
+ EOF
-Unpack the client, find the `mysql` command-line tool in the `bin/` directory.
Then execute the following command to connect to Apache Doris.
+ Take effect immediately
+ sysctl -p
+ ```
-```shell
-mysql -uroot -P9030 -h127.0.0.1
-```
+### Step 3: Install FE
-Note:
+1. Configure FE
-- The root user here is the built-in super admin user of Apache Doris. See
[Authentication and
Authorization](../admin-manual/auth/authentication-and-authorization.md) for
more information.
-- -P: This specifies the query port that is connected to. The default port is
9030. It corresponds to the `query_port`setting in fe.conf.
-- -h: This specifies the IP address of the FE that is connected to. If your
client and FE are installed on the same node, you can use 127.0.0.1.
+ Modify the following contents in the FE configuration file
`apache-doris/fe/conf/fe.conf`:
-### Add BE nodes to cluster
+ ```sql
+ ## Specify Java environment
+ JAVA_HOME=/home/doris/jdk
-An example SQL to execute in the MySQL client to add BE nodes to the cluster:
+ ## Specify the CIDR block for FE listening IP
+ priority_networks=127.0.0.1/32
+ ```
-```SQL
- ALTER SYSTEM ADD BACKEND "be_host_ip:heartbeat_service_port";
-```
+2. Start FE
-Note:
+ Run the FE process by executing the start_fe.sh script:
-1. be_host_ip: the IP address of the BE node to be added
-2. heartbeat_service_port: the heartbeat reporting port of the BE node to be
added, which can be found in `be.conf`under `heartbeat_service_port`, set as
`9050` by default
-3. You can use the "show backends" statement to view the newly added BE nodes.
+ ```sql
+ apache-doris/fe/bin/start_fe.sh --daemon
+ ```
-### Modify passwords for root and admin
+3. Check FE Status
-Example SQLs to execute in the MySQL client to set new passwords for root and
admin users:
+ Connect to the cluster using MySQL client and check the cluster status:
-```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)
-```
+ ```sql
+ ## Check FE Status to ensure that both the Join and Alive columns are 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 |
+
+-----------------------------------------+-----------+-------------+----------+-----------+---------+----------+----------+-----------+------+-------+-------------------+---------------------+----------+--------+-------------------------+------------------+
+ ```
-:::tip
-Difference between root and admin users
+### Step 4: Install BE
-The root and admin users are two default accounts that are automatically
created after Doris installation. The root user has superuser privileges for
the entire cluster and can perform various management operations, such as
adding or removing nodes. The admin user does not have administrative
privileges but is a superuser within the cluster, possessing all permissions
except those related to cluster management. It is recommended to use the root
privileges only when necessary for cluster [...]
-:::
+1. Configure BE
-## Create database and table
+ Modify the following contents in the BE configuration file
`apache-doris/be/conf/be.conf`:
-### Connect to Apache Doris
+ ```sql
+ ## Specify Java environment
+ JAVA_HOME=/home/doris/jdk
-Use admin account to connect to Apache Doris FE.
+ ## Specify the CIDR block for BE's listening IP
+ priority_networks=127.0.0.1/32
+ ```
-```shell
-mysql -uadmin -P9030 -h127.0.0.1
-```
+2. Start BE
-:::tip
-If the MySQL client connecting to 127.0.0.1 is on the same machine as FE, no
password will be required.
-:::
+ Start the BE process with the following command:
-### Create database and table
-
-```SQL
-create database demo;
-
-use demo;
-create table mytable
-(
- k1 TINYINT,
- k2 DECIMAL(10, 2) DEFAULT "10.05",
- k3 CHAR(10) COMMENT "string column",
- k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
-)
-COMMENT "my first table"
-DISTRIBUTED BY HASH(k1) BUCKETS 1
-PROPERTIES ('replication_num' = '1');
-```
+ ```sql
+ apache-doris/fe/bin/start_be.sh --daemon
+ ```
-### Ingest data
+3. Register BE Node in the Cluster
-Save the following example data to the local "data.csv" file:
+ Connect to the cluster using MySQL client:
-```Plaintext
-1,0.14,a1,20
-2,1.04,b2,21
-3,3.14,c3,22
-4,4.35,d4,23
-```
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
-Load the data from "data.csv" into the newly created table using the Stream
Load method.
+ Use the ADD BACKEND command to register the BE node:
-```shell
-curl --location-trusted -u admin:admin_password -T data.csv -H
"column_separator:," http://127.0.0.1:8030/api/demo/mytable/_stream_load
-```
+ ```sql
+ ALTER SYSTEM ADD BACKEND "127.0.0.1:9050";
+ ```
-- -T data.csv: data file name
-- -u admin:admin_password: admin account and password
-- 127.0.0.1:8030: IP and http_port of FE
+4. Check BE Status
-Once it is executed successfully, a message like the following will be
returned:
+ Connect to the cluster using MySQL client and check the cluster status:
-```shell
-{
- "TxnId": 30,
- "Label": "a56d2861-303a-4b50-9907-238fea904363",
- "Comment": "",
- "TwoPhaseCommit": "false",
- "Status": "Success",
- "Message": "OK",
- "NumberTotalRows": 4,
- "NumberLoadedRows": 4,
- "NumberFilteredRows": 0,
- "NumberUnselectedRows": 0,
- "LoadBytes": 52,
- "LoadTimeMs": 206,
- "BeginTxnTimeMs": 13,
- "StreamLoadPutTimeMs": 141,
- "ReadDataTimeMs": 0,
- "WriteDataTimeMs": 7,
- "CommitAndPublishTimeMs": 42
-}
-```
+ ```sql
+ ## Check BE Status to ensure that the Alive column is true
+ mysql -uroot -P9030 -h127.0.0.1 -e "show backends;"
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | BackendId | Host | HeartbeatPort | BePort | HttpPort | BrpcPort |
LastStartTime | LastHeartbeat | Alive | SystemDecommissioned |
TabletNum | DataUsedCapacity | TrashUsedCapcacity | AvailCapacity |
TotalCapacity | UsedPct | MaxDiskUsedPct | RemoteUsedCapacity | Tag
| ErrMsg | Version | Status
| HeartbeatFailureCou [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | 10156 | 127.0.0.1 | 9050 | 9060 | 8040 | 8060 |
2024-07-28 17:59:14 | 2024-07-28 18:08:24 | true | false | 14
| 0.000 | 0.000 | 8.342 GB | 19.560 GB |
57.35 % | 57.35 % | 0.000 | {"location" : "default"} |
| doris-2.0.12-2971efd194 | {"lastSuccessReportTabletsTime":"2024-07-28
18:08:14","lastStreamLoadTime":-1,"isQueryDisabled":false,"isLoadDisabled":false}
| 0 [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ ```
-- `NumberLoadedRows`: the number of rows that have been loaded
-- `NumberTotalRows`: the total number of rows to be loaded
-- `Status`: "Success" means data has been loaded successfully.
-
-### Query data
-
-Execute the following SQL in the MySQL client to query the loaded data:
-
-```SQL
-mysql> select * from mytable;
-+------+------+------+------+
-| k1 | k2 | k3 | k4 |
-+------+------+------+------+
-| 1 | 0.14 | a1 | 20 |
-| 2 | 1.04 | b2 | 21 |
-| 3 | 3.14 | c3 | 22 |
-| 4 | 4.35 | d4 | 23 |
-+------+------+------+------+
-4 rows in set (0.01 sec)
-```
+## Run Queries
-## Stop Apache Doris
+1. Connect to the cluster using MySQL client:
-### Stop FE
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
+
+2. Create database and test table:
+
+ ```sql
+ create database demo;
+
+ use demo;
+ create table mytable
+ (
+ k1 TINYINT,
+ k2 DECIMAL(10, 2) DEFAULT "10.05",
+ k3 CHAR(10) COMMENT "string column",
+ k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
+ )
+ COMMENT "my first table"
+ DISTRIBUTED BY HASH(k1) BUCKETS 1;
+ ```
+
+3. Import test data:
+
+ Insert test data using the Insert Into statement
+
+ ```sql
+ insert into mytable values
+ (1,0.14,'a1',20),
+ (2,1.04,'b2',21),
+ (3,3.14,'c3',22),
+ (4,4.35,'d4',23);
+ ```
+
+4. Execute the following SQL query in the MySQL client to view the imported
data:
+
+ ```sql
+ MySQL [demo]> select * from demo.mytable;
+ +------+------+------+------+
+ | k1 | k2 | k3 | k4 |
+ +------+------+------+------+
+ | 1 | 0.14 | a1 | 20 |
+ | 2 | 1.04 | b2 | 21 |
+ | 3 | 3.14 | c3 | 22 |
+ | 4 | 4.35 | d4 | 23 |
+ +------+------+------+------+
+ 4 rows in set (0.10 sec)
+ ```
-Execute the following command under apache-doris/fe to stop FE.
-```shell
-server1:apache-doris/fe doris$ ./bin/stop_fe.sh
-```
-### Stop BE
-Execute the following command under apache-doris/be to stop BE.
-```shell
-server1:apache-doris/be doris$ ./bin/stop_be.sh
-```
diff --git a/versioned_docs/version-3.0/gettingStarted/quick-start.md
b/versioned_docs/version-3.0/gettingStarted/quick-start.md
index d932ba252b..80f40d7124 100644
--- a/versioned_docs/version-3.0/gettingStarted/quick-start.md
+++ b/versioned_docs/version-3.0/gettingStarted/quick-start.md
@@ -3,6 +3,7 @@
"title": "Quick Start",
"language": "en"
}
+
---
<!--
@@ -24,241 +25,257 @@ specific language governing permissions and limitations
under the License.
-->
-# Quick Start
+:::caution Warning:
+
+Quick deployment **is only suitable for local development**. Do not use this
deployment method in production environments:
-This guide is about how to download the latest stable version of Apache Doris,
install it on a single node, and get it running, including steps for creating a
database, data tables, importing data, and performing queries.
+1. When deploying quickly using Docker, data will be released when the Docker
instance is destroyed.
-## Environment requirements
+2. Deploying a single-instance Doris manually does not have data replication
capability, and a single machine failure may result in data loss.
-- A mainstream Linux x86-64 environment. CentOS 7.1 or Ubuntu 16.04 or later
versions are recommended. See the "Install and Deploy" section of the doc for
guides on more environments.
-- Install Java 8 runtime environment. (If you are not an Oracle JDK commercial
license user, we suggest using the free Oracle JDK 8u202. [Download
now](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox).)
-- It is recommended to create a new user for Apache Doris on Linux (avoid
using the root user to prevent accidental operations on the operating system).
+3. The tables created in this example are single-instance. In production,
please use multi-replica storage for data.
+:::
+
+## Use Docker for Quick Deployment
+
+### Step 1: Create the docker-compose.yaml File
+
+Copy the following content into the docker-compose.yaml file, and replace the
`DORIS_QUICK_START_VERSION` parameter with the specified version, such as
`3.0.1`.
+
+```text
+version: "3"
+services:
+ fe:
+ image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: fe
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - FE_ID=1
+ network_mode: host
+ be:
+ image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
+ hostname: be
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - BE_ADDR=127.0.0.1:9050
+ depends_on:
+ - fe
+ network_mode: host
+```
-## Download binary package
+### Step 2：Start Cluster
-Download the Apache Doris installation package from doris.apache.org and
proceed with the following steps.
+Start the cluster using the docker-compose command.
```shell
-# Download the binary installation package of Apache Doris
-server1:~ doris$ wget
https://apache-doris-releases.oss-accelerate.aliyuncs.com/apache-doris-2.0.3-bin-x64.tar.gz
+docker-compose -f ./docker-compose.yaml up -d
+```
-# Extract the installation package
-server1:~ doris$ tar zxf apache-doris-2.0.3-bin-x64.tar.gz
+### Step 3: Connect to the cluster using MySQL client and check the cluster
status
+
+```sql
+## Check the FE status to ensure that both the Join and Alive columns are true.
+mysql -uroot -P9030 -h127.0.0.1 -e 'SELECT `host`, `join`, `alive` FROM
frontends()'
++-----------+------+-------+
+| host | join | alive |
++-----------+------+-------+
+| 127.0.0.1 | true | true |
++-----------+------+-------+
+
+## Check the BE status to ensure that the Alive column is true.
+mysql -uroot -P9030 -h127.0.0.1 -e 'SELECT `host`, `alive` FROM backends()'
++-----------+-------+
+| host | alive |
++-----------+-------+
+| 127.0.0.1 | 1 |
++-----------+-------+
-# Rename the directory to apache-doris for simplicity
-server1:~ doris$ mv apache-doris-2.0.3-bin-x64 apache-doris
```
-## Install Apache Doris
-### Configure FE
-Go to the `apache-doris/fe/conf/fe.conf` file for FE configuration. Below are
some key configurations to pay attention to. Add JAVA_HOME manually and point
it to your JDK8 runtime environment. For other configurations, you can go with
the default values for a quick single-machine experience.
+## Local Quick Deployment
-```Shell
-# Add JAVA_HOME and point it to your JDK8 runtime environment. Suppose your
JDK8 is at /home/doris/jdk8, set it as follows:
-JAVA_HOME=/home/doris/jdk8
+:::info Environment Recommendations:
-# The CIDR network segment of FE listening IP is empty by default. When
started, Apache Doris will automatically select an available network segment.
If you need to specify a segment, you can set priority_networks=192.168.0.0/24,
for example.
-# priority_networks =
+* Choose a mainstream Linux environment on AMD/ARM, preferably CentOS 7.1 or
Ubuntu 16.04 and above. For more supported environments, refer to the
installation and deployment section.
-# By default, FE metadata is stored in the doris-meta directory under
DORIS_HOME. It is created already. You can change it to your specified path.
-# meta_dir = ${DORIS_HOME}/doris-meta
-```
+* Java 8 runtime environment (for non-Oracle JDK commercial license users, it
is recommended to use the free Oracle JDK 8u300 or later versions, [Download
Now](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html#license-lightbox)).
-### Start FE
+* It is recommended to create a new Doris user on Linux. Avoid using the root
user to prevent accidental system operation errors.
-Run the following command under apache-doris/fe to start FE.
+:::
-```shell
-# Start FE in the background to ensure that the process continues running even
after exiting the terminal.
-server1:apache-doris/fe doris$ ./bin/start_fe.sh --daemon
-```
+### Step 1: Download the Binary Package
-### Configure BE
+Download the corresponding binary installation package from the Apache Doris
website [here](https://doris.apache.org/en-us/download), and extract it.
-Go to the `apache-doris/be/conf/be.conf` file for BE configuration. Below are
some key configurations to pay attention to. Add JAVA_HOME manually and point
it to your JDK8 runtime environment. For other configurations, you can go with
the default values for a quick single-machine experience.
+### Step 2: Modify the Environment Variables
-```Shell
-# Add JAVA_HOME and point it to your JDK8 runtime environment. Suppose your
JDK8 is at /home/doris/jdk8, set it as follows:
-JAVA_HOME=/home/doris/jdk8
+1. Modify the system's maximum open file descriptor limit
-# The CIDR network segment of BE listening IP is empty by default. When
started, Doris will automatically select an available network segment. If you
need to specify a segment, you can set priority_networks=192.168.0.0/24, for
example.
-# priority_networks =
+ Use the following command to adjust the maximum file descriptor limit.
After making this change, you need to restart the session to apply the
configuration:
-# By default, BE data is stored in the storage directory under DORIS_HOME. It
is created already. You can change it to your specified path.
-# storage_root_path = ${DORIS_HOME}/storage
-```
-### Start BE
-Run the following command under apache-doris/be to start BE.
+ ```sql
+ vi /etc/security/limits.conf
+ * soft nofile 1000000
+ * hard nofile 1000000
+ ```
-```shell
-# Start BE in the background to ensure that the process continues running even
after exiting the terminal.
-server1:apache-doris/be doris$ ./bin/start_be.sh --daemon
-```
+2. Modify Virtual Memory Area
-### Connect to Doris FE
+ Use the following command to permanently modify the virtual memory area to
at least 2000000, and apply the change immediately:
-Download the [portable MySQL client](https://dev.mysql.com/downloads/mysql/)
to connect to Doris FE.
+ ```bash
+ cat >> /etc/sysctl.conf << EOF
+ vm.max_map_count = 2000000
+ EOF
-Unpack the client, find the `mysql` command-line tool in the `bin/` directory.
Then execute the following command to connect to Apache Doris.
+ Take effect immediately
+ sysctl -p
+ ```
-```shell
-mysql -uroot -P9030 -h127.0.0.1
-```
+### Step 3: Install FE
-Note:
+1. Configure FE
-- The root user here is the built-in super admin user of Apache Doris. See
[Authentication and
Authorization](../admin-manual/auth/authentication-and-authorization.md) for
more information.
-- -P: This specifies the query port that is connected to. The default port is
9030. It corresponds to the `query_port`setting in fe.conf.
-- -h: This specifies the IP address of the FE that is connected to. If your
client and FE are installed on the same node, you can use 127.0.0.1.
+ Modify the following contents in the FE configuration file
`apache-doris/fe/conf/fe.conf`:
-### Add BE nodes to cluster
+ ```sql
+ ## Specify Java environment
+ JAVA_HOME=/home/doris/jdk
-An example SQL to execute in the MySQL client to add BE nodes to the cluster:
+ ## Specify the CIDR block for FE listening IP
+ priority_networks=127.0.0.1/32
+ ```
-```SQL
- ALTER SYSTEM ADD BACKEND "be_host_ip:heartbeat_service_port";
-```
+2. Start FE
-Note:
+ Run the FE process by executing the start_fe.sh script:
-1. be_host_ip: the IP address of the BE node to be added
-2. heartbeat_service_port: the heartbeat reporting port of the BE node to be
added, which can be found in `be.conf`under `heartbeat_service_port`, set as
`9050` by default
-3. You can use the "show backends" statement to view the newly added BE nodes.
+ ```sql
+ apache-doris/fe/bin/start_fe.sh --daemon
+ ```
-### Modify passwords for root and admin
+3. Check FE Status
-Example SQLs to execute in the MySQL client to set new passwords for root and
admin users:
+ Connect to the cluster using MySQL client and check the cluster status:
-```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)
-```
+ ```sql
+ ## Check FE Status to ensure that both the Join and Alive columns are 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 |
+
+-----------------------------------------+-----------+-------------+----------+-----------+---------+----------+----------+-----------+------+-------+-------------------+---------------------+----------+--------+-------------------------+------------------+
+ ```
-:::tip
-Difference between root and admin users
+### Step 4: Install BE
-The root and admin users are two default accounts that are automatically
created after Doris installation. The root user has superuser privileges for
the entire cluster and can perform various management operations, such as
adding or removing nodes. The admin user does not have administrative
privileges but is a superuser within the cluster, possessing all permissions
except those related to cluster management. It is recommended to use the root
privileges only when necessary for cluster [...]
-:::
+1. Configure BE
-## Create database and table
+ Modify the following contents in the BE configuration file
`apache-doris/be/conf/be.conf`:
-### Connect to Apache Doris
+ ```sql
+ ## Specify Java environment
+ JAVA_HOME=/home/doris/jdk
-Use admin account to connect to Apache Doris FE.
+ ## Specify the CIDR block for BE's listening IP
+ priority_networks=127.0.0.1/32
+ ```
-```shell
-mysql -uadmin -P9030 -h127.0.0.1
-```
+2. Start BE
-:::tip
-If the MySQL client connecting to 127.0.0.1 is on the same machine as FE, no
password will be required.
-:::
+ Start the BE process with the following command:
-### Create database and table
-
-```SQL
-create database demo;
-
-use demo;
-create table mytable
-(
- k1 TINYINT,
- k2 DECIMAL(10, 2) DEFAULT "10.05",
- k3 CHAR(10) COMMENT "string column",
- k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
-)
-COMMENT "my first table"
-DISTRIBUTED BY HASH(k1) BUCKETS 1
-PROPERTIES ('replication_num' = '1');
-```
+ ```sql
+ apache-doris/fe/bin/start_be.sh --daemon
+ ```
-### Ingest data
+3. Register BE Node in the Cluster
-Save the following example data to the local "data.csv" file:
+ Connect to the cluster using MySQL client:
-```Plaintext
-1,0.14,a1,20
-2,1.04,b2,21
-3,3.14,c3,22
-4,4.35,d4,23
-```
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
-Load the data from "data.csv" into the newly created table using the Stream
Load method.
+ Use the ADD BACKEND command to register the BE node:
-```shell
-curl --location-trusted -u admin:admin_password -T data.csv -H
"column_separator:," http://127.0.0.1:8030/api/demo/mytable/_stream_load
-```
+ ```sql
+ ALTER SYSTEM ADD BACKEND "127.0.0.1:9050";
+ ```
-- -T data.csv: data file name
-- -u admin:admin_password: admin account and password
-- 127.0.0.1:8030: IP and http_port of FE
+4. Check BE Status
-Once it is executed successfully, a message like the following will be
returned:
+ Connect to the cluster using MySQL client and check the cluster status:
-```shell
-{
- "TxnId": 30,
- "Label": "a56d2861-303a-4b50-9907-238fea904363",
- "Comment": "",
- "TwoPhaseCommit": "false",
- "Status": "Success",
- "Message": "OK",
- "NumberTotalRows": 4,
- "NumberLoadedRows": 4,
- "NumberFilteredRows": 0,
- "NumberUnselectedRows": 0,
- "LoadBytes": 52,
- "LoadTimeMs": 206,
- "BeginTxnTimeMs": 13,
- "StreamLoadPutTimeMs": 141,
- "ReadDataTimeMs": 0,
- "WriteDataTimeMs": 7,
- "CommitAndPublishTimeMs": 42
-}
-```
+ ```sql
+ ## Check BE Status to ensure that the Alive column is true
+ mysql -uroot -P9030 -h127.0.0.1 -e "show backends;"
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | BackendId | Host | HeartbeatPort | BePort | HttpPort | BrpcPort |
LastStartTime | LastHeartbeat | Alive | SystemDecommissioned |
TabletNum | DataUsedCapacity | TrashUsedCapcacity | AvailCapacity |
TotalCapacity | UsedPct | MaxDiskUsedPct | RemoteUsedCapacity | Tag
| ErrMsg | Version | Status
| HeartbeatFailureCou [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ | 10156 | 127.0.0.1 | 9050 | 9060 | 8040 | 8060 |
2024-07-28 17:59:14 | 2024-07-28 18:08:24 | true | false | 14
| 0.000 | 0.000 | 8.342 GB | 19.560 GB |
57.35 % | 57.35 % | 0.000 | {"location" : "default"} |
| doris-2.0.12-2971efd194 | {"lastSuccessReportTabletsTime":"2024-07-28
18:08:14","lastStreamLoadTime":-1,"isQueryDisabled":false,"isLoadDisabled":false}
| 0 [...]
+
+-----------+-----------+---------------+--------+----------+----------+---------------------+---------------------+-------+----------------------+-----------+------------------+--------------------+---------------+---------------+---------+----------------+--------------------+--------------------------+--------+-------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------
[...]
+ ```
-- `NumberLoadedRows`: the number of rows that have been loaded
-- `NumberTotalRows`: the total number of rows to be loaded
-- `Status`: "Success" means data has been loaded successfully.
-
-### Query data
-
-Execute the following SQL in the MySQL client to query the loaded data:
-
-```SQL
-mysql> select * from mytable;
-+------+------+------+------+
-| k1 | k2 | k3 | k4 |
-+------+------+------+------+
-| 1 | 0.14 | a1 | 20 |
-| 2 | 1.04 | b2 | 21 |
-| 3 | 3.14 | c3 | 22 |
-| 4 | 4.35 | d4 | 23 |
-+------+------+------+------+
-4 rows in set (0.01 sec)
-```
+## Run Queries
-## Stop Apache Doris
+1. Connect to the cluster using MySQL client:
-### Stop FE
+ ```sql
+ mysql -uroot -P9030 -h127.0.0.1
+ ```
+
+2. Create database and test table:
+
+ ```sql
+ create database demo;
+
+ use demo;
+ create table mytable
+ (
+ k1 TINYINT,
+ k2 DECIMAL(10, 2) DEFAULT "10.05",
+ k3 CHAR(10) COMMENT "string column",
+ k4 INT NOT NULL DEFAULT "1" COMMENT "int column"
+ )
+ COMMENT "my first table"
+ DISTRIBUTED BY HASH(k1) BUCKETS 1;
+ ```
+
+3. Import test data:
+
+ Insert test data using the Insert Into statement
+
+ ```sql
+ insert into mytable values
+ (1,0.14,'a1',20),
+ (2,1.04,'b2',21),
+ (3,3.14,'c3',22),
+ (4,4.35,'d4',23);
+ ```
+
+4. Execute the following SQL query in the MySQL client to view the imported
data:
+
+ ```sql
+ MySQL [demo]> select * from demo.mytable;
+ +------+------+------+------+
+ | k1 | k2 | k3 | k4 |
+ +------+------+------+------+
+ | 1 | 0.14 | a1 | 20 |
+ | 2 | 1.04 | b2 | 21 |
+ | 3 | 3.14 | c3 | 22 |
+ | 4 | 4.35 | d4 | 23 |
+ +------+------+------+------+
+ 4 rows in set (0.10 sec)
+ ```
-Execute the following command under apache-doris/fe to stop FE.
-```shell
-server1:apache-doris/fe doris$ ./bin/stop_fe.sh
-```
-### Stop BE
-Execute the following command under apache-doris/be to stop BE.
-```shell
-server1:apache-doris/be doris$ ./bin/stop_be.sh
-```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
