You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/kubernetes/reference/_index.md
+89-4Lines changed: 89 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,14 +5,99 @@ categories:
5
5
- docs
6
6
- operate
7
7
- kubernetes
8
-
description: Reference material for the operator, cluster, and database deployment
9
-
options.
10
-
hideListLinks: false
8
+
description: API reference and guides for managing Redis Enterprise custom resources on Kubernetes.
9
+
hideListLinks: true
11
10
linkTitle: Reference
12
11
weight: 89
13
12
---
14
13
15
-
This section contains the API reference for Redis custom resources and supported distributions.
14
+
Reference documentation for Redis Enterprise custom resources, including API specifications and practical guides for creating, configuring, and managing Redis Enterprise deployments on Kubernetes.
16
15
16
+
## Working with custom resources
17
17
18
+
Redis Enterprise for Kubernetes uses custom resources to manage clusters and databases. You can create, modify, and delete these resources using standard Kubernetes tools.
18
19
20
+
### Creating custom resources
21
+
22
+
Create custom resources using `kubectl apply` with YAML manifests:
23
+
24
+
```bash
25
+
kubectl apply -f my-redis-cluster.yaml
26
+
kubectl apply -f my-redis-database.yaml
27
+
```
28
+
29
+
### Viewing custom resources
30
+
31
+
List and inspect existing custom resources:
32
+
33
+
```bash
34
+
# List Redis Enterprise clusters
35
+
kubectl get rec
36
+
37
+
# List Redis Enterprise databases
38
+
kubectl get redb
39
+
40
+
# List Active-Active databases
41
+
kubectl get reaadb
42
+
43
+
# List remote clusters
44
+
kubectl get rerc
45
+
46
+
# Get detailed information about a specific resource
47
+
kubectl describe rec my-cluster
48
+
kubectl describe redb my-database
49
+
```
50
+
51
+
### Modifying custom resources
52
+
53
+
Update custom resources by editing the YAML manifest and reapplying:
54
+
55
+
```bash
56
+
# Edit and apply updated manifest
57
+
kubectl apply -f updated-redis-cluster.yaml
58
+
59
+
# Or edit directly (not recommended for production)
60
+
kubectl edit rec my-cluster
61
+
kubectl edit redb my-database
62
+
```
63
+
64
+
### Deleting custom resources
65
+
66
+
Remove custom resources when no longer needed:
67
+
68
+
```bash
69
+
kubectl delete redb my-database
70
+
kubectl delete rec my-cluster
71
+
```
72
+
73
+
**Important:** Always delete databases (REDB) before deleting the cluster (REC) to ensure proper cleanup.
74
+
75
+
## API reference
76
+
77
+
Complete API specifications for all Redis Enterprise custom resources:
0 commit comments