Skip to content
Permalink
Browse files

*: add TiDB in K8s deployment files and reorganize toc (#1324)

* *: add TiDB in K8s deployment files and reorganize toc

* dev, v3.0: merge upstream
  • Loading branch information...
lilin90 committed Jul 5, 2019
1 parent fccc659 commit 01fc1e44c3a0216ef1455cded46800d33acb9a23
Showing with 623 additions and 144 deletions.
  1. +3 −3 _index.md
  2. +9 −7 dev/TOC.md
  3. +3 −3 dev/_index.md
  4. +1 −1 dev/faq/tidb.md
  5. +1 −1 dev/how-to/deploy/from-tarball/production-environment.md
  6. +1 −1 dev/how-to/deploy/from-tarball/testing-environment.md
  7. +1 −1 dev/how-to/deploy/orchestrated/ansible.md
  8. +0 −44 dev/how-to/deploy/orchestrated/kubernetes.md
  9. 0 dev/how-to/get-started/{local-cluster/install-from-binary.md → deploy-tidb-from-binary.md}
  10. +1 −1 .../local-cluster/install-from-dbdeployer.md → dev/how-to/get-started/deploy-tidb-from-dbdeployer.md
  11. +1 −1 ...o/get-started/{local-cluster/install-from-docker-compose.md → deploy-tidb-from-docker-compose.md}
  12. 0 dev/how-to/get-started/{local-cluster/install-from-homebrew.md → deploy-tidb-from-homebrew.md}
  13. +3 −3 ...w-to/get-started/{local-cluster/install-from-kubernetes.md → deploy-tidb-from-kubernetes-dind.md}
  14. +6 −2 ...ernetes/google-kubernetes-tutorial.md → dev/how-to/get-started/deploy-tidb-from-kubernetes-gke.md
  15. 0 ...-kubernetes/minikube-tutorial.md → dev/how-to/get-started/deploy-tidb-from-kubernetes-minikube.md
  16. +1 −1 dev/how-to/get-started/tidb-binlog.md
  17. +3 −3 dev/overview.md
  18. +9 −7 v3.0/TOC.md
  19. +3 −3 v3.0/_index.md
  20. +1 −1 v3.0/faq/tidb.md
  21. +1 −1 v3.0/how-to/deploy/from-tarball/production-environment.md
  22. +1 −1 v3.0/how-to/deploy/from-tarball/testing-environment.md
  23. +1 −1 v3.0/how-to/deploy/orchestrated/ansible.md
  24. +0 −45 v3.0/how-to/deploy/orchestrated/kubernetes.md
  25. +1 −1 v3.0/how-to/get-started/{local-cluster/install-from-binary.md → deploy-tidb-from-binary.md}
  26. +2 −1 ...local-cluster/install-from-dbdeployer.md → v3.0/how-to/get-started/deploy-tidb-from-dbdeployer.md
  27. +1 −1 ...o/get-started/{local-cluster/install-from-docker-compose.md → deploy-tidb-from-docker-compose.md}
  28. +3 −2 v3.0/how-to/get-started/{local-cluster/install-from-homebrew.md → deploy-tidb-from-homebrew.md}
  29. +4 −4 ...w-to/get-started/{local-cluster/install-from-kubernetes.md → deploy-tidb-from-kubernetes-dind.md}
  30. +317 −0 v3.0/how-to/get-started/deploy-tidb-from-kubernetes-gke.md
  31. +241 −0 v3.0/how-to/get-started/deploy-tidb-from-kubernetes-minikube.md
  32. +1 −1 v3.0/how-to/get-started/tidb-binlog.md
  33. +3 −3 v3.0/overview.md
@@ -13,9 +13,9 @@ TiDB can be deployed on-premise or in-cloud. The following deployment options ar
- [Ansible Deployment](/v3.0/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB using Ansible. It is strongly recommended for production deployment.
- [Ansible Offline Deployment](/v3.0/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 Ansible.
- [Docker Deployment](/v3.0/how-to/deploy/orchestrated/docker.md): This guide describes how to deploy TiDB using Docker.
- [Docker Compose Deployment](/v3.0/how-to/get-started/local-cluster/install-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 (beta)](/v3.0/how-to/get-started/local-cluster/install-from-kubernetes.md): This guide describes how to deploy TiDB on Kubernetes using [TiDB Operator](https://github.com/pingcap/tidb-operator). You can follow this guide to see how to deploy TiDB on Google Kubernetes Engine or deploy TiDB locally using Docker in Docker.
- [Binary Tarball Deployment](/v3.0/how-to/deploy/from-tarball/production-environment.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/v3.0/how-to/get-started/local-cluster/install-from-binary.md) and [testing](/v3.0/how-to/deploy/from-tarball/testing-environment.md) environments are also available.
- [Docker Compose Deployment](/v3.0/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 (beta): You can use [TiDB Operator](https://github.com/pingcap/tidb-operator) to deploy TiDB on [AWS EKS (Elastic Kubernetes Service)](/v3.0/how-to/deploy/orchestrated/tidb-in-kubernetes/aws-eks.md), [GKE (Google Kubernetes Engine)](/v3.0/how-to/deploy/orchestrated/tidb-in-kubernetes/gcp-gke.md), [Google Cloud Shell](/v3.0/how-to/get-started/deploy-tidb-from-kubernetes-gke.md), [Alibaba Cloud ACK (Container Service for Kubernetes)](/v3.0/how-to/deploy/orchestrated/tidb-in-kubernetes/alibaba-cloud.md), or deploy TiDB locally using [DinD (Docker in Docker)](/v3.0/how-to/get-started/deploy-tidb-from-kubernetes-dind.md), [Minikube](/v3.0/how-to/get-started/deploy-tidb-from-kubernetes-minikube.md).
- [Binary Tarball Deployment](/v3.0/how-to/deploy/from-tarball/production-environment.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/v3.0/how-to/get-started/deploy-tidb-from-binary.md) and [testing](/v3.0/how-to/deploy/from-tarball/testing-environment.md) environments are also available.

## Community Provided Blog Posts & Tutorials

@@ -25,12 +25,15 @@
- [Online Schema Changes](key-features.md#online-schema-changes)
+ How-to
+ Get Started
+ Start a Local Cluster
- [From Binary](how-to/get-started/local-cluster/install-from-binary.md)
- [From Homebrew](how-to/get-started/local-cluster/install-from-homebrew.md)
- [From DBdeployer](how-to/get-started/local-cluster/install-from-dbdeployer.md)
- [In Kubernetes](how-to/get-started/local-cluster/install-from-kubernetes.md)
- [In Docker Compose](how-to/get-started/local-cluster/install-from-docker-compose.md)
+ Start a Cluster
- [From Binary](how-to/get-started/deploy-tidb-from-binary.md)
- [From Homebrew](how-to/get-started/deploy-tidb-from-homebrew.md)
- [From DBdeployer](how-to/get-started/deploy-tidb-from-dbdeployer.md)
+ In Kubernetes
- [DinD](how-to/get-started/deploy-tidb-from-kubernetes-dind.md)
- [Minikube](how-to/get-started/deploy-tidb-from-kubernetes-minikube.md)
- [GKE](how-to/get-started/deploy-tidb-from-kubernetes-gke.md)
- [In Docker Compose](how-to/get-started/deploy-tidb-from-docker-compose.md)
- [Explore SQL with TiDB](how-to/get-started/explore-sql.md)
- [Import Example Database](how-to/get-started/import-example-database.md)
- [Read Historical Data](how-to/get-started/read-historical-data.md)
@@ -46,7 +49,6 @@
- [Ansible Deployment (Recommended)](how-to/deploy/orchestrated/ansible.md)
- [Ansible Offline Deployment](how-to/deploy/orchestrated/offline-ansible.md)
- [Docker Deployment](how-to/deploy/orchestrated/docker.md)
- [Kubernetes Deployment](how-to/deploy/orchestrated/kubernetes.md)
+ TiDB in Kubernetes
- [AWS EKS](how-to/deploy/orchestrated/tidb-in-kubernetes/aws-eks.md)
- [GCP](how-to/deploy/orchestrated/tidb-in-kubernetes/gcp-gke.md)
@@ -13,9 +13,9 @@ TiDB can be deployed on-premise or in-cloud. The following deployment options ar
- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB using Ansible. 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 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/local-cluster/install-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 (beta)](/how-to/get-started/local-cluster/install-from-kubernetes.md): This guide describes how to deploy TiDB on Kubernetes using [TiDB Operator](https://github.com/pingcap/tidb-operator). You can follow this guide to see how to deploy TiDB on Google Kubernetes Engine or deploy TiDB locally using Docker in Docker.
- [Binary Tarball Deployment](/how-to/deploy/from-tarball/production-environment.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/how-to/get-started/local-cluster/install-from-binary.md) and [testing](/how-to/deploy/from-tarball/testing-environment.md) environments are also available.
- [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 (beta): You can use [TiDB Operator](https://github.com/pingcap/tidb-operator) to deploy TiDB on [AWS EKS (Elastic Kubernetes Service)](/how-to/deploy/orchestrated/tidb-in-kubernetes/aws-eks.md), [GKE (Google Kubernetes Engine)](/how-to/deploy/orchestrated/tidb-in-kubernetes/gcp-gke.md), [Google Cloud Shell](/how-to/get-started/deploy-tidb-from-kubernetes-gke.md), [Alibaba Cloud ACK (Container Service for Kubernetes)](/how-to/deploy/orchestrated/tidb-in-kubernetes/alibaba-cloud.md), or deploy TiDB locally using [DinD (Docker in Docker)](/how-to/get-started/deploy-tidb-from-kubernetes-dind.md), [Minikube](/how-to/get-started/deploy-tidb-from-kubernetes-minikube.md).
- [Binary Tarball Deployment](/how-to/deploy/from-tarball/production-environment.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/how-to/get-started/deploy-tidb-from-binary.md) and [testing](/how-to/deploy/from-tarball/testing-environment.md) environments are also available.

## Community Provided Blog Posts & Tutorials

@@ -249,7 +249,7 @@ It is not recommended to deploy TiDB offline using Ansible. If the Control Machi

#### How to deploy TiDB quickly using Docker Compose on a single machine?

You can use Docker Compose to build a TiDB cluster locally, including the cluster monitoring components. You can also customize the version and number of instances for each component. The configuration file can also be customized. You can only use this deployment method for testing and development environment. For details, see [Building the Cluster Using Docker Compose](/how-to/get-started/local-cluster/install-from-docker-compose.md).
You can use Docker Compose to build a TiDB cluster locally, including the cluster monitoring components. You can also customize the version and number of instances for each component. The configuration file can also be customized. You can only use this deployment method for testing and development environment. For details, see [Building the Cluster Using Docker Compose](/how-to/get-started/deploy-tidb-from-docker-compose.md).

#### How to separately record the slow query log in TiDB? How to locate the slow query SQL statement?

@@ -8,7 +8,7 @@ category: how-to

This guide provides installation instructions from a binary tarball on Linux. A complete TiDB cluster contains PD, TiKV, and TiDB. To start the database service, follow the order of PD -> TiKV -> TiDB. To stop the database service, follow the order of stopping TiDB -> TiKV -> PD.

See also [local deployment](/how-to/get-started/local-cluster/install-from-binary.md) and [testing environment](/how-to/deploy/from-tarball/testing-environment.md) deployment.
See also [local deployment](/how-to/get-started/deploy-tidb-from-binary.md) and [testing environment](/how-to/deploy/from-tarball/testing-environment.md) deployment.

## Prepare

@@ -8,7 +8,7 @@ category: how-to

This guide provides installation instructions for all TiDB components across multiple nodes for testing purposes. It does not match the recommended usage for production systems.

See also [local deployment](/how-to/get-started/local-cluster/install-from-binary.md) and [production environment](/how-to/deploy/from-tarball/production-environment.md) deployment.
See also [local deployment](/how-to/get-started/deploy-tidb-from-binary.md) and [production environment](/how-to/deploy/from-tarball/production-environment.md) deployment.

## Prepare

@@ -43,7 +43,7 @@ Before you start, make sure you have:

> **Note:**
>
> When you deploy TiDB using Ansible, **use SSD disks for the data directory of TiKV and PD nodes**. Otherwise, it cannot pass the check. 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/local-cluster/install-from-docker-compose.md) on a single machine.
> When you deploy TiDB using Ansible, **use SSD disks for the data directory of TiKV and PD nodes**. Otherwise, it cannot pass the check. 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.
2. A Control Machine that meets the following requirements:

This file was deleted.

@@ -8,7 +8,7 @@ category: how-to

DBdeployer is designed to allow multiple versions of TiDB deployed concurrently. It is recommended for advanced users who are testing out new builds of TiDB, or testing compatibility across releases.

Similar to [Homebrew](/how-to/get-started/local-cluster/install-from-homebrew.md), the DBdeployer installation method installs the tidb-server **without** the tikv-server or pd-server. This is useful for development environments, since you can test your application's compatibility with TiDB without needing to deploy a full TiDB platform.
Similar to [Homebrew](/how-to/get-started/deploy-tidb-from-homebrew.md), the DBdeployer installation method installs the tidb-server **without** the tikv-server or pd-server. This is useful for development environments, since you can test your application's compatibility with TiDB without needing to deploy a full TiDB platform.

> **Note:**
>
@@ -1,7 +1,7 @@
---
title: TiDB Docker Compose Deployment
summary: Use Docker Compose to quickly deploy a TiDB testing cluster.
category: how-to
category: how-to
---

# TiDB Docker Compose Deployment
@@ -1,10 +1,10 @@
---
title: Deploy TiDB to Kubernetes Locally
summary: Use TiDB Operator to quickly deploy a TiDB cluster on Kubernetes
title: Deploy TiDB in Kubernetes Using DinD
summary: Learn how to quickly deploy a TiDB cluster in Kubernetes Using DinD.
category: how-to
---

# Deploy TiDB to Kubernetes Locally
# Deploy TiDB in Kubernetes Using DinD

This document describes how to deploy a TiDB cluster to Kubernetes on your laptop (Linux or macOS) for development or testing.

@@ -1,12 +1,16 @@
---
title: Deploy TiDB to Kubernetes on Google Cloud
summary: Learn how to deploy TiDB on Google Cloud using Kubernetes.
summary: Learn how to quickly deploy a TiDB cluster on Google Cloud using Kubernetes.
category: how-to
---

# Deploy TiDB to Kubernetes on Google Cloud

This tutorial is designed to be [run in Google Cloud Shell](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/pingcap/tidb-operator&tutorial=docs/google-kubernetes-tutorial.md). It takes you through these steps:
This tutorial is designed to directly [run in Google Cloud Shell](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/pingcap/tidb-operator&tutorial=docs/google-kubernetes-tutorial.md).

<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/pingcap/tidb-operator&tutorial=docs/google-kubernetes-tutorial.md"><img src="https://gstatic.com/cloudssh/images/open-btn.png"/></a>

It takes you through the following steps:

- Launch a new 3-node Kubernetes cluster (optional)
- Install the Helm package manager for Kubernetes
@@ -43,7 +43,7 @@ We're using MariaDB Server in this case instead of MySQL Server because RHEL/Cen
sudo yum install -y mariadb-server
```

Even if you've already started a TiDB cluster, it will be easier to follow along with this tutorial where we will set up a new, simple cluster. We will install from a tarball, using a simplified form of the [Local Deployment](/how-to/get-started/local-cluster/install-from-binary.md) guide. You may also wish to refer to [Testing Deployment from Binary Tarball](/how-to/deploy/from-tarball/testing-environment.md) for best practices of establishing a real testing deployment, but that goes beyond the scope of this tutorial.
Even if you've already started a TiDB cluster, it will be easier to follow along with this tutorial where we will set up a new, simple cluster. We will install from a tarball, using a simplified form of the [Local Deployment](/how-to/get-started/deploy-tidb-from-binary.md) guide. You may also wish to refer to [Testing Deployment from Binary Tarball](/how-to/deploy/from-tarball/testing-environment.md) for best practices of establishing a real testing deployment, but that goes beyond the scope of this tutorial.

```bash
curl -L http://download.pingcap.org/tidb-latest-linux-amd64.tar.gz | tar xzf -
@@ -13,9 +13,9 @@ TiDB can be deployed on-premise or in-cloud. The following deployment options ar
- [Ansible Deployment](/how-to/deploy/orchestrated/ansible.md): This guide describes how to deploy TiDB using Ansible. 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 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/local-cluster/install-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 (beta)](/how-to/get-started/local-cluster/install-from-kubernetes.md): This guide describes how to deploy TiDB on Kubernetes using [TiDB Operator](https://github.com/pingcap/tidb-operator). You can follow this guide to see how to deploy TiDB on Google Kubernetes Engine or deploy TiDB locally using Docker in Docker.
- [Binary Tarball Deployment](/how-to/deploy/from-tarball/production-environment.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/how-to/get-started/local-cluster/install-from-binary.md) and [testing](/how-to/deploy/from-tarball/testing-environment.md) environments are also available.
- [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 (beta)](/how-to/get-started/deploy-tidb-from-kubernetes-dind.md): This guide describes how to deploy TiDB on Kubernetes using [TiDB Operator](https://github.com/pingcap/tidb-operator). You can follow this guide to see how to deploy TiDB on Google Kubernetes Engine or deploy TiDB locally using Docker in Docker.
- [Binary Tarball Deployment](/how-to/deploy/from-tarball/production-environment.md): This guide describes how to deploy TiDB from a binary tarball in production. Guides for [development](/how-to/get-started/deploy-tidb-from-binary.md) and [testing](/how-to/deploy/from-tarball/testing-environment.md) environments are also available.

## Community Provided Blog Posts & Tutorials

0 comments on commit 01fc1e4

Please sign in to comment.
You can’t perform that action at this time.