Skip to content

Commit a645e9c

Browse files
committed
docs: add stub files for restructured hierarchy
New structure follows the 3-tier model (API/Commands/Workflows): - Getting Started with common features - Streamlined Walkthrough (3 pages) - Cloud and Enterprise sections with light grouping - Cookbook moved after main docs - Consolidated Reference section
1 parent d214749 commit a645e9c

26 files changed

+484
-106
lines changed

docs/src/SUMMARY.md

Lines changed: 42 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,49 @@
55
# Getting Started
66

77
- [Installation](./getting-started/installation.md)
8-
- [Docker Quick Start](./getting-started/docker.md)
9-
- [Configuration](./getting-started/configuration.md)
10-
- [Authentication](./getting-started/authentication.md)
11-
- [Examples](./getting-started/examples.md)
8+
- [Profiles & Authentication](./getting-started/profiles.md)
9+
- [Common Features](./getting-started/common-features.md)
10+
- [Output Formats](./getting-started/output-formats.md)
11+
- [JMESPath Queries](./getting-started/jmespath-queries.md)
12+
- [Async Operations](./getting-started/async-operations.md)
1213
- [Shell Completions](./getting-started/shell-completions.md)
13-
- [Quick Start Guide](./getting-started/quickstart.md)
1414

15-
# Complete Walkthrough
15+
# Walkthrough
1616

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)
17+
- [Overview & Concepts](./walkthrough/overview.md)
18+
- [Cloud Quick Examples](./walkthrough/cloud-examples.md)
19+
- [Enterprise Quick Examples](./walkthrough/enterprise-examples.md)
20+
21+
# Redis Cloud
22+
23+
- [Overview](./cloud/overview.md)
24+
- [API Layer](./cloud/api.md)
25+
- [Commands]()
26+
- [Databases](./cloud/commands/databases.md)
27+
- [Subscriptions](./cloud/commands/subscriptions.md)
28+
- [Access Control](./cloud/commands/access-control.md)
29+
- [Networking](./cloud/commands/networking.md)
30+
- [Tasks](./cloud/commands/tasks.md)
31+
- [Workflows](./cloud/workflows.md)
32+
33+
# Redis Enterprise
34+
35+
- [Overview](./enterprise/overview.md)
36+
- [API Layer](./enterprise/api.md)
37+
- [Commands]()
38+
- [Cluster](./enterprise/commands/cluster.md)
39+
- [Databases](./enterprise/commands/databases.md)
40+
- [Nodes](./enterprise/commands/nodes.md)
41+
- [Access Control](./enterprise/commands/access-control.md)
42+
- [Monitoring](./enterprise/commands/monitoring.md)
43+
- [Active-Active](./enterprise/commands/active-active.md)
44+
- [Workflows](./enterprise/workflows.md)
45+
- [Operations](./enterprise/operations.md)
46+
- [Support Package](./enterprise/operations/support-package.md)
47+
- [License Management](./enterprise/operations/license.md)
48+
- [Debug Info](./enterprise/operations/debuginfo.md)
49+
- [Diagnostics](./enterprise/operations/diagnostics.md)
50+
- [Migrations](./enterprise/operations/migration.md)
2851

2952
# Cookbook
3053

@@ -44,103 +67,16 @@
4467
- [Configure Replication](./cookbook/enterprise/configure-replication.md)
4568
- [Configure Redis ACLs](./cookbook/enterprise/configure-redis-acls.md)
4669

