Custom Resource Object API

CRD Schema details for Redis and Redis Cluster Reference API

API Reference

Packages

redis.redis.opstreelabs.in/v1beta1

Package v1beta1 contains API Schema definitions for the redis v1beta1 API group

Resource Types

ExistingPasswordSecret

ExistingPasswordSecret is the struct to access the existing secret

Appears in:

Field Description
name string
key string

KubernetesConfig

KubernetesConfig will be the JSON struct for Basic Redis Config

Appears in:

Field Description
image string
imagePullPolicy ImagePullPolicy
resources ResourceRequirements
redisSecret ExistingPasswordSecret
imagePullSecrets LocalObjectReference
updateStrategy StatefulSetUpdateStrategy

VolumeMount

Mount External Volumes

Appears in:

Field Description
volume Volume Array
mountPath VolumeMount Array

Redis

Redis is the Schema for the redis API

Field Description
apiVersion string redis.redis.opstreelabs.in/v1beta1
kind string Redis
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec RedisSpec

RedisCluster

RedisCluster is the Schema for the redisclusters API

Field Description
apiVersion string redis.redis.opstreelabs.in/v1beta1
kind string RedisCluster
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec RedisClusterSpec

RedisReplication

RedisReplication is the Schema for the redisreplication API

Field Description
apiVersion string redis.redis.opstreelabs.in/v1beta1
kind string RedisReplication
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec RedisReplicationSpec

RedisSentinel

RedisSentinel is the Schema for the redissentinel API

Field Description
apiVersion string redis.redis.opstreelabs.in/v1beta1
kind string RedisSentinel
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec RedisSentinelSpec

RedisClusterSpec

RedisClusterSpec defines the desired state of RedisCluster

Appears in:

Field Description
clusterSize integer
kubernetesConfig KubernetesConfig
clusterVersion string
redisLeader RedisLeader
redisFollower RedisFollower
redisExporter RedisExporter
storage Storage
nodeSelector object (keys:string, values:string)
securityContext PodSecurityContext
priorityClassName string
tolerations Toleration
resources ResourceRequirements
TLS TLSConfig
sidecars Sidecar
serviceAccountName string
persistenceEnabled boolean

RedisSpec

RedisSpec defines the desired state of Redis

Appears in:

Field Description
kubernetesConfig KubernetesConfig
redisExporter RedisExporter
redisConfig RedisConfig
storage Storage
nodeSelector object (keys:string, values:string)
securityContext PodSecurityContext
priorityClassName string
affinity Affinity
tolerations Toleration
TLS TLSConfig
readinessProbe Probe
livenessProbe Probe
sidecars Sidecar
serviceAccountName string

RedisReplicationSpec

RedisReplicationSpec defines the desired state of RedisReplication

Appears in:

Field Description
clusterSize integer
kubernetesConfig KubernetesConfig
redisExporter RedisExporter
redisConfig RedisConfig
storage Storage
nodeSelector object (keys:string, values:string)
securityContext PodSecurityContext
priorityClassName string
affinity Affinity
tolerations Toleration
TLS TLSConfig
readinessProbe Probe
livenessProbe Probe
sidecars Sidecar
serviceAccountName string

RedisSentinelSpec

RedisSentinelSpec defines the desired state of RedisSentinel

Appears in:

Field Description
clusterSize integer
kubernetesConfig KubernetesConfig
redisSentinelConfig RedisSentinelConfig
nodeSelector object (keys:string, values:string)
securityContext PodSecurityContext
priorityClassName string
affinity Affinity
tolerations Toleration
TLS TLSConfig
readinessProbe Probe
livenessProbe Probe
sidecars Sidecar
serviceAccountName string
volumeMount VolumeMount

RedisConfig

RedisConfig defines the external configuration of Redis

Appears in:

Field Description
additionalRedisConfig string

RedisSentinelConfig

RedisSentinelConfig defines the external configuration of RedisSentinel

Appears in:

Field Description
additionalRedisConfig string
masterGroupName string
redisPort string
quorum string
parallelSyncs string
failoverTimeout string
downAfterMilliseconds string

RedisExporter

RedisExporter interface will have the information for redis exporter related stuff

Appears in:

Field Description
enabled boolean
image string
resources ResourceRequirements
imagePullPolicy ImagePullPolicy
env EnvVar
securityContext PodSecurityContext

RedisFollower

RedisFollower interface will have the redis follower configuration

Appears in:

Field Description
replicas integer
redisConfig RedisConfig
affinity Affinity
pdb RedisPodDisruptionBudget
readinessProbe Probe
livenessProbe Probe

RedisLeader

RedisLeader interface will have the redis leader configuration

Appears in:

Field Description
replicas integer
redisConfig RedisConfig
affinity Affinity
pdb RedisPodDisruptionBudget
readinessProbe Probe
livenessProbe Probe

RedisPodDisruptionBudget

RedisPodDisruptionBudget configure a PodDisruptionBudget on the resource (leader/follower)

Appears in:

Field Description
enabled boolean
minAvailable integer
maxUnavailable integer

Sidecar

Sidecar for each Redis pods

Appears in:

Field Description
name string
image string
imagePullPolicy ImagePullPolicy
resources ResourceRequirements
env EnvVar
securityContext PodSecurityContext

Storage

Storage is the inteface to add pvc and pv support in redis

Appears in:

Field Description
volumeClaimTemplate PersistentVolumeClaim

TLSConfig

TLS Configuration for redis instances

Appears in:

Field Description
ca string
cert string
key string
secret SecretVolumeSource Reference to secret which contains the certificates
Last modified June 19, 2024: feat: add support for extra volume mounts for redis sentinel (#994) (909d9e4)