Skip to content

Latest commit

 

History

History
281 lines (183 loc) · 8.68 KB

deploy-tidb-from-kubernetes-kind.md

File metadata and controls

281 lines (183 loc) · 8.68 KB
Raw
title summary category aliases
Deploy TiDB in Kubernetes Using kind
Learn how to deploy a TiDB cluster in Kubernetes using kind.
how-to
/docs/dev/tidb-in-kubernetes/deploy-tidb-from-kubernetes-dind/

Deploy TiDB in Kubernetes Using kind

This tutorial shows how to deploy TiDB Operator and a TiDB cluster in Kubernetes on your laptop (Linux or macOS) using kind.

kind is a tool for running local Kubernetes clusters using Docker containers as cluster nodes. It is developed for testing local Kubernetes clusters, initially targeting the conformance tests. The Kubernetes cluster version depends on the node image that your kind uses, and you can specify the image to be used for the nodes and choose any other published version. Refer to Docker hub to see available tags.

Warning:

This deployment is for testing only. DO NOT USE in production!

Prerequisites

Before deployment, make sure the following requirements are satisfied:

  • Resources requirement: 2 CPU cores+, Memory 4G+

    Note:

    For macOS, you need to allocate at least 2 CPU cores and 4G Memory to Docker. For details, see Docker configuration for Mac.

  • Docker: version >= 17.03

  • Helm Client: version >= 2.11.0 and < 2.16.4

  • Kubectl: version >= 1.12 (1.13 or later recommended)

    Note:

    The output might vary slightly among different versions of kubectl.

  • kind: version >= 0.4.0

  • The value of net.ipv4.ip_forward should be set to 1

Step 1: Create a Kubernetes cluster using kind

First, make sure that Docker is running. Then, you can create a local Kubernetes cluster with a script in our repository. Follow the steps below:

  1. Clone the code:

    {{< copyable "shell-regular" >}}

    git clone --depth=1 https://github.com/pingcap/tidb-operator && \
cd tidb-operator

  2. Run the script and create a local Kubernetes cluster:

    {{< copyable "shell-regular" >}}

    hack/kind-cluster-build.sh

    Note:

    By default, this script starts a Kubernetes cluster of the 1.12.8 version, with six nodes in the cluster and for each node the number of mount points is 9. You can configure these items by startup options.

    {{< copyable "shell-regular" >}}

    hack/kind-cluster-build.sh --nodeNum 2 --k8sVersion v1.14.6 --volumeNum 3

  3. To connect the local Kubernetes cluster, set the default configuration file path of kubectl to kube-config.

    {{< copyable "shell-regular" >}}

    export KUBECONFIG="$(kind get kubeconfig-path)"

  4. Verify whether the Kubernetes cluster is on and running:

    {{< copyable "shell-regular" >}}

    kubectl cluster-info

    The output is like this:

    Kubernetes master is running at https://127.0.0.1:50295
KubeDNS is running at https://127.0.0.1:50295/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy

  5. Check the storageClass of the cluster:

    {{< copyable "shell-regular" >}}

    kubectl get storageClass

    The output is like this:

    NAME                 PROVISIONER                    AGE
local-storage        kubernetes.io/no-provisioner   7m50s
standard (default)   kubernetes.io/host-path        8m29s

Step 2: Deploy TiDB Operator

Add the official chart repository provided by PingCAP:

{{< copyable "shell-regular" >}}

helm repo add pingcap https://charts.pingcap.org/

Use helm search to search the chart provided by PingCAP:

{{< copyable "shell-regular" >}}

helm search pingcap -l

TiDB Operator uses CRD (Custom Resource Definition) to extend Kubernetes. Therefore, to use TiDB Operator, you must first create the TidbCluster CRD.

{{< copyable "shell-regular" >}}

kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/crd.yaml && \
kubectl get crd tidbclusters.pingcap.com

After TidbCluster CRD is created, install TiDB Operator in your Kubernetes cluster:

  1. Get the values.yaml file of the tidb-operator chart you want to install:

    {{< copyable "shell-regular" >}}

    mkdir -p /home/tidb/tidb-operator && \
helm inspect values pingcap/tidb-operator --version=v1.1.0-rc.1 > /home/tidb/tidb-operator/values-tidb-operator.yaml

    Modify the configuration in values.yaml according to your needs.

  2. Install TiDB Operator:

    {{< copyable "shell-regular" >}}

    helm install pingcap/tidb-operator --name=tidb-operator --namespace=tidb-admin --version=v1.1.0-rc.1 -f /home/tidb/tidb-operator/values-tidb-operator.yaml && \
kubectl get po -n tidb-admin -l app.kubernetes.io/name=tidb-operator

Step 3: Deploy the TiDB cluster

To deploy the TiDB cluster, perform the following steps:

  1. Create Namespace:

    {{< copyable "shell-regular" >}}

    kubectl create namespace demo

  2. Deploy the TiDB cluster:

    {{< copyable "shell-regular" >}}

    kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/basic/tidb-cluster.yaml -n demo

  3. Deploy the TiDB cluster monitor:

    {{< copyable "shell-regular" >}}

    kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/basic/tidb-monitor.yaml -n demo

  4. View the Pod status:

    {{< copyable "shell-regular" >}}

    kubectl get po -n demo

Access the database and monitoring dashboards

To access the TiDB cluster, use the kubectl port-forward command to expose services to the host. The ports in the command are in <host machine port>:<k8s service port> format.

  • Access TiDB using the MySQL client

    Before you start testing your TiDB cluster, make sure you have installed a MySQL client.

    1. Use kubectl to forward the host machine port to the TiDB service port:

      {{< copyable "shell-regular" >}}

      kubectl port-forward svc/basic-tidb 4000:4000 --namespace=demo

      If the output is similar to Forwarding from 0.0.0.0:4000 -> 4000, then the proxy is set up.

    2. To access TiDB using the MySQL client, open a new terminal tab or window and run the following command:

      {{< copyable "shell-regular" >}}

      mysql -h 127.0.0.1 -P 4000 -u root

      When the testing finishes, press Ctrl+C to stop the proxy and exit.

  • View the monitoring dashboard

    1. Use kubectl to forward the host machine port to the Grafana service port:

      {{< copyable "shell-regular" >}}

      kubectl port-forward svc/basic-grafana 3000:3000 --namespace=demo

      If the output is similar to Forwarding from 0.0.0.0:4000 -> 4000, then the proxy is set up.

    2. Open your web browser at http://localhost:3000 to access the Grafana monitoring dashboard.

      • default username: admin
      • default password: admin

      When the testing finishes, press Ctrl+C to stop the proxy and exit.

    Note:

    If you are deploying kind on a remote machine rather than a local PC, there might be problems accessing the monitoring dashboard of the remote system through "localhost".

    When you use kubectl 1.13 or later versions, you can expose the port on 0.0.0.0 instead of the default 127.0.0.1 by adding --address 0.0.0.0 to the kubectl port-forward command.

    {{< copyable "shell-regular" >}}

    kubectl port-forward --address 0.0.0.0 -n tidb svc/basic-grafana 3000:3000

    Then, open your browser at http://<VM's IP address>:3000 to access the Grafana monitoring dashboard.

Destroy the TiDB and Kubernetes cluster

To destroy the local TiDB cluster, run the following command:

{{< copyable "shell-regular" >}}

kubectl delete tc basic -n demo

To destroy the monitor component, run the following command:

{{< copyable "shell-regular" >}}

kubectl delete tidbmonitor basic -n demo

To destroy the Kubernetes cluster, run the following command:

{{< copyable "shell-regular" >}}

kind delete cluster