You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
New to KubeDB? Please start here.
Restart Solr
KubeDB supports restarting the Solr database via a SolrOpsRequest. Restarting is useful if some pods are got stuck in some phase, or they are not working correctly. This tutorial will show you how to use that.
Before You Begin
At first, you need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using kind.
Now, install KubeDB cli on your workstation and KubeDB operator in your cluster following the steps here.
To keep things isolated, this tutorial uses a separate namespace called
demothroughout this tutorial.
$ kubectl create ns demo
namespace/demo created
Note: YAML files used in this tutorial are stored in docs/examples/Solr folder in GitHub repository kubedb/docs.
Deploy Solr
In this section, we are going to deploy a Solr database using KubeDB.
apiVersion: kubedb.com/v1alpha2
kind: Solr
metadata:
name: solr-cluster
namespace: demo
spec:
version: 9.6.1
zookeeperRef:
name: zoo
namespace: demo
topology:
overseer:
replicas: 1
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
data:
replicas: 1
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
coordinator:
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
spec.topologyrepresents the specification for Solr topology.datadenotes the data node of solr topology.overseerdenotes the controller node of solr topology.coordinatordenotes the controller node of solr topology
Let’s create the Solr CR we have shown above,
$ kubectl create -f https://github.com/kubedb/docs/raw/v2025.2.6-rc.0/docs/examples/Sslr/restart/solr-cluster.yaml
solr.kubedb.com/solr-cluster created
Apply Restart opsRequest
apiVersion: ops.kubedb.com/v1alpha1
kind: SolrOpsRequest
metadata:
name: restart
namespace: demo
spec:
apply: IfReady
databaseRef:
name: solr-cluster
type: Restart
spec.typespecifies the Type of the ops Requestspec.databaseRefholds the name of the Solr CR. It should be available in the same namespace as the opsRequest- The meaning of
spec.timeout&spec.applyfields will be found here
Note: The method of restarting the combined node is exactly same as above. All you need, is to specify the corresponding Solr name in
spec.databaseRef.namesection.
Let’s create the SolrOpsRequest CR we have shown above,
$ kubectl create -f https://github.com/kubedb/docs/raw/v2025.2.6-rc.0/docs/examples/solr/restart/ops.yaml
solropsrequest.ops.kubedb.com/restart created
Now the Ops-manager operator will first restart the controller pods, then broker of the referenced Solr.
$ kubectl get slops -n demo
NAME TYPE STATUS AGE
restart Restart Successful 2m34s
$ kubectl get slops -n demo restart -oyaml
apiVersion: ops.kubedb.com/v1alpha1
kind: SolrOpsRequest
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: |
{"apiVersion":"ops.kubedb.com/v1alpha1","kind":"SolrOpsRequest","metadata":{"annotations":{},"name":"restart","namespace":"demo"},"spec":{"apply":"IfReady","databaseRef":{"name":"solr-cluster"},"type":"Restart"}}
creationTimestamp: "2024-11-06T06:11:55Z"
generation: 1
name: restart
namespace: demo
resourceVersion: "1746799"
uid: de3f03f9-512e-44d2-b29f-6c084c5d993b
spec:
apply: IfReady
databaseRef:
name: solr-cluster
type: Restart
status:
conditions:
- lastTransitionTime: "2024-11-06T06:11:55Z"
message: Solr ops-request has started to restart solr nodes
observedGeneration: 1
reason: Restart
status: "True"
type: Restart
- lastTransitionTime: "2024-11-06T06:14:23Z"
message: Successfully Restarted Solr nodes
observedGeneration: 1
reason: RestartNodes
status: "True"
type: RestartNodes
- lastTransitionTime: "2024-11-06T06:12:03Z"
message: get pod; ConditionStatus:True; PodName:solr-cluster-overseer-0
observedGeneration: 1
status: "True"
type: GetPod--solr-cluster-overseer-0
- lastTransitionTime: "2024-11-06T06:12:03Z"
message: evict pod; ConditionStatus:True; PodName:solr-cluster-overseer-0
observedGeneration: 1
status: "True"
type: EvictPod--solr-cluster-overseer-0
- lastTransitionTime: "2024-11-06T06:12:08Z"
message: running pod; ConditionStatus:False
observedGeneration: 1
status: "False"
type: RunningPod
- lastTransitionTime: "2024-11-06T06:12:48Z"
message: get pod; ConditionStatus:True; PodName:solr-cluster-data-0
observedGeneration: 1
status: "True"
type: GetPod--solr-cluster-data-0
- lastTransitionTime: "2024-11-06T06:12:48Z"
message: evict pod; ConditionStatus:True; PodName:solr-cluster-data-0
observedGeneration: 1
status: "True"
type: EvictPod--solr-cluster-data-0
- lastTransitionTime: "2024-11-06T06:13:38Z"
message: get pod; ConditionStatus:True; PodName:solr-cluster-coordinator-0
observedGeneration: 1
status: "True"
type: GetPod--solr-cluster-coordinator-0
- lastTransitionTime: "2024-11-06T06:13:38Z"
message: evict pod; ConditionStatus:True; PodName:solr-cluster-coordinator-0
observedGeneration: 1
status: "True"
type: EvictPod--solr-cluster-coordinator-0
- lastTransitionTime: "2024-11-06T06:14:23Z"
message: Controller has successfully restart the Solr replicas
observedGeneration: 1
reason: Successful
status: "True"
type: Successful
observedGeneration: 1
phase: Successful
Cleaning up
To cleanup the Kubernetes resources created by this tutorial, run:
kubectl delete solropsrequest -n demo restart
kubectl delete solr -n demo solr-cluster
kubectl delete ns demo
Next Steps
Detail concepts of Solr object.
Different Solr topology clustering modes here.
Monitor your Solr database with KubeDB using out-of-the-box Prometheus operator.
Monitor your Solr database with KubeDB using out-of-the-box builtin-Prometheus
Want to hack on KubeDB? Check our contribution guidelines.