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, 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 Solr in Google Kubernetes Engine (GKE) Using KubeDB. We will cover the following steps:
- Install KubeDB
- Deploy ZooKeeper
- Deploy Solr Cluster
- 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.6.4 v2024.6.4 KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler v0.31.0 v0.31.0 KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog v2024.6.4 v2024.6.4 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.1.0 v0.1.0 KubeDB CRD Manager by AppsCode
appscode/kubedb-crds v2024.6.4 v2024.6.4 KubeDB Custom Resource Definitions
appscode/kubedb-dashboard v0.22.0 v0.22.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.6.4 v2024.6.4 A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-kubestash-catalog v2024.6.4 v2024.6.4 KubeStash Catalog by AppsCode - Catalog of Kube...
appscode/kubedb-metrics v2024.6.4 v2024.6.4 KubeDB State Metrics
appscode/kubedb-one v2023.12.28 v2023.12.28 KubeDB and Stash by AppsCode - Production ready...
appscode/kubedb-ops-manager v0.33.0 v0.33.1 KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter v2024.6.4 v2024.6.4 KubeDB Opscenter by AppsCode
appscode/kubedb-provider-aws v2024.6.4 v0.8.0 A Helm chart for KubeDB AWS Provider for Crossp...
appscode/kubedb-provider-azure v2024.6.4 v0.8.0 A Helm chart for KubeDB Azure Provider for Cros...
appscode/kubedb-provider-gcp v2024.6.4 v0.8.0 A Helm chart for KubeDB GCP Provider for Crossp...
appscode/kubedb-provisioner v0.46.0 v0.46.1 KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager v0.22.0 v0.22.0 KubeDB Schema Manager by AppsCode
appscode/kubedb-ui v2024.7.4 0.7.3 A Helm chart for Kubernetes
appscode/kubedb-ui-presets v2024.7.4 v2024.7.4 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.22.0 v0.22.0 KubeDB Webhook Server by AppsCode
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2024.6.4 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt \
--set global.featureGates.Solr=true \
--set global.featureGates.ZooKeeper=true \
--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-55bcf9c95c-h9gxh 1/1 Running 0 2m17s
kubedb kubedb-kubedb-ops-manager-577dc487b4-f2v9j 1/1 Running 0 2m17s
kubedb kubedb-kubedb-provisioner-56fc94cc7f-88mv2 1/1 Running 0 2m17s
kubedb kubedb-kubedb-webhook-server-6cddc7bb9d-zm7sx 1/1 Running 0 2m17s
kubedb kubedb-petset-operator-77b6b9897f-vm9fb 1/1 Running 0 2m17s
kubedb kubedb-petset-webhook-server-658f595f79-4qphv 2/2 Running 0 2m17s
kubedb kubedb-sidekick-c898cff4c-cmwdq 1/1 Running 0 2m17s
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-08-09T06:31:45Z
connectclusters.kafka.kubedb.com 2024-08-09T06:34:41Z
connectors.kafka.kubedb.com 2024-08-09T06:34:41Z
druidversions.catalog.kubedb.com 2024-08-09T06:31:45Z
elasticsearchautoscalers.autoscaling.kubedb.com 2024-08-09T06:34:38Z
elasticsearchdashboards.elasticsearch.kubedb.com 2024-08-09T06:34:38Z
elasticsearches.kubedb.com 2024-08-09T06:34:37Z
elasticsearchopsrequests.ops.kubedb.com 2024-08-09T06:34:38Z
elasticsearchversions.catalog.kubedb.com 2024-08-09T06:31:45Z
etcdversions.catalog.kubedb.com 2024-08-09T06:31:45Z
ferretdbversions.catalog.kubedb.com 2024-08-09T06:31:45Z
kafkaautoscalers.autoscaling.kubedb.com 2024-08-09T06:34:41Z
kafkaconnectorversions.catalog.kubedb.com 2024-08-09T06:31:45Z
kafkaopsrequests.ops.kubedb.com 2024-08-09T06:34:41Z
kafkas.kubedb.com 2024-08-09T06:34:41Z
kafkaversions.catalog.kubedb.com 2024-08-09T06:31:45Z
mariadbarchivers.archiver.kubedb.com 2024-08-09T06:34:45Z
mariadbautoscalers.autoscaling.kubedb.com 2024-08-09T06:34:45Z
mariadbdatabases.schema.kubedb.com 2024-08-09T06:34:45Z
mariadbopsrequests.ops.kubedb.com 2024-08-09T06:34:45Z
mariadbs.kubedb.com 2024-08-09T06:34:45Z
mariadbversions.catalog.kubedb.com 2024-08-09T06:31:45Z
memcachedversions.catalog.kubedb.com 2024-08-09T06:31:45Z
mongodbarchivers.archiver.kubedb.com 2024-08-09T06:34:49Z
mongodbautoscalers.autoscaling.kubedb.com 2024-08-09T06:34:49Z
mongodbdatabases.schema.kubedb.com 2024-08-09T06:34:50Z
mongodbopsrequests.ops.kubedb.com 2024-08-09T06:34:49Z
mongodbs.kubedb.com 2024-08-09T06:34:49Z
mongodbversions.catalog.kubedb.com 2024-08-09T06:31:45Z
mssqlserverversions.catalog.kubedb.com 2024-08-09T06:31:45Z
mysqlarchivers.archiver.kubedb.com 2024-08-09T06:34:53Z
mysqlautoscalers.autoscaling.kubedb.com 2024-08-09T06:34:53Z
mysqldatabases.schema.kubedb.com 2024-08-09T06:34:54Z
mysqlopsrequests.ops.kubedb.com 2024-08-09T06:34:53Z
mysqls.kubedb.com 2024-08-09T06:34:53Z
mysqlversions.catalog.kubedb.com 2024-08-09T06:31:45Z
perconaxtradbversions.catalog.kubedb.com 2024-08-09T06:31:45Z
pgbouncerversions.catalog.kubedb.com 2024-08-09T06:31:45Z
pgpoolversions.catalog.kubedb.com 2024-08-09T06:31:45Z
postgresarchivers.archiver.kubedb.com 2024-08-09T06:34:58Z
postgresautoscalers.autoscaling.kubedb.com 2024-08-09T06:34:57Z
postgresdatabases.schema.kubedb.com 2024-08-09T06:34:58Z
postgreses.kubedb.com 2024-08-09T06:34:57Z
postgresopsrequests.ops.kubedb.com 2024-08-09T06:34:57Z
postgresversions.catalog.kubedb.com 2024-08-09T06:31:45Z
proxysqlversions.catalog.kubedb.com 2024-08-09T06:31:46Z
publishers.postgres.kubedb.com 2024-08-09T06:34:58Z
rabbitmqversions.catalog.kubedb.com 2024-08-09T06:31:46Z
redisautoscalers.autoscaling.kubedb.com 2024-08-09T06:35:01Z
redises.kubedb.com 2024-08-09T06:35:01Z
redisopsrequests.ops.kubedb.com 2024-08-09T06:35:01Z
redissentinelautoscalers.autoscaling.kubedb.com 2024-08-09T06:35:02Z
redissentinelopsrequests.ops.kubedb.com 2024-08-09T06:35:02Z
redissentinels.kubedb.com 2024-08-09T06:35:01Z
redisversions.catalog.kubedb.com 2024-08-09T06:31:46Z
schemaregistries.kafka.kubedb.com 2024-08-09T06:34:41Z
schemaregistryversions.catalog.kubedb.com 2024-08-09T06:31:46Z
singlestoreversions.catalog.kubedb.com 2024-08-09T06:31:46Z
solrs.kubedb.com 2024-08-09T06:35:05Z
solrversions.catalog.kubedb.com 2024-08-09T06:31:46Z
subscribers.postgres.kubedb.com 2024-08-09T06:34:58Z
zookeepers.kubedb.com 2024-08-09T08:50:45Z
zookeeperversions.catalog.kubedb.com 2024-08-09T06:31:46Z
Create a Namespace
To keep resources isolated, we’ll use a separate namespace called demo throughout this tutorial.
Run the following command to create the namespace:
$ kubectl create namespace demo
namespace/demo created
Create ZooKeeper Instance
Since KubeDB Solr operates in solrcloud mode, it requires an external ZooKeeper to manage replica distribution and configuration.
In this tutorial, we will use KubeDB ZooKeeper. Below is the configuration for the ZooKeeper instance we’ll create:
apiVersion: kubedb.com/v1alpha2
kind: ZooKeeper
metadata:
name: zookeeper
namespace: demo
spec:
version: 3.9.1
replicas: 3
adminServerPort: 8080
storage:
resources:
requests:
storage: "100Mi"
storageClassName: standard
accessModes:
- ReadWriteOnce
deletionPolicy: "WipeOut"
Let’s save this yaml configuration into zookeeper.yaml Then create the above ZooKeeper CRO,
$ kubectl apply -f zookeeper.yaml
zookeeper.kubedb.com/zookeeper created
In this yaml,
spec.versionfield specifies the version of ZooKeeper Here, we are using ZooKeeperversion 3.9.1. You can list the KubeDB supported versions of ZooKeeper by running$ kubectl get zookeeperversionscommand.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.spec.deletionPolicyfield is Wipeout means that the database will be deleted without restrictions. It can also be “Halt”, “Delete” and “DoNotTerminate”.
Once the ZooKeeper instance’s STATUS is Ready, we can proceed to deploy Solr in our cluster.
$ kubectl get zookeeper -n demo zookeeper
NAME TYPE VERSION STATUS AGE
zookeeper kubedb.com/v1alpha2 3.9.1 Ready 4m14s
Deploy Solr Cluster
Here is the yaml of the Solr we are going to use:
apiVersion: kubedb.com/v1alpha2
kind: Solr
metadata:
name: solr-cluster
namespace: demo
spec:
version: 9.4.1
replicas: 3
zookeeperRef:
name: zookeeper
namespace: demo
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 2Gi
storageClassName: standard
deletionPolicy: "WipeOut"
Let’s save this yaml configuration into solr-cluster.yaml
Then apply the above Solr yaml,
$ kubectl apply -f solr-cluster.yaml
solr.kubedb.com/solr-cluster created
In this yaml,
spec.versionis the name of the SolrVersion CR. Here, a Solr ofversion 9.4.1will be created.spec.replicasspecifies the number of Solr nodes.spec.storageTypespecifies the type of storage that will be used for Solr database. It can beDurableorEphemeral. The default value of this field isDurable. IfEphemeralis used then KubeDB will create the Solr database usingEmptyDirvolume. In this case, you don’t have to specifyspec.storagefield. This is useful for testing purposes.spec.storagespecifies the StorageClass of PVC dynamically allocated to store data for this database. This storage spec will be passed to the Petset created by the KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests. If you don’t specifyspec.storageType: Ephemeral, then this field is required.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 Solr object is deployed, you will see that the following resources are created:
$ kubectl get all -n demo
NAME READY STATUS RESTARTS AGE
pod/solr-cluster-0 1/1 Running 0 3m16s
pod/solr-cluster-1 1/1 Running 0 2m4s
pod/solr-cluster-2 1/1 Running 0 83s
pod/zookeeper-0 1/1 Running 0 13m
pod/zookeeper-1 1/1 Running 0 12m
pod/zookeeper-2 1/1 Running 0 11m
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/solr-cluster ClusterIP 10.128.134.1 <none> 8983/TCP 3m18s
service/solr-cluster-pods ClusterIP None <none> 8983/TCP 3m18s
service/zookeeper ClusterIP 10.128.217.238 <none> 2181/TCP 13m
service/zookeeper-admin-server ClusterIP 10.128.108.153 <none> 8080/TCP 13m
service/zookeeper-pods ClusterIP None <none> 2181/TCP,2888/TCP,3888/TCP 13m
NAME TYPE VERSION AGE
appbinding.appcatalog.appscode.com/solr-cluster kubedb.com/solr 9.4.1 3m19s
appbinding.appcatalog.appscode.com/zookeeper kubedb.com/zookeeper 3.9.1 13m
Let’s check if the database is ready to use,
$ kubectl get solr -n demo solr-cluster
NAME TYPE VERSION STATUS AGE
solr-cluster kubedb.com/v1alpha2 9.4.1 Ready 3m59s
We have successfully deployed Solr in GKE. Now we can exec into the container to use the database.
Connect with Solr Database
We will use port forwarding
to connect with our Solr database. Then we will use curl to send HTTP requests to check cluster health to verify that our Solr 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
solr-cluster ClusterIP 10.128.134.1 <none> 8983/TCP 4m58s
solr-cluster-pods ClusterIP None <none> 8983/TCP 4m58s
zookeeper ClusterIP 10.128.217.238 <none> 2181/TCP 15m
zookeeper-admin-server ClusterIP 10.128.108.153 <none> 8080/TCP 15m
zookeeper-pods ClusterIP None <none> 2181/TCP,2888/TCP,3888/TCP 15m
To connect to the Solr database, we will use the solr-cluster service. First, we need to port-forward the solr-cluster service to port 8983 on the local machine:
$ kubectl port-forward -n demo svc/solr-cluster 8983
Forwarding from 127.0.0.1:8983 -> 8983
Forwarding from [::1]:8983 -> 8983
Now, the Solr cluster is accessible at localhost:8983.
Export the Credentials
KubeDB creates several Secrets for managing the database. To view the Secrets created for solr-cluster, run the following command:
$ kubectl get secret -n demo | grep solr-cluster
solr-cluster-admin-cred kubernetes.io/basic-auth 2 8m15s
solr-cluster-auth-config Opaque 1 8m15s
solr-cluster-config Opaque 1 8m15s
solr-cluster-zk-digest kubernetes.io/basic-auth 2 8m15s
solr-cluster-zk-digest-readonly kubernetes.io/basic-auth 2 8m15s
From the above list, the solr-cluster-admin-cred Secret contains the admin-level credentials needed to connect to the database.
Accessing Database Through CLI
To access the database via the CLI, you first need to retrieve the credentials. Use the following commands to obtain the username and password:
$ kubectl get secret -n demo solr-cluster-admin-cred -o jsonpath='{.data.username}' | base64 -d
admin
$ kubectl get secret -n demo solr-cluster-admin-cred -o jsonpath='{.data.password}' | base64 -d
uWTo0EhB~hudcX~s
Now, let’s check the health of our Solr cluster.
# curl -XGET -k -u 'username:password' "http://localhost:8983/solr/admin/collections?action=CLUSTERSTATUS"
$ curl -XGET -k -u 'admin:uWTo0EhB~hudcX~s' "http://localhost:8983/solr/admin/collections?action=CLUSTERSTATUS"
{
"responseHeader":{
"status":0,
"QTime":4
},
"cluster":{
"collections":{
"kubedb-collection":{
"pullReplicas":"0",
"configName":"kubedb-collection.AUTOCREATED",
"replicationFactor":1,
"router":{
"name":"compositeId"
},
"nrtReplicas":1,
"tlogReplicas":"0",
"shards":{
"shard1":{
"range":"80000000-7fffffff",
"state":"active",
"replicas":{
"core_node2":{
"core":"kubedb-collection_shard1_replica_n1",
"node_name":"solr-cluster-1.solr-cluster-pods.demo:8983_solr",
"type":"NRT",
"state":"active",
"leader":"true",
"force_set_state":"false",
"base_url":"http://solr-cluster-1.solr-cluster-pods.demo:8983/solr"
}
},
"health":"GREEN"
}
},
"health":"GREEN",
"znodeVersion":4
}
},
"live_nodes":["solr-cluster-1.solr-cluster-pods.demo:8983_solr","solr-cluster-2.solr-cluster-pods.demo:8983_solr","solr-cluster-0.solr-cluster-pods.demo:8983_solr"]
}
}
Insert Sample Data
In this section, we’ll create a collection in Solr and insert some sample data using curl. To disable certificate verification (useful for testing with self-signed certificates), use the -k flag.
Execute the following command to create a collection named music in Solr:
$ curl -XPOST -k -u 'admin:uWTo0EhB~hudcX~s' "http://localhost:8983/solr/admin/collections?action=CREATE&name=music&numShards=2&replicationFactor=2&wt=xml"
<?xml version="1.0" encoding="UTF-8"?>
<response>
<lst name="responseHeader">
<int name="status">0</int>
<int name="QTime">4398</int>
</lst>
<lst name="success">
<lst name="solr-cluster-0.solr-cluster-pods.demo:8983_solr">
<lst name="responseHeader">
<int name="status">0</int>
<int name="QTime">1849</int>
</lst>
<str name="core">music_shard2_replica_n4</str>
</lst>
<lst name="solr-cluster-1.solr-cluster-pods.demo:8983_solr">
<lst name="responseHeader">
<int name="status">0</int>
<int name="QTime">2223</int>
</lst>
<str name="core">music_shard1_replica_n6</str>
</lst>
<lst name="solr-cluster-2.solr-cluster-pods.demo:8983_solr">
<lst name="responseHeader">
<int name="status">0</int>
<int name="QTime">2535</int>
</lst>
<str name="core">music_shard2_replica_n2</str>
</lst>
<lst name="solr-cluster-2.solr-cluster-pods.demo:8983_solr">
<lst name="responseHeader">
<int name="status">0</int>
<int name="QTime">2543</int>
</lst>
<str name="core">music_shard1_replica_n1</str>
</lst>
</lst>
</response>
$ curl -X POST -u 'admin:uWTo0EhB~hudcX~s' -H 'Content-Type: application/json' "http://localhost:8983/solr/music/update" --data-binary '[{ "Artist": "Bobby Bare","Song": "Five Hundred Miles"}]'
{
"responseHeader":{
"rf":2,
"status":0,
"QTime":909
}
}
To verify that the collection has been created successfully, run the following command:
$ curl -X GET -u 'admin:uWTo0EhB~hudcX~s' 'http://localhost:8983/solr/admin/collections?action=LIST&wt=json'
{
"responseHeader":{
"status":0,
"QTime":1
},
"collections":["kubedb-collection","music"]
}
To check the sample data in the music collection, use the following command:
$ curl -X GET -u 'admin:uWTo0EhB~hudcX~s' "http://localhost:8983/solr/music/select" -H 'Content-Type: application/json' -d '{"query": "*:*"}'
{
"responseHeader":{
"zkConnected":true,
"status":0,
"QTime":36,
"params":{
"json":"{\"query\": \"*:*\"}"
}
},
"response":{
"numFound":1,
"start":0,
"maxScore":1.0,
"numFoundExact":true,
"docs":[{
"Artist":["Bobby Bare"],
"Song":["Five Hundred Miles"],
"id":"33f80682-88b7-4720-9efd-0d98baed9034",
"_version_":1807264708483350528
}]
}
}
We’ve successfully inserted some sample data to our Solr database. More information about Deploy & Manage Production-Grade Solr Database on Kubernetes can be found in Solr Kubernetes
We have made a in depth tutorial on Provision and Manage Solr on Kubernetes 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 X .
To watch tutorials of various Production-Grade Kubernetes Tools Subscribe our YouTube channel.
More about Solr on Kubernetes
If you have found a bug with KubeDB or want to request for new features, please file an issue .