Skip to content

tiflash: add more explanation for multi disk deployment (#2467) #2471

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

Merged
merged 3 commits into from
May 9, 2020
Merged

tiflash: add more explanation for multi disk deployment (#2467) #2471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0d2c52
cherry pick #2467 to release-3.1
toutdesuite May 6, 2020
961bb0e
resolve conflict and add links
toutdesuite May 8, 2020
260dd47
Merge branch 'release-3.1' into release-3.1-58b321097256
sre-bot May 9, 2020
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
10 changes: 9 additions & 1 deletion reference/tiflash/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This section introduces the configuration parameters of TiFlash.

```
tmp_path = The path in which the TiFlash temporary files are stored.
path = The TiFlash data storage path. # If there are multiple directories, separate each directory with a comma. For example, `/ssd_a/data/tiflash,/hdd_b/data/tiflash,/hdd_c/data/tiflash`. If your environment has multiple disks, it is recommended that each path corresponds to one disk and you put disks with best performance at the front to fully use performance of all disks.
path = The TiFlash data storage path. # If there are multiple directories, separate each directory with a comma.
path_realtime_mode = false # The default value is `false`. If you set it to `true` and multiple directories are deployed in the path, the latest data is stored in the first directory and older data is stored in the rest directories.
listen_host = The TiFlash service listening host. # Generally, it is configured as `0.0.0.0`.
tcp_port = The TiFlash TCP service port.
Expand Down Expand Up @@ -78,3 +78,11 @@ Multiple TiFlash nodes elect a master to add or delete placement rules to PD, an
engine-addr = The listening address of the TiFlash coprocessor service.
status-addr = The port and IP through which Prometheus pulls proxy metrics information.
```

### Multi-disk deployment

TiFlash supports multi-disk deployment, controlled by the `path` and `path_realtime_mode` parameters in the [`tiflash.toml` file](#configure-the-tiflashtoml-file).

If there are multiple data storage directories in `path`, separate each with a comma. For example, `/ssd_a/data/tiflash,/hdd_b/data/tiflash,/hdd_c/data/tiflash`. If there are multiple disks in your environment, it is recommended that each directory corresponds to one disk and you put disks with the best performance at the front to maximize the performance of all disks.

The default value of the `path_realtime_mode` parameter is `false`, which means that data are evenly distributed on all storage directories. If the parameter is set to `true`, and `path` contains multiple directories, it means that the first directory only stores the latest data, and the older data are evenly distributed on other directories.
6 changes: 3 additions & 3 deletions reference/tiflash/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ It is recommended to use an SSD disk to buffer the real-time data being replicat

For other hard disks, you can use multiple HDDs or regular SSDs. A better hard disk will surely bring better performance.

TiFlash supports multi-directory storage, so there is no need to use RAID.
TiFlash supports [multi-disk deployment](/reference/tiflash/configuration.md#multi-disk-deployment), so there is no need to use RAID.

### TiFlash and TiKV are deployed on the same node

Expand Down Expand Up @@ -77,7 +77,7 @@ For fresh TiFlash deployment, it is recommended to deploy TiFlash by downloading

3. Edit the `inventory.ini` configuration file. In addition to [configuring for TiDB cluster deployment](/how-to/deploy/orchestrated/ansible.md#step-9-edit-the-inventoryini-file-to-orchestrate-the-tidb-cluster), you also need to specify the IPs of your TiFlash servers under the `[tiflash_servers]` section (currently only IPs are supported; domain names are not supported).

If you want to customize the deployment directory, configure the `data_dir` parameter. If you want multi-disk deployment, separate the deployment directories with commas (note that the parent directory of each `data_dir` directory needs to give the `tidb` user write permissions). For example:
If you want to customize the deployment directory, configure the `data_dir` parameter. If you want [multi-disk deployment](/reference/tiflash/configuration.md#multi-disk-deployment), separate the deployment directories with commas (note that the parent directory of each `data_dir` directory needs to give the `tidb` user write permissions). For example:

{{< copyable "" >}}

Expand All @@ -101,7 +101,7 @@ For fresh TiFlash deployment, it is recommended to deploy TiFlash by downloading

3. Edit the `inventory.ini` configuration file. You need to specify the IPs of your TiFlash servers under the `[tiflash_servers]` section (currently only IPs are supported; domain names are not supported).

If you want to customize the deployment directory, configure the `data_dir` parameter. If you want multi-disk deployment, separate the deployment directories with commas (note that the parent directory of each `data_dir` directory needs to give the `tidb` user write permissions). For example:
If you want to customize the deployment directory, configure the `data_dir` parameter. If you want [multi-disk deployment](/reference/tiflash/configuration.md#multi-disk-deployment) separate the deployment directories with commas (note that the parent directory of each `data_dir` directory needs to give the `tidb` user write permissions). For example:

{{< copyable "" >}}

Expand Down