Skip to content

Commit 5a5db85

Browse files
docs: complete cookbook Phase 3 and fix support-package syntax (#395)
Phase 3 Complete: - Add all 12 cookbook recipes to navigation in SUMMARY.md - Redis Cloud: 6 recipes (create database, VPC peering, ACLs, backup/restore, migration, Active-Active) - Redis Enterprise: 6 recipes (create database, support package, cluster health, node management, replication, Redis ACLs) Command Syntax Fixes (discovered during Docker testing): - Correct support-package commands: 'create' → 'cluster/database' subcommands - Fix flag names: '--output' → '--file' - Remove unnecessary '--wait' flags All Enterprise commands tested against local Docker instance. Closes #388
1 parent 8f7ee63 commit 5a5db85

File tree

2 files changed

+30
-34
lines changed

2 files changed

+30
-34
lines changed

docs/src/SUMMARY.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,18 @@
1717
- [Overview](./cookbook/README.md)
1818
- [Redis Cloud]()
1919
- [Create Your First Database](./cookbook/cloud/create-first-database.md)
20+
- [Set Up VPC Peering](./cookbook/cloud/setup-vpc-peering.md)
21+
- [Configure ACL Security](./cookbook/cloud/configure-acls.md)
22+
- [Backup and Restore](./cookbook/cloud/backup-restore.md)
23+
- [Database Migration](./cookbook/cloud/database-migration.md)
24+
- [Active-Active Setup](./cookbook/cloud/active-active-setup.md)
2025
- [Redis Enterprise]()
2126
- [Create a Database](./cookbook/enterprise/create-database.md)
2227
- [Generate Support Package](./cookbook/enterprise/support-package.md)
28+
- [Cluster Health Monitoring](./cookbook/enterprise/cluster-health.md)
29+
- [Node Management](./cookbook/enterprise/node-management.md)
30+
- [Configure Replication](./cookbook/enterprise/configure-replication.md)
31+
- [Configure Redis ACLs](./cookbook/enterprise/configure-redis-acls.md)
2332

2433
# Redis Cloud
2534

docs/src/cookbook/enterprise/support-package.md

Lines changed: 21 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@
1111
Generate support package for entire cluster:
1212

1313
```bash
14-
redisctl enterprise support-package create \
15-
--output /tmp/support-package.tar.gz \
16-
--wait
14+
redisctl enterprise support-package cluster \
15+
--file /tmp/support-package.tar.gz
1716
```
1817

1918
## What is a Support Package?
@@ -34,9 +33,8 @@ Used for troubleshooting with Redis support or internal diagnostics.
3433
Create a support package for the entire cluster:
3534

3635
```bash
37-
redisctl enterprise support-package create \
38-
--output /tmp/cluster-support-$(date +%Y%m%d).tar.gz \
39-
--wait
36+
redisctl enterprise support-package cluster \
37+
--file /tmp/cluster-support-$(date +%Y%m%d).tar.gz
4038
```
4139

4240
**What you should see:**
@@ -51,22 +49,20 @@ Size: 45.2 MB
5149
Create a package for just one database (smaller, faster):
5250

5351
```bash
54-
redisctl enterprise support-package create \
52+
redisctl enterprise support-package database \
5553
--database-id 1 \
56-
--output /tmp/db1-support.tar.gz \
57-
--wait
54+
--file /tmp/db1-support.tar.gz
5855
```
5956

6057
### 3. Optimize Before Upload
6158

6259
Reduce package size for faster upload:
6360

6461
```bash
65-
redisctl enterprise support-package create \
62+
redisctl enterprise support-package database \
6663
--database-id 1 \
6764
--optimize \
68-
--output /tmp/db1-optimized.tar.gz \
69-
--wait
65+
--file /tmp/db1-optimized.tar.gz
7066
```
7167

7268
**What `--optimize` does:**
@@ -94,12 +90,11 @@ export FILES_API_KEY="your-api-key"
9490
Create package and upload in one command:
9591

9692
```bash
97-
redisctl enterprise support-package create \
93+
redisctl enterprise support-package database \
9894
--database-id 1 \
9995
--optimize \
10096
--upload \
101-
--no-save \
102-
--wait
97+
--no-save
10398
```
10499

105100
**Flags explained:**
@@ -123,14 +118,9 @@ URL: https://yourcompany.files.com/file/support-packages/db1-20251007-abc123.tar
123118
Exclude certain log types:
124119

125120
```bash
126-
redisctl enterprise support-package create \
127-
--data '{
128-
"database_id": 1,
129-
"log_types": ["redis", "cluster"],
130-
"time_range": "last_24_hours"
131-
}' \
132-
--output /tmp/filtered-support.tar.gz \
133-
--wait
121+
redisctl enterprise support-package database \
122+
--database-id 1 \
123+
--file /tmp/filtered-support.tar.gz
134124
```
135125

136126
### Automated Uploads
@@ -144,12 +134,11 @@ Schedule regular support package uploads:
144134
DATE=$(date +%Y%m%d-%H%M%S)
145135
DB_ID=$1
146136

147-
redisctl enterprise support-package create \
137+
redisctl enterprise support-package database \
148138
--database-id "$DB_ID" \
149139
--optimize \
150140
--upload \
151141
--no-save \
152-
--wait \
153142
-o json | tee /var/log/support-upload-$DATE.log
154143
```
155144

@@ -164,11 +153,10 @@ Run via cron:
164153
Generate and get sharable link:
165154

166155
```bash
167-
RESULT=$(redisctl enterprise support-package create \
156+
RESULT=$(redisctl enterprise support-package cluster \
168157
--optimize \
169158
--upload \
170159
--no-save \
171-
--wait \
172160
-o json)
173161

174162
URL=$(echo "$RESULT" | jq -r '.upload_url')
@@ -184,12 +172,11 @@ echo "$URL"
184172
Error: Support package generation timed out
185173
```
186174

187-
**Solution:** Increase timeout for large clusters:
175+
**Solution:** Use optimize flag to reduce generation time:
188176
```bash
189-
redisctl enterprise support-package create \
190-
--wait \
191-
--wait-timeout 600 \
192-
--output /tmp/support.tar.gz
177+
redisctl enterprise support-package cluster \
178+
--optimize \
179+
--file /tmp/support.tar.gz
193180
```
194181

195182
### Upload Fails
@@ -219,9 +206,9 @@ Error: Not enough disk space
219206
find /tmp -name "*support*.tar.gz" -mtime +7
220207

221208
# Use optimization
222-
redisctl enterprise support-package create \
209+
redisctl enterprise support-package cluster \
223210
--optimize \
224-
--output /tmp/support.tar.gz
211+
--file /tmp/support.tar.gz
225212
```
226213

227214
### Database Not Found

0 commit comments

Comments
 (0)