New to KubeDB? Please start here.

SolrVersion

What is SolrVersion

SolrVersion is a Kubernetes Custom Resource Definitions (CRD). It provides a declarative configuration to specify the docker images to be used for Solr database deployed with KubeDB in a Kubernetes native way.

When you install KubeDB, a SolrVersion custom resource will be created automatically for every supported Solr versions. You have to specify the name of SolrVersion crd in spec.version field of Solr crd. Then, KubeDB will use the docker images specified in the SolrVersion crd to create your expected database.

Using a separate crd for specifying respective docker images, and pod security policy names allow us to modify the images, and policies independent of KubeDB operator. This will also allow the users to use a custom image for the database.

SolrVersion Specification

As with all other Kubernetes objects, a SolrVersion needs apiVersion, kind, and metadata fields. It also needs a .spec section.

apiVersion: catalog.kubedb.com/v1alpha1
kind: SolrVersion
metadata:
  annotations:
    meta.helm.sh/release-name: kubedb-catalog
    meta.helm.sh/release-namespace: kubedb
  creationTimestamp: "2024-05-06T08:55:33Z"
  generation: 2
  labels:
    app.kubernetes.io/instance: kubedb-catalog
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/name: kubedb-catalog
    app.kubernetes.io/version: v2024.4.27
    helm.sh/chart: kubedb-catalog-v2024.4.27
  name: 9.4.1
  resourceVersion: "3229"
  uid: 441f6f1e-943c-4a34-84ac-f2705da63fb1
spec:
  db:
    image: ghcr.io/appscode-images/solr:9.4.1
  initContainer:
    image: ghcr.io/kubedb/solr-init:9.4.1
  securityContext:
    runAsUser: 8983
  version: 9.4.1

metadata.name

metadata.name is a required field that specifies the name of the SolrVersion crd. You have to specify this name in spec.version field of Solr crd.

spec.version

spec.version is a required field that specifies the original version of Solr server that has been used to build the docker image specified in spec.db.image field.

spec.deprecated

spec.deprecated is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator.

The default value of this field is false. If spec.deprecated is set to true, KubeDB operator will skip processing this CRD object and will add a event to the CRD object specifying that the DB version is deprecated.

spec.db.image

spec.db.image is a required field that specifies the docker image which will be used to create Petset(Appscode managed customized statefulset) by KubeDB operator to create expected Solr server.

spec.initContainer.image

spec.initContainer.image is a required field that specifies the image for init container.

spec.securityContext

DB specific security context which will be added in petset.

helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \
  --namespace kubedb --create-namespace \
  --set additionalPodSecurityPolicies[0]=custom-db-policy \
  --set-file global.license=/path/to/the/license.txt \
  --set gloabal.featureGates.Solr=true --set gloabal.featureGates.ZooKeeper=true \
  --wait --burst-limit=10000 --debug

Next Steps

• Learn about Solr crd here.
• Deploy your first Solr server with KubeDB by following the guide here.