47-
# Redis Cloud
48-
49-
- [Overview](./cloud/overview.md)
50-
- [Core Resources]()
51-
- [Subscriptions](./cloud/core-resources/subscriptions.md)
52-
- [Databases](./cloud/core-resources/databases.md)
53-
- [Access Control]()
54-
- [Users](./cloud/access-control/users.md)
55-
- [ACLs](./cloud/access-control/acl.md)
56-
- [Networking]()
57-
- [Connectivity (VPC, PSC, TGW)](./cloud/networking/connectivity.md)
58-
- [Operations]()
59-
- [Tasks](./cloud/operations/tasks.md)
60-
- [Workflows](./cloud/operations/workflows.md)
61-
- [Examples](./cloud/examples.md)
62-
- [Human-Friendly Commands](./cloud/human-commands.md)
63-
- [All Commands](./cloud/commands.md)
64-
65-
# Redis Enterprise
66-
67-
- [Overview](./enterprise/overview.md)
68-
- [Core Resources]()
69-
- [Cluster](./enterprise/core-resources/cluster.md)
70-
- [Databases](./enterprise/core-resources/databases.md)
71-
- [Nodes](./enterprise/core-resources/nodes.md)
72-
- [Shards](./enterprise/core-resources/shards.md)
73-
- [Modules](./enterprise/core-resources/modules.md)
74-
- [Database Groups](./enterprise/core-resources/bdb-groups.md)
75-
- [Access Control]()
76-
- [Users & Roles](./enterprise/access-control/users.md)
77-
- [LDAP Integration](./enterprise/access-control/ldap.md)
78-
- [Active-Active]()
79-
- [CRDB Operations](./enterprise/active-active/crdb.md)
80-
- [CRDB Tasks](./enterprise/active-active/crdb-tasks.md)
81-
- [Monitoring]()
82-
- [Statistics](./enterprise/monitoring/stats.md)
83-
- [Logs](./enterprise/monitoring/logs.md)
84-
- [Alerts](./enterprise/monitoring/alerts.md)
85-
- [Usage Reports](./enterprise/monitoring/usage-report.md)
86-
- [Operations]()
87-
- [Support Package](./enterprise/operations/support-package.md)
88-
- [Debug Info](./enterprise/operations/debuginfo.md)
89-
- [Diagnostics](./enterprise/operations/diagnostics.md)
90-
- [License Management](./enterprise/operations/license.md)
91-
- [Migrations](./enterprise/operations/migration.md)
92-
- [Advanced]()
93-
- [Actions](./enterprise/advanced/actions.md)
94-
- [Workflows](./enterprise/advanced/workflows.md)
95-
- [Job Scheduler](./enterprise/advanced/job-scheduler.md)
96-
- [Bootstrap](./enterprise/advanced/bootstrap.md)
97-
- [Proxies](./enterprise/advanced/proxy.md)
98-
- [Endpoints](./enterprise/advanced/endpoints.md)
99-
- [Services](./enterprise/advanced/services.md)
100-
- [CM Settings](./enterprise/advanced/cm-settings.md)
101-
- [OCSP](./enterprise/advanced/ocsp.md)
102-
- [DNS Suffix](./enterprise/advanced/suffix.md)
103-
- [JSON Schema](./enterprise/advanced/jsonschema.md)
104-
- [Examples](./enterprise/examples.md)
105-
- [Human-Friendly Commands](./enterprise/human-commands.md)
106-
- [All Commands](./enterprise/commands.md)
107-
- [API Access](./enterprise/api-access.md)
108-
109-
# Common Features
110-
111-
- [Output Formats](./common-features/output-formats.md)
112-
- [JMESPath Queries](./common-features/jmespath-queries.md)
113-
- [Async Operations](./common-features/async-operations.md)
114-
- [Raw API Access](./common-features/raw-api.md)
115-
- [Secure Storage](./common-features/secure-storage.md)
116-
117-
# Comparison
118-
119-
- [rladmin vs redisctl](./comparison/rladmin.md)
120-
121-
# Tutorials
122-
123-
- [CI/CD Integration](./tutorials/cicd.md)
124-
- [Common Recipes](./tutorials/common-recipes.md)
125-
- [Disaster Recovery](./tutorials/disaster-recovery.md)
126-
- [Monitoring Setup](./tutorials/monitoring.md)
127-
- [Network Security](./tutorials/network-security.md)
128-
- [Production Databases](./tutorials/production-databases.md)
129-
13070
# Reference
13171

13272
- [Environment Variables](./reference/environment-variables.md)
13373
- [Configuration File](./reference/config-file.md)
13474
- [Security](./reference/security.md)
135-
- [Best Practices](./reference/best-practices.md)
13675
- [Troubleshooting](./reference/troubleshooting.md)
137-
138-
# API Reference
139-
140-
- [API Overview](./api-reference/api.md)
76+
- [rladmin Comparison](./reference/rladmin.md)
14177

14278
# Developer
14379

14480
- [Architecture](./developer/architecture.md)
14581
- [Libraries](./developer/libraries.md)
146-
- [Contributing](./developer/contributing.md)
82+
- [Contributing](./developer/contributing.md)

