Skip to content

Commit d70ab28

Browse files
committed
Update documentation for clusters create with free tier info
1 parent ffdebff commit d70ab28

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

docs/commands/clusters.adoc

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,31 @@ This will create a single node cluster, running the index, data query and search
6565
The full list of flags supported by `clusters create` is:
6666
6767
```
68-
--name <String> - the name of the cluster
69-
--provider <String> - the cloud provider
70-
--version <String> - the couchbase server version
71-
--capella <String> - the Capella organization to use
72-
--nodes <Int> - the number of nodes in the cluster
73-
--project <String> - the Capella project to use
68+
--name <string>: the name of the cluster
69+
--provider <string>: the cloud provider
70+
--version <string>: the couchbase server version
71+
--capella <string>: the Capella organization to use
72+
--nodes <int>: the number of nodes in the cluster
73+
--project <string>: the Capella project to use
74+
--free-tier: deploy a free tier cluster
75+
--description <string>: description for the cluster
76+
--region <string>: cloud provider region for the cluster
77+
--cidr <string>: cider block for the cluster
7478
```
7579
76-
If you want complete control over the structure of the cluster then you can pipe a JSON cluster definition into the command:
80+
The `--free-tier` flag can be used to create free tier clusters in the active Capella project.
81+
For example:
82+
83+
```
84+
👤 Charlie 🏠 remote in ☁️ default._default._default
85+
> clusters create --free-tier --provider aws --region eu-west-1 --cidr 10.0.0.0/24 --description "My first Couchbase cluster"
86+
```
87+
88+
Free clusters clusters are more limited in how they can be customised, and only the name, description, cloud provider and cidr can be configured using flags.
89+
Check the https://docs.couchbase.com/cloud/management-api-reference/index.html#tag/Free-Tier[Capella API docs] for more information.
90+
Currently free tier clusters do not support creation with a JSON cluster definition.
91+
92+
If you are using a paid cluster and want complete control over the structure of the cluster then you can pipe a JSON cluster definition into the command:
7793
7894
```
7995
👤 Charlie 🏠 remote in ☁️ default._default._default

0 commit comments

Comments
 (0)