Skip to content

Commit 93caf95

Browse files
joshrotenbergjoshrotenberg
committed
docs: fix Cloud database command syntax
- Use --subscription instead of --subscription-id - Use colon format for database IDs (123456:789) - Fix examples throughout docs
1 parent 6fd3170 commit 93caf95

File tree

19 files changed

+300
-361
lines changed

19 files changed

+300
-361
lines changed

‎docs/src/cloud/commands/databases.md‎

Lines changed: 103 additions & 209 deletions
Large diffs are not rendered by default.

‎docs/src/cloud/commands/networking.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ Connect your Redis Cloud subscription to your VPC.
99
### List VPC Peerings
1010

1111
```bash
12-
redisctl cloud vpc-peering list --subscription-id <ID>
12+
redisctl cloud vpc-peering list --subscription <ID>
1313
```
1414

1515
### Get VPC Peering
1616

1717
```bash
18-
redisctl cloud vpc-peering get --subscription-id <ID> --peering-id <PEERING_ID>
18+
redisctl cloud vpc-peering get --subscription <ID> --peering-id <PEERING_ID>
1919
```
2020

2121
### Create VPC Peering
2222

2323
```bash
24-
redisctl cloud vpc-peering create --subscription-id <ID> --data '{
24+
redisctl cloud vpc-peering create --subscription <ID> --data '{
2525
"region": "us-east-1",
2626
"awsAccountId": "123456789012",
2727
"vpcId": "vpc-abc123",
@@ -32,7 +32,7 @@ redisctl cloud vpc-peering create --subscription-id <ID> --data '{
3232
### Delete VPC Peering
3333

3434
```bash
35-
redisctl cloud vpc-peering delete --subscription-id <ID> --peering-id <PEERING_ID> --wait
35+
redisctl cloud vpc-peering delete --subscription <ID> --peering-id <PEERING_ID> --wait
3636
```
3737

3838
### AWS Setup
@@ -49,15 +49,15 @@ After creating the peering in redisctl:
4949
### Create PSC Service
5050

5151
```bash
52-
redisctl cloud psc create-service --subscription-id <ID> --data '{
52+
redisctl cloud psc create-service --subscription <ID> --data '{
5353
"region": "us-central1"
5454
}' --wait
5555
```
5656

5757
### Create PSC Endpoint
5858

5959
```bash
60-
redisctl cloud psc create-endpoint --subscription-id <ID> --data '{
60+
redisctl cloud psc create-endpoint --subscription <ID> --data '{
6161
"serviceId": "psc-123",
6262
"endpointName": "redis-endpoint"
6363
}' --wait
@@ -66,15 +66,15 @@ redisctl cloud psc create-endpoint --subscription-id <ID> --data '{
6666
### List PSC Services
6767

6868
```bash
69-
redisctl cloud psc list-services --subscription-id <ID>
69+
redisctl cloud psc list-services --subscription <ID>
7070
```
7171

7272
## Transit Gateway (AWS)
7373

7474
### Create Transit Gateway Attachment
7575