docs/src/cloud/api.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Cloud API Layer
2+
3+
Direct REST access to the Redis Cloud API.
4+
5+
## Overview
6+
7+
The API layer provides raw access to all Redis Cloud REST endpoints. Use this for:
8+
- Scripting and automation
9+
- Accessing endpoints not yet wrapped in human commands
10+
- CI/CD pipelines
11+
12+
## Authentication
13+
14+
Uses `x-api-key` and `x-api-secret-key` headers. Configure via profile or environment variables.
15+
16+
## Usage
17+
18+
```bash
19+
# GET request
20+
redisctl api cloud get /subscriptions
21+
22+
# POST request with data
23+
redisctl api cloud post /subscriptions -d '{"name": "test", ...}'
24+
25+
# PUT request
26+
redisctl api cloud put /subscriptions/123 -d '{"name": "updated"}'
27+
28+
# DELETE request
29+
redisctl api cloud delete /subscriptions/123/databases/456
30+
```
31+
32+
## Common Endpoints
33+
34+
- `/account` - Account information
35+
- `/subscriptions` - Subscription management
36+
- `/subscriptions/{id}/databases` - Database operations
37+
- `/acl/users` - User management
38+
- `/acl/roles` - Role management
39+
- `/tasks` - Async task status
40+
41+
TODO: Move detailed content from common-features/raw-api.md
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Cloud Access Control
2+
3+
User and ACL management.
4+
5+
TODO: Consolidate from access-control/users.md and access-control/acl.md
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Cloud Databases
2+
3+
Database management commands for Redis Cloud.
4+
5+
## List Databases
6+
7+
```bash
8+
redisctl cloud database list
9+
redisctl cloud database list --subscription-id 123456
10+
```
11+
12+
## Get Database
13+
14+
```bash
15+
redisctl cloud database get <subscription-id> <database-id>
16+
```
17+
18+
## Create Database
19+
20+
```bash
21+
redisctl cloud database create \
22+
--subscription-id 123456 \
23+
--name mydb \
24+
--memory-limit-in-gb 1
25+
```
26+
27+
## Update Database
28+
29+
```bash
30+
redisctl cloud database update <subscription-id> <database-id> \
31+
--name newname
32+
```
33+
34+
## Delete Database
35+
36+
```bash
37+
redisctl cloud database delete <subscription-id> <database-id>
38+
```
39+
40+
TODO: Consolidate from core-resources/databases.md
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Cloud Networking
2+
3+
VPC peering, Private Service Connect, and Transit Gateway.
4+
5+
TODO: Consolidate from networking/connectivity.md
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Cloud Subscriptions
2+
3+
Subscription management commands.
4+
5+
TODO: Consolidate from core-resources/subscriptions.md

docs/src/cloud/commands/tasks.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Cloud Tasks
2+
3+
Async task monitoring.
4+
5+
TODO: Consolidate from operations/tasks.md

docs/src/cloud/workflows.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Cloud Workflows
2+
3+
Multi-step operations for common tasks.
4+
5+
## Available Workflows
6+
7+
### subscription-setup
8+
9+
Creates a subscription with optional VPC peering and initial database.
10+
11+
```bash
12+
redisctl cloud workflow subscription-setup \
13+
--name production \
14+
--region us-east-1 \
15+
--cloud-provider aws
16+
```
17+
18+
TODO: Expand with actual workflow documentation

docs/src/enterprise/api.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Enterprise API Layer
2+
3+
Direct REST access to the Redis Enterprise API.
4+
5+
## Overview
6+
7+
The API layer provides raw access to all Redis Enterprise REST endpoints. Use this for:
8+
- Scripting and automation
9+
- Accessing endpoints not yet wrapped in human commands
10+
- CI/CD pipelines
11+
12+
## Authentication
13+
14+
Uses Basic auth (username/password). Configure via profile or environment variables.
15+
16+
## Usage
17+
18+
```bash
19+
# GET request
20+
redisctl api enterprise get /v1/cluster
21+
22+
# POST request with data
23+
redisctl api enterprise post /v1/bdbs -d '{"name": "test", ...}'
24+
25+
# PUT request
26+
redisctl api enterprise put /v1/bdbs/1 -d '{"name": "updated"}'
27+
28+
# DELETE request
29+
redisctl api enterprise delete /v1/bdbs/1
30+
```
31+
32+
## Common Endpoints
33+
34+
- `/v1/cluster` - Cluster information
35+
- `/v1/nodes` - Node management
36+
- `/v1/bdbs` - Database operations
37+
- `/v1/users` - User management
38+
- `/v1/roles` - Role management
39+
40+
TODO: Move detailed content from enterprise/api-access.md
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Enterprise Access Control
2+
3+
User, role, and LDAP management.
4+
5+
TODO: Consolidate from access-control/users.md and access-control/ldap.md

0 commit comments

Comments
 (0)