Deploy Production-Grade MySQL Cluster in Rancher Using KubeDB


KubeDB is the Kubernetes Native Database Management Solution which simplifies and automates routine database tasks such as Provisioning, Monitoring, Upgrading, Patching, Scaling, Volume Expansion, Backup, Recovery, Failure detection, and Repair for various popular databases on private and public clouds. The databases that KubeDB supports are MySQL, MongoDB, MariaDB, Elasticsearch, Redis, PostgreSQL, ProxySQL, Percona XtraDB, Memcached and PgBouncer. You can find the guides to all the supported databases in KubeDB . In this tutorial we will Deploy Production-Grade MySQL Cluster in Rancher Using KubeDB. We will cover the following steps:

  1. Create a Kubernetes Cluster via Rancher
  2. Access Kubernetes Cluster with Rancher UI
  3. Install KubeDB
  4. Deploy MySQL Clustered Database
  5. Read/Write Sample Data

Create a Kubernetes Cluster

First, we have created a local Kubernetes cluster via Rancher. If you don’t have a Kubernetes cluster you can create one using Rancher . After successfully creating the cluster we are able to access it via Rancher Web UI. welcome page

Create a StorageClass

By default, Rancher does not have a StorageClass. Therefore, we need to create one. We can do this by applying the following YAML in the cluster kubectl shell of the Rancher UI:

$ kubectl apply -f

kubectl shell create storageclass applied storageclass To verify that the StorageClass has been created successfully, navigate to the left menu bar and select Storage > StorageClasses. Here, you should be able to see the previously created StorageClass. created storageclass

Get License

In order to use KubeDB Enterprise Edition, we need to obtain a license file from the Appscode License Server. To do this, we first need to retrieve the cluster ID by running the following command:

$ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'

get cluster id

Once we have the cluster ID, we can navigate to the Appscode License Server to get the license.txt file. For this tutorial we will use KubeDB Enterprise Edition. KubeDB offers a 30 days license free of cost to try all features of the Enterprise Edition.

License Server

Next, we will save the license file in license.txt file using the vim editor. vim editor vim editor license file

Install KubeDB

We will use helm to install KubeDB using the following command. Please install helm here if it is not already installed.

$ helm repo add appscode
$ helm repo update
$ helm install kubedb appscode/kubedb \
  --version v2023.02.28 \
  --namespace kubedb --create-namespace \
  --set kubedb-provisioner.enabled=true \
  --set kubedb-ops-manager.enabled=true \
  --set kubedb-autoscaler.enabled=true \
  --set kubedb-dashboard.enabled=true \
  --set kubedb-schema-manager.enabled=true \
  --set-file global.license=license.txt

kubedb installation

To verify that KubeDB has been successfully installed, navigate to the left menu bar and select Workload > Pods. Here, you should be able to see the newly created KubeDB pods. kubedb installation

To keep things separated, we will use a new namespace called demo throughout this tutorial. To create this namespace, navigate to the left menu bar and select the Projects/Namespaces section. namespace bar create namespace demo verify namespace

Deploy MySQL Clustered Database

In this section, we will deploy a MySQL cluster using KubeDB. Here is the YAML configuration that we will be using:

kind: MySQL
  name: mysql-cluster
  namespace: demo
  version: "8.0.32"
  replicas: 3
    mode: GroupReplication
  storageType: Durable
    storageClassName: "local-path"
      - ReadWriteOnce
        storage: 64Mi
  terminationPolicy: WipeOut

To deploy this configuration, navigate to the left menu bar, select Workload > Pods, and click the “Import YAML” button. import mysql yaml read from file apply resource

In this yaml,

  • spec.version field specifies the version of MySQL. Here, we are using MySQL version 8.0.32. You can list the KubeDB supported versions of MySQL by running $ kubectl get mysqlversions command.
  • specifies PVC spec that will be dynamically allocated to store data for this database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests.
  • And the spec.terminationPolicy field is Wipeout means that the database will be deleted without restrictions. It can also be “Halt”, “Delete” and “DoNotTerminate”. Learn More about these HERE .

After deploying the MySQL Cluster configuration, you should see the following pods created in the Workload > Pods section: mysql pods To verify that the MySQL deployment was successful, connect to the cluster kubectl shell and run the following commands to see the objects that were created. Also, we will check the database STATUS is ready to or not,

$ kubectl get all -n demo
$ kubectl get mysql -n demo mysql-test

cluster kubectl shell run command

We have successfully deployed our MySQL into Rancher Kubernetes cluster.

Accessing Database Through MySQL Pod

To access the database through MySQL Pod, you need the credentials. KubeDB creates a Secret for the deployed database, and in this case, it’s named mysql-cluster-auth. Navigate to the Storage > Secrets section, locate the mysql-cluster-auth secret and click on it to see the credentials. Copy the Username and Password for further use. secrets copy secret

To connect to the MySQL database, we can use the mysql-cluster-0 pod. click the Execute Shell button on the right side of the row. In the pop-up window, Run the following command to connect to the MySQL database:

bash-4.4# mysql --user=root --password='0rpTvIUfX3XkZtWT'

execute mysql shell connect to mysql database This will connect you to the MySQL database using the root user and the password we get from the mysql-cluster-auth secret.

Insert Sample Data

Now, we are going to insert some sample data to our MySQL database. To insert sample data into our MySQL database, we will create a new database Music in MySQL and then Verify it by executing the following commands,


create music database

Then we will create a new table in the “Music” database by executing the following commands, These commands creates a new table named “Artist” in the “Music” database, with three columns: “id”, “Name”, and “Song”. Also, we are going to insert some sample data into it.

mysql> INSERT INTO Music.Artist (Name, Song) VALUES ("John Denver", "Country Roads");

create table and insert data

Now,verify that the data has been inserted into the database by executing the following command:

mysql> SELECT * FROM Music.Artist;

verify the data

We’ve successfully inserted some sample data to our database. More information about Run & Manage Production-Grade MySQL Database on Kubernetes can be found HERE

If you want to learn more about Production-Grade MySQL in Kubernetes you can have a look into that playlist below:


To speak with us, please leave a message on our website .

To receive product announcements, follow us on Twitter .

To watch tutorials of various Production-Grade Kubernetes Tools Subscribe our YouTube channel.

More about MySQL in Kubernetes

If you have found a bug with KubeDB or want to request for new features, please file an issue .


Get Up and Running Quickly

Deploy, manage, upgrade Kubernetes on any cloud and automate deployment, scaling, and management of containerized applications.