@@ -3,51 +3,86 @@ level: 3
3
3
ref : create-account
4
4
content : |
5
5
To get started with `MongoDB Atlas <https://cloud.mongodb.com?jmp=docs>`_,
6
- create your user account and log in to Atlas.
6
+ create your user account or log in using your existing MongoDB Cloud
7
+ Manager or JIRA credentials.
7
8
8
9
---
9
- title : " Create an Atlas Group ."
10
+ title : " Create an Atlas Organization ."
10
11
level : 3
11
- ref : create-group
12
+ ref : create-organization
12
13
content : |
13
- Choose a name for your group .
14
+ Choose a name for your organization and click :guilabel:`Next` .
14
15
15
- .. include:: /images/atlas-create-group .rst
16
+ .. include:: /images/atlas-create-organization .rst
16
17
post : |
17
- Groups manage related MongoDB deployments. To create additional Atlas groups,
18
- click on your user name in the upper-right hand corner and select
19
- :guilabel:`My Groups`. Click the :guilabel:`Add Group` button.
18
+ Organizations are top-level hierarchy structures. You configure
19
+ alerts and billing for paid clusters at the organization level, and
20
+ all projects and clusters part of that organization inherit those
21
+ settings.
22
+ ---
23
+ title : " Create an Atlas Project."
24
+ level : 3
25
+ ref : create-project
26
+ content : |
27
+ Choose a name for your project and click :guilabel:`Next`.
28
+
29
+ .. include:: /images/atlas-create-project.rst
30
+
31
+ post : |
32
+ Projects manage related MongoDB deployments, or "clusters" in Atlas.
33
+ An organization can contain multiple projects. To create additional
34
+ Atlas Projects, click :guilabel:`Projects` on the left-hand navigation
35
+ pane then :guilabel:`New Project`. For more information, see
36
+ :ref:`Projects<projects>`.
37
+ ---
38
+ title : " Add Members to the Project."
39
+ level : 3
40
+ ref : project-add-members
41
+ content : |
42
+ *Optional:* Add additional Atlas members by entering their email
43
+ address, pressing enter, and assigning them a role. For more
44
+ information on roles, see :ref:`Project Roles<project-roles>`. When
45
+ you are finished adding users, click the :guilabel:`Create Project`
46
+ button.
47
+
48
+ .. include:: /images/atlas-project-add-members.rst
20
49
---
21
50
title : " Create a cluster."
22
51
level : 3
23
52
ref : create-cluster
24
53
content : |
25
- MongoDB deployments, or " clusters" in Atlas, can be either a
26
- :term:`replica set` or a :term:` sharded cluster`.
54
+ MongoDB clusters can be either a :term:`replica set` or a
55
+ :term:`sharded cluster`.
27
56
28
57
To create a cluster, go to the :guilabel:`Clusters` view and click the
29
- :guilabel:`Add New Cluster` or :guilabel:`Build a New Cluster` button.
30
-
31
- .. include:: /images/atlas-create-cluster.rst
58
+ :guilabel:`Build a New Cluster` button.
32
59
33
60
1. Enter a :guilabel:`Cluster Name`.
34
- 2. Click the :guilabel:`Select` button for :guilabel:`Instance Size` ``M0``
61
+ 2. Select :guilabel:`Amazon Web Services` as the
62
+ :guilabel:`Cloud Provider`.
63
+ 3. For :guilabel:`Region`, chose either ``US-EAST-1`` or
64
+ ``EU-CENTRAL-1``.
65
+ 4. Click the :guilabel:`Select` button for :guilabel:`Instance Size` ``M0``
35
66
for Atlas Free Tier.
36
- 3. Enter a :guilabel:`Username` and :guilabel:`Password`.
67
+
68
+ .. include:: /images/atlas-create-cluster.rst
69
+
70
+ 5. Enter a :guilabel:`Username` and :guilabel:`Password`.
37
71
38
72
.. include:: /images/atlas-create-cluster-add-user.rst
39
73
40
- These fields appear only if no MongoDB user exists for your Atlas group. If
41
- you created users in the group beforehand these fields will not appear.
74
+ These fields appear only if no MongoDB user exists for your Atlas
75
+ project. If you created users in the project beforehand these
76
+ fields will not appear.
42
77
43
- 4 . Click :guilabel:`Confirm & Deploy`.
78
+ 6 . Click :guilabel:`Confirm & Deploy`.
44
79
---
45
80
title : " Setup security."
46
81
level : 3
47
82
ref : setup-cluster-security
48
83
content : |
49
84
Atlas only allows client connections to the cluster from entries in
50
- the group 's whitelist. To add an entry to the whitelist:
85
+ the projects 's whitelist. To add an entry to the whitelist:
51
86
52
87
.. include:: /images/atlas-setup-cluster-security.rst
53
88
@@ -70,21 +105,35 @@ content: |
70
105
71
106
1. Click the :guilabel:`Connect` button from the :guilabel:`Clusters`
72
107
view.
73
- 2. Under the :guilabel:`Connect with the Mongo Shell` section, select
74
- your operating system from the dropdown and click :guilabel:`Download Shell`.
75
- 3. Extract the download to the desired location or install the
108
+ 2. Verify the IP address added in the previous step appears
109
+ under the :guilabel:`Check the IP Whitelist` section.
110
+ You may also add additional IP addresses via the
111
+ :guilabel:`Add Entry` button.
112
+ 3. Click :guilabel:`Connect with the Mongo Shell`, select
113
+ your operating system, and click the :guilabel:`Download`
114
+ button.
115
+ 4. Extract the download to the desired location or install the
76
116
:program:`mongo` shell depending on your operating system.
77
- 4 . Optionally, add the ``<mongodb-install-directory>/bin`` to your
117
+ 5 . Optionally, add the ``<mongodb-install-directory>/bin`` to your
78
118
operating system's ``PATH`` or environment variables.
79
119
80
120
For more operating system specific installation information, see
81
121
:ref:`Installation<tutorial-installation>`.
82
122
83
123
- id: compass
84
124
content: |
85
- Download MongoDB Compass from the
86
- `download center <https://www.mongodb.com/download-center?filter=enterprise#compass>`_
87
- and install it.
125
+ To download MongoDB Compass:
126
+
127
+ 1. Click the :guilabel:`Connect` button from the :guilabel:`Clusters`
128
+ view.
129
+ 2. Verify the IP address added in the previous step appears
130
+ under the :guilabel:`Check the IP Whitelist` section.
131
+ You may also add additional IP addresses via the
132
+ :guilabel:`Add Entry` button.
133
+ 3. Click :guilabel:`Connect with MongoDB Compass`, select
134
+ your operating system, and click the :guilabel:`Download`
135
+ button.
136
+ 4. Run the installer.
88
137
89
138
- id: python
90
139
content: |
@@ -116,22 +165,60 @@ title: "Get the URI connection string."
116
165
level : 3
117
166
ref : get-connection-string
118
167
content : |
119
- From the MongoDB Atlas :guilabel:`Clusters` view:
120
-
121
- 1. Click the :guilabel:`Connect` button to view the
122
- :ref:`URI Connection String<mongodb-uri>`.
123
- 2. Copy the connection string to the clipboard.
124
- 3. Paste the connection string somewhere and replace ``<PASSWORD>`` with the
125
- password for the user created earlier, and ``<DATABASE>`` with the name of
126
- the database to which you wish to connect. In the following examples, the
127
- ``test`` database is used.
128
- 4. Copy the modified URI to the clipboard.
168
+ .. tabs-drivers::
169
+
170
+ tabs:
171
+ - id: shell
172
+ content: |
173
+ From the :guilabel:`Connect with the Mongo Shell` modal:
174
+
175
+ 1. Beneath the :guilabel:`Download` button from the previous
176
+ step, specify which version of the Mongo Shell you are
177
+ using for the :guilabel:`2. Connect via the Mongo Shell`
178
+ section.
179
+ 2. Copy the :ref:`URI Connection String<mongodb-uri>` to the
180
+ clipboard.
181
+ 3. Paste the connection string somewhere and replace
182
+ ``<PASSWORD>`` with the password for the user created
183
+ earlier. The sample connection string connects to the
184
+ ``test`` database which is used by the following examples.
185
+ If you wish to connect to a different database, change
186
+ ``test`` to whichever database you wish to connect to.
187
+
188
+ .. include:: /includes/atlas-connection-string-user.rst
189
+
190
+ 4. Copy the modified connection string to the clipboard.
191
+
192
+ - id: compass
193
+ content: |
194
+ From the :guilabel:`Connect to Compass` modal:
195
+
196
+ 1. Copy the :ref:`URI Connection String<mongodb-uri>` to the
197
+ clipboard located below the :guilabel:`Download` button
198
+ from the previous step.
199
+ 2. Paste the connection string somewhere and replace
200
+ ``<PASSWORD>`` with the password for the user created
201
+ earlier.
202
+
203
+ .. include:: /includes/atlas-connection-string-user.rst
204
+
205
+ 3. Copy the modified connection string to the clipboard.
206
+
207
+ - id: python
208
+ content: |
209
+ .. include:: /includes/atlas-connection-string-drivers.rst
210
+
211
+ - id: nodejs
212
+ content: |
213
+ .. include:: /includes/atlas-connection-string-drivers.rst
214
+
129
215
---
130
216
title : " Connect to the cluster."
131
217
level : 3
132
218
ref : connect-cluster-shell
133
219
content : |
134
- Using the **URI string** from the previous step, connect to the Atlas cluster:
220
+ Using the connection string from the previous step, connect to the
221
+ Atlas cluster:
135
222
136
223
.. tabs-drivers::
137
224
@@ -161,7 +248,7 @@ content: |
161
248
162
249
- id: compass
163
250
content: |
164
- 1. Launch MongoDB Compass with the URI from the previous step copied to the clipboard.
251
+ 1. Launch MongoDB Compass with the connection string from the previous step copied to the clipboard.
165
252
2. A dialog box will prompt you to use the URI to fill out the connect form. Click :guilabel:`Yes`.
166
253
167
254
.. include:: /images/compass-connect-uri-detected.rst
0 commit comments