API reference - Redis

The Redis Enterprise operator provides Kubernetes custom resource definitions (CRDs) that let you manage Redis Enterprise clusters and databases declaratively. This section contains the complete API reference for all operator resources.

API versions and stability

The operator uses different API versions to indicate stability and feature maturity:

app.redislabs.com/v1 - Stable APIs for production use
app.redislabs.com/v1alpha1 - Alpha APIs that may change in future releases

Custom resources

Resource	API Version	Purpose
RedisEnterpriseCluster (REC)	`v1`	Manages Redis Enterprise cluster deployments
RedisEnterpriseDatabase (REDB)	`v1alpha1`	Creates and configures Redis databases
RedisEnterpriseActiveActiveDatabase (REAADB)	`v1alpha1`	Sets up active-active databases across clusters
RedisEnterpriseRemoteCluster (RERC)	`v1alpha1`	Defines remote cluster connections for active-active

Working with the APIs

Using kubectl

Manage all resources using standard kubectl commands:

bash

# List all Redis Enterprise clusters
kubectl get rec

# Get detailed information about a specific database
kubectl describe redb my-database

# Apply a configuration from a YAML file
kubectl apply -f my-redis-config.yaml

Resource relationships

Create a RedisEnterpriseCluster (REC) first to provide the Redis Enterprise infrastructure
Create RedisEnterpriseDatabase (REDB) resources within a cluster to provision individual databases
Use RedisEnterpriseActiveActiveDatabase (REAADB) with RedisEnterpriseRemoteCluster (RERC) resources to define participating clusters

For complete YAML configuration examples, see the [YAML examples]({{< relref "/operate/kubernetes/7.22/reference/yaml/" >}}) section.