Skip to content

Commit

Permalink
Improve workflow in docs/google-kubernetes-tutorial.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cofyc committed Apr 16, 2019
1 parent 8e56b41 commit 5e69c78
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
7 changes: 5 additions & 2 deletions charts/tidb-cluster/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,16 @@ Cluster access
kubectl port-forward -n {{ .Release.Namespace }} svc/{{ template "cluster.name" . }}-tidb 4000:4000 &
{{- if .Values.tidb.passwordSecretName }}
mysql -h 127.0.0.1 -P 4000 -u root -D test -p
{{- else -}}
{{- else }}
mysql -h 127.0.0.1 -P 4000 -u root -D test
Set a password for your user
SET PASSWORD FOR 'root'@'%' = '{{ (randAlphaNum 10) }}'; FLUSH PRIVILEGES
SET PASSWORD FOR 'root'@'%' = '{{ (randAlphaNum 10) }}'; FLUSH PRIVILEGES;
{{- end -}}
{{- if .Values.monitor.create }}
* View monitor dashboard for TiDB cluster
kubectl port-forward -n {{ .Release.Namespace }} svc/{{ template "cluster.name" . }}-grafana 3000:3000
Open browser at http://localhost:3000. The default username and password is admin/admin.
Note that, this works only on your local machine, if you test in remote server, you need to specify your server's external IP address.
For gcloud web console users, you can use web preview feature, e.g. https://ssh.cloud.google.com/devshell/proxy&port=3000.
Please refer to https://cloud.google.com/shell/docs/using-web-preview for more details.
{{- end -}}
21 changes: 9 additions & 12 deletions docs/google-kubernetes-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ Copy `helm` to your `$HOME` directory so that it will persist after the Cloud Sh

Helm will also need a couple of permissions to work properly:

kubectl create serviceaccount tiller --namespace kube-system &&
kubectl apply -f ./manifests/tiller-rbac.yaml &&
helm init --service-account tiller --upgrade

Expand All @@ -101,7 +100,7 @@ We can watch the operator come up with:

watch kubectl get pods --namespace tidb-admin -o wide

When you see `Running`, `Control + C` and proceed to launch a TiDB cluster!
When you see all pods are `Running`, `Control + C` and proceed to launch a TiDB cluster!

## Deploy your first TiDB cluster

Expand All @@ -123,29 +122,27 @@ There can be a small delay between the pod being up and running, and the service

When you see `demo-tidb` appear, you can `Control + C`. The service is ready to connect to!

You can connect to the clustered service within the Kubernetes cluster:
To connect to TiDB within the Kubernetes cluster, you can establish a tunnel between the TiDB service and your Cloud Shell. This is recommended only for debugging purposes, because the tunnel will not automatically be transferred if your Cloud Shell restarts. To establish a tunnel:

kubectl run -n tidb mysql-client --rm -i --tty --image mysql -- mysql -P 4000 -u root -h $(kubectl get svc demo-tidb -n tidb -o jsonpath='{.spec.clusterIP}') -p

Congratulations, you are now up and running with a distributed TiDB database compatible with MySQL!

In addition to connecting to TiDB within the Kubernetes cluster, you can also establish a tunnel between the TiDB service and your Cloud Shell. This is recommended only for debugging purposes, because the tunnel will not automatically be transferred if your Cloud Shell restarts. To establish a tunnel:

kubectl -n tidb port-forward demo-tidb-0 4000:4000 &>/tmp/port-forward.log &
kubectl -n tidb port-forward svc/demo-tidb 4000:4000 &>/tmp/port-forward.log &

From your Cloud Shell:

sudo apt-get install -y mysql-client &&
mysql -h 127.0.0.1 -u root -P 4000 -p
mysql -h 127.0.0.1 -u root -P 4000

Try out a MySQL command inside your MySQL terminal:

select tidb_version();

If you did not specify a password in helm, set one now:

SET PASSWORD FOR 'root'@'%' =
SET PASSWORD FOR 'root'@'%' = '<change-to-your-password>';

Note that, this command contains some special characters which cannot be
auto-populated, you need to copy and paste it into your console manually.

Congratulations, you are now up and running with a distributed TiDB database compatible with MySQL!

## Scale out the TiDB cluster

Expand Down

0 comments on commit 5e69c78

Please sign in to comment.