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, Percona XtraDB, and Memcached. Additionally, KubeDB also supports ProxySQL, PgBouncer, and the streaming platform Kafka. You can find the guides to all the supported databases in KubeDB . KubeDB provides support not only for the official Elasticsearch by Elastic and OpenSearch by AWS, but also other open source distributions like SearchGuard and OpenDistro . KubeDB provides all of these distribution’s support under the Elasticsearch CR of KubeDB. In this tutorial we will deploy OpenSearch Hot-Warm-Cold Cluster in Google Kubernetes Engine (GKE). We will cover the following steps:
- Install KubeDB
- Deploy OpenSearch Hot-Warm-Cold Cluster
- Verify Node Role
- Read/Write Sample Data
OpenSearch Hot-Warm-Cold Cluster
Hot-warm-cold architectures are common for time series data such as logging or metrics and it also has various use cases too. For example, assume OpenSearch is being used to aggregate log files from multiple systems. Logs from today are actively being indexed and this week’s logs are the most heavily searched (hot). Last week’s logs may be searched but not as much as the current week’s logs (warm). Last month’s logs may or may not be searched often, but are good to keep around just in case (cold).
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
, 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.2.14 v2024.2.14 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler v0.27.0 v0.27.0 KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog v2024.2.14 v2024.2.14 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.0.5 v0.0.5 KubeDB CRD Manager by AppsCode
appscode/kubedb-crds v2024.2.14 v2024.2.14 KubeDB Custom Resource Definitions
appscode/kubedb-dashboard v0.18.0 v0.18.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.2.14 v2024.2.14 A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-kubestash-catalog v2024.2.14 v2024.2.14 KubeStash Catalog by AppsCode - Catalog of Kube...
appscode/kubedb-metrics v2024.2.14 v2024.2.14 KubeDB State Metrics
appscode/kubedb-one v2023.12.28 v2023.12.28 KubeDB and Stash by AppsCode - Production ready...
appscode/kubedb-ops-manager v0.29.0 v0.29.0 KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter v2024.2.14 v2024.2.14 KubeDB Opscenter by AppsCode
appscode/kubedb-provider-aws v2024.2.14 v0.4.0 A Helm chart for KubeDB AWS Provider for Crossp...
appscode/kubedb-provider-azure v2024.2.14 v0.4.0 A Helm chart for KubeDB Azure Provider for Cros...
appscode/kubedb-provider-gcp v2024.2.14 v0.4.0 A Helm chart for KubeDB GCP Provider for Crossp...
appscode/kubedb-provisioner v0.42.0 v0.42.0 KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager v0.18.0 v0.18.0 KubeDB Schema Manager by AppsCode
appscode/kubedb-ui v2024.2.13 0.6.4 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.18.0 v0.18.0 KubeDB Webhook Server by AppsCode
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2024.2.14 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
Let’s verify the installation:
$ kubectl get pods --all-namespaces -l "app.kubernetes.io/instance=kubedb"
NAMESPACE NAME READY STATUS RESTARTS AGE
kubedb kubedb-kubedb-autoscaler-77cdd9c596-mgwjj 1/1 Running 0 3m47s
kubedb kubedb-kubedb-ops-manager-5b648b6c96-4v7rc 1/1 Running 0 3m47s
kubedb kubedb-kubedb-provisioner-84fb8864f-ghmkg 1/1 Running 0 3m47s
kubedb kubedb-kubedb-webhook-server-5997c9b57b-pj96w 1/1 Running 0 3m47s
kubedb kubedb-sidekick-5dc87959b7-2hbst 1/1 Running 0 3m47s
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
connectclusters.kafka.kubedb.com 2024-03-06T09:09:22Z
connectors.kafka.kubedb.com 2024-03-06T09:09:22Z
druidversions.catalog.kubedb.com 2024-03-06T09:08:38Z
elasticsearchautoscalers.autoscaling.kubedb.com 2024-03-06T09:09:19Z
elasticsearchdashboards.elasticsearch.kubedb.com 2024-03-06T09:09:19Z
elasticsearches.kubedb.com 2024-03-06T09:09:19Z
elasticsearchopsrequests.ops.kubedb.com 2024-03-06T09:09:19Z
elasticsearchversions.catalog.kubedb.com 2024-03-06T09:08:38Z
etcdversions.catalog.kubedb.com 2024-03-06T09:08:38Z
ferretdbversions.catalog.kubedb.com 2024-03-06T09:08:38Z
kafkaconnectorversions.catalog.kubedb.com 2024-03-06T09:08:38Z
kafkaopsrequests.ops.kubedb.com 2024-03-06T09:09:22Z
kafkas.kubedb.com 2024-03-06T09:09:22Z
kafkaversions.catalog.kubedb.com 2024-03-06T09:08:38Z
mariadbautoscalers.autoscaling.kubedb.com 2024-03-06T09:09:25Z
mariadbdatabases.schema.kubedb.com 2024-03-06T09:09:25Z
mariadbopsrequests.ops.kubedb.com 2024-03-06T09:09:25Z
mariadbs.kubedb.com 2024-03-06T09:09:25Z
mariadbversions.catalog.kubedb.com 2024-03-06T09:08:38Z
memcachedversions.catalog.kubedb.com 2024-03-06T09:08:38Z
mongodbarchivers.archiver.kubedb.com 2024-03-06T09:09:29Z
mongodbautoscalers.autoscaling.kubedb.com 2024-03-06T09:09:28Z
mongodbdatabases.schema.kubedb.com 2024-03-06T09:09:29Z
mongodbopsrequests.ops.kubedb.com 2024-03-06T09:09:28Z
mongodbs.kubedb.com 2024-03-06T09:09:28Z
mongodbversions.catalog.kubedb.com 2024-03-06T09:08:38Z
mysqlarchivers.archiver.kubedb.com 2024-03-06T09:09:32Z
mysqlautoscalers.autoscaling.kubedb.com 2024-03-06T09:09:32Z
mysqldatabases.schema.kubedb.com 2024-03-06T09:09:32Z
mysqlopsrequests.ops.kubedb.com 2024-03-06T09:09:32Z
mysqls.kubedb.com 2024-03-06T09:09:32Z
mysqlversions.catalog.kubedb.com 2024-03-06T09:08:38Z
perconaxtradbversions.catalog.kubedb.com 2024-03-06T09:08:38Z
pgbouncerversions.catalog.kubedb.com 2024-03-06T09:08:38Z
pgpoolversions.catalog.kubedb.com 2024-03-06T09:08:38Z
postgresarchivers.archiver.kubedb.com 2024-03-06T09:09:35Z
postgresautoscalers.autoscaling.kubedb.com 2024-03-06T09:09:35Z
postgresdatabases.schema.kubedb.com 2024-03-06T09:09:35Z
postgreses.kubedb.com 2024-03-06T09:09:35Z
postgresopsrequests.ops.kubedb.com 2024-03-06T09:09:35Z
postgresversions.catalog.kubedb.com 2024-03-06T09:08:38Z
proxysqlversions.catalog.kubedb.com 2024-03-06T09:08:38Z
publishers.postgres.kubedb.com 2024-03-06T09:09:35Z
rabbitmqversions.catalog.kubedb.com 2024-03-06T09:08:38Z
redisautoscalers.autoscaling.kubedb.com 2024-03-06T09:09:39Z
redises.kubedb.com 2024-03-06T09:09:39Z
redisopsrequests.ops.kubedb.com 2024-03-06T09:09:39Z
redissentinelautoscalers.autoscaling.kubedb.com 2024-03-06T09:09:39Z
redissentinelopsrequests.ops.kubedb.com 2024-03-06T09:09:39Z
redissentinels.kubedb.com 2024-03-06T09:09:39Z
redisversions.catalog.kubedb.com 2024-03-06T09:08:38Z
singlestoreversions.catalog.kubedb.com 2024-03-06T09:08:38Z
solrversions.catalog.kubedb.com 2024-03-06T09:08:38Z
subscribers.postgres.kubedb.com 2024-03-06T09:09:35Z
zookeeperversions.catalog.kubedb.com 2024-03-06T09:08:38Z
Deploy OpenSearch Hot-Warm-Cold Cluster
Now, We are going to use the KubeDB-provided Custom Resource object OpenSearch for deployment. First, let’s create a Namespace in which we will deploy the cluster.
$ kubectl create namespace demo
namespace/demo created
Here is the yaml we are going to use:
apiVersion: kubedb.com/v1alpha2
kind: Elasticsearch
metadata:
name: opensearch-hwc
namespace: demo
spec:
version: opensearch-2.8.0
enableSSL: true
storageType: Durable
topology:
master:
replicas: 2
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
ingest:
replicas: 2
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
dataHot:
replicas: 3
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 5Gi
resources:
requests:
cpu: 1.5
memory: 2Gi
limits:
cpu: 2
memory: 3Gi
dataWarm:
replicas: 2
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 5Gi
resources:
limits:
cpu: 1
memory: 2Gi
dataCold:
replicas: 1
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 5Gi
resources:
requests:
cpu: .5
memory: 1Gi
limits:
cpu: .5
memory: 1.5Gi
Let’s save this yaml configuration into opensearch-hwc.yaml
Then apply the above OpenSearch yaml,
$ kubectl apply -f opensearch-hwc.yaml
elasticsearch.kubedb.com/opensearch-hwc created
In this yaml,
spec.versionfield specifies the version of OpenSearch. Here, we are using OpenSearch versionopensearch-2.8.0. You can list the KubeDB supported versions of OpenSearch by running$ kubectl get elasticsearchversions | grep opensearchcommand. If you want to get other distributions, usegrepcommand accordingly.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. You can get all the availablestorageclassin your cluster by running$ kubectl get storageclasscommand.spec.enableSSL- specifies whether the HTTP layer is secured with certificates or not.spec.storageType- specifies the type of storage that will be used for OpenSearch database. It can beDurableorEphemeral. The default value of this field isDurable. IfEphemeralis used then KubeDB will create the OpenSearch database usingEmptyDirvolume. In this case, you don’t have to specifyspec.storagefield. This is useful for testing purposes.spec.topology- specifies the node-specific properties for the OpenSearch cluster.topology.master- specifies the properties of master nodes.master.replicas- specifies the number of master nodes.master.storage- specifies the master node storage information that passed to the StatefulSet.
topology.data- specifies the properties of data nodes.data.replicas- specifies the number of data nodes.data.storage- specifies the data node storage information that passed to the StatefulSet.
topology.ingest- specifies the properties of ingest nodes.ingest.replicas- specifies the number of ingest nodes.ingest.storage- specifies the ingest node storage information that passed to the StatefulSet.
You can see the detailed yaml specifications in the Kubernetes OpenSearch documentation.
Once these are handled correctly and the OpenSearch object is deployed, you will see that the following resources are created:
$ kubectl get all -n demo
NAME READY STATUS RESTARTS AGE
pod/opensearch-hwc-data-cold-0 1/1 Running 0 5m14s
pod/opensearch-hwc-data-hot-0 1/1 Running 0 5m29s
pod/opensearch-hwc-data-hot-1 1/1 Running 0 5m11s
pod/opensearch-hwc-data-hot-2 1/1 Running 0 5m11s
pod/opensearch-hwc-data-warm-0 1/1 Running 0 5m29s
pod/opensearch-hwc-data-warm-1 1/1 Running 0 5m11s
pod/opensearch-hwc-ingest-0 1/1 Running 0 5m29s
pod/opensearch-hwc-ingest-1 1/1 Running 0 5m11s
pod/opensearch-hwc-master-0 1/1 Running 0 5m29s
pod/opensearch-hwc-master-1 1/1 Running 0 5m11s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/opensearch-hwc ClusterIP 10.96.144.238 <none> 9200/TCP 5m29s
service/opensearch-hwc-master ClusterIP None <none> 9300/TCP 5m29s
service/opensearch-hwc-pods ClusterIP None <none> 9200/TCP 5m29s
NAME READY AGE
statefulset.apps/opensearch-hwc-data-cold 1/1 5m14s
statefulset.apps/opensearch-hwc-data-hot 3/3 5m29s
statefulset.apps/opensearch-hwc-data-warm 2/2 5m29s
statefulset.apps/opensearch-hwc-ingest 2/2 5m29s
statefulset.apps/opensearch-hwc-master 2/2 5m29s
NAME TYPE VERSION AGE
appbinding.appcatalog.appscode.com/opensearch-hwc kubedb.com/elasticsearch 2.8.0 5m14s
NAME VERSION STATUS AGE
elasticsearch.kubedb.com/opensearch-hwc opensearch-2.8.0 Ready 5m29s
Let’s check if the database is ready to use,
$ kubectl get elasticsearch -n demo opensearch-hwc
NAME VERSION STATUS AGE
opensearch-hwc opensearch-2.8.0 Ready 6m41s
We have successfully deployed OpenSearch in Google Kubernetes Engine (GKE). Now we can exec into the container to use the database.
Connect with OpenSearch Database
We will use port forwarding
to connect with our OpenSearch database. Then we will use curl to send HTTP requests to check cluster health to verify that our OpenSearch database is working well.
Port-forward the Service
KubeDB will create few Services to connect with the database. Let’s check the Services by following command,
$ kubectl get service -n demo
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
opensearch-hwc ClusterIP 10.96.144.238 <none> 9200/TCP 7m44s
opensearch-hwc-master ClusterIP None <none> 9300/TCP 7m44s
opensearch-hwc-pods ClusterIP None <none> 9200/TCP 7m44s
Here, we are going to use opensearch-hwc Service to connect with the database. Now, let’s port-forward the opensearch-hwc Service to the port 9200 to local machine:
$ kubectl port-forward -n demo svc/opensearch-hwc 9200
Forwarding from 127.0.0.1:9200 -> 9200
Forwarding from [::1]:9200 -> 9200
Now, our OpenSearch cluster is accessible at localhost:9200.
Export the Credentials
KubeDB also create some Secrets for the database. Let’s check which Secrets have been created by KubeDB for our opensearch-hwc.
$ kubectl get secret -n demo | grep opensearch-hwc
opensearch-hwc-admin-cert kubernetes.io/tls 3 8m35s
opensearch-hwc-admin-cred kubernetes.io/basic-auth 2 8m35s
opensearch-hwc-ca-cert kubernetes.io/tls 2 8m35s
opensearch-hwc-client-cert kubernetes.io/tls 3 8m35s
opensearch-hwc-config Opaque 3 8m35s
opensearch-hwc-http-cert kubernetes.io/tls 3 8m35s
opensearch-hwc-kibanaro-cred kubernetes.io/basic-auth 2 8m35s
opensearch-hwc-kibanaserver-cred kubernetes.io/basic-auth 2 8m35s
opensearch-hwc-logstash-cred kubernetes.io/basic-auth 2 8m35s
opensearch-hwc-readall-cred kubernetes.io/basic-auth 2 8m35s
opensearch-hwc-snapshotrestore-cred kubernetes.io/basic-auth 2 8m35s
opensearch-hwc-transport-cert kubernetes.io/tls 3 8m35s
Now, we can connect to the database with opensearch-hwc-admin-cred which contains the admin level credentials to connect with the database.
Accessing Database Through CLI
To access the database through CLI, we have to get the credentials to access. Let’s export the credentials as environment variable to our current shell :
$ kubectl get secret -n demo opensearch-hwc-admin-cred -o jsonpath='{.data.username}' | base64 -d
admin
$ kubectl get secret -n demo opensearch-hwc-admin-cred -o jsonpath='{.data.password}' | base64 -d
A;qdVR(WI3XjczBa
Now, let’s check the health of our OpenSearch cluster
# curl -XGET -k -u 'username:password' https://localhost:9200/_cluster/health?pretty"
$ curl -XGET -k -u 'admin:A;qdVR(WI3XjczBa' "https://localhost:9200/_cluster/health?pretty"
{
"cluster_name" : "opensearch-hwc",
"status" : "green",
"timed_out" : false,
"number_of_nodes" : 10,
"number_of_data_nodes" : 6,
"discovered_master" : true,
"discovered_cluster_manager" : true,
"active_primary_shards" : 4,
"active_shards" : 13,
"relocating_shards" : 0,
"initializing_shards" : 0,
"unassigned_shards" : 0,
"delayed_unassigned_shards" : 0,
"number_of_pending_tasks" : 0,
"number_of_in_flight_fetch" : 0,
"task_max_waiting_in_queue_millis" : 0,
"active_shards_percent_as_number" : 100.0
}
Verify Node Role
As we have assigned a dedicated role to each type of node, let’s verify them by following command,
$ curl -XGET -k -u 'admin:A;qdVR(WI3XjczBa' "https://localhost:9200/_cat/nodes?v"
ip heap.percent ram.percent cpu load_1m load_5m load_15m node.role node.roles cluster_manager name
10.244.0.7 43 68 0 1.04 6.23 5.90 d data - opensearch-hwc-data-hot-0
10.244.0.10 55 67 0 1.04 6.23 5.90 d data - opensearch-hwc-data-warm-1
10.244.0.12 51 66 0 1.04 6.23 5.90 m cluster_manager * opensearch-hwc-master-1
10.244.0.19 46 68 0 1.04 6.23 5.90 d data - opensearch-hwc-data-hot-2
10.244.0.9 52 68 0 1.04 6.23 5.90 ir ingest,remote_cluster_client - opensearch-hwc-ingest-1
10.244.0.6 43 69 0 1.04 6.23 5.90 ir ingest,remote_cluster_client - opensearch-hwc-ingest-0
10.244.0.17 14 74 0 1.04 6.23 5.90 d data - opensearch-hwc-data-cold-0
10.244.0.8 46 66 0 1.04 6.23 5.90 m cluster_manager - opensearch-hwc-master-0
10.244.0.18 12 65 0 1.04 6.23 5.90 d data - opensearch-hwc-data-hot-1
10.244.0.11 14 75 0 1.04 6.23 5.90 d data - opensearch-hwc-data-warm-0
node.rolefield specifies the dedicated role that we have assigned for each type of node. Wheredrefers to the data node,irrefers to the ingest node,mrefers to the master node.masterfield specifies the active master node. Here, we can see a*in theopensearch-hwc-master-1which shows that it is the active master node now.
Insert Sample Data
In this section, we are going to create few indexes in OpenSearch. You can use curl for post some sample data into OpenSearch. Use the -k flag to disable attempts to verify self-signed certificates for testing purposes.
$ curl -XPOST -k --user 'admin:A;qdVR(WI3XjczBa' "https://localhost:9200/music/_doc?pretty" -H 'Content-Type: application/json' -d'
{
"Artist": "John Denver",
"Song": "Country Roads"
}
'
{
"_index" : "music",
"_id" : "ODcaHo4Bvi0hOBvmUCCs",
"_version" : 1,
"result" : "created",
"_shards" : {
"total" : 2,
"successful" : 2,
"failed" : 0
},
"_seq_no" : 0,
"_primary_term" : 1
}
Now, let’s verify that the index has been created successfully.
$ curl -XGET -k --user 'admin:A;qdVR(WI3XjczBa' "https://localhost:9200/_cat/indices?v&s=index&pretty"
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size
green open .opendistro_security w0PT_AHsRw2HS3bhWD_uYw 1 5 10 0 418.7kb 75.4kb
green open .opensearch-observability 3SOLAZuJSUucTV3gR4W7Zg 1 2 0 0 624b 208b
green open kubedb-system b59odv8ZTmmK_VzOJEd0Lg 1 1 1 133 1.2mb 668.8kb
green open music HbCoMR1pTXiRAw7Ane_8ZA 1 1 1 0 9.2kb 4.6kb
green open security-auditlog-2024.03.08 RP2oa_G-SWepIK71oan6GQ 1 1 12 0 421.8kb 210.9kb
Also, let’s verify the data in the indexes:
$ curl -XGET -k --user 'admin:A;qdVR(WI3XjczBa' "https://localhost:9200/music/_search?pretty"
{
"took" : 93,
"timed_out" : false,
"_shards" : {
"total" : 1,
"successful" : 1,
"skipped" : 0,
"failed" : 0
},
"hits" : {
"total" : {
"value" : 1,
"relation" : "eq"
},
"max_score" : 1.0,
"hits" : [
{
"_index" : "music",
"_id" : "ODcaHo4Bvi0hOBvmUCCs",
"_score" : 1.0,
"_source" : {
"Artist" : "John Denver",
"Song" : "Country Roads"
}
}
]
}
}
We’ve successfully inserted some sample data to our OpenSearch database. More information about Deploy & Manage Production-Grade OpenSearch Database on Kubernetes can be found in OpenSearch Kubernetes
If you want to learn more about Production-Grade OpenSearch on Kubernetes you can have a look into that playlist below:
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 OpenSearch on Kubernetes
If you have found a bug with KubeDB or want to request for new features, please file an issue .