From a7059c4aefdb20bee0024fd6c90b3ab2bf76ddce Mon Sep 17 00:00:00 2001
From: pingcap-github-bot <sre-bot@pingcap.com>
Date: Fri, 21 Feb 2020 16:18:11 +0800
Subject: [PATCH] add basic yaml deployment example (#1573) (#1741)

* add basic yaml deployment example

Signed-off-by: Aylei <rayingecho@gmail.com>

* Address review comments

Signed-off-by: Aylei <rayingecho@gmail.com>

* fix typo

Signed-off-by: Aylei <rayingecho@gmail.com>

Co-authored-by: Aylei <rayingecho@gmail.com>
---
 examples/basic/README.md         | 73 ++++++++++++++++++++++++++++++++
 examples/basic/tidb-cluster.yaml | 26 ++++++++++++
 examples/basic/tidb-monitor.yaml | 20 +++++++++
 3 files changed, 119 insertions(+)
 create mode 100644 examples/basic/README.md
 create mode 100644 examples/basic/tidb-cluster.yaml
 create mode 100644 examples/basic/tidb-monitor.yaml

diff --git a/examples/basic/README.md b/examples/basic/README.md
new file mode 100644
index 0000000000..9933d7e7c9
--- /dev/null
+++ b/examples/basic/README.md
@@ -0,0 +1,73 @@
+# A Basic TiDB cluster with monitoring
+
+> **Note:**
+>
+> This setup is for test or demo purpose only and **IS NOT** applicable for critical environment. Refer to the [Documents](https://pingcap.com/docs/stable/tidb-in-kubernetes/deploy/prerequisites/) for production setup.
+
+The following steps will create a TiDB cluster with monitoring, the monitoring data is not persisted by default.
+
+**Prerequisites**: 
+- Has TiDB operator `v1.1.0-beta.1` or higher version installed. [Doc](https://pingcap.com/docs/stable/tidb-in-kubernetes/deploy/tidb-operator/)
+- Has default `StorageClass` configured, and there are enough PVs (by default, 6 PVs are required) of that storageClass:
+  
+  This could by verified by the following command:
+  
+  ```bash
+  > kubectl get storageclass
+  ```
+  
+  The output is similar to this:
+  
+  ```bash
+  NAME                 PROVISIONER               AGE
+  standard (default)   kubernetes.io/gce-pd      1d
+  gold                 kubernetes.io/gce-pd      1d
+  ```
+  
+  Alternatively, you could specify the storageClass explicitly by modifying `tidb-cluster.yaml`.
+
+## Install
+
+The following commands is assumed to be executed in this directory.
+
+Install the cluster:
+
+```bash
+> kubectl -n <namespace> apply -f ./
+```
+
+Wait for cluster Pods ready:
+
+```bash
+watch kubectl -n <namespace> get pod
+```
+
+## Explore
+
+Explore the TiDB sql interface:
+
+```bash
+> kubectl -n <namespace> port-forward svc/basic-tidb 4000:4000 &>/tmp/pf-tidb.log &
+> mysql -h 127.0.0.1 -P 4000 -u root
+```
+
+Explore the monitoring dashboards:
+
+```bash
+> kubectl -n <namespace> port-forward svc/basic-grafana 4000:4000 &>/tmp/pf-grafana.log &
+```
+
+Browse [localhost:4000](http://localhost:4000).
+
+## Destroy
+
+```bash
+> kubectl -n <namespace> delete -f ./
+```
+
+The PVCs used by TiDB cluster will not be deleted in the above process, therefore, the PVs will be not be released neither. You can delete PVCs and release the PVs by the following command:
+
+```bash
+> kubectl -n <namespace> delete pvc app.kubernetes.io/instance=basic,app.kubernetes.io,app.kubernetes.io/managed-by=tidb-operator
+```
+
diff --git a/examples/basic/tidb-cluster.yaml b/examples/basic/tidb-cluster.yaml
new file mode 100644
index 0000000000..63b1894fd6
--- /dev/null
+++ b/examples/basic/tidb-cluster.yaml
@@ -0,0 +1,26 @@
+apiVersion: pingcap.com/v1alpha1
+kind: TidbCluster
+metadata:
+  name: basic
+spec:
+  version: v3.0.8
+  timezone: UTC
+  pvReclaimPolicy: Delete
+  pd:
+    baseImage: pingcap/pd
+    replicas: 3
+    requests:
+      storage: "1Gi"
+    config: {}
+  tikv:
+    baseImage: pingcap/tikv
+    replicas: 3
+    requests:
+      storage: "50Gi"
+    config: {}
+  tidb:
+    baseImage: pingcap/tidb
+    replicas: 2
+    service:
+      type: ClusterIP
+    config: {}
diff --git a/examples/basic/tidb-monitor.yaml b/examples/basic/tidb-monitor.yaml
new file mode 100644
index 0000000000..d314dc1f3e
--- /dev/null
+++ b/examples/basic/tidb-monitor.yaml
@@ -0,0 +1,20 @@
+apiVersion: pingcap.com/v1alpha1
+kind: TidbMonitor
+metadata:
+  name: basic
+spec:
+  clusters:
+  - name: basic
+  prometheus:
+    baseImage: prom/prometheus
+    version: v2.11.1
+  grafana:
+    baseImage: grafana/grafana
+    version: 6.0.1
+  initializer:
+    baseImage: pingcap/tidb-monitor-initializer
+    version: v3.0.5
+  reloader:
+    baseImage: pingcap/tidb-monitor-reloader
+    version: v1.0.1
+  imagePullPolicy: IfNotPresent