-
Notifications
You must be signed in to change notification settings - Fork 66
/
atlas-clusters-create.txt
216 lines (163 loc) · 7.29 KB
/
atlas-clusters-create.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
.. _atlas-clusters-create:
=====================
atlas clusters create
=====================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Create a cluster for your project.
To get started quickly, specify a name for your cluster, a cloud provider, and a region to deploy a three-member replica set with the latest MongoDB server version.
For full control of your deployment, or to create multi-cloud clusters, provide a JSON configuration file with the --file flag.
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
Syntax
------
.. code-block::
:caption: Command Syntax
atlas clusters create [name] [options]
.. Code end marker, please don't delete this comment
Arguments
---------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - Name
- Type
- Required
- Description
* - name
- string
- false
- Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphens. You must specify the cluster name argument if you don't use the --file option.
Options
-------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - Name
- Type
- Required
- Description
* - --backup
-
- false
- Flag that enables Continuous Cloud Backup for your deployment. This option is unavailable for clusters smaller than M10.
* - --biConnector
-
- false
- Flag that enables BI Connector for Atlas on the deployment.
Mutually exclusive with --file.
* - --diskSizeGB
- float
- false
- Capacity, in gigabytes, of the host's root volume.
Mutually exclusive with --file. This value defaults to 2.
* - --enableTerminationProtection
-
- false
- Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled.
* - -f, --file
- string
- false
- Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
Mutually exclusive with --tier, --provider, --members, --region, --diskSizeGB, --mdbVersion, --biConnector, --type, --shards, --tag.
* - -h, --help
-
- false
- help for create
* - --mdbVersion
- string
- false
- Major MongoDB version of the cluster.
Mutually exclusive with --file. This value defaults to "7.0".
* - -m, --members
- int
- false
- Number of members in the replica set.
Mutually exclusive with --file. This value defaults to 3.
* - -o, --output
- string
- false
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
* - --projectId
- string
- false
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
* - --provider
- string
- false
- Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. You must specify the provider option if you don't use the --file option.
Mutually exclusive with --file.
* - -r, --region
- string
- false
- Physical location of your MongoDB cluster. You must specify the region option if you don't use the --file option. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas.
Mutually exclusive with --file.
* - -s, --shards
- int
- false
- Number of shards in the cluster.
Mutually exclusive with --file. This value defaults to 1.
* - --tag
- key=value
- false
- List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.
Mutually exclusive with --file.
* - --tier
- string
- false
- Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas.
Mutually exclusive with --file. This value defaults to "M2".
* - --type
- string
- false
- Type of the cluster that you want to create. Valid values are REPLICASET or SHARDED.
Mutually exclusive with --file. This value defaults to "REPLICASET".
* - -w, --watch
-
- false
- Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option.
* - --watchTimeout
- uint
- false
- Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command.
Inherited Options
-----------------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
Output
------
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
.. code-block::
Cluster '<Name>' is being created.
Examples
--------
.. code-block::
# Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0
.. code-block::
# Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3 and tag "env=dev":
atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0 --tag env=dev
.. code-block::
# Deploy a three-member replica set named myRS in AWS for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10
.. code-block::
# Deploy a three-member replica set named myRS in AZURE for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10
.. code-block::
# Deploy a three-member replica set named myRS in GCP for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10
.. code-block::
# Deploy a cluster or a multi-cloud cluster from a JSON configuration file named myfile.json for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas cluster create --projectId <projectId> --file myfile.json