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.

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

op-guide: Add Kubernetes Deployment #593

Merged
merged 7 commits into from
Sep 5, 2018
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,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)
Expand Down
24 changes: 24 additions & 0 deletions op-guide/kubernetes.md
Original file line number Diff line number Diff line change
@@ -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)