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 supported by KubeDB include MongoDB, Elasticsearch, MySQL, MariaDB, Redis, PostgreSQL, Solr, Microsoft SQL Server, Druid, FerretDB, SingleStore, Percona XtraDB, and Memcached. Additionally, KubeDB also supports ProxySQL, PgBouncer, Pgpool, ZooKeeper and the streaming platform Kafka, RabbitMQ. You can find the guides to all the supported databases in KubeDB . In this tutorial we will deploy Memcached in Google Kubernetes Engine (GKE) Using KubeDB. We will cover the following steps:
- Install KubeDB
- Deploy Memcached
- Read/Write Sample Data
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}'
8e336615-0dbb-4ae8-b72f-2e7ec34c399d
Get License
Go to Appscode License Server to get the license.txt file. For this tutorial we will use KubeDB.
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 search repo appscode/kubedb
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb v2024.8.21 v2024.8.21 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler v0.32.0 v0.32.0 KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog v2024.8.21 v2024.8.21 KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-community v0.24.2 v0.24.2 KubeDB Community by AppsCode - Community featur...
appscode/kubedb-crd-manager v0.2.0 v0.2.0 KubeDB CRD Manager by AppsCode
appscode/kubedb-crds v2024.8.21 v2024.8.21 KubeDB Custom Resource Definitions
appscode/kubedb-dashboard v0.23.0 v0.23.0 KubeDB Dashboard by AppsCode
appscode/kubedb-enterprise v0.11.2 v0.11.2 KubeDB Enterprise by AppsCode - Enterprise feat...
appscode/kubedb-grafana-dashboards v2024.8.21 v2024.8.21 A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-kubestash-catalog v2024.8.21 v2024.8.21 KubeStash Catalog by AppsCode - Catalog of Kube...
appscode/kubedb-metrics v2024.8.21 v2024.8.21 KubeDB State Metrics
appscode/kubedb-one v2023.12.28 v2023.12.28 KubeDB and Stash by AppsCode - Production ready...
appscode/kubedb-ops-manager v0.34.0 v0.34.0 KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter v2024.8.21 v2024.8.21 KubeDB Opscenter by AppsCode
appscode/kubedb-provider-aws v2024.8.21 v0.9.0 A Helm chart for KubeDB AWS Provider for Crossp...
appscode/kubedb-provider-azure v2024.8.21 v0.9.0 A Helm chart for KubeDB Azure Provider for Cros...
appscode/kubedb-provider-gcp v2024.8.21 v0.9.0 A Helm chart for KubeDB GCP Provider for Crossp...
appscode/kubedb-provisioner v0.47.0 v0.47.0 KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager v0.23.0 v0.23.0 KubeDB Schema Manager by AppsCode
appscode/kubedb-ui v2024.8.21 0.7.5 A Helm chart for Kubernetes
appscode/kubedb-ui-presets v2024.8.21 v2024.8.21 KubeDB UI Presets
appscode/kubedb-ui-server v2021.12.21 v2021.12.21 A Helm chart for kubedb-ui-server by AppsCode
appscode/kubedb-webhook-server v0.23.0 v0.23.0 KubeDB Webhook Server by AppsCode
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2024.8.21 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt \
--set global.featureGates.Memcached=true \
--wait --burst-limit=10000 --debug
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-55848f86c-shwqw 1/1 Running 0 2m37s
kubedb kubedb-kubedb-ops-manager-6bdcfc6885-gdswn 1/1 Running 0 2m37s
kubedb kubedb-kubedb-provisioner-85bcc99f57-p7sn4 1/1 Running 0 2m37s
kubedb kubedb-kubedb-webhook-server-7d7887799b-9bcht 1/1 Running 0 2m37s
kubedb kubedb-petset-operator-77b6b9897f-72rnk 1/1 Running 0 2m37s
kubedb kubedb-petset-webhook-server-7679665d78-vlzcq 2/2 Running 0 2m37s
kubedb kubedb-sidekick-c898cff4c-928pp 1/1 Running 0 2m37s
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
clickhouseversions.catalog.kubedb.com 2024-09-05T10:10:29Z
connectclusters.kafka.kubedb.com 2024-09-05T10:11:03Z
connectors.kafka.kubedb.com 2024-09-05T10:11:03Z
druidversions.catalog.kubedb.com 2024-09-05T10:10:29Z
elasticsearchautoscalers.autoscaling.kubedb.com 2024-09-05T10:11:00Z
elasticsearchdashboards.elasticsearch.kubedb.com 2024-09-05T10:11:00Z
elasticsearches.kubedb.com 2024-09-05T10:11:00Z
elasticsearchopsrequests.ops.kubedb.com 2024-09-05T10:11:00Z
elasticsearchversions.catalog.kubedb.com 2024-09-05T10:10:29Z
etcdversions.catalog.kubedb.com 2024-09-05T10:10:29Z
ferretdbversions.catalog.kubedb.com 2024-09-05T10:10:29Z
kafkaautoscalers.autoscaling.kubedb.com 2024-09-05T10:11:04Z
kafkaconnectorversions.catalog.kubedb.com 2024-09-05T10:10:29Z
kafkaopsrequests.ops.kubedb.com 2024-09-05T10:11:04Z
kafkas.kubedb.com 2024-09-05T10:11:03Z
kafkaversions.catalog.kubedb.com 2024-09-05T10:10:29Z
mariadbarchivers.archiver.kubedb.com 2024-09-05T10:11:07Z
mariadbautoscalers.autoscaling.kubedb.com 2024-09-05T10:11:07Z
mariadbdatabases.schema.kubedb.com 2024-09-05T10:11:07Z
mariadbopsrequests.ops.kubedb.com 2024-09-05T10:11:07Z
mariadbs.kubedb.com 2024-09-05T10:11:07Z
mariadbversions.catalog.kubedb.com 2024-09-05T10:10:29Z
memcachedautoscalers.autoscaling.kubedb.com 2024-09-05T10:11:10Z
memcachedopsrequests.ops.kubedb.com 2024-09-05T10:11:10Z
memcacheds.kubedb.com 2024-09-05T10:11:10Z
memcachedversions.catalog.kubedb.com 2024-09-05T10:10:29Z
mongodbarchivers.archiver.kubedb.com 2024-09-05T10:11:14Z
mongodbautoscalers.autoscaling.kubedb.com 2024-09-05T10:11:14Z
mongodbdatabases.schema.kubedb.com 2024-09-05T10:11:14Z
mongodbopsrequests.ops.kubedb.com 2024-09-05T10:11:14Z
mongodbs.kubedb.com 2024-09-05T10:11:13Z
mongodbversions.catalog.kubedb.com 2024-09-05T10:10:29Z
mssqlserverversions.catalog.kubedb.com 2024-09-05T10:10:29Z
mysqlarchivers.archiver.kubedb.com 2024-09-05T10:11:17Z
mysqlautoscalers.autoscaling.kubedb.com 2024-09-05T10:11:17Z
mysqldatabases.schema.kubedb.com 2024-09-05T10:11:17Z
mysqlopsrequests.ops.kubedb.com 2024-09-05T10:11:17Z
mysqls.kubedb.com 2024-09-05T10:11:17Z
mysqlversions.catalog.kubedb.com 2024-09-05T10:10:29Z
perconaxtradbversions.catalog.kubedb.com 2024-09-05T10:10:29Z
pgbouncerversions.catalog.kubedb.com 2024-09-05T10:10:29Z
pgpoolversions.catalog.kubedb.com 2024-09-05T10:10:29Z
postgresarchivers.archiver.kubedb.com 2024-09-05T10:11:21Z
postgresautoscalers.autoscaling.kubedb.com 2024-09-05T10:11:21Z
postgresdatabases.schema.kubedb.com 2024-09-05T10:11:21Z
postgreses.kubedb.com 2024-09-05T10:11:21Z
postgresopsrequests.ops.kubedb.com 2024-09-05T10:11:21Z
postgresversions.catalog.kubedb.com 2024-09-05T10:10:30Z
proxysqlversions.catalog.kubedb.com 2024-09-05T10:10:30Z
publishers.postgres.kubedb.com 2024-09-05T10:11:21Z
rabbitmqversions.catalog.kubedb.com 2024-09-05T10:10:30Z
redisautoscalers.autoscaling.kubedb.com 2024-09-05T10:11:24Z
redises.kubedb.com 2024-09-05T10:11:24Z
redisopsrequests.ops.kubedb.com 2024-09-05T10:11:24Z
redissentinelautoscalers.autoscaling.kubedb.com 2024-09-05T10:11:24Z
redissentinelopsrequests.ops.kubedb.com 2024-09-05T10:11:24Z
redissentinels.kubedb.com 2024-09-05T10:11:24Z
redisversions.catalog.kubedb.com 2024-09-05T10:10:30Z
restproxies.kafka.kubedb.com 2024-09-05T10:11:04Z
schemaregistries.kafka.kubedb.com 2024-09-05T10:11:04Z
schemaregistryversions.catalog.kubedb.com 2024-09-05T10:10:30Z
singlestoreversions.catalog.kubedb.com 2024-09-05T10:10:30Z
solrversions.catalog.kubedb.com 2024-09-05T10:10:30Z
subscribers.postgres.kubedb.com 2024-09-05T10:11:21Z
zookeeperversions.catalog.kubedb.com 2024-09-05T10:10:30Z
Deploy Memcached
Now, we are going to Deploy Memcached using KubeDB. First, let’s create a Namespace in which we will deploy the Memcached.
$ kubectl create namespace demo
namespace/demo created
Here is the yaml of the Memcached CRO we are going to use:
apiVersion: kubedb.com/v1
kind: Memcached
metadata:
name: sample-memcached
namespace: demo
spec:
replicas: 1
version: "1.6.22"
podTemplate:
spec:
containers:
- name: memcached
deletionPolicy: "WipeOut"
Let’s save this yaml configuration into sample-memcached.yaml
Then create the above Memcached CRO,
$ kubectl apply -f sample-memcached.yaml
memcached.kubedb.com/sample-memcached created
In this yaml,
spec.versionfield specifies the version of Memcached Here, we are using Memcached1.6.22. You can list the KubeDB supported versions of Memcached by running$ kubectl get memcachedversionscommand.spec.replicasis an optional field that specifies the number of desired Instances/Replicas of Memcached server.spec.podTemplateKubeDB allows providing a template for database pod. KubeDB operator will pass the information provided inspec.podTemplateto the Petset created for Memcached server.spec.deletionPolicyfield is Wipeout means that the database will be deleted without restrictions. It can also be “Halt”, “Delete” and “DoNotTerminate”.
Once these are handled correctly and the Memcached object is deployed, you will see that the following objects are created:
$ kubectl get all -n demo
NAME READY STATUS RESTARTS AGE
pod/sample-memcached-0 1/1 Running 0 64s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/sample-memcached ClusterIP 10.96.124.94 <none> 11211/TCP 64s
service/sample-memcached-pods ClusterIP None <none> 11211/TCP 64s
NAME TYPE VERSION AGE
appbinding.appcatalog.appscode.com/sample-memcached kubedb.com/memcached 1.6.22 65s
NAME VERSION STATUS AGE
memcached.kubedb.com/sample-memcached 1.6.22 Ready 65s
Let’s check if the Memcached is ready to use,
$ kubectl get memcached -n demo sample-memcached
NAME VERSION STATUS AGE
sample-memcached 1.6.22 Ready 108s
We have successfully deployed Memcached in GKE.
Connect with Memcached
We will use port forwarding
to connect with Memcached. Here, we will use the sample-memcached-0 pod. First, we need to port-forward the sample-memcached-0 pod to the port 11211 on the local machine:
$ kubectl port-forward -n demo sample-memcached-0 11211
Forwarding from 127.0.0.1:11211 -> 11211
Forwarding from [::1]:11211 -> 11211
Once port forwarding is established, you can connect to Memcached locally using telnet. Start a telnet session to connect to the Memcached.
Insert Sample Data
$ telnet 127.0.0.1 11211
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
With the connection active, you can insert some sample data into Memcached. Use the set command to store a key-value pair:
set AppsCode 0 2592000 6
KubeDB
STORED
Here, AppsCode is the key, 0 is the flags field, 2592000 is the expiration time in seconds, 6 is the length of the data, and KubeDB is the value being stored. To verify that the data was successfully stored, retrieve it using the get command:
get AppsCode
VALUE AppsCode 0 6
KubeDB
END
telnet> quit
Congratulations! You’ve successfully connected to Memcached and inserted sample data. More information about Deploy & Manage Production-Grade Memcached on Kubernetes can be found in Memcached Kubernetes
Support
To speak with us, please leave a message on our website .
To receive product announcements, follow us on X .
To watch tutorials of various Production-Grade Kubernetes Tools Subscribe our YouTube channel.
More about Memcached on Kubernetes
If you have found a bug with KubeDB or want to request for new features, please file an issue .