Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ TiDB ("Ti" stands for Titanium) is an open-source NewSQL database that supports

TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP:

- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB using TiDB Ansible. It is strongly recommended for production deployment.
- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md): This guide describes how to deploy a TiDB cluster using [TiUP](https://github.com/pingcap-incubator/tiup). It is strongly recommended for production deployment.
- [Ansible Offline Deployment](/how-to/deploy/orchestrated/offline-ansible.md): If your environment has no access to the internet, you can follow this guide to see how to deploy a TiDB cluster offline using TiDB Ansible.
- [Docker Deployment](/how-to/deploy/orchestrated/docker.md): This guide describes how to deploy TiDB using Docker.
- [Docker Compose Deployment](/how-to/get-started/deploy-tidb-from-docker-compose.md): This guide describes how to deploy TiDB using Docker compose. You can follow this guide to quickly deploy a TiDB cluster for testing and development on your local drive.
- Kubernetes Deployment:

You can use [TiDB Operator](https://github.com/pingcap/tidb-operator) to deploy TiDB on:
You can use [TiDB Operator](https://github.com/pingcap/tidb-operator) to deploy TiDB for production environments on:

- [AWS EKS (Elastic Kubernetes Service)](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-on-aws-eks/)
- [GKE (Google Kubernetes Engine)](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-on-gcp-gke/)
Expand Down
4 changes: 2 additions & 2 deletions faq/tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,9 @@ For details, see [Software and Hardware Recommendations](/how-to/deploy/hardware

### Install and deploy

#### Deploy TiDB using TiDB Ansible (recommended)
#### Deploy TiDB for production (recommended)

See [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md).
See [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md).

##### Why the modified `toml` configuration for TiKV/PD does not take effect?

Expand Down
4 changes: 4 additions & 0 deletions how-to/deploy/orchestrated/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ You can use the TiDB Ansible configuration file to set up the cluster topology a
- [Clean up data of the TiDB cluster](/how-to/deploy/orchestrated/ansible-operations.md#clean-up-cluster-data)
- [Destroy the TiDB cluster](/how-to/deploy/orchestrated/ansible-operations.md#destroy-a-cluster)

> **Note:**
>
> For production environments, it is recommended that you deploy TiDB [using TiUP](/how-to/deploy/orchestrated/tiup.md). You can also deploy TiDB using TiDB Ansible. If you only want to try TiDB out and explore the features, it is recommended to [deploy TiDB using Docker Compose](/how-to/get-started/deploy-tidb-from-docker-compose.md) on a single machine.

## Prepare

Before you start, make sure you have:
Expand Down
2 changes: 1 addition & 1 deletion how-to/deploy/orchestrated/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To learn more, see [TiDB architecture](/architecture.md) and [Software and Hardw

> **Warning:**
>
> This is for testing only. DO NOT USE in production! Please deploy TiDB with [our Ansible solution](/how-to/deploy/orchestrated/ansible.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production.
> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/how-to/deploy/orchestrated/tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production.

## Preparation

Expand Down
6 changes: 3 additions & 3 deletions how-to/deploy/orchestrated/tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ You need to fill in the result in the configuration file (as described in the St
- Configuration optimization for TiKV

- Make `readpool` thread pool self-adaptive. Configure the `readpool.unified.max-thread-count` parameter to make `readpool.storage` and `readpool.coprocessor` share a unified thread pool, and also enable self-adaptive switches for them. The calculation formula is as follows:

```
readpool.unified.max-thread-count = cores * 0.8 / the number of TiKV instances
```
Expand All @@ -465,15 +465,15 @@ You need to fill in the result in the configuration file (as described in the St
```

- If multiple TiKV instances are deployed on the same physical disk, you need to modify the `capacity` parameter in `conf/tikv.yml`:

```
raftstore.capactiy = the total disk capacity / the number of TiKV instances
```

- Label scheduling configuration

Because multiple TiKV instances are deployed on a single machine, in order to avoid losing 2 replicas of the default 3 replicas in the Region Group during machine downtime which causes cluster unavailability, you can use labels to implement intelligent scheduling of PD.

- TiKV configuration

Configure the same host-level label information on the same physical machines:
Expand Down
2 changes: 1 addition & 1 deletion how-to/get-started/deploy-tidb-from-docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ With Docker Compose, you can use a YAML file to configure application services i

> **Warning:**
>
> This is for testing only. DO NOT USE in production! Please deploy TiDB with [our Ansible solution](/how-to/deploy/orchestrated/ansible.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production.
> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/how-to/deploy/orchestrated/tiup.md) or [TiDB Operator in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/) in production.

## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ TiDB ("Ti" stands for Titanium) is an open-source NewSQL database that supports

TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP:

- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB using TiDB Ansible. It is strongly recommended for production deployment.
- [TiUP Deployment](/how-to/deploy/orchestrated/tiup.md): This guide describes how to deploy TiDB using [TiUP](https://github.com/pingcap-incubator/tiup). It is strongly recommended for production deployment.
- [Ansible Offline Deployment](/how-to/deploy/orchestrated/offline-ansible.md): If your environment has no access to the internet, you can follow this guide to see how to deploy a TiDB cluster offline using TiDB Ansible.
- [Docker Deployment](/how-to/deploy/orchestrated/docker.md): This guide describes how to deploy TiDB using Docker.
- [Docker Compose Deployment](/how-to/get-started/deploy-tidb-from-docker-compose.md): This guide describes how to deploy TiDB using Docker compose. You can follow this guide to quickly deploy a TiDB cluster for testing and development on your local drive.
Expand Down