Deploy and Manage Percona XtraDB in Amazon Elastic Kubernetes Service (Amazon EKS) Using KubeDB

Deploy and Manage Percona XtraDB in Amazon Elastic Kubernetes Service (Amazon EKS) Using KubeDB

AppsCode Inc. AppsCode Inc.

AppsCode Inc.

Cloud Native Data Platform

Published Nov 18, 2022
+ Follow

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 here . In this tutorial we will deploy and manage Percona XtraDB database in Amazon Elastic Kubernetes Service (Amazon EKS). We will cover the following steps:

  1. Install KubeDB
  2. Deploy Percona XtraDB Clustered Database
  3. Horizontal Scaling of Percona XtraDB Database
  4. Vertical Scaling of Percona XtraDB Database

Install KubeDB

We will follow the steps to install KubeDB.

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}'
debacab3-y89q-4168-ba24-e97a553dcfa4

Get License

Go to Appscode License Server to get the license.txt file. For this tutorial we will use KubeDB Enterprise Edition.

No alt text provided for this image

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                   	v2022.10.18  	v2022.10.18	KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler        	v0.14.0      	v0.14.0    	KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog           	v2022.10.18  	v2022.10.18	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              	v2022.10.18  	v2022.10.18	KubeDB Custom Resource Definitions                
appscode/kubedb-dashboard         	v0.5.0       	v0.5.0     	KubeDB Dashboard by AppsCode                      
appscode/kubedb-enterprise        	v0.11.2      	v0.11.2    	KubeDB Enterprise by AppsCode - Enterprise feat...
appscode/kubedb-grafana-dashboards	v2022.10.18  	v2022.10.18	A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-metrics           	v2022.10.18  	v2022.10.18	KubeDB State Metrics                              
appscode/kubedb-ops-manager       	v0.16.0      	v0.16.2    	KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter         	v2022.10.18  	v2022.10.18	KubeDB Opscenter by AppsCode                      
appscode/kubedb-provisioner       	v0.29.0      	v0.29.2    	KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager    	v0.5.0       	v0.5.0     	KubeDB Schema Manager by AppsCode                 
appscode/kubedb-ui                	v2022.06.14  	0.3.22     	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.5.0       	v0.5.0     	KubeDB Webhook Server by AppsCode 

# Install KubeDB Enterprise operator chart
$ helm install kubedb appscode/kubedb \
  --version v2022.10.18 \
  --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-8486d9954-p2kjd        1/1     Running   0          4m6s
