Skip to content

Commit ed09598

Browse files
sarahsimperssarahsimpers
authored
(DOCSP-31520) Updates tutorial from quickstart to setup (#191)
1 parent f1ad3f4 commit ed09598

File tree

1 file changed

+47
-69
lines changed

1 file changed

+47
-69
lines changed

‎source/atlas-cli-quickstart.txt

Lines changed: 47 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Create and Configure an |service| Cluster
1212
:depth: 1
1313
:class: singlecol
1414

15-
This tutorial demonstrates how to use the ``atlas quickstart`` command to:
15+
This tutorial demonstrates how to use the :ref:`atlas-setup` command to:
1616

1717
1. Create one cluster in your |service| project.
1818
#. Load :atlas:`sample data </sample-data/available-sample-datasets/>`
@@ -26,9 +26,13 @@ account, see :ref:`atlas-cli-onboarding`.
2626

2727
To create a {+cluster+} using a configuration file, run the
2828
:ref:`atlas-clusters-create` command with the ``--file`` option instead
29-
of ``atlas quickstart``. To learn more about the configuration file
29+
of ``atlas setup``. To learn more about the configuration file
3030
for an |service| {+cluster+}, see :ref:`atlas-cli-cluster-config-file`.
3131

32+
You can also use ``atlas setup`` to create an |service| account and
33+
authenticate with |service|. To learn more, see
34+
:ref:`atlas-cli-onboarding`.
35+
3236
.. _atlas-cli-quick-start-reqs:
3337

3438
Prerequisites
@@ -45,15 +49,15 @@ Before you begin, complete the following tasks:
4549
Configure an |service| Cluster
4650
------------------------------
4751

48-
Use the ``atlas quickstart`` command to create an ``M0``
52+
Use the ``atlas setup`` command to create an ``M0``
4953
cluster in |service|. ``M0`` clusters have some operational :ref:`limitations <atlas-free-tier>`.
5054

5155
You can run this command in the following ways:
5256

53-
- **Default settings mode**: the command creates a sample shared-tier cluster with the
54-
default settings.
55-
- **Interactive mode**: the command prompts you for the cluster settings
56-
and provides default values.
57+
- **Default settings mode**: the command creates a sample shared-tier
58+
cluster with the default settings.
59+
- **Interactive mode**: the command prompts you for the cluster
60+
settings and provides default values.
5761
- **Noninteractive mode**: you run the command with the options.
5862

5963
Click the tab to see the command for your preferred mode.
@@ -66,12 +70,12 @@ Click the tab to see the command for your preferred mode.
6670
The command creates a sample shared-tier cluster with the
6771
following default settings:
6872

69-
- Cluster name: ``Quickstart-<number>``
73+
- Cluster name: ``Cluster<number>``
7074
- Service provider: ``AWS``
7175
- Provider region: ``US_EAST_1``
7276
- Cluster tier: ``M0``
7377
- Disk size: ``0.5`` GB
74-
- Database Username: ``Quickstart-<number>``
78+
- Database Username: ``Cluster<number>``
7579
- Database User Password: ``abcdef12345``
7680
- Allow connections from IP Address: ``<YourIPAddress>``
7781
- Load Sample Data: ``Yes``
@@ -87,74 +91,67 @@ Click the tab to see the command for your preferred mode.
8791
.. input::
8892
:language: sh
8993

90-
atlas quickstart --default --force
94+
atlas setup --force
9195

9296
.. output::
9397
:language: sh
9498

95-
We are deploying Quickstart-9876543...
99+
We are deploying Cluster9876543...
100+
101+
Please store your database authentication access details in a secure location
102+
Database User Username: Cluster9876543
103+
Database User Password: abcdef12345
104+
96105
Creating your cluster... [Its safe to 'Ctrl + C']
106+
Cluster created.
107+
Your connection string: mongodb+srv://cluster9876543.example.mongodb.net
97108

98109
Loading sample data into your cluster... [Its safe to 'Ctrl + C']
99110

100-
Now you can connect to your Atlas cluster with: mongosh -u Quickstart-9876543 -p abcdef12345 mongodb+srv://quickstart-9876543.example.mongodb.net
111+
Now you can connect to your Atlas cluster with: mongosh -u Cluster9876543 -p abcdef12345 mongodb+srv://cluster9876543.example.mongodb.net
101112

102113
.. tab:: Interactive Mode
103114
:tabid: interactive
104115

105116
The command prompts you for the cluster settings and provides
106-
default options. Press :kbd:`Enter` when prompted to accept the
107-
default settings.
117+
default options. When prompted, press :kbd:`Y`, then press
118+
:kbd:`Enter` to accept the default settings.
108119

109120
.. io-code-block::
110121

111122
.. input::
112123
:language: sh
113124

114-
atlas quickstart
125+
atlas setup
115126

116127
.. output::
117128
:language: sh
118129

119-
You are creating a new Atlas cluster and enabling access to it.
120-
121130
Press [Enter] to use the default values.
122131

123132
Enter [?] on any option to get help.
124133

125-
[Set up your Atlas cluster]
126-
? Cluster Name [This cant be changed later] Quickstart-9876543
127-
? Cloud Provider AWS
128-
? Cloud Provider Region US_EAST_1
129-
? Do you want to load sample data into Quickstart-9876543? Yes
130-
131-
[Set up your database authentication access details]
132-
? Database User Username Quickstart-2345678
133-
? Database User Password [Press Enter to use an auto-generated password 'abcdef12345'] abcdef12345
134-
135-
[Set up your database network access details]
136-
? Access List Entry [Press Enter to use your public IP address '192.0.2.0'] 192.0.2.0
137-
138-
[Connect to Quickstart-9876543]
139-
? Do you want to access Quickstart-9876543 with MongoDB Shell? Yes
140-
141-
[Summary of changes]
142-
Cluster Name: Quickstart-9876543
143-
Cluster Tier: M0
144-
Cloud Provider: AWS
145-
Region: US_EAST_1
146-
Cluster Disk Size (GiB): 0.5
147-
Database Username: Quickstart-9876543
148-
Allow connections from (IP Address): 192.0.2.0
149-
Load sample data: Yes
150-
Open shell: No
151-
? Do you want to create a new cluster Quickstart-9876543 with the following settings? Yes
134+
[Default Settings]
135+
Cluster Name: Cluster9876543
136+
Cloud Provider and Region: AWS - US_EAST_1
137+
Database User Username: Cluster9876543
138+
Load sample data: Yes
139+
Allow connections from (IP Address): <your-IP>
140+
? Do you want to set up your first free database in Atlas with default settings (it's free forever)? Yes
152141
We are deploying Quickstart-9876543...
142+
143+
Please store your database authentication access details in a secure location:
144+
Database User Username: Cluster9876543
145+
Database User Password: abcdef12345
146+
153147
Creating your cluster... [Its safe to 'Ctrl + C']
148+
Cluster created.
149+
150+
Your connection string: mongodb+srv://cluster9876543.example.mongodb.net
154151

155152
Loading sample data into your cluster... [Its safe to 'Ctrl + C']
156153

157-
Now you can connect to your Atlas cluster with: mongosh -u Quickstart-9876543 -p abcdef12345 mongodb+srv://quickstart-9876543.example.mongodb.net
154+
Now you can connect to your Atlas cluster with: mongosh -u Cluster9876543 -p abcdef12345 mongodb+srv://cluster9876543.example.mongodb.net
158155

159156

160157
.. tab:: Non-Interactive Mode
@@ -176,38 +173,19 @@ Click the tab to see the command for your preferred mode.
176173
.. input::
177174
:language: sh
178175

179-
atlas quickstart --clusterName getStarted --provider AWS --region US_EAST_1 --username testUser --password changeMe accessListIp 192.0.2.15 --skipSampleData
176+
atlas setup --clusterName getStarted --provider AWS --region US_EAST_1 --username testUser --password changeMe --accessListIp 192.0.2.15 --skipSampleData --force
180177

181178
.. output::
182179
:language: sh
183180

184-
You are creating a new Atlas cluster and enabling access to it.
181+
We are deploying getStarted...
185182

186-
Press [Enter] to use the default values.
183+
Please store your database authentication access details in a secure location:
184+
Database User Username: testUser
185+
Database User Password: changeMe
187186

188-
Enter [?] on any option to get help.
189-
190-
[Set up your database network access details]
191-
? Access List Entry [Press Enter to use your public IP address '192.0.2.15'] 192.0.2.15
192-
193-
[Connect to getStarted]
194-
? Do you want to access getStarted with MongoDB Shell? Yes
195-
196-
[Summary of changes]
197-
Cluster Name: getStarted
198-
Cluster Tier: M0
199-
Cloud Provider: AWS
200-
Region: US_EAST_1
201-
Cluster Disk Size (GiB): 0.5
202-
Database Username: testUser
203-
Allow connections from (IP Address): 192.0.2.15
204-
Load sample data: No
205-
Open shell: No
206-
? Do you want to create a new cluster getStarted with the following settings? Yes
207-
We are deploying getStarted...
208187
Creating your cluster... [Its safe to 'Ctrl + C']
209188

210-
211189
Now you can connect to your |service| cluster with: mongosh -u testUser -p changeMe mongodb+srv://getStarted.example.mongodb.net
212190

213191
.. _atlas-cli-quick-start-summary:

0 commit comments

Comments
 (0)