docs/dind: update documentation of DinD installation

docs/local-dind-tutorial.md

@@ -16,15 +16,23 @@ Before deploying a TiDB cluster to Kubernetes, make sure the following requireme
 
     > **Note:** [Legacy Docker Toolbox](https://docs.docker.com/toolbox/toolbox_install_mac/) users must migrate to [Docker for Mac](https://store.docker.com/editions/community/docker-ce-desktop-mac) by uninstalling Legacy Docker Toolbox and installing Docker for Mac, because DinD cannot run on Docker Toolbox and Docker Machine.
 
+    > **Note:** `kubeadm` validates installed Docker version during installation process, if you are using Docker newer than 18.06, there would be warning messages, the cluster may still be working, but it's recommended to use Docker version between 17.03 and 18.06 for better compatiability.
+
 - [Helm Client](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client): 2.9.0 or later
-- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl): 1.10 or later
+- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl): at least 1.10 required, 1.13 or later recommended
 
     > **Note:** The outputs of different versions of `kubectl` might be slightly different.
 
+- For Linux users, `kubeadm` may produce warning messages during installation process if you are using kernel 5.x or later versions. The cluster may still be working, but it's recommended to use kernel version 3.10+ or 4.x for better compatiability.
+
+- `root` access or permissions to operate with Docker daemon.
+
 ## Step 1: Deploy a Kubernetes cluster using DinD
 
+There is a script in our repository that can help you install and setup a Kubernetes cluster (version 1.12) using DinD for TiDB Operator.
+
 ```sh
-$ git clone https://github.com/pingcap/tidb-operator
+$ git clone --depth=1 https://github.com/pingcap/tidb-operator
 $ cd tidb-operator
 $ manifests/local-dind/dind-cluster-v1.12.sh up
 ```
@@ -37,16 +45,7 @@ $ KUBE_REPO_PREFIX=uhub.ucloud.cn/pingcap manifests/local-dind/dind-cluster-v1.1
 
 ## Step 2: Install TiDB Operator in the DinD Kubernetes cluster
 
-Uncomment the `scheduler.kubeSchedulerImage` in `values.yaml`, set it to the same as your kubernetes cluster version.
-
 ```sh
-$ kubectl apply -f manifests/crd.yaml
-
-$ # This creates the custom resource for the cluster that the operator uses.
-$ kubectl get customresourcedefinitions
-NAME                             AGE
-tidbclusters.pingcap.com         1m
-
 $ # Install TiDB Operator into Kubernetes
 $ helm install charts/tidb-operator --name=tidb-operator --namespace=tidb-admin --set scheduler.kubeSchedulerImageName=mirantis/hypokube --set scheduler.kubeSchedulerImageTag=final
 $ # wait operator running
@@ -61,11 +60,11 @@ tidb-scheduler-56757c896c-clzdg            2/2       Running   0          1m
 ```sh
 $ helm install charts/tidb-cluster --name=demo --namespace=tidb
 $ watch kubectl get pods --namespace tidb -l app.kubernetes.io/instance=demo -o wide
-$ # wait a few minutes to get all TiDB components created and ready
+$ # wait a few minutes to get all TiDB components get created and ready
 
 $ kubectl get tidbcluster -n tidb
-NAME      AGE
-demo      3m
+NAME   PD                  STORAGE   READY   DESIRE   TIKV                  STORAGE   READY   DESIRE   TIDB                  READY   DESIRE
+demo   pingcap/pd:v2.1.8   1Gi       3       3        pingcap/tikv:v2.1.8   10Gi      3       3        pingcap/tidb:v2.1.8   2       2
 
 $ kubectl get statefulset -n tidb
 NAME        DESIRED   CURRENT   AGE
@@ -85,17 +84,17 @@ demo-tidb-peer    ClusterIP   None             <none>        10080/TCP
 demo-tikv-peer    ClusterIP   None             <none>        20160/TCP                        1m
 
 $ kubectl get configmap -n tidb
