Skip to content

Commit 0bc1223

Browse files
authored
fix: clarify quick start commands for creating a cluster and hint the user to create a key (#15)
1 parent 9b3a566 commit 0bc1223

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222

2323
## Quick Start
2424

25+
Before using `qcloud`, create a management API key and note your account ID from the [Qdrant Cloud UI](https://cloud.qdrant.io).
26+
2527
```sh
2628
# 1. Create a context with your credentials
2729
qcloud context set my-cloud \
@@ -32,21 +34,27 @@ qcloud context set my-cloud \
3234
qcloud cluster cloud-provider list
3335
qcloud cluster cloud-region list --cloud-provider aws
3436

35-
# 3. List available packages
36-
qcloud cluster package list --cloud-provider aws --cloud-region us-east-1
37-
38-
# 4. Create a cluster (waits until healthy)
37+
# 3. Create a cluster by specifying resources (waits until healthy)
38+
# Use --cpu, --ram, --disk (and optionally --gpu / --multi-az) to select
39+
# a matching package automatically.
3940
qcloud cluster create \
4041
--cloud-provider aws \
4142
--cloud-region us-east-1 \
42-
--package <PACKAGE_ID> \
43+
--cpu 2000m \
44+
--ram 8GiB \
45+
--disk 50GiB \
4346
--name my-cluster \
4447
--wait
4548

46-
# 5. Describe your new cluster
49+
# Alternatively, pick a package explicitly with --package:
50+
# qcloud cluster package list --cloud-provider aws --cloud-region us-east-1
51+
# qcloud cluster create --cloud-provider aws --cloud-region us-east-1 \
52+
# --package <PACKAGE_ID> --name my-cluster --wait
53+
54+
# 4. Describe your new cluster
4755
qcloud cluster describe <CLUSTER_ID>
4856

49-
# 6. Create an API key for it
57+
# 5. Create an API key for it
5058
qcloud cluster key create <CLUSTER_ID> --name my-key
5159
```
5260

0 commit comments

Comments
 (0)