Skip to content

Commit 9683c0e

Browse files
api section
1 parent 6f9c84d commit 9683c0e

13 files changed

+57
-1
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: API reference
3+
categories:
4+
- docs
5+
- operate
6+
- kubernetes
7+
linkTitle: API reference
8+
description: Reference documentation for Redis Enterprise operator APIs
9+
weight: 30
10+
alwaysopen: false
11+
hideListLinks: true
12+
aliases:
13+
---
14+
15+
The Redis Enterprise operator provides Kubernetes custom resource definitions (CRDs) that allow you to manage Redis Enterprise clusters and databases declaratively. This section contains the complete API reference for all operator resources.
16+
17+
## API versions and stability
18+
19+
The operator uses different API versions to indicate stability and feature maturity:
20+
21+
- **`app.redislabs.com/v1`** - Stable APIs for production use
22+
- **`app.redislabs.com/v1alpha1`** - Alpha APIs that may change in future releases
23+
24+
## Custom resources
25+
26+
| Resource | API Version | Purpose |
27+
|----------|-------------|---------|
28+
| [RedisEnterpriseCluster (REC)](redis_enterprise_cluster_api) | `v1` | Manages Redis Enterprise cluster deployments |
29+
| [RedisEnterpriseDatabase (REDB)](redis_enterprise_database_api) | `v1alpha1` | Creates and configures Redis databases |
30+
| [RedisEnterpriseActiveActiveDatabase (REAADB)](redis_enterprise_active_active_database_api) | `v1alpha1` | Sets up active-active databases across clusters |
31+
| [RedisEnterpriseRemoteCluster (RERC)](redis_enterprise_remote_cluster_api) | `v1alpha1` | Defines remote cluster connections for active-active |
32+
33+
## Working with the APIs
34+
35+
### Using kubectl
36+
37+
All resources can be managed using standard `kubectl` commands:
38+
39+
```bash
40+
# List all Redis Enterprise clusters
41+
kubectl get rec
42+
43+
# Get detailed information about a specific database
44+
kubectl describe redb my-database
45+
46+
# Apply a configuration from a YAML file
47+
kubectl apply -f my-redis-config.yaml
48+
```
49+
50+
### Resource relationships
51+
52+
- A `RedisEnterpriseCluster` (REC) must be created first to provide the Redis Enterprise infrastructure
53+
- `RedisEnterpriseDatabase` (REDB) resources are created within a cluster to provision individual databases
54+
- `RedisEnterpriseActiveActiveDatabase` (REAADB) requires `RedisEnterpriseRemoteCluster (RERC)` resources to define participating clusters
55+
56+
For complete YAML configuration examples, see the [YAML examples](../yaml/) section.

content/operate/kubernetes/reference/supported_k8s_distributions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ categories:
77
- kubernetes
88
description: Support matrix for the current Redis Enterprise K8s operator
99
linkTitle: Supported distributions
10-
weight: 30
10+
weight: 10
1111
---
1212

1313
Each release of Redis Enterprise for Kubernetes is thoroughly tested against a set of Kubernetes distributions. The table below lists Redis Enterprise for Kubernetes versions and the Kubernetes distributions they support.

0 commit comments

Comments
 (0)