7676
```bash
77-
redisctl cloud tgw create --subscription-id <ID> --data '{
77+
redisctl cloud tgw create --subscription <ID> --data '{
7878
"region": "us-east-1",
7979
"transitGatewayId": "tgw-abc123",
8080
"cidrs": ["10.0.0.0/16"]
@@ -84,13 +84,13 @@ redisctl cloud tgw create --subscription-id <ID> --data '{
8484
### List Transit Gateway Attachments
8585

8686
```bash
87-
redisctl cloud tgw list --subscription-id <ID>
87+
redisctl cloud tgw list --subscription <ID>
8888
```
8989

9090
### Delete Transit Gateway Attachment
9191

9292
```bash
93-
redisctl cloud tgw delete --subscription-id <ID> --tgw-id <TGW_ID> --wait
93+
redisctl cloud tgw delete --subscription <ID> --tgw-id <TGW_ID> --wait
9494
```
9595

9696
## CIDR Allowlist
@@ -100,13 +100,13 @@ Control which IP ranges can access your subscription.
100100
### Get CIDR Allowlist
101101

102102
```bash
103-
redisctl cloud subscription get-cidr --subscription-id <ID>
103+
redisctl cloud subscription get-cidr --subscription <ID>
104104
```
105105

106106
### Update CIDR Allowlist
107107

108108
```bash
109-
redisctl cloud subscription update-cidr --subscription-id <ID> --data '{
109+
redisctl cloud subscription update-cidr --subscription <ID> --data '{
110110
"cidrIps": ["10.0.0.0/16", "192.168.1.0/24"],
111111
"securityGroupIds": ["sg-abc123"]
112112
}'
@@ -119,7 +119,7 @@ redisctl cloud subscription update-cidr --subscription-id <ID> --data '{
119119
```bash
120120
# Create peering
121121
PEERING=$(redisctl cloud vpc-peering create \
122-
--subscription-id 123456 \
122+
--subscription 123456 \
123123
--data '{
124124
"region": "us-east-1",
125125
"awsAccountId": "123456789012",
@@ -135,13 +135,13 @@ echo "Peering ID: $(echo $PEERING | jq -r '.vpcPeeringId')"
135135

136136
```bash
137137
# VPC peerings
138-
redisctl cloud vpc-peering list --subscription-id 123456 -o table
138+
redisctl cloud vpc-peering list --subscription 123456 -o table
139139

140140
# PSC services
141-
redisctl cloud psc list-services --subscription-id 123456 -o table
141+
redisctl cloud psc list-services --subscription 123456 -o table
142142

143143
# Transit gateways
144-
redisctl cloud tgw list --subscription-id 123456 -o table
144+
redisctl cloud tgw list --subscription 123456 -o table
145145
```
146146

147147
## Active-Active Networking
@@ -150,7 +150,7 @@ For Active-Active subscriptions, use the `--active-active` flag:
150150

151151
```bash
152152
redisctl cloud vpc-peering create-active-active \
153-
--subscription-id <ID> \
153+
--subscription <ID> \
154154
--region us-east-1 \
155155
--data '{...}' --wait
156156
```

‎docs/src/cloud/commands/subscriptions.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ SUBS=$(redisctl cloud subscription list -q "[].id" | jq -r '.[]')
223223
# List databases for each subscription
224224
for sub in $SUBS; do
225225
echo "Subscription $sub:"
226-
redisctl cloud database list --subscription-id $sub
226+
redisctl cloud database list --subscription $sub
227227
done
228228
```
229229

@@ -244,7 +244,7 @@ redisctl cloud subscription get 123456 -q "databases[].{name: name, memory: memo
244244
- Check that your API key has access to the subscription
245245

246246
**"Cannot delete subscription with active databases"**
247-
- Delete all databases first: `redisctl cloud database list --subscription-id <ID>`
247+
- Delete all databases first: `redisctl cloud database list --subscription <ID>`
248248
- Then delete each database before deleting the subscription
249249

250250
**"Operation timeout"**

‎docs/src/cloud/commands/tasks.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ redisctl cloud task get abc-123-def -q 'response.error.description'
6363

6464
```bash
6565
# Using --wait flag (recommended)
66-
redisctl cloud database create --subscription-id 123 --data '{...}' --wait
66+
redisctl cloud database create --subscription 123 --data '{...}' --wait
6767

6868
# Manual polling
69-
TASK_ID=$(redisctl cloud database create --subscription-id 123 --data '{...}' -q 'taskId')
69+
TASK_ID=$(redisctl cloud database create --subscription 123 --data '{...}' -q 'taskId')
7070

7171
while true; do
7272
STATUS=$(redisctl cloud task get $TASK_ID -q 'status')

‎docs/src/cloud/overview.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ redisctl api cloud post /subscriptions -d @subscription.json
1515
Human-friendly commands for day-to-day operations:
1616
```bash
1717
redisctl cloud subscription list
18-
redisctl cloud database create --subscription-id 123 --data @db.json --wait
18+
redisctl cloud database create --subscription 123 --data @db.json --wait
1919
```
2020

2121
### 3. Workflows
@@ -66,17 +66,17 @@ redisctl cloud subscription list -o table
6666

6767
# Create database and wait
6868
redisctl cloud database create \
69-
--subscription-id 123456 \
69+
--subscription 123456 \
7070
--data '{"name": "cache", "memoryLimitInGb": 1}' \
7171
--wait
7272

7373
# Get database connection info
74-
redisctl cloud database get 123456 789 \
74+
redisctl cloud database get 123456:789 \
7575
-q '{endpoint: publicEndpoint, password: password}'
7676

7777
# Set up VPC peering
7878
redisctl cloud vpc-peering create \
79-
--subscription-id 123456 \
79+
--subscription 123456 \
8080
--data @peering.json \
8181
--wait
8282
```

