Skip to content

Commit 2d9932a

Browse files
docs: add comprehensive command documentation structure (#250)
Phase 2 of documentation reorganization (#245) - Created detailed documentation for key commands: - Cloud: subscriptions, databases, connectivity - Enterprise: cluster management - Added consistent documentation template: - Command syntax and options - Real-world examples - Common patterns - Troubleshooting section - API reference - Reorganized SUMMARY.md with logical command grouping - Added placeholder files for remaining commands - Created tutorials section structure - Added smart commands documentation Each command page now includes: - Clear command syntax - All available options - Multiple examples - Common usage patterns - Troubleshooting tips - Related commands - Direct API endpoints
1 parent 4a5a4ee commit 2d9932a

23 files changed

+1171
-29
lines changed

docs/src/SUMMARY.md

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,53 @@
88
- [Configuration](./getting-started/configuration.md)
99
- [Quick Start](./getting-started/quickstart.md)
1010

11-
# Features
12-
13-
- [Async Operations](./features/async-operations.md)
14-
- [Database Operations](./features/database-operations.md)
15-
- [Subscription Management](./features/subscription-management.md)
16-
- [Network Connectivity](./features/network-connectivity.md)
17-
- [ACL Management](./features/acl-management.md)
18-
- [User & Account Management](./features/user-management.md)
19-
- [Output Formats](./features/output-formats.md)
20-
- [Profile Management](./features/profiles.md)
21-
22-
# Redis Cloud
11+
# Redis Cloud Commands
2312

2413
- [Overview](./cloud/overview.md)
25-
- [Commands](./cloud/commands.md)
26-
- [Human-Friendly Commands](./cloud/human-commands.md)
27-
- [Raw API Access](./cloud/api-access.md)
28-
- [Workflows (Coming Soon)]()
29-
- [Examples](./cloud/examples.md)
14+
- [Subscriptions](./cloud/subscriptions.md)
15+
- [Databases](./cloud/databases.md)
16+
- [Network Connectivity](./cloud/connectivity.md)
17+
- [Access Control](./cloud/acl.md)
18+
- [Users](./cloud/users.md)
19+
- [Provider Accounts](./cloud/provider-accounts.md)
20+
- [Tasks](./cloud/tasks.md)
21+
- [Raw API Access](./cloud/api-access.md)
3022

31-
# Redis Enterprise
23+
# Redis Enterprise Commands
3224

3325
- [Overview](./enterprise/overview.md)
34-
- [Commands](./enterprise/commands.md)
35-
- [Human-Friendly Commands](./enterprise/human-commands.md)
36-
- [Raw API Access](./enterprise/api-access.md)
37-
- [Workflows (Coming Soon)]()
38-
- [Examples](./enterprise/examples.md)
26+
- [Cluster](./enterprise/cluster.md)
27+
- [Databases](./enterprise/databases.md)
28+
- [Nodes](./enterprise/nodes.md)
29+
- [Users & RBAC](./enterprise/users.md)
30+
- [Statistics](./enterprise/stats.md)
31+
- [Modules](./enterprise/modules.md)
32+
- [Logs](./enterprise/logs.md)
33+
- [Active-Active (CRDB)](./enterprise/crdb.md)
34+
- [Raw API Access](./enterprise/api-access.md)
35+
36+
# Core Features
37+
38+
- [Async Operations](./features/async-operations.md)
39+
- [Output Formats](./features/output-formats.md)
40+
- [Profile Management](./features/profiles.md)
41+
- [Smart Commands](./features/smart-commands.md)
3942

40-
# CLI Reference
43+
# Tutorials
4144

42-
- [Global Options](./cli-reference/global-options.md)
43-
- [Cloud Commands](./cli-reference/cloud-commands.md)
44-
- [Enterprise Commands](./cli-reference/enterprise-commands.md)
45-
- [Smart Commands](./cli-reference/smart-commands.md)
46-
- [Profile Commands](./cli-reference/profile-commands.md)
45+
- [Managing Production Databases](./tutorials/production-databases.md)
46+
- [Setting Up Monitoring](./tutorials/monitoring.md)
47+
- [Disaster Recovery](./tutorials/disaster-recovery.md)
48+
- [Network Security](./tutorials/network-security.md)
49+
- [CI/CD Integration](./tutorials/cicd.md)
4750

4851
# Reference
4952

5053
- [Environment Variables](./reference/environment-variables.md)
5154
- [Configuration File](./reference/config-file.md)
5255
- [Troubleshooting](./reference/troubleshooting.md)
5356
- [Best Practices](./reference/best-practices.md)
57+
- [API Reference](./reference/api.md)
5458

5559
# Developer Guide
5660

docs/src/cloud/acl.md

Whitespace-only changes.

docs/src/cloud/connectivity.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Network Connectivity
2+
3+
Configure VPC peering, Private Service Connect, and Transit Gateway connections for secure network access.
4+
5+
## VPC Peering
6+
7+
### List VPC Peerings
8+
9+
```bash
10+
redisctl cloud connectivity list-vpc --subscription-id <ID>
11+
```
12+
13+
### Create VPC Peering
14+
15+
```bash
16+
redisctl cloud connectivity create-vpc --subscription-id <ID> --data @vpc.json --wait
17+
```
18+
19+
**Example Payload:**
20+
```json
21+
{
22+
"region": "us-east-1",
23+
"awsAccountId": "123456789012",
24+
"vpcId": "vpc-0abc123def456",
25+
"vpcCidr": "10.0.0.0/16"
26+
}
27+
```
28+
29+
### Delete VPC Peering
30+
31+
```bash
32+
redisctl cloud connectivity delete-vpc --subscription-id <ID> --peering-id <PEERING_ID> --wait
33+
```
34+
35+
## Private Service Connect (GCP)
36+
37+
### Create PSC
38+
39+
```bash
40+
redisctl cloud connectivity create-psc --subscription-id <ID> --data @psc.json --wait
41+
```
42+
43+
## Transit Gateway (AWS)
44+
45+
### Create Transit Gateway Attachment
46+
47+
```bash
48+
redisctl cloud connectivity create-tgw --subscription-id <ID> --data @tgw.json --wait
49+
```
50+
51+
## Common Patterns
52+
53+
### Verify Connectivity
54+
55+
```bash
56+
# List all connections
57+
redisctl cloud connectivity list-vpc --subscription-id 123456
58+
59+
# Check connection status
60+
redisctl cloud connectivity get-vpc --subscription-id 123456 --peering-id abc123 \
61+
-q "status"
62+
```
63+
64+
## Troubleshooting
65+
66+
- Ensure CIDR blocks don't overlap
67+
- Verify cloud provider permissions
68+
- Check security group rules allow Redis ports

0 commit comments

Comments
 (0)