kubedb      kubedb-kubedb-dashboard-7d8df6d5d6-mxjs6        1/1     Running   0          4m6s
kubedb      kubedb-kubedb-ops-manager-6bbcb4b77b-lh2db      1/1     Running   0          4m6s
kubedb      kubedb-kubedb-provisioner-575cb86d84-qqfch      1/1     Running   0          4m6s
kubedb      kubedb-kubedb-schema-manager-797cb7c485-fpff9   1/1     Running   0          4m6s
kubedb      kubedb-kubedb-webhook-server-5998fd668-wtwch    1/1     Running   0          4m6s

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   2022-11-15T10:47:33Z
elasticsearchdashboards.dashboard.kubedb.com      2022-11-15T10:47:32Z
elasticsearches.kubedb.com                        2022-11-15T10:47:33Z
elasticsearchopsrequests.ops.kubedb.com           2022-11-15T10:47:36Z
elasticsearchversions.catalog.kubedb.com          2022-11-15T10:35:35Z
etcds.kubedb.com                                  2022-11-15T10:47:36Z
etcdversions.catalog.kubedb.com                   2022-11-15T10:35:36Z
mariadbautoscalers.autoscaling.kubedb.com         2022-11-15T10:47:33Z
mariadbdatabases.schema.kubedb.com                2022-11-15T10:47:40Z
mariadbopsrequests.ops.kubedb.com                 2022-11-15T10:47:53Z
mariadbs.kubedb.com                               2022-11-15T10:47:37Z
mariadbversions.catalog.kubedb.com                2022-11-15T10:35:37Z
memcacheds.kubedb.com                             2022-11-15T10:47:37Z
memcachedversions.catalog.kubedb.com              2022-11-15T10:35:38Z
mongodbautoscalers.autoscaling.kubedb.com         2022-11-15T10:47:33Z
mongodbdatabases.schema.kubedb.com                2022-11-15T10:47:35Z
mongodbopsrequests.ops.kubedb.com                 2022-11-15T10:47:39Z
mongodbs.kubedb.com                               2022-11-15T10:47:36Z
mongodbversions.catalog.kubedb.com                2022-11-15T10:35:38Z
mysqlautoscalers.autoscaling.kubedb.com           2022-11-15T10:47:34Z
mysqldatabases.schema.kubedb.com                  2022-11-15T10:47:34Z
mysqlopsrequests.ops.kubedb.com                   2022-11-15T10:47:50Z
mysqls.kubedb.com                                 2022-11-15T10:47:34Z
mysqlversions.catalog.kubedb.com                  2022-11-15T10:35:40Z
perconaxtradbautoscalers.autoscaling.kubedb.com   2022-11-15T10:47:34Z
perconaxtradbopsrequests.ops.kubedb.com           2022-11-15T10:48:08Z
perconaxtradbs.kubedb.com                         2022-11-15T10:47:44Z
perconaxtradbversions.catalog.kubedb.com          2022-11-15T10:35:41Z
pgbouncers.kubedb.com                             2022-11-15T10:47:44Z
pgbouncerversions.catalog.kubedb.com              2022-11-15T10:35:41Z
postgresautoscalers.autoscaling.kubedb.com        2022-11-15T10:47:34Z
postgresdatabases.schema.kubedb.com               2022-11-15T10:47:38Z
postgreses.kubedb.com                             2022-11-15T10:47:38Z
postgresopsrequests.ops.kubedb.com                2022-11-15T10:48:01Z
postgresversions.catalog.kubedb.com               2022-11-15T10:35:42Z
proxysqlopsrequests.ops.kubedb.com                2022-11-15T10:48:05Z
proxysqls.kubedb.com                              2022-11-15T10:47:45Z
proxysqlversions.catalog.kubedb.com               2022-11-15T10:35:43Z
publishers.postgres.kubedb.com                    2022-11-15T10:48:14Z
redisautoscalers.autoscaling.kubedb.com           2022-11-15T10:47:34Z
redises.kubedb.com                                2022-11-15T10:47:46Z
redisopsrequests.ops.kubedb.com                   2022-11-15T10:47:57Z
redissentinelautoscalers.autoscaling.kubedb.com   2022-11-15T10:47:34Z
redissentinelopsrequests.ops.kubedb.com           2022-11-15T10:48:11Z
redissentinels.kubedb.com                         2022-11-15T10:47:46Z
redisversions.catalog.kubedb.com                  2022-11-15T10:35:44Z
subscribers.postgres.kubedb.com                   2022-11-15T10:48:18Z

Deploy Percona XtraDB Clustered Database

Now, we are going to Deploy Percona XtraDB with the help of KubeDB. First, let’s create a Namespace in which we will deploy the database.

$ kubectl create ns demo
namespace/demo created

Here is the yaml of the Percona XtraDB CRO we are going to use:

apiVersion: kubedb.com/v1alpha2
kind: PerconaXtraDB
metadata:
  name: percona-cluster
  namespace: demo
spec:
  version: "8.0.28"
  replicas: 3
  storageType: Durable
  storage:
    storageClassName: "gp2"
    accessModes:
    - ReadWriteOnce
    resources:
      requests:
        storage: 500Mi
  terminationPolicy: WipeOut

Let’s save this yaml configuration into percona-cluster.yaml Then create the above Percona XtraDB CRO

$ kubectl apply -f percona-cluster.yaml 
perconaxtradb.kubedb.com/percona-cluster created
  • In this yaml we can see in the spec.version field specifies the version of Percona XtraDB. Here, we are using Percona XtraDB version 8.0.28. You can list the KubeDB supported versions of Percona XtraDB by running $ kubectl get perconaxtradbversions command.
  • spec.storage 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 .