‎docs/src/cloud/workflows.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,15 @@ echo "Created subscription: $SUB_ID"
8282

8383
# Set up VPC peering
8484
redisctl cloud vpc-peering create \
85-
--subscription-id $SUB_ID \
85+
--subscription $SUB_ID \
8686
--data @peering.json \
8787
--wait
8888

8989
echo "VPC peering created - accept in AWS console"
9090

9191
# Create database
9292
DB_ID=$(redisctl cloud database create \
93-
--subscription-id $SUB_ID \
93+
--subscription $SUB_ID \
9494
--data @database.json \
9595
--wait \
9696
-q 'databaseId')
@@ -99,7 +99,7 @@ echo "Created database: $DB_ID"
9999

100100
# Get connection info
101101
redisctl cloud database get \
102-
--subscription-id $SUB_ID \
102+
--subscription $SUB_ID \
103103
--database-id $DB_ID \
104104
-q '{endpoint: publicEndpoint, password: password}'
105105
```
@@ -114,7 +114,7 @@ Workflows handle errors gracefully:
114114
```bash
115115
# If workflow fails, check what was created
116116
redisctl cloud subscription list -o table
117-
redisctl cloud vpc-peering list --subscription-id <ID>
117+
redisctl cloud vpc-peering list --subscription <ID>
118118
```
119119

120120
## Comparison: Workflow vs Manual
@@ -138,10 +138,10 @@ while [ "$(redisctl cloud subscription get $SUB_ID -q 'status')" != "active" ];
138138
done
139139

140140
# 3. Create database
141-
redisctl cloud database create --subscription-id $SUB_ID --data '{...}' --wait
141+
redisctl cloud database create --subscription $SUB_ID --data '{...}' --wait
142142

143143
# 4. Get connection info
144-
redisctl cloud database list --subscription-id $SUB_ID
144+
redisctl cloud database list --subscription $SUB_ID
145145
```
146146

147147
The workflow handles all the waiting, polling, and sequencing automatically.

‎docs/src/common-features/async-operations.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Use `--wait` to block until the operation completes:
88

99
```bash
1010
# Returns immediately with task ID
11-
redisctl cloud database create --subscription-id 123 --data '{...}'
11+
redisctl cloud database create --subscription 123 --data '{...}'
1212

1313
# Waits for completion, returns final result
14-
redisctl cloud database create --subscription-id 123 --data '{...}' --wait
14+
redisctl cloud database create --subscription 123 --data '{...}' --wait
1515
```
1616

1717
## Polling Options
@@ -87,7 +87,7 @@ $ redisctl cloud task get abc-123
8787
```bash
8888
# Create and get the new database ID
8989
DB_ID=$(redisctl cloud database create \
90-
--subscription-id 123 \
90+
--subscription 123 \
9191
--data '{"name": "mydb"}' \
9292
--wait \
9393
-q 'databaseId')

‎docs/src/common-features/jmespath-queries.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Filter and transform output using JMESPath expressions with the `-q` or `--query
99
redisctl enterprise cluster get -q 'name'
1010

1111
# Get nested field
12-
redisctl cloud database get 123 456 -q 'security.ssl_client_authentication'
12+
redisctl cloud database get 123:456 -q 'security.ssl_client_authentication'
1313

