Skip to content

Commit 7c24c24

Browse files
committed
docs: simplify walkthrough structure and add clean demo script
- Flatten walkthrough navigation (8, 8.1, 8.2, etc. instead of separate top-level items) - Create DEMO.md with clean copy-paste commands for live presentation - Organized by demo flow: problem -> solution -> features -> automation - Includes setup, recovery commands, and talking points - Commands tested and ready to run This makes the presentation cleaner and gives you a reliable script to practice and present from.
1 parent 759451a commit 7c24c24

File tree

2 files changed

+141
-11
lines changed

2 files changed

+141
-11
lines changed

docs/src/SUMMARY.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@
1414

1515
# Complete Walkthrough
1616

17-
- [Introduction](./walkthrough/README.md)
18-
- [1. The Problem](./walkthrough/01-problem.md)
19-
- [2. Enter redisctl](./walkthrough/02-solution.md)
20-
- [3. Installation & Setup](./walkthrough/03-setup.md)
21-
- [4. Raw API Layer](./walkthrough/04-raw-api.md)
22-
- [5. Human-Friendly Layer](./walkthrough/05-human-friendly.md)
23-
- [6. Workflows Layer](./walkthrough/06-workflows.md)
24-
- [7. Advanced Features](./walkthrough/07-advanced.md)
25-
- [8. Library Architecture](./walkthrough/08-libraries.md)
26-
- [9. Next Steps](./walkthrough/09-next-steps.md)
27-
- [Appendix: rladmin vs redisctl](./walkthrough/rladmin-comparison.md)
17+
- [8. Introduction](./walkthrough/README.md)
18+
- [8.1 The Problem](./walkthrough/01-problem.md)
19+
- [8.2 Enter redisctl](./walkthrough/02-solution.md)
20+
- [8.3 Installation & Setup](./walkthrough/03-setup.md)
21+
- [8.4 Raw API Layer](./walkthrough/04-raw-api.md)
22+
- [8.5 Human-Friendly Layer](./walkthrough/05-human-friendly.md)
23+
- [8.6 Workflows Layer](./walkthrough/06-workflows.md)
24+
- [8.7 Advanced Features](./walkthrough/07-advanced.md)
25+
- [8.8 Library Architecture](./walkthrough/08-libraries.md)
26+
- [8.9 Next Steps](./walkthrough/09-next-steps.md)
27+
- [8.10 Appendix: rladmin vs redisctl](./walkthrough/rladmin-comparison.md)
2828

2929
# Cookbook
3030

examples/presentation/DEMO.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Live Demo Script - redisctl Presentation
2+
3+
Clean, copy-paste ready commands for terminal demo.
4+
5+
## Setup (Run Once Before Presentation)
6+
7+
```bash
8+
# Start Docker cluster
9+
docker compose up -d
10+
11+
# Set environment variables (keep in terminal)
12+
export REDIS_ENTERPRISE_URL="https://localhost:9443"
13+
export REDIS_ENTERPRISE_USER="[email protected]"
14+
export REDIS_ENTERPRISE_PASSWORD="Redis123!"
15+
export REDIS_ENTERPRISE_INSECURE="true"
16+
```
17+
18+
## Demo Flow
19+
20+
### 1. Show the Problem (30 seconds)
21+
22+
**Before redisctl - The old way with curl + jq + polling:**
23+
24+
```bash
25+
# Get cluster info - verbose curl
26+
curl -k -u "[email protected]:Redis123!" \
27+
https://localhost:9443/v1/cluster | jq '.name'
28+
29+
# List databases - messy output
30+
curl -k -u "[email protected]:Redis123!" \
31+
https://localhost:9443/v1/bdbs | jq
32+
```
33+
34+
### 2. Show redisctl - The new way (2 minutes)
35+
36+
**Clean, simple commands:**
37+
38+
```bash
39+
# Cluster info - one command
40+
redisctl enterprise cluster get -o json -q 'name'
41+
42+
# List databases - clean table
43+
redisctl enterprise database list -o table
44+
45+
# Database details with filtering
46+
redisctl enterprise database get 1 -o json -q '{name: name, memory: memory_size, status: status}'
47+
```
48+
49+
### 3. Show the Comprehensive Status Command (1 minute)
50+
51+
**NEW feature - single view of everything:**
52+
53+
```bash
54+
# Show everything at once (like rladmin status)
55+
redisctl enterprise status -o json -q 'summary'
56+
57+
# Full status
58+
redisctl enterprise status
59+
```
60+
61+
### 4. Show Structured Output Power (1 minute)
62+
63+
**JSON/YAML for automation:**
64+
65+
```bash
66+
# Get all database names as array
67+
redisctl enterprise database list -o json -q '[].name'
68+
69+
# Filter active databases only
70+
redisctl enterprise database list -o json -q '[?status==`active`].{name: name, memory: memory_size}'
71+
72+
# YAML output for configs
73+
redisctl enterprise cluster get -o yaml
74+
```
75+
76+
### 5. Show Multi-Cluster Management (1 minute)
77+
78+
**Profile system:**
79+
80+
```bash
81+
# List profiles
82+
redisctl profile list
83+
84+
# Switch between clusters (if you have multiple)
85+
redisctl enterprise database list --profile prod
86+
redisctl enterprise database list --profile staging
87+
```
88+
89+
### 6. Show Support Package Automation (30 seconds)
90+
91+
**From 10 minutes to 30 seconds:**
92+
93+
```bash
94+
# Generate optimized support package
95+
redisctl enterprise support-package cluster --optimize
96+
97+
# With upload (if configured)
98+
# redisctl enterprise support-package cluster --optimize --upload
99+
```
100+
101+
## Recovery Commands (If Demo Fails)
102+
103+
```bash
104+
# Restart Docker cluster
105+
docker compose restart
106+
107+
# Check cluster health
108+
curl -k -u "[email protected]:Redis123!" https://localhost:9443/v1/cluster/healthcheck
109+
110+
# Rebuild if needed
111+
docker compose down -v && docker compose up -d
112+
```
113+
114+
## Key Talking Points During Demo
115+
116+
- **No SSH required** - All remote via REST API
117+
- **Structured output** - JSON/YAML for automation
118+
- **JMESPath queries** - Filter output easily
119+
- **Cross-platform** - Works on macOS, Linux, Windows
120+
- **One binary** - No dependencies
121+
- **Profile management** - Multi-cluster support
122+
- **Library-first** - Can be used in Terraform, automation tools
123+
124+
## Notes
125+
126+
- Keep the terminal window large (readable font)
127+
- Have commands pre-typed or in clipboard manager
128+
- Run through sequence 2-3 times before presentation
129+
- If a command hangs, Ctrl+C and move on
130+
- The Docker cluster is local - everything is fast

0 commit comments

Comments
 (0)