Skip to content

Commit

Permalink
change quick start
Browse files Browse the repository at this point in the history
  • Loading branch information
FreeOnePlus committed Jan 7, 2025
1 parent ef8f2ec commit fe8bfb5
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 51 deletions.
8 changes: 3 additions & 5 deletions docs/gettingStarted/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,15 @@ Quick deployment **is only suitable for local development**. Do not use this dep
2. Deploying a single-instance Doris manually does not have data replication capability, and a single machine failure may result in data loss.

3. The tables created in this example are single-instance. In production, please use multi-replica storage for data.

4. The quick deployment of Docker without setting environment variables is only applicable to versions `2.1.8`, `3.0.4`, and later versions.
:::

## Use Docker for Quick Deployment

### Step 1: Create the docker-compose.yaml File
### Step 1: Create the docker-compose.yaml

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.4`.

```text
```yaml
version: "3"
services:
fe:
Expand Down Expand Up @@ -73,7 +71,7 @@ Start the cluster using the docker-compose command.
docker-compose -f ./docker-compose.yaml up -d
```

### Step 3: Connect to the cluster using MySQL client and check the cluster status
### Step 3: Check the cluster status

```sql
## Check the FE status to ensure that both the Join and Alive columns are true.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,15 @@ under the License.
2. 通过手动部署单副本 Doris 实例,不具有数据多副本存储能力,单台机器宕机可能会造成数据丢失。

3. 本示例中的建表均为单副本,在生产中请使用多副本存储数据。

4. 不设置环境变量的 Docker 快速部署仅适用于 `2.1.8``3.0.4` 及后续版本。
:::

## 使用 Docker 快速部署

### 第 1 步:创建 docker-compose.yaml 文件
### 第 1 步:创建 docker-compose.yaml

复制以下内容到 docker-compose.yaml,替换 DORIS_QUICK_START_VERSION 参数为指定版本,如 `3.0.4`

```text
```yaml
version: "3"
services:
fe:
Expand Down Expand Up @@ -73,7 +71,7 @@ services:
docker-compose -f ./docker-compose.yaml up -d
```

### 第 3 步:使用 MySQL 客户端连接集群,并检查集群状态
### 第 3 步:检查集群状态

```sql
## 检查 FE 状态,确定 Join 与 Alive 列都为 true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,19 @@ under the License.

### 第 1 步:调整宿主机环境变量

复制以下内容,在宿主机上顺次执行,调整以下三处环境变量值,以满足进程运行最低需要。
通过以下命令,调整宿主机的环境变量:

```text
```bash
ulimit -n 65536
swapoff -a
sysctl -w vm.max_map_count=2000000
```

### 第 2 步:创建 docker-compose.yaml 文件
### 第 2 步:创建 docker-compose.yaml

复制以下内容到 docker-compose.yaml,替换 DORIS_QUICK_START_VERSION 参数为指定版本,如 `2.1.7`

```text
```yaml
version: "3"
services:
fe:
Expand Down Expand Up @@ -81,7 +81,7 @@ services:
docker-compose -f ./docker-compose.yaml up -d
```

### 第 4 步:使用 MySQL 客户端连接集群,并检查集群状态
### 第 4 步:检查集群状态

```sql
## 检查 FE 状态,确定 Join 与 Alive 列都为 true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,11 @@ under the License.

## 使用 Docker 快速部署

### 第 1 步:调整宿主机环境变量
### 第 1 步:创建 docker-compose.yaml

复制以下内容,在宿主机上顺次执行,调整以下三处环境变量值,以满足进程运行最低需要
复制以下内容到 docker-compose.yaml,替换 DORIS_QUICK_START_VERSION 参数为指定版本,如 `3.0.4`

```text
ulimit -n 65536
swapoff -a
sysctl -w vm.max_map_count=2000000
```

### 第 2 步:创建 docker-compose.yaml 文件

复制以下内容到 docker-compose.yaml,替换 DORIS_QUICK_START_VERSION 参数为指定版本,如 `3.0.3`

```text
```yaml
version: "3"
services:
fe:
Expand All @@ -73,15 +63,15 @@ services:
network_mode: host
```
### 3 步:启动集群
### 第 2 步:启动集群
使用 docker-compose 命令启动集群
```shell
docker-compose -f ./docker-compose.yaml up -d
```

### 4 步:使用 MySQL 客户端连接集群,并检查集群状态
### 3 步:检查集群状态

```sql
## 检查 FE 状态,确定 Join 与 Alive 列都为 true
Expand Down
12 changes: 6 additions & 6 deletions versioned_docs/version-2.1/gettingStarted/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,21 @@ Quick deployment **is only suitable for local development**. Do not use this dep

## Use Docker for Quick Deployment

### Step 1: Adjust the Host Machine Environment Variables
### Step 1: Set the Host Machine Environment Variables

Copy the following commands and execute them sequentially on the host machine to adjust the values of the three environment variables to meet the minimum requirements for process operation.
Set the environment variables of the host machine using the following command:

```text
```bash
ulimit -n 65536
swapoff -a
sysctl -w vm.max_map_count=2000000
```

### Step 2: Create the docker-compose.yaml File
### Step 2: Create the docker-compose.yaml

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
```yaml
version: "3"
services:
fe:
Expand Down Expand Up @@ -81,7 +81,7 @@ Start the cluster using the docker-compose command.
docker-compose -f ./docker-compose.yaml up -d
```

### Step 4: Connect to the cluster using MySQL client and check the cluster status
### Step 4: Check the cluster status

```sql
## Check the FE status to ensure that both the Join and Alive columns are true.
Expand Down
20 changes: 5 additions & 15 deletions versioned_docs/version-3.0/gettingStarted/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,11 @@ Quick deployment **is only suitable for local development**. Do not use this dep

## Use Docker for Quick Deployment

### Step 1: Adjust the Host Machine Environment Variables
### Step 1: Create the docker-compose.yaml

Copy the following commands and execute them sequentially on the host machine to adjust the values of the three environment variables to meet the minimum requirements for process operation.
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.4`.

```text
ulimit -n 65536
swapoff -a
sysctl -w vm.max_map_count=2000000
```

### Step 2: 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.3`.

```text
```yaml
version: "3"
services:
fe:
Expand All @@ -73,15 +63,15 @@ services:
network_mode: host
```
### Step 3:Start Cluster
### Step 2:Start Cluster
Start the cluster using the docker-compose command.
```shell
docker-compose -f ./docker-compose.yaml up -d
```

### Step 4: Connect to the cluster using MySQL client and check the cluster status
### Step 3: Check the cluster status

```sql
## Check the FE status to ensure that both the Join and Alive columns are true.
Expand Down

0 comments on commit fe8bfb5

Please sign in to comment.