Skip to content

Commit 3f3dacd

Browse files
joshrotenbergjoshrotenberg
committed
docs: add comprehensive documentation for new enterprise commands
- Add documentation for bootstrap commands (cluster initialization) - Add documentation for debug-info commands (diagnostics collection) - Add documentation for LDAP integration commands - Add documentation for OCSP certificate validation commands - Add documentation for service management commands - Update SUMMARY.md to include all new documentation pages - Update CLAUDE.md to enforce documentation requirements for all new features This ensures PR #309's new commands are fully documented and establishes a clear requirement that all future commands must include documentation.
1 parent cb6d902 commit 3f3dacd

File tree

6 files changed

+1099
-0
lines changed

6 files changed

+1099
-0
lines changed

‎docs/src/SUMMARY.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828

2929
- [Overview](./enterprise/overview.md)
3030
- [Cluster](./enterprise/cluster.md)
31+
- [Bootstrap](./enterprise/bootstrap.md)
3132
- [CM Settings](./enterprise/cm-settings.md)
3233
- [Databases](./enterprise/databases.md)
3334
- [Database Groups](./enterprise/bdb-groups.md)
@@ -44,11 +45,15 @@
4445
- [CRDB Tasks](./enterprise/crdb-tasks.md)
4546
- [Actions (Tasks)](./enterprise/actions.md)
4647
- [Alerts](./enterprise/alerts.md)
48+
- [Debug Info](./enterprise/debuginfo.md)
4749
- [Diagnostics](./enterprise/diagnostics.md)
4850
- [Endpoints](./enterprise/endpoints.md)
4951
- [Job Scheduler](./enterprise/job-scheduler.md)
5052
- [JSON Schema](./enterprise/jsonschema.md)
53+
- [LDAP Integration](./enterprise/ldap.md)
5154
- [License Management](./enterprise/license.md)
55+
- [OCSP Validation](./enterprise/ocsp.md)
56+
- [Service Management](./enterprise/services.md)
5257
- [DNS Suffixes](./enterprise/suffix.md)
5358
- [Workflows](./enterprise/workflows.md)
5459
- [Raw API Access](./enterprise/api-access.md)

‎docs/src/enterprise/bootstrap.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Bootstrap Commands
2+
3+
Initialize and manage Redis Enterprise cluster setup.
4+
5+
## Overview
6+
7+
Bootstrap commands handle the initial setup and configuration of Redis Enterprise clusters, including node initialization, cluster creation, and joining existing clusters.
8+
9+
## Available Commands
10+
11+
### Get Bootstrap Status
12+
13+
```bash
14+
redisctl enterprise bootstrap status
15+
```
16+
17+
Returns the current bootstrap status and node information:
18+
- Bootstrap state (not_started, in_progress, completed)
19+
- Local node details (architecture, memory, storage paths)
20+
- Available network addresses
21+
- Supported database versions
22+
23+
### Create New Cluster
24+
25+
```bash
26+
redisctl enterprise bootstrap create-cluster --data '{
27+
"cluster_name": "my-cluster",
28+
"rack_aware": false,
29+
"license": "...",
30+
"nodes": [...]
31+
}'
32+
```
33+
34+
Initialize a new Redis Enterprise cluster with the specified configuration.
35+
36+
### Join Existing Cluster
37+
38+
```bash
39+
redisctl enterprise bootstrap join-cluster --data '{
40+
"cluster_address": "192.168.1.100",
41+
"username": "[email protected]",
42+
"password": "password",
43+
"replace_node": false
44+
}'
45+
```
46+
47+
Join this node to an existing Redis Enterprise cluster.
48+
49+
### Validate Configuration
50+
51+
```bash
52+
# Validate cluster creation config
53+
redisctl enterprise bootstrap validate create_cluster --data '{...}'
54+
55+
# Validate join cluster config
56+
redisctl enterprise bootstrap validate join_cluster --data '{...}'
57+
```
58+
59+
Pre-flight validation of bootstrap configurations before execution.
60+
61+
## Common Use Cases
62+
63+
### Initial Cluster Setup
64+
65+
```bash
66+
# 1. Check bootstrap status
67+
redisctl enterprise bootstrap status
68+
69+
# 2. Validate configuration
70+
redisctl enterprise bootstrap validate create_cluster --data @cluster-config.json
71+
72+
# 3. Create the cluster
73+
redisctl enterprise bootstrap create-cluster --data @cluster-config.json
74+
```
75+
76+
### Adding Nodes to Cluster
77+
78+
```bash
79+
# 1. On new node, check status
80+
redisctl enterprise bootstrap status
81+
82+
# 2. Join the cluster
83+
redisctl enterprise bootstrap join-cluster --data '{
84+
"cluster_address": "node1.redis.local",
85+
"username": "[email protected]",
86+
"password": "${REDIS_PASSWORD}"
87+
}'
88+
```
89+
90+
## Output Examples
91+
92+
### Bootstrap Status
93+
94+
```json
95+
{
96+
"bootstrap_status": {
97+
"state": "completed",
98+
"start_time": "2025-09-15T00:18:27Z",
99+
"end_time": "2025-09-15T00:18:49Z"
100+
},
101+
"local_node_info": {
102+
"uid": "1",
103+
"architecture": "x86_64",
104+
"total_memory": 8217473024,
105+
"cores": 14,
106+
"persistent_storage_path": "/var/opt/redislabs/persist",
107+
"ephemeral_storage_path": "/var/opt/redislabs/tmp",
108+
"os_version": "Red Hat Enterprise Linux 9.6"
109+
}
110+
}
111+
```
112+
113+
## Important Notes
114+
115+
- Bootstrap operations are typically one-time actions during initial cluster setup
116+
- Most bootstrap operations require root or sudo privileges
117+
- Always validate configurations before applying them
118+
- Bootstrap operations cannot be undone - ensure backups exist
119+
120+
## Related Commands
121+
122+
- [Cluster Commands](cluster.md) - Manage cluster after bootstrap
123+
- [Node Commands](node.md) - Manage individual nodes
124+
- [Auth Commands](auth.md) - Configure authentication after bootstrap