1414
# Get multiple fields
15-
redisctl enterprise database get 1 -q '{name: name, memory: memory_size, port: port}'
15+
redisctl enterprise database get 1:-q '{name: name, memory: memory_size, port: port}'
1616
```
1717

1818
## Array Operations

‎docs/src/cookbook/cloud/active-active-setup.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ redisctl cloud subscription create \
3232

3333
# Create Active-Active database
3434
redisctl cloud database create \
35-
--subscription-id 42 \
35+
--subscription 42 \
3636
--data '{
3737
"name": "global-cache",
3838
"memory_limit_in_gb": 2,
@@ -99,7 +99,7 @@ redisctl cloud subscription create \
9999

100100
```bash
101101
redisctl cloud database create \
102-
--subscription-id 42 \
102+
--subscription 42 \
103103
--data '{
104104
"name": "global-sessions",
105105
"memory_limit_in_gb": 5,
@@ -124,7 +124,7 @@ redisctl cloud database create \
124124
```bash
125125
# Get all regional endpoints
126126
redisctl cloud database get \
127-
--subscription-id 42 \
127+
--subscription 42 \
128128
--database-id 12345 \
129129
-o json \
130130
-q '{
@@ -189,7 +189,7 @@ r = redis.Redis(
189189
```bash
190190
# US East peering
191191
redisctl cloud connectivity vpc-peering create-aa \
192-
--subscription-id 42 \
192+
--subscription 42 \
193193
--region-id 1 \
194194
--data '{
195195
"provider_name": "AWS",
@@ -202,7 +202,7 @@ redisctl cloud connectivity vpc-peering create-aa \
202202

203203
# EU West peering
204204
redisctl cloud connectivity vpc-peering create-aa \
205-
--subscription-id 42 \
205+
--subscription 42 \
206206
--region-id 2 \
207207
--data '{
208208
"provider_name": "AWS",
@@ -255,7 +255,7 @@ redis.set('user:status', 'active') # May conflict with other region
255255
```bash
256256
# Get replication status for all regions
257257
redisctl cloud database get \
258-
--subscription-id 42 \
258+
--subscription 42 \
259259
--database-id 12345 \
260260
-o json \
261261
-q 'regions[].{
@@ -270,7 +270,7 @@ redisctl cloud database get \
270270
```bash
271271
# Check inter-region bandwidth usage
272272
redisctl cloud subscription get \
273-
--subscription-id 42 \
273+
--subscription 42 \
274274
-q 'deployment.regions[].{
275275
region: region,
276276
sync_traffic_gb: sync_traffic_gb_per_month
@@ -284,7 +284,7 @@ redisctl cloud subscription get \
284284
```bash
285285
# Add new region to subscription
286286
redisctl cloud subscription update \
287-
--subscription-id 42 \
287+
--subscription 42 \
288288
--data '{
289289
"add_regions": [
290290
{
@@ -304,7 +304,7 @@ redisctl cloud subscription update \
304304

305305
```bash
306306
redisctl cloud subscription update \
307-
--subscription-id 42 \
307+
--subscription 42 \
308308
--data '{
309309
"remove_regions": ["ap-southeast-1"]
310310
}' \
@@ -323,7 +323,7 @@ If a region becomes unavailable:
323323
```bash
324324
# Check region health
325325
redisctl cloud database get \
326-
--subscription-id 42 \
326+
--subscription 42 \
327327
--database-id 12345 \
328328
-q 'regions[].{region: region, status: status}'
329329

@@ -338,7 +338,7 @@ redisctl cloud database get \
338338
```bash
339339
# Check sync costs
340340
redisctl cloud subscription get \
341-
--subscription-id 42 \
341+
--subscription 42 \
342342
-o json \
343343
-q '{
344344
monthly_sync_gb: (deployment.regions | map(&sync_traffic_gb_per_month, @) | sum(@)),
@@ -351,7 +351,7 @@ redisctl cloud subscription get \
351351
```bash
352352
# Use read replicas in regions with heavy reads
353353
redisctl cloud database update \
354-
--subscription-id 42 \
354+
--subscription 42 \
355355
--database-id 12345 \
356356
--data '{
357357
"replication": true,
@@ -405,7 +405,7 @@ def get_top_players(n=10):
405405
# Check network connectivity between regions
406406
# Increase bandwidth allocation
407407
redisctl cloud subscription update \
408-
--subscription-id 42 \
408+
--subscription 42 \
409409
--data '{"bandwidth_gb_per_month": 500}' \
410410
--wait
411411
```

0 commit comments

Comments
 (0)