Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] update post-deploy doc (backport #55630) #55638

Merged
merged 1 commit into from
Feb 9, 2025
Merged

[Doc] update post-deploy doc (backport #55630) #55638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 29 additions & 21 deletions docs/en/deployment/post_deployment_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,51 +30,59 @@ StarRocks automatically assigns an empty password to the `root` user when the cl
SET PASSWORD = PASSWORD('<password>')
```

> **NOTE**
>
> - Keep the password properly after resetting it. If you forgot the password, see [Reset lost root password](../administration/user_privs/User_privilege.md#reset-lost-root-password) for detailed instructions.
> - After completing the post-deployment setup, you can create new users and roles to manage the privileges within your team. See [Manage user privileges](../administration/user_privs/User_privilege.md) for detailed instructions.
:::note
- Keep the password properly after resetting it. If you forgot the password, see [Reset lost root password](../administration/user_privs/User_privilege.md#reset-lost-root-password) for detailed instructions.
- After completing the post-deployment setup, you can create new users and roles to manage the privileges within your team. See [Manage user privileges](../administration/user_privs/User_privilege.md) for detailed instructions.
:::

## Set necessary system variables

To allow your StarRocks cluster to work properly in production, you need to set the following system variables:

| **Variable name** | **StarRocks Version** | **Recommended value** | **Description** |
| ----------------------------------- | --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| is_report_success | v2.4 or earlier | false | The boolean switch that controls whether to send the profile of a query for analysis. The default value is `false`, which means no profile is required. Setting this variable to `true` can affect the concurrency of StarRocks. |
| enable_profile | v2.5 or later | false | The boolean switch that controls whether to send the profile of a query for analysis. The default value is `false`, which means no profile is required. Setting this variable to `true` can affect the concurrency of StarRocks. |
| enable_pipeline_engine | v2.3 or later | true | The boolean switch that controls whether to enable the pipeline execution engine. `true` indicates enabled and `false` indicates the opposite. Default value: `true`. |
| parallel_fragment_exec_instance_num | v2.3 or later | If you have enabled the pipeline engine, you can set this variable to `1`.If you have not enabled the pipeline engine, you should set it to half the number of CPU cores. | The number of instances used to scan nodes on each BE. The default value is `1`. |
| pipeline_dop | v2.3, v2.4, and v2.5 | 0 | The parallelism of a pipeline instance, which is used to adjust the query concurrency. Default value: `0`, indicating the system automatically adjusts the parallelism of each pipeline instance.<br />From v3.0 onwards, StarRocks adaptively adjusts this parameter based on query parallelism. |
### enable_profile

- Set `is_report_success` to `false` globally:
#### Description
The boolean switch that controls whether to send the profile of a query for analysis.
The default value is `false`, which means no profile is required.
Setting this variable to `true` can affect the concurrency of StarRocks.

```SQL
SET GLOBAL is_report_success = false;
```
#### Recommended value
false

- Set `enable_profile` to `false` globally:

```SQL
SET GLOBAL enable_profile = false;
```

### enable_pipeline_engine

#### Description
The boolean switch that controls whether to enable the pipeline execution engine.
`true` indicates enabled and `false` indicates the opposite. Default value: `true`.

#### Recommended value
true

- Set `enable_pipeline_engine` to `true` globally:

```SQL
SET GLOBAL enable_pipeline_engine = true;
```

- Set `parallel_fragment_exec_instance_num` to `1` globally:
### parallel_fragment_exec_instance_num

```SQL
SET GLOBAL parallel_fragment_exec_instance_num = 1;
```
#### Description
The number of instances used to scan nodes on each BE. The default value is `1`.

- Set `pipeline_dop` to `0` globally:
#### Recommended value
If you have enabled the pipeline engine, you can set this variable to `1`.
If you have not enabled the pipeline engine, you should set it to half the number of CPU cores.

- Set `parallel_fragment_exec_instance_num` to `1` globally:

```SQL
SET GLOBAL pipeline_dop = 0;
SET GLOBAL parallel_fragment_exec_instance_num = 1;
```

For more information about system variables, see [System variables](../sql-reference/System_variable.md).
Expand Down
34 changes: 16 additions & 18 deletions docs/zh/deployment/post_deployment_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,42 +36,40 @@ displayed_sidebar: docs

为使您的 StarRocks 集群在生产环境中正常工作，您需要设置以下系统变量：

| **变量名** | **StarRocks 版本** | **推荐值** | **说明** |
| ----------------------------------- | ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| is_report_success | v2.4 或更早 | false | 是否发送查询 Profile 以供分析。默认值为 `false`，即不发送。将此变量设置为 `true` 会影响 StarRocks 的并发性能。 |
| enable_profile | v2.5 或以后 | false | 是否发送查询 Profile 以供分析。默认值为 `false`，即不发送。将此变量设置为 `true` 会影响 StarRocks 的并发性能。 |
| enable_pipeline_engine | v2.3 或以后 | true | 是否启用 Pipeline Engine。`true` 表示启用，`false` 表示禁用。默认值为 `true`. |
| parallel_fragment_exec_instance_num | v2.3 或以后 | 如果您启用了 Pipeline Engine，您可以将此变量设置为`1`。如果您未启用 Pipeline Engine，您可以将此变量设置为 CPU 核数的一半。 | 每个 BE 上用于扫描节点的实例数。默认值为 `1`。 |
| pipeline_dop | v2.3、v2.4 及 v2.5 | 0 | Pipeline 实例的并行度，用于调整查询并发度。默认值：0，表示系统自动调整每个 Pipeline 实例的并行度。<br />自 v3.0 起，StarRocks 根据查询并行度自适应调整该参数。 |
### enable_profile

- 全局设置 `is_report_success` 为 `false`：

```SQL
SET GLOBAL is_report_success = false;
```
**StarRocks Version**: v2.5 或以后 <br/>
**推荐值**: false <br/>
**推荐值**: 是否发送查询 Profile 以供分析。默认值为 `false`，即不发送。将此变量设置为 `true` 会影响 StarRocks 的并发性能。

- 全局设置 `enable_profile` 为 `false`：

```SQL
SET GLOBAL enable_profile = false;
```

### enable_pipeline_engine

**StarRocks Version**: v2.3 或以后 <br/>
**推荐值**: true <br/>
**推荐值**: 是否启用 Pipeline Engine。`true` 表示启用，`false` 表示禁用。默认值为 `true`.

- 全局设置 `enable_pipeline_engine` 为 `true`：

```SQL
SET GLOBAL enable_pipeline_engine = true;
```

- 全局设置 `parallel_fragment_exec_instance_num` 为 `1`：
### parallel_fragment_exec_instance_num

```SQL
SET GLOBAL parallel_fragment_exec_instance_num = 1;
```
**StarRocks Version**: v2.3 或以后 <br/>
**推荐值**: 如果您启用了 Pipeline Engine，您可以将此变量设置为`1`。如果您未启用 Pipeline Engine，您可以将此变量设置为 CPU 核数的一半。 <br/>
**推荐值**: 每个 BE 上用于扫描节点的实例数。默认值为 `1`。

- 全局设置 `pipeline_dop` 为 `0`：
- 全局设置 `parallel_fragment_exec_instance_num` 为 `1`：

```SQL
SET GLOBAL pipeline_dop = 0;
SET GLOBAL parallel_fragment_exec_instance_num = 1;
```

有关系统变量的更多信息，请参阅 [系统变量](../sql-reference/System_variable.md)。
Expand Down
Loading