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

Jump to bottom

op-guide: update ansible deployment steps and wording #483

Merged
merged 3 commits into from
Jun 11, 2018
Merged

op-guide: update ansible deployment steps and wording #483

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fbc676
op-guide: update ansible deployment steps and wording
lilin90 Jun 4, 2018
d219f6d
op-guide: add description under a headline
lilin90 Jun 5, 2018
5b8cbac
Merge branch 'master' into ansible-tidb-improve
lilin90 Jun 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 22 additions & 20 deletions op-guide/ansible-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Ansible Deployment
title: Deploy TiDB Using Ansible
category: operations
---

# Ansible Deployment
# Deploy TiDB Using Ansible

## Overview

Expand All @@ -20,7 +20,6 @@ You can use the TiDB-Ansible configuration file to set up the cluster topology,
- Cleaning environment
- Configuring monitoring modules


## Prepare

Before you start, make sure that you have:
Expand Down Expand Up @@ -56,12 +55,6 @@ Before you start, make sure that you have:

Login to the Control Machine using the `tidb` user account and enter the `/home/tidb` directory. Use the following command to download the corresponding version of TiDB-Ansible from GitHub [TiDB-Ansible project](https://github.com/pingcap/tidb-ansible). The default folder name is `tidb-ansible`. The following are examples of downloading various versions, and you can turn to the official team for advice on which version to choose.

Download the 1.0 GA version:

```
git clone -b release-1.0 https://github.com/pingcap/tidb-ansible.git
```

Download the 2.0 version:

```
Expand Down Expand Up @@ -105,7 +98,7 @@ The standard cluster has 6 machines:
- 3 PD nodes
- 3 TiKV nodes

### The cluster topology of single TiKV instance on a single machine
### The cluster topology of a single TiKV instance on each TiKV node

| Name | Host IP | Services |
|:------|:------------|:-----------|
Expand Down Expand Up @@ -146,8 +139,7 @@ The standard cluster has 6 machines:
172.16.10.6
```


### The cluster topology of multiple TiKV instances on a single machine
### The cluster topology of multiple TiKV instances on each TiKV node

Take two TiKV instances as an example:

Expand All @@ -173,13 +165,10 @@ Take two TiKV instances as an example:
[tikv_servers]
TiKV1-1 ansible_host=172.16.10.4 deploy_dir=/data1/deploy tikv_port=20171 labels="host=tikv1"
TiKV1-2 ansible_host=172.16.10.4 deploy_dir=/data2/deploy tikv_port=20172 labels="host=tikv1"
TiKV1-3 ansible_host=172.16.10.4 deploy_dir=/data3/deploy tikv_port=20173 labels="host=tikv1"
TiKV2-1 ansible_host=172.16.10.5 deploy_dir=/data1/deploy tikv_port=20171 labels="host=tikv2"
TiKV2-2 ansible_host=172.16.10.5 deploy_dir=/data2/deploy tikv_port=20172 labels="host=tikv2"
TiKV2-3 ansible_host=172.16.10.5 deploy_dir=/data3/deploy tikv_port=20173 labels="host=tikv2"
TiKV3-1 ansible_host=172.16.10.6 deploy_dir=/data1/deploy tikv_port=20171 labels="host=tikv3"
TiKV3-2 ansible_host=172.16.10.6 deploy_dir=/data2/deploy tikv_port=20172 labels="host=tikv3"
TiKV3-3 ansible_host=172.16.10.6 deploy_dir=/data3/deploy tikv_port=20173 labels="host=tikv3"

[monitoring_servers]
172.16.10.1
Expand All @@ -203,21 +192,34 @@ location_labels = ["host"]

**Edit the parameters in the service configuration file:**

1. For multiple TiKV instances, edit the `end-point-concurrency` and `block-cache-size` parameters in `tidb-ansible/conf/tikv.yml`:
1. For the cluster topology of multiple TiKV instances on each TiKV node, you need to edit the `block-cache-size` parameter in `tidb-ansible/conf/tikv.yml`:

- `end-point-concurrency`: keep the number lower than CPU Vcores
- `rocksdb defaultcf block-cache-size(GB)`: MEM * 80% / TiKV instance number * 30%
- `rocksdb writecf block-cache-size(GB)`: MEM * 80% / TiKV instance number * 45%
- `rocksdb lockcf block-cache-size(GB)`: MEM * 80% / TiKV instance number * 2.5% (128 MB at a minimum)
- `raftdb defaultcf block-cache-size(GB)`: MEM * 80% / TiKV instance number * 2.5% (128 MB at a minimum)

2. If multiple TiKV instances are deployed on a same physical disk, edit the `capacity` parameter in `conf/tikv.yml`:
2. For the cluster topology of multiple TiKV instances on each TiKV node, you need to edit the `high-concurrency`, `normal-concurrency` and `low-concurrency` parameters in the `tidb-ansible/conf/tikv.yml` file:

```
readpool:
coprocessor:
# Notice: if CPU_NUM > 8, default thread pool size for coprocessors
# will be set to CPU_NUM * 0.8.
# high-concurrency: 8
# normal-concurrency: 8
# low-concurrency: 8
```

Recommended configuration: `number of instances * parameter value = CPU_Vcores * 0.8`.

3. If multiple TiKV instances are deployed on a same physical disk, edit the `capacity` parameter in `conf/tikv.yml`:

- `capacity`: (DISK - log space) / TiKV instance number (the unit is GB)

### Description of inventory.ini variables
### Edit variables in the `inventory.ini` file
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This headline has no content, why does it exist?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Hoverbear This is resolved.


#### Description of the deployment directory
#### Edit the deployment directory

You can configure the deployment directory using the `deploy_dir` variable. The global variable is set to `/home/tidb/deploy` by default, and it applies to all services. If the data disk is mounted on the `/data1` directory, you can set it to `/data1/deploy`. For example:

Expand Down
4 changes: 2 additions & 2 deletions op-guide/offline-ansible-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Offline Deployment Using Ansible
title: Deploy TiDB Offline Using Ansible
category: operations
---

# Offline Deployment Using Ansible
# Deploy TiDB Offline Using Ansible

## Prepare

Expand Down