Once these are handled correctly and the Percona XtraDB object is deployed, you will see that the following objects are created:

$ kubectl get all -n demo
NAME                    READY   STATUS    RESTARTS   AGE
pod/percona-cluster-0   2/2     Running   0          4m34s
pod/percona-cluster-1   2/2     Running   0          4m34s
pod/percona-cluster-2   2/2     Running   0          4m34s

NAME                           TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)    AGE
service/percona-cluster        ClusterIP   10.100.22.202   <none>        3306/TCP   4m37s
service/percona-cluster-pods   ClusterIP   None            <none>        3306/TCP   4m37s

NAME                               READY   AGE
statefulset.apps/percona-cluster   3/3     4m41s

NAME                                                 TYPE                       VERSION   AGE
appbinding.appcatalog.appscode.com/percona-cluster   kubedb.com/perconaxtradb   8.0.28    4m44s

NAME                                       VERSION   STATUS   AGE
perconaxtradb.kubedb.com/percona-cluster   8.0.28    Ready    5m17s

Let’s check if the database is ready to use,

$ kubectl get perconaxtradb -n demo percona-cluster
NAME              VERSION   STATUS   AGE
percona-cluster   8.0.28    Ready    6m7s

We have successfully deployed Percona XtraDB in Amazon EKS. 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 the database percona-cluster that we have deployed. Let’s check them using the following commands,

$ kubectl get secret -n demo -l=app.kubernetes.io/instance=percona-cluster
NAME                          TYPE                       DATA   AGE
percona-cluster-auth          kubernetes.io/basic-auth   2      6m53s
percona-cluster-monitor       kubernetes.io/basic-auth   2      6m53s
percona-cluster-replication   kubernetes.io/basic-auth   2      6m53s


$ kubectl get service -n demo -l=app.kubernetes.io/instance=percona-cluster
NAME                   TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)    AGE
percona-cluster        ClusterIP   10.100.22.202   <none>        3306/TCP   7m26s
percona-cluster-pods   ClusterIP   None            <none>        3306/TCP   7m26s

Now, we are going to use percona-cluster-auth to get the credentials.

$ kubectl get secrets -n demo percona-cluster-auth -o jsonpath='{.data.username}' | base64 -d
root

