New to KubeDB? Please start here.
RedisVersion
What is RedisVersion
RedisVersion is a Kubernetes Custom Resource Definitions (CRD). It provides a declarative configuration to specify the docker images to be used for Redis database deployed with KubeDB in a Kubernetes native way.
When you install KubeDB, a RedisVersion custom resource will be created automatically for every supported Redis versions. You have to specify the name of RedisVersion crd in spec.version field of Redis crd. Then, KubeDB will use the docker images specified in the RedisVersion 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.
RedisVersion Specification
As with all other Kubernetes objects, a RedisVersion needs apiVersion, kind, and metadata fields. It also needs a .spec section.
apiVersion: catalog.kubedb.com/v1alpha1
kind: RedisVersion
metadata:
annotations:
meta.helm.sh/release-name: kubedb
meta.helm.sh/release-namespace: kubedb
labels:
app.kubernetes.io/instance: kubedb
app.kubernetes.io/managed-by: Helm
app.kubernetes.io/name: kubedb-catalog
app.kubernetes.io/version: v2023.01.17
helm.sh/chart: kubedb-catalog-v2023.01.17
name: 6.2.14
spec:
coordinator:
image: kubedb/redis-coordinator:v0.9.1
db:
image: redis:6.2.14
exporter:
image: kubedb/redis_exporter:1.9.0
initContainer:
image: kubedb/redis-init:0.7.0
podSecurityPolicies:
databasePolicyName: redis-db
stash:
addon:
backupTask:
name: redis-backup-6.2.5
restoreTask:
name: redis-restore-6.2.5
version: 6.2.14
metadata.name
metadata.name is a required field that specifies the name of the RedisVersion crd. You have to specify this name in spec.version field of Redis crd.
We follow this convention for naming RedisVersion crd:
- Name format:
{Original Redis image verion}-{modification tag}
We modify original Redis docker image to support Redis clustering and re-tag the image with v1, v2 etc. modification tag. An image with higher modification tag will have more features than the images with lower modification tag. Hence, it is recommended to use RedisVersion crd with highest modification tag to enjoy the latest features.
spec.version
spec.version is a required field that specifies the original version of Redis 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 by KubeDB operator to create expected Redis server.
spec.initContainer.image
spec.initContainer.image is a required field that specifies the image for init container.
spec.exporter.image
spec.exporter.image is a required field that specifies the image which will be used to export Prometheus metrics.
spec.stash
This holds the Backup & Restore task definitions, where a TaskRef has a Name & Params section. Params specifies a list of parameters to pass to the task.
To learn more, visit stash documentation
spec.updateConstraints
updateConstraints specifies the constraints that need to be considered during version update. Here allowList contains the versions those are allowed for updating from the current version.
An empty list of AllowList indicates all the versions are accepted except the denyList.
On the other hand, DenyList contains all the rejected versions for the update request. An empty list indicates no version is rejected.
spec.podSecurityPolicies.databasePolicyName
spec.podSecurityPolicies.databasePolicyName is a required field that specifies the name of the pod security policy required to get the database server pod(s) running. To use a user-defined policy, the name of the policy has to be set in spec.podSecurityPolicies and in the list of allowed policy names in KubeDB operator like below:
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 \
--wait --burst-limit=10000 --debug