From c87fa2962f5b5b75e3d01b8f7ddaa07373c87151 Mon Sep 17 00:00:00 2001 From: Morgan Tocker Date: Wed, 5 Sep 2018 03:28:11 -0600 Subject: [PATCH] op-guide: Add Kubernetes Deployment (#593) * Add GKE Deployment * Added GKE Tutorial * Renamed to Kubernetes * Update README.md * Update README.md * Changed to Kubernetes generic * Update kubernetes.md --- README.md | 1 + op-guide/kubernetes.md | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 op-guide/kubernetes.md diff --git a/README.md b/README.md index 87a6ceffbd56f..86f63aab8dc01 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,7 @@ - [Docker Deployment](op-guide/docker-deployment.md) - [Docker Compose Deployment](op-guide/docker-compose.md) - [Cross-Region Deployment](op-guide/location-awareness.md) + - [Kubernetes Deployment](op-guide/kubernetes.md) + Configure - [Configuration Flags](op-guide/configuration.md) - [Configuration File Description](op-guide/tidb-config-file.md) diff --git a/op-guide/kubernetes.md b/op-guide/kubernetes.md new file mode 100644 index 0000000000000..08d4e79e09f58 --- /dev/null +++ b/op-guide/kubernetes.md @@ -0,0 +1,24 @@ +--- +title: TiDB Deployment on Kubernetes +summary: Use TiDB Operator to quickly deploy a TiDB cluster on Kubernetes +category: operations +--- + +# TiDB Deployment on Kubernetes + +[TiDB Operator](https://github.com/pingcap/tidb-operator) manages TiDB clusters on [Kubernetes](https://kubernetes.io) +and automates tasks related to operating a TiDB cluster. It makes TiDB a truly cloud-native database. + +> **Warning:** Currently, TiDB Operator is work in progress [WIP] and is NOT ready for production. Use at your own risk. + +## Google Kubernetes Engine (GKE) + +The TiDB Operator tutorial for GKE runs directly in the Google Cloud Shell. + +[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/pingcap/tidb-operator&tutorial=docs/google-kubernetes-tutorial.md) + +## Local install using Docker in Docker + +Docker in Docker (DinD) runs Docker containers as virtual machines and runs another layer of Docker containers inside the first layer of Docker containers. `kubeadm-dind-cluster` uses this technology to run the Kubernetes cluster in Docker containers. TiDB Operator uses a modified DinD script to manage the DinD Kubernetes cluster. + +[Continue reading tutorial on GitHub →](https://github.com/pingcap/tidb-operator/blob/master/docs/local-dind-tutorial.md)