‎docs/src/enterprise/debuginfo.md‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Debug Info Commands
2+
3+
Collect diagnostic information for troubleshooting Redis Enterprise clusters.
4+
5+
## Overview
6+
7+
Debug info commands gather comprehensive diagnostic data from Redis Enterprise clusters, nodes, and databases. This information is essential for troubleshooting issues and working with Redis support.
8+
9+
## Available Commands
10+
11+
### Collect All Debug Info
12+
13+
```bash
14+
redisctl enterprise debug-info all
15+
```
16+
17+
Collects complete diagnostic information from the entire cluster, including:
18+
- Cluster configuration and state
19+
- All node information
20+
- Database configurations
21+
- Log files
22+
- Performance metrics
23+
24+
**Note**: This can generate large amounts of data and may take several minutes.
25+
26+
### Collect Node Debug Info
27+
28+
```bash
29+
redisctl enterprise debug-info node
30+
```
31+
32+
Collects diagnostic information from the current node only:
33+
- Node configuration
34+
- System resources
35+
- Local log files
36+
- Process information
37+
- Network configuration
38+
39+
### Collect Database Debug Info
40+
41+
```bash
42+
redisctl enterprise debug-info database <bdb_uid>
43+
```
44+
45+
Collects diagnostic information for a specific database:
46+
- Database configuration
47+
- Shard distribution
48+
- Replication state
49+
- Performance metrics
50+
- Recent operations
51+
52+
## Output Options
53+
54+
### Save to File
55+
56+
```bash
57+
# Save debug info to file
58+
redisctl enterprise debug-info all > debug-$(date +%Y%m%d-%H%M%S).json
59+
60+
# Compress large debug outputs
61+
redisctl enterprise debug-info all | gzip > debug-$(date +%Y%m%d-%H%M%S).json.gz
62+
```
63+
64+
### Filter Output
65+
66+
```bash
67+
# Get specific sections with JMESPath
68+
redisctl enterprise debug-info all -q 'cluster_info'
69+
redisctl enterprise debug-info node -q 'system_info.memory'
70+
```
71+
72+
## Common Use Cases
73+
74+
### Troubleshooting Cluster Issues
75+
76+
```bash
77+
# Collect full cluster diagnostics
78+
redisctl enterprise debug-info all > cluster-debug.json
79+
80+
# Check specific node
81+
redisctl enterprise debug-info node -q 'errors'
82+
```
83+
84+
### Database Performance Issues
85+
86+
```bash
87+
# Collect database-specific diagnostics
88+
redisctl enterprise debug-info database 1 > db1-debug.json
89+
90+
# Check shard distribution
91+
redisctl enterprise debug-info database 1 -q 'shards'
92+
```
93+
94+
### Preparing Support Tickets
95+
96+
```bash
97+
# Collect and compress all diagnostics
98+
redisctl enterprise debug-info all | gzip > support-$(date +%Y%m%d).json.gz
99+
100+
# Include cluster and node info
101+
echo "=== Cluster Info ===" > support-info.txt
102+
redisctl enterprise cluster info >> support-info.txt
103+
echo "=== Debug Info ===" >> support-info.txt
104+
redisctl enterprise debug-info node >> support-info.txt
105+
```
106+
107+
## Important Notes
108+
109+
- Debug info may contain sensitive information (hostnames, IPs, configuration)
110+
- Large clusters can generate gigabytes of debug data
111+
- Collection may impact cluster performance during execution
112+
- Always review debug info before sharing with support
113+
- Some debug operations require admin privileges
114+
115+
## Output Example
116+
117+
```json
118+
{
119+
"collection_time": "2025-09-15T10:30:00Z",
120+
"cluster_info": {
121+
"name": "prod-cluster",
122+
"nodes": 3,
123+
"databases": 5,
124+
"version": "7.2.4-92"
125+
},
126+
"system_info": {
127+
"total_memory": "64GB",
128+
"cpu_cores": 16,
129+
"storage": {
130+
"persistent": "/var/opt/redislabs/persist",
131+
"ephemeral": "/var/opt/redislabs/tmp"
132+
}
133+
},
134+
"diagnostics": {
135+
"warnings": [],
136+
"errors": [],
137+
"recommendations": []
138+
}
139+
}
140+
```
141+
142+
## Performance Considerations
143+
144+
- Use `node` or `database` specific commands when possible
145+
- Run during maintenance windows for production clusters
146+
- Consider network bandwidth when collecting from remote clusters
147+
- Compress output for large datasets
148+
149+
## Related Commands
150+
151+
- [Logs Commands](logs.md) - View cluster logs
152+
- [Stats Commands](stats.md) - Monitor performance metrics
153+
- [Cluster Commands](cluster.md) - Check cluster health

0 commit comments

Comments
 (0)