-NAME           DATA      AGE
-demo-monitor   3         1m
-demo-pd        2         1m
-demo-tidb      2         1m
-demo-tikv      2         1m
+NAME                     DATA   AGE
+demo-monitor             5      1m
+demo-monitor-dashboard   0      1m
+demo-pd                  2      1m
+demo-tidb                2      1m
+demo-tikv                2      1m
 
 $ kubectl get pod -n tidb
 NAME                              READY     STATUS      RESTARTS   AGE
-demo-discovery-649c7bcbdc-t5r2k   2/2       Running     0          1m
+demo-discovery-649c7bcbdc-t5r2k   1/1       Running     0          1m
 demo-monitor-58745cf54f-gb8kd     2/2       Running     0          1m
-demo-monitor-configurator-stvw6   0/1       Completed   0          1m
 demo-pd-0                         1/1       Running     0          1m
 demo-pd-1                         1/1       Running     0          1m
 demo-pd-2                         1/1       Running     0          1m
@@ -106,7 +105,9 @@ demo-tikv-1                       2/2       Running     0          1m
 demo-tikv-2                       2/2       Running     0          1m
 ```
 
-To access the TiDB cluster, use `kubectl port-forward` to expose the services to host.
+To access the TiDB cluster, use `kubectl port-forward` to expose services to host. The port numbers in command are in `<host machine port>:<k8s service port>` format.
+
+> **Note:** If you are deploying DinD on a remote machine rather than local PC, there may be problem accessing "localhost" of that remote system. When using `kubectl` 1.13 or later, it's possible to expose the port on `0.0.0.0` instead of `127.0.0.1` (which is default) by adding `--address 0.0.0.0` to the `kubectl port-forward` command.
 
 - Access TiDB using the MySQL client
 
@@ -119,7 +120,7 @@ To access the TiDB cluster, use `kubectl port-forward` to expose the services to
     2. To connect to TiDB using the MySQL client, open a new terminal tab or window and run the following command:
 
         ```sh
-        $ mysql -h 127.0.0.1 -P 4000 -u root -p
+        $ mysql -h 127.0.0.1 -P 4000 -u root
         ```
 
 - View the monitor dashboard
@@ -135,6 +136,31 @@ To access the TiDB cluster, use `kubectl port-forward` to expose the services to
         * Default username: admin
         * Default password: admin
 
+- Permanent remote access
+
+    Although this is a very simple demo cluster and not suitable for any serius usage, it may be useful if it can be accessed remotely without `kubectl port-forward`, which may require an open terminal.
+
+    By default, TiDB, Prometheus, and Grafana are exposed as `NodePort` Services, so it's possible to setup reverse proxy for them.
+
+    1. You can find their listing port numbers by:
+
+        ```sh
+        $ kubectl get service -n tidb | grep NodePort
+        demo-grafana      NodePort    10.111.80.73     <none>        3000:32503/TCP                   1m
+        demo-prometheus   NodePort    10.104.97.84     <none>        9090:32448/TCP                   1m
+        demo-tidb         NodePort    10.102.165.13    <none>        4000:32714/TCP,10080:32680/TCP   1m
+        ```
+
+        In this sample output, the ports are: 32503 for Grafana, 32448 for Prometheus, and 32714 for TiDB.
+
+    2. Find host IP address of the cluster.
+
+        DinD is a k8s cluster running inside docker containers, so Services expose ports to the containers' address, instead of the real host machine. We can find IP addresses of docker containers by `kubectl get nodes -o yaml | grep address`.
+
+    3. Setup reverse proxy
+
+        Either (or all) of the container IPs can be used as upstream for reverse proxy. You may use any reverse proxy server that supports TCP (for TiDB) or HTTP (for Grafana and Prometheus) to provide remote access. HAProxy and nginx are two common choices.
+
 ## Scale the TiDB cluster
 
 You can scale out or scale in the TiDB cluster simply by modifying the number of `replicas`.
@@ -203,4 +229,4 @@ $ sudo rm -rf data/kube-node-*
 $ manifests/local-dind/dind-cluster-v1.12.sh up
 ```
 
-> **Warning:** You must clean the data after you destroy the DinD Kubernetes cluster, otherwise the TiDB cluster would fail to start when you bring it up again.
+> **Warning:** You must clean the data after you destroy the DinD Kubernetes cluster, otherwise the TiDB cluster would fail to start when you try to bring it up again.