Overview
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 and manage ProxySQL in Google Kubernetes Engine (GKE). We will cover the following steps:
- Install KubeDB
- Deploy MySQL Group Replication
- Deploy ProxySQL Cluster
- Read/Write through ProxySQL
- Horizontal Scaling of ProxySQL
Get Cluster ID
We need the cluster ID to get the KubeDB License. To get cluster ID we can run the following command:
$ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'
fc435a61-c74b-9243-83a5-f1110ef2462c
Get License
Go to Appscode License Server to get the license.txt file. For this tutorial we will use KubeDB Enterprise Edition.
Install KubeDB
We will use helm to install KubeDB. Please install helm here
if it is not already installed.
Now, let’s install KubeDB.
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search repo appscode/kubedb
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb v2023.04.10 v2023.04.10 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler v0.18.0 v0.18.0 KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog v2023.04.10 v2023.04.10 KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-community v0.24.2 v0.24.2 KubeDB Community by AppsCode - Community featur...
appscode/kubedb-crds v2023.04.10 v2023.04.10 KubeDB Custom Resource Definitions
appscode/kubedb-dashboard v0.9.0 v0.9.0 KubeDB Dashboard by AppsCode
appscode/kubedb-enterprise v0.11.2 v0.11.2 KubeDB Enterprise by AppsCode - Enterprise feat...
appscode/kubedb-grafana-dashboards v2023.04.10 v2023.04.10 A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-metrics v2023.04.10 v2023.04.10 KubeDB State Metrics
appscode/kubedb-one v2023.04.10 v2023.04.10 KubeDB and Stash by AppsCode - Production ready...
appscode/kubedb-ops-manager v0.20.0 v0.20.1 KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter v2023.04.10 v2023.04.10 KubeDB Opscenter by AppsCode
appscode/kubedb-provisioner v0.33.0 v0.33.1 KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager v0.9.0 v0.9.0 KubeDB Schema Manager by AppsCode
appscode/kubedb-ui v2023.03.23 0.3.28 A Helm chart for Kubernetes
appscode/kubedb-ui-server v2021.12.21 v2021.12.21 A Helm chart for kubedb-ui-server by AppsCode
appscode/kubedb-webhook-server v0.9.0 v0.9.0 KubeDB Webhook Server by AppsCode
# Install KubeDB Enterprise operator chart
$ helm install kubedb appscode/kubedb \
--version v2023.04.10 \
--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=/path/to/the/license.txt
Let’s verify the installation:
$ watch kubectl get pods --all-namespaces -l "app.kubernetes.io/instance=kubedb"
NAMESPACE NAME READY STATUS RESTARTS AGE
kubedb kubedb-kubedb-autoscaler-8b8544586-l5f58 1/1 Running 0 4m39s
kubedb kubedb-kubedb-dashboard-55f7bf58cc-7brgw 1/1 Running 0 4m40s
kubedb kubedb-kubedb-ops-manager-6668bb8b54-x2v4s 1/1 Running 0 4m40s
kubedb kubedb-kubedb-provisioner-56c97f6d86-dl9mb 1/1 Running 0 4m40s
kubedb kubedb-kubedb-schema-manager-584d784bf4-8kcmp 1/1 Running 0 4m40s
kubedb kubedb-kubedb-webhook-server-756dbbf799-tx66m 1/1 Running 0 4m40s
We can list the CRD Groups that have been registered by the operator by running the following command:
$ kubectl get crd -l app.kubernetes.io/name=kubedb
NAME CREATED AT
elasticsearchautoscalers.autoscaling.kubedb.com 2023-04-28T05:31:44Z
elasticsearchdashboards.dashboard.kubedb.com 2023-04-28T05:31:45Z
elasticsearches.kubedb.com 2023-04-28T05:31:46Z
elasticsearchopsrequests.ops.kubedb.com 2023-04-28T05:32:39Z
elasticsearchversions.catalog.kubedb.com 2023-04-28T05:29:14Z
etcds.kubedb.com 2023-04-28T05:31:48Z
etcdversions.catalog.kubedb.com 2023-04-28T05:29:15Z
kafkas.kubedb.com 2023-04-28T05:32:38Z
kafkaversions.catalog.kubedb.com 2023-04-28T05:29:15Z
mariadbautoscalers.autoscaling.kubedb.com 2023-04-28T05:31:45Z
mariadbdatabases.schema.kubedb.com 2023-04-28T05:31:59Z
mariadbopsrequests.ops.kubedb.com 2023-04-28T05:34:50Z
mariadbs.kubedb.com 2023-04-28T05:31:58Z
mariadbversions.catalog.kubedb.com 2023-04-28T05:29:15Z
memcacheds.kubedb.com 2023-04-28T05:31:59Z
memcachedversions.catalog.kubedb.com 2023-04-28T05:29:16Z
mongodbautoscalers.autoscaling.kubedb.com 2023-04-28T05:31:45Z
mongodbdatabases.schema.kubedb.com 2023-04-28T05:31:42Z
mongodbopsrequests.ops.kubedb.com 2023-04-28T05:32:42Z
mongodbs.kubedb.com 2023-04-28T05:31:44Z
mongodbversions.catalog.kubedb.com 2023-04-28T05:29:16Z
mysqlautoscalers.autoscaling.kubedb.com 2023-04-28T05:31:46Z
mysqldatabases.schema.kubedb.com 2023-04-28T05:31:40Z
mysqlopsrequests.ops.kubedb.com 2023-04-28T05:33:00Z
mysqls.kubedb.com 2023-04-28T05:31:41Z
mysqlversions.catalog.kubedb.com 2023-04-28T05:29:16Z
perconaxtradbautoscalers.autoscaling.kubedb.com 2023-04-28T05:31:47Z
perconaxtradbopsrequests.ops.kubedb.com 2023-04-28T05:35:40Z
perconaxtradbs.kubedb.com 2023-04-28T05:32:24Z
perconaxtradbversions.catalog.kubedb.com 2023-04-28T05:29:17Z
pgbouncers.kubedb.com 2023-04-28T05:32:25Z
pgbouncerversions.catalog.kubedb.com 2023-04-28T05:29:17Z
postgresautoscalers.autoscaling.kubedb.com 2023-04-28T05:31:48Z
postgresdatabases.schema.kubedb.com 2023-04-28T05:31:47Z
postgreses.kubedb.com 2023-04-28T05:31:48Z
postgresopsrequests.ops.kubedb.com 2023-04-28T05:35:33Z
postgresversions.catalog.kubedb.com 2023-04-28T05:29:17Z
proxysqlautoscalers.autoscaling.kubedb.com 2023-04-28T05:31:58Z
proxysqlopsrequests.ops.kubedb.com 2023-04-28T05:35:37Z
proxysqls.kubedb.com 2023-04-28T05:32:32Z
proxysqlversions.catalog.kubedb.com 2023-04-28T05:29:18Z
publishers.postgres.kubedb.com 2023-04-28T05:35:50Z
redisautoscalers.autoscaling.kubedb.com 2023-04-28T05:31:58Z
redises.kubedb.com 2023-04-28T05:32:33Z
redisopsrequests.ops.kubedb.com 2023-04-28T05:34:53Z
redissentinelautoscalers.autoscaling.kubedb.com 2023-04-28T05:32:00Z
redissentinelopsrequests.ops.kubedb.com 2023-04-28T05:35:44Z
redissentinels.kubedb.com 2023-04-28T05:32:38Z
redisversions.catalog.kubedb.com 2023-04-28T05:29:18Z
subscribers.postgres.kubedb.com 2023-04-28T05:35:54Z
Deploy MySQL Group Replication
Now, we are going to Deploy MySQL Group Replication using KubeDB. First, let’s create a Namespace in which we will deploy the server.
$ kubectl create namespace demo
namespace/demo created
Here, is the yaml of the MySQL CRO we are going to use:
apiVersion: kubedb.com/v1alpha2
kind: MySQL
metadata:
name: mysql-server
namespace: demo
spec:
version: "8.0.32"
replicas: 3
topology:
mode: GroupReplication
storageType: Durable
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
podTemplate:
spec:
resources:
requests:
memory: "512Mi"
cpu: "500m"
limits:
memory: "1Gi"
cpu: "700m"
terminationPolicy: WipeOut
Let’s save this yaml configuration into mysql-server.yaml
Then create the above MySQL CRO
$ kubectl apply -f mysql-server.yaml
mysql.kubedb.com/mysql-server created
In this yaml,
spec.versionfield specifies the version of MySQL. Here, we are using MySQLversion 8.0.32. You can list the KubeDB supported versions of MySQL by running$ kubectl get mysqlversionscommand.spec.topologycontains the information of clustering configuration for MySQL.spec.storagespecifies 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.terminationPolicyfield is Wipeout means that the database will be deleted without restrictions. It can also be “Halt”, “Delete” and “DoNotTerminate”. Learn More about these HERE .
Let’s check if the server is ready to use,
$ kubectl get mysql -n demo mysql-server
NAME VERSION STATUS AGE
mysql-server 8.0.32 Ready 2m46s
Deploy ProxySQL Cluster
We are going to Deploy ProxySQL cluster using KubeDB. Here, is the yaml of the ProxySQL CRO we are going to use:
apiVersion: kubedb.com/v1alpha2
kind: ProxySQL
metadata:
name: proxy-server
namespace: demo
spec:
version: "2.4.4-debian"
replicas: 3
mode: GroupReplication
backend:
name: mysql-server
podTemplate:
spec:
resources:
requests:
memory: "512Mi"
cpu: "500m"
limits:
memory: "1Gi"
cpu: "700m"
syncUsers: true
terminationPolicy: WipeOut
Let’s save this yaml configuration into proxy-server.yaml
Then create the above ProxySQL CRO
$ kubectl apply -f proxy-server.yaml
proxysql.kubedb.com/proxy-server created
In this yaml,
spec.versionfield specifies the version of ProxySQL. Here, we are using ProxySQL2.4.4-debian. You can list the KubeDB supported versions of ProxySQL by running$ kubectl get proxysqlversionscommand.spec.backend.namecontains the name of MySQL server backend which ismysql-serverin this case.spec.syncUsersconfirms that the ProxySQL will sync it’s user list with MySQL server or not.- And the
spec.terminationPolicyfield is Wipeout means that the database will be deleted without restrictions. It can also be “Halt”, “Delete” and “DoNotTerminate”.
Let’s check if the server is ready to use,
$ kubectl get proxysql -n demo proxy-server
NAME VERSION STATUS AGE
proxy-server 2.4.4-debian Ready 3m34s
Once all of the above things are handled correctly then you will see that the following objects are created:
$ kubectl get all -n demo
NAME READY STATUS RESTARTS AGE
pod/mysql-server-0 2/2 Running 0 7m46s
pod/mysql-server-1 2/2 Running 0 7m31s
pod/mysql-server-2 2/2 Running 0 7m11s
pod/proxy-server-0 1/1 Running 0 4m1s
pod/proxy-server-1 1/1 Running 0 3m2s
pod/proxy-server-2 1/1 Running 0 2m11s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/mysql-server ClusterIP 10.8.11.177 <none> 3306/TCP 7m49s
service/mysql-server-pods ClusterIP None <none> 3306/TCP 7m49s
service/mysql-server-standby ClusterIP 10.8.9.165 <none> 3306/TCP 7m49s
service/proxy-server ClusterIP 10.8.13.150 <none> 6033/TCP 4m3s
service/proxy-server-pods ClusterIP None <none> 6032/TCP,6033/TCP 4m4s
NAME READY AGE
statefulset.apps/mysql-server 3/3 7m52s
statefulset.apps/proxy-server 3/3 4m7s
NAME TYPE VERSION AGE
appbinding.appcatalog.appscode.com/mysql-server kubedb.com/mysql 8.0.32 7m56s
NAME VERSION STATUS AGE
mysql.kubedb.com/mysql-server 8.0.32 Ready 8m11s
NAME VERSION STATUS AGE
proxysql.kubedb.com/proxy-server 2.4.4-debian Ready 4m29s
We have successfully deployed ProxySQL in GKE. Now, we can exec into the container to use the database.
Accessing Database Through CLI
To access the database through CLI, we have to get the credentials to access.
KubeDB will create Secret and Service for mysql-server that we have deployed. Let’s check them using the following commands,
$ kubectl get secret -n demo -l=app.kubernetes.io/instance=mysql-server
NAME TYPE DATA AGE
mysql-server-auth kubernetes.io/basic-auth 2 8m46s
$ kubectl get service -n demo -l=app.kubernetes.io/instance=mysql-server
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
mysql-server ClusterIP 10.8.11.177 <none> 3306/TCP 9m
mysql-server-pods ClusterIP None <none> 3306/TCP 9m
mysql-server-standby ClusterIP 10.8.9.165 <none> 3306/TCP 9m
Now, we are going to use mysql-server-auth to get the credentials.
$ kubectl get secrets -n demo mysql-server-auth -o jsonpath='{.data.username}' | base64 -d
root
$ kubectl get secrets -n demo mysql-server-auth -o jsonpath='{.data.password}' | base64 -d
FtJEoYURsZJhQx*G
Insert Sample Data
Now, let’s exec to the ProxySQL Pod to enter into MySQL server using MySQL user credentials to write and read some sample data to the database,
$ kubectl exec -it proxy-server-0 -n demo -- bash
root@proxy-server-0:/# mysql --user=root --password='FtJEoYURsZJhQx*G' --host 127.0.0.1 --port=6033
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
MySQL [(none)]> CREATE DATABASE Music;
Query OK, 1 row affected (0.035 sec)
MySQL [(none)]> SHOW DATABASES;
+--------------------+
| Database |
+--------------------+
| Music |
| information_schema |
| kubedb_system |
| mysql |
| performance_schema |
| sys |
+--------------------+
6 rows in set (0.004 sec)
MySQL [(none)]> CREATE TABLE Music.Artist (id INT(6) UNSIGNED AUTO_INCREMENT PRIMARY KEY, Name VARCHAR(50), Song VARCHAR(50));
Query OK, 0 rows affected, 1 warning (0.049 sec)
MySQL [(none)]> INSERT INTO Music.Artist (Name, Song) VALUES ("Bobby Bare", "Five Hundred Miles");
Query OK, 1 row affected (0.010 sec)
MySQL [(none)]> SELECT * FROM Music.Artist;
+----+------------+--------------------+
| id | Name | Song |
+----+------------+--------------------+
| 1 | Bobby Bare | Five Hundred Miles |
+----+------------+--------------------+
1 row in set (0.009 sec)
MySQL [(none)]> exit
Bye
root@proxy-server-0:/# exit
exit
We’ve successfully inserted some sample data to our database. Click Run & Manage Production-Grade ProxySQL on Kubernetes for more detailed information.
Horizontal Scaling of ProxySQL Cluster
Scale Up Replicas
Here, we are going to scale up the replicas of the ProxySQL cluster replicaset to meet the desired number of replicas after scaling.
Before applying Horizontal Scaling, let’s check the current number of replicas,
$ kubectl get proxysql -n demo proxy-server -o json | jq '.spec.replicas'
3
Let’s connect to a ProxySQL instance and run this command to check the number of replicas,
$ kubectl exec -it proxy-server-0 -n demo -- bash
root@proxy-server-0:/# mysql -uadmin -padmin --host 127.0.0.1 --port=6032
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
MySQL [(none)]> SELECT * FROM proxysql_servers;
+---------------------------------------+------+--------+---------+
| hostname | port | weight | comment |
+---------------------------------------+------+--------+---------+
| proxy-server-0.proxy-server-pods.demo | 6032 | 1 | |
| proxy-server-1.proxy-server-pods.demo | 6032 | 1 | |
| proxy-server-2.proxy-server-pods.demo | 6032 | 1 | |
+---------------------------------------+------+--------+---------+
3 rows in set (0.002 sec)
MySQL [(none)]> exit
Bye
Create ProxySQLOpsRequest
In order to scale up the replicas of the replicaset of the database, we have to create a ProxySQLOpsRequest CR with our desired replicas. Let’s create it using this following yaml,
apiVersion: ops.kubedb.com/v1alpha1
kind: ProxySQLOpsRequest
metadata:
name: horizontal-scale-up
namespace: demo
spec:
type: HorizontalScaling
proxyRef:
name: proxy-server
horizontalScaling:
member: 5
Here,
spec.proxyref.namespecifies that we are performing horizontal scaling operation onproxy-server.spec.typespecifies that we are performingHorizontalScalingon our ProxySQL.spec.horizontalScaling.memberspecifies the desired replicas after scaling.
Let’s save this yaml configuration into horizontal-scale-up.yaml and apply it,
$ kubectl apply -f horizontal-scale-up.yaml
proxysqlopsrequest.ops.kubedb.com/horizontal-scale-up created
Let’s wait for ProxySQLOpsRequest STATUS to be Successful. Run the following command to watch ProxySQLOpsRequest CR,
$ watch kubectl get proxysqlopsrequest -n demo
NAME TYPE STATUS AGE
horizontal-scale-up HorizontalScaling Successful 68s
We can see from the above output that the ProxySQLOpsRequest has succeeded. Now, we are going to verify the number of replicas,
$ kubectl get proxysql -n demo proxy-server -o json | jq '.spec.replicas'
5
Let’s connect to a ProxySQL instance and run this command to check the number of replicas,
$ kubectl exec -it proxy-server-0 -n demo -- bash
root@proxy-server-0:/# mysql -uadmin -padmin --host 127.0.0.1 --port=6032
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
MySQL [(none)]> SELECT * FROM proxysql_servers;
+---------------------------------------+------+--------+---------+
| hostname | port | weight | comment |
+---------------------------------------+------+--------+---------+
| proxy-server-0.proxy-server-pods.demo | 6032 | 1 | |
| proxy-server-1.proxy-server-pods.demo | 6032 | 1 | |
| proxy-server-2.proxy-server-pods.demo | 6032 | 1 | |
| proxy-server-3.proxy-server-pods.demo | 6032 | 1 | |
| proxy-server-4.proxy-server-pods.demo | 6032 | 1 | |
+---------------------------------------+------+--------+---------+
5 rows in set (0.002 sec)
MySQL [(none)]> exit
Bye
root@proxy-server-0:/# exit
exit
From all the above outputs we can see that the replicas of the cluster is now increased to 5. That means we have successfully scaled up the replicas of the ProxySQL cluster.
Scale Down Replicas
Here, we are going to scale down the replicas of the cluster to meet the desired number of replicas after scaling.
Create ProxySQLOpsRequest
In order to scale down the cluster of the database, we need to create a ProxySQLOpsRequest CR with our desired replicas. Let’s create it using this following yaml,
apiVersion: ops.kubedb.com/v1alpha1
kind: ProxySQLOpsRequest
metadata:
name: horizontal-scale-down
namespace: demo
spec:
type: HorizontalScaling
proxyRef:
name: proxy-server
horizontalScaling:
member: 3
Here,
spec.databaseRef.namespecifies that we are performing horizontal scaling operation onproxy-server.spec.typespecifies that we are performingHorizontalScalingon our ProxySQL.spec.horizontalScaling.memberspecifies the desired replicas after scaling.
Let’s save this yaml configuration into horizontal-scale-down.yaml and apply it,
$ kubectl apply -f horizontal-scale-down.yaml
proxysqlopsrequest.ops.kubedb.com/horizontal-scale-down created
Let’s wait for ProxySQLOpsRequest STATUS to be Successful. Run the following command to watch ProxySQLOpsRequest CR,
$ watch kubectl get proxysqlopsrequest -n demo
NAME TYPE STATUS AGE
horizontal-scale-down HorizontalScaling Successful 51s
We can see from the above output that the ProxySQLOpsRequest has succeeded. Now, we are going to verify the number of replicas,
$ kubectl get proxysql -n demo proxy-server -o json | jq '.spec.replicas'
3
Let’s connect to a ProxySQL instance and run this command to check the number of replicas,
$ kubectl exec -it proxy-server-0 -n demo -- bash
root@proxy-server-0:/# mysql -uadmin -padmin --host 127.0.0.1 --port=6032
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
MySQL [(none)]> SELECT * FROM proxysql_servers;
+---------------------------------------+------+--------+---------+
| hostname | port | weight | comment |
+---------------------------------------+------+--------+---------+
| proxy-server-0.proxy-server-pods.demo | 6032 | 1 | |
| proxy-server-1.proxy-server-pods.demo | 6032 | 1 | |
| proxy-server-2.proxy-server-pods.demo | 6032 | 1 | |
+---------------------------------------+------+--------+---------+
3 rows in set (0.002 sec)
MySQL [(none)]> exit
Bye
root@proxy-server-0:/# exit
exit
From all the above outputs we can see that the replicas of the cluster is decreased to 3. That means we have successfully scaled down the replicas of the ProxySQL cluster.
We have made an in depth tutorial on ProxySQL Declarative Provisioning, Reconfiguration and Horizontal Scaling using KubeDB. You can have a look into the video below:
Support
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 ProxySQL in Kubernetes
If you have found a bug with KubeDB or want to request for new features, please file an issue .