$ kubectl get secrets -n demo percona-cluster-auth -o jsonpath='{.data.password}' | base64 -d
KWTPi3Dgibp(OsEU

Insert Sample Data

In this section, we are going to login into our Percona XtraDB database pod and insert some sample data.

$ kubectl exec -it percona-cluster-0 -n demo -c perconaxtradb -- bash
bash-4.4$ mysql --user=root --password='KWTPi3Dgibp(OsEU'
Welcome to the MySQL monitor.  Commands end with ; or \g.

Copyright (c) 2009-2022 Percona LLC and/or its affiliates
Copyright (c) 2000, 2022, Oracle and/or its affiliates.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> CREATE DATABASE Music;
Query OK, 1 row affected (0.01 sec)

mysql> SHOW DATABASES;
+--------------------+
| Database           |
+--------------------+
| Music              |
| information_schema |
| kubedb_system      |
| mysql              |
| performance_schema |
| sys                |
+--------------------+
6 rows in set (0.01 sec)

mysql> CREATE TABLE Music.Artist (id INT(6) UNSIGNED AUTO_INCREMENT PRIMARY KEY, Name VARCHAR(50), Song VARCHAR(25));
Query OK, 0 rows affected, 1 warning (0.03 sec)

mysql> INSERT INTO Music.Artist (Name, Song) VALUES ("Bobby Bare", "500 Miles Away From Home");
Query OK, 1 row affected (0.01 sec)

mysql> SELECT * FROM Music.Artist;
+----+------------+--------------------------+
| id | Name       | Song                     |
+----+------------+--------------------------+
|  1 | Bobby Bare | 500 Miles Away From Home |
+----+------------+--------------------------+
1 row in set (0.00 sec)

mysql> exit
Bye

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

Horizontal Scaling of Percona XtraDB Cluster

Scale Up Replicas

Here, we are going to scale up the replicas of the Percona XtraDB 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 perconaxtradb -n demo percona-cluster -o json | jq '.spec.replicas'
3

Let’s connect to a Percona XtraDB instance and run this command to check the number of replicas,

$ kubectl exec -it percona-cluster-0 -n demo -c perconaxtradb -- bash
bash-4.4$ mysql --user=root --password='KWTPi3Dgibp(OsEU'
Welcome to the MySQL monitor.  Commands end with ; or \g.

Copyright (c) 2009-2022 Percona LLC and/or its affiliates
Copyright (c) 2000, 2022, Oracle and/or its affiliates.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> SHOW STATUS LIKE 'wsrep_cluster_size';
+--------------------+-------+
| Variable_name      | Value |
+--------------------+-------+
| wsrep_cluster_size | 3     |
+--------------------+-------+
1 row in set (0.00 sec)

mysql> exit
Bye

Create PerconaXtraDBOpsRequest

In order to scale up the replicas of the replicaset of the database, we have to create a PerconaXtraDBOpsRequest CR with our desired replicas. Let’s create it using this following yaml,

apiVersion: ops.kubedb.com/v1alpha1
kind: PerconaXtraDBOpsRequest
metadata:
  name: horizontal-scale-up
  namespace: demo
spec:
  type: HorizontalScaling
  databaseRef:
    name: percona-cluster
  horizontalScaling:
    member : 5

Here,

  • spec.databaseRef.name specifies that we are performing horizontal scaling operation on percona-cluster database.
  • spec.type specifies that we are performing HorizontalScaling on our database.
  • spec.horizontalScaling.member specifies 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 
perconaxtradbopsrequest.ops.kubedb.com/horizontal-scale-up created

Let’s wait for PerconaXtraDBOpsRequest STATUS to be Successful. Run the following command to watch PerconaXtraDBOpsRequest CR,

$ watch kubectl get perconaxtradbopsrequest -n demo
NAME                  TYPE                STATUS       AGE
horizontal-scale-up   HorizontalScaling   Successful   2m41s

We can see from the above output that the PerconaXtraDBOpsRequest has succeeded. Now, we are going to verify the number of replicas,

$ kubectl get perconaxtradb -n demo percona-cluster -o json | jq '.spec.replicas'
5

Let’s connect to a Percona XtraDB instance and run this command to check the number of replicas,

$ kubectl exec -it percona-cluster-0 -n demo -c perconaxtradb -- bash
bash-4.4$ mysql --user=root --password='KWTPi3Dgibp(OsEU'
Welcome to the MySQL monitor.  Commands end with ; or \g.

Copyright (c) 2009-2022 Percona LLC and/or its affiliates
Copyright (c) 2000, 2022, Oracle and/or its affiliates.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> SHOW STATUS LIKE 'wsrep_cluster_size';
+--------------------+-------+
| Variable_name      | Value |
+--------------------+-------+
| wsrep_cluster_size | 5     |
+--------------------+-------+
1 row in set (0.00 sec)

mysql> exit
Bye

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 Percona XtraDB replicaset.

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 PerconaXtraDBOpsRequest

In order to scale down the cluster of the database, we need to create a PerconaXtraDBOpsRequest CR with our desired replicas. Let’s create it using this following yaml,

apiVersion: ops.kubedb.com/v1alpha1
kind: PerconaXtraDBOpsRequest
metadata:
  name: horizontal-scale-down
  namespace: demo
spec:
  type: HorizontalScaling
  databaseRef:
    name: percona-cluster
  horizontalScaling:
    member : 3

Here,

  • spec.databaseRef.name specifies that we are performing horizontal scaling operation on percona-cluster database.
  • spec.type specifies that we are performing HorizontalScaling on our database.
  • spec.horizontalScaling.member specifies 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
perconaxtradbopsrequest.ops.kubedb.com/horizontal-scale-down created

Let’s wait for PerconaXtraDBOpsRequest STATUS to be Successful. Run the following command to watch PerconaXtraDBOpsRequest CR,

$ watch kubectl get perconaxtradbopsrequest -n demo
NAME                    TYPE                STATUS       AGE
horizontal-scale-down   HorizontalScaling   Successful   2m6s

We can see from the above output that the PerconaXtraDBOpsRequest has succeeded. Now, we are going to verify the number of replicas,

$ kubectl get perconaxtradb -n demo percona-cluster -o json | jq '.spec.replicas'
3

Let’s connect to a Percona XtraDB instance and run this command to check the number of replicas,

$ kubectl exec -it percona-cluster-0 -n demo -c perconaxtradb -- bash
bash-4.4$ mysql --user=root --password='KWTPi3Dgibp(OsEU'
Welcome to the MySQL monitor.  Commands end with ; or \g.

Copyright (c) 2009-2022 Percona LLC and/or its affiliates
Copyright (c) 2000, 2022, Oracle and/or its affiliates.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> SHOW STATUS LIKE 'wsrep_cluster_size';
+--------------------+-------+
| Variable_name      | Value |
+--------------------+-------+
| wsrep_cluster_size | 3     |
+--------------------+-------+
1 row in set (0.00 sec)

mysql> exit
Bye

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 Percona XtraDB replicaset.

Vetical Scaling of Percona XtraDB Cluster

Here, we are going to scale up the current cpu resource of the Percona XtraDB cluster by applying Vertical Scaling. Before applying it, let’s check the current resources,

$ kubectl get pod -n demo percona-cluster-0 -o json | jq '.spec.containers[].resources'
{
  "limits": {
    "memory": "1Gi"
  },
  "requests": {
    "cpu": "500m",
    "memory": "1Gi"
  }
}

Create PerconaXtraDBOpsRequest

In order to update the resources of the database, we have to create a PerconaXtraDBOpsRequest CR with our desired resources. Let’s create it using this following yaml,

apiVersion: ops.kubedb.com/v1alpha1
kind: PerconaXtraDBOpsRequest
metadata:
  name: vertical-scale
  namespace: demo
spec:
  type: VerticalScaling
  databaseRef:
    name: percona-cluster
  verticalScaling:
    perconaxtradb:
      requests:
        memory: "1.5Gi"
        cpu: "0.7"
      limits:
        memory: "1.5Gi"
        cpu: "0.7"

Here,

  • spec.databaseRef.name specifies that we are performing vertical scaling operation on percona-cluster database.
  • spec.type specifies that we are performing VerticalScaling on our database.
  • spec.VerticalScaling.perconaxtradb specifies the desired resources after scaling.

Let’s save this yaml configuration into vertical-scale.yaml and apply it,

$ kubectl apply -f vertical-scale.yaml 
perconaxtradbopsrequest.ops.kubedb.com/vertical-scale created

Let’s wait for PerconaXtraDBOpsRequest STATUS to be Successful. Run the following command to watch PerconaXtraDBOpsRequest CR,

$ kubectl get perconaxtradbopsrequest -n demo
NAME                    TYPE                STATUS       AGE
vertical-scale          VerticalScaling     Successful   3m

We can see from the above output that the PerconaXtraDBOpsRequest has succeeded. Now, we are going to verify from one of the Pod yaml whether the resources of the database has updated to meet up the desired state. Let’s check with the following command,

$ kubectl get pod -n demo percona-cluster-0 -o json | jq '.spec.containers[].resources'
{
  "limits": {
    "cpu": "700m",
    "memory": "1536Mi"
  },
  "requests": {
    "cpu": "700m",
    "memory": "1536Mi"
  }
}

The above output verifies that we have successfully scaled up the resources of the Percona XtraDB database.

We have made an in depth tutorial on Managing Percona XtraDB Cluster Day-2 Operations by 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 Percona XtraDB in Kubernetes

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

PS: This article was initially published on ByteBuilders Blog


To view or add a comment, sign in

More articles by this author

Others also viewed

Explore topics