-
Notifications
You must be signed in to change notification settings - Fork 498
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
add basic yaml deployment example #1573
Changes from 1 commit
eea127c
308cb7a
f6e019d
1a462df
00b5768
48aeabd
d77b7bd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
# 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 | ||
``` | ||
|
||
It is expected to see the following outputs: | ||
|
||
```bash | ||
``` | ||
|
||
## Explore | ||
|
||
Explore the TiDB sql interface: | ||
|
||
```bash | ||
> kubectl -n <namespace> port-forward svc/basic-tidb 4000:4000 &>/tmp/pf-tidb.log & | ||
> mysql -h localhost: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 | ||
``` | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
apiVersion: pingcap.com/v1alpha1 | ||
kind: TidbCluster | ||
metadata: | ||
name: basic | ||
spec: | ||
version: v3.0.8 | ||
timezone: UTC | ||
imagePullPolicy: IfNotPresent | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is this necessary? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. no, removed |
||
pvReclaimPolicy: Delete | ||
pd: | ||
baseImage: pingcap/pd | ||
replicas: 3 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. how about deploying 1 replica for pd/tikv/tidb to make this basic example can be applied in one node cluster, e.g. default cluster started by minikube / kind? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I prefer 2/3/3, which preserves the taste of distributed and scalable |
||
storageClassName: "" | ||
requests: | ||
storage: "10Gi" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can storage be omitted or use a smaller one, e.g. |
||
config: {} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. in my test, There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, it could only be omitted after defaulting wehook enabled |
||
tikv: | ||
baseImage: pingcap/tikv | ||
replicas: 3 | ||
storageClassName: "" | ||
requests: | ||
storage: "50Gi" | ||
config: {} | ||
tidb: | ||
baseImage: pingcap/tidb | ||
replicas: 2 | ||
service: | ||
type: ClusterIP | ||
config: {} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I need to run
mysql -h 127.0.0.1 -P 4000
to connect to the TiDB serverThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good catch