Skip to content

Commit 43d86b9

Browse files
reference custom resource info
1 parent 27a6eca commit 43d86b9

File tree

1 file changed

+89
-4
lines changed
  • content/operate/kubernetes/reference

1 file changed

+89
-4
lines changed

content/operate/kubernetes/reference/_index.md

Lines changed: 89 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,99 @@ categories:
55
- docs
66
- operate
77
- 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
1110
linkTitle: Reference
1211
weight: 89
1312
---
1413

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.
1615

16+
## Working with custom resources
1717

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.
1819

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:
78+
79+
### Core resources
80+
81+
- [Redis Enterprise cluster API (REC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) - Manage Redis Enterprise clusters
82+
- [Redis Enterprise database API (REDB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}}) - Manage Redis databases
83+
84+
### Active-Active resources
85+
86+
- [Active-Active database API (REAADB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}}) - Manage Active-Active databases
87+
- [Remote cluster API (RERC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}}) - Configure remote cluster connections
88+
89+
## Compatibility
90+
91+
Information about supported Kubernetes distributions and versions:
92+
93+
- [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) - Compatible Kubernetes platforms and versions
94+
95+
## Best practices
96+
97+
When working with custom resources:
98+
99+
- **Use version control**: Store your YAML manifests in version control systems
100+
- **Validate before applying**: Use `kubectl apply --dry-run=client` to validate changes
101+
- **Monitor resource status**: Check resource status after applying changes
102+
- **Follow naming conventions**: Use consistent naming for easier management
103+
- **Document configurations**: Add annotations and labels to describe resource purpose

0 commit comments

Comments
 (0)