Skip to content

Commit 126eb15

Browse files
DOCS-11092 - Update Atlas Free Tier setup and move it from Getting Started to its own page.
1 parent 13bfd56 commit 126eb15

17 files changed

+254
-88
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
.. figure:: /images/atlas-create-cluster-add-user.png
22
:alt: Screenshot of admin username and password fields that appear only when
33
admin user doesn't exist.
4-
:figwidth: 658px
4+
:figwidth: 630px
-53.6 KB
Loading
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
.. figure:: /images/atlas-create-cluster.png
22
:alt: Screenshot of cluster config options during creation.
3-
:figwidth: 750px
3+
:figwidth: 634px
4+

source/images/atlas-create-group.png

-7.6 KB
Binary file not shown.

source/images/atlas-create-group.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.
33.9 KB
Loading
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. figure:: /images/atlas-create-organization.png
2+
:alt: Screeenshot of the Atlas organization creation form.
3+
:figwidth: 750px
26.3 KB
Loading
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. figure:: /images/atlas-create-project.png
2+
:alt: Screeenshot of the Atlas project creation form.
3+
:figwidth: 750px
33.5 KB
Loading
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. figure:: /images/atlas-project-add-members.png
2+
:alt: Screeenshot of the adding members to an Atlas project.
3+
:figwidth: 750px
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
1. Click the :guilabel:`Connect` button from the :guilabel:`Clusters`
2+
view.
3+
2. Verify the IP address added earlier appears under the
4+
:guilabel:`Check the IP Whitelist` section. You may also
5+
add additional IP addresses via the :guilabel:`Add Entry`
6+
button.
7+
3. Click :guilabel:`Connect Your Application`.
8+
4. Specify which driver version you are using for the
9+
:guilabel:`Copy a connection string` section.
10+
5. Copy the :ref:`URI Connection String<mongodb-uri>` to the
11+
clipboard.
12+
6. Paste the clipboard contents into your preferred text editor and
13+
replace ``<PASSWORD>`` with the password for the user created
14+
earlier. The sample connects to the ``test`` database
15+
which the following examples use. If you wish to connect
16+
to a different database, change ``test`` to whichever
17+
database you wish to connect to.
18+
19+
.. include:: /includes/atlas-connection-string-user.rst
20+
21+
7. Copy the modified connection string to the clipboard.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. note::
2+
3+
Atlas automatically chooses a username from the list of the project's
4+
configured MongoDB users. Replace the username with another MongoDB
5+
user in that project if necessary.

source/includes/steps-getting-started.yaml

Lines changed: 125 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,51 +3,86 @@ level: 3
33
ref: create-account
44
content: |
55
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.
78
89
---
9-
title: "Create an Atlas Group."
10+
title: "Create an Atlas Organization."
1011
level: 3
11-
ref: create-group
12+
ref: create-organization
1213
content: |
13-
Choose a name for your group.
14+
Choose a name for your organization and click :guilabel:`Next`.
1415
15-
.. include:: /images/atlas-create-group.rst
16+
.. include:: /images/atlas-create-organization.rst
1617
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
2049
---
2150
title: "Create a cluster."
2251
level: 3
2352
ref: create-cluster
2453
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`.
2756
2857
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.
3259
3360
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``
3566
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`.
3771
3872
.. include:: /images/atlas-create-cluster-add-user.rst
3973
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.
4277
43-
4. Click :guilabel:`Confirm & Deploy`.
78+
6. Click :guilabel:`Confirm & Deploy`.
4479
---
4580
title: "Setup security."
4681
level: 3
4782
ref: setup-cluster-security
4883
content: |
4984
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:
5186
5287
.. include:: /images/atlas-setup-cluster-security.rst
5388
@@ -70,21 +105,35 @@ content: |
70105
71106
1. Click the :guilabel:`Connect` button from the :guilabel:`Clusters`
72107
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
76116
: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
78118
operating system's ``PATH`` or environment variables.
79119
80120
For more operating system specific installation information, see
81121
:ref:`Installation<tutorial-installation>`.
82122
83123
- id: compass
84124
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.
88137
89138
- id: python
90139
content: |
@@ -116,22 +165,60 @@ title: "Get the URI connection string."
116165
level: 3
117166
ref: get-connection-string
118167
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+
129215
---
130216
title: "Connect to the cluster."
131217
level: 3
132218
ref: connect-cluster-shell
133219
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:
135222
136223
.. tabs-drivers::
137224
@@ -161,7 +248,7 @@ content: |
161248
162249
- id: compass
163250
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.
165252
2. A dialog box will prompt you to use the URI to fill out the connect form. Click :guilabel:`Yes`.
166253
167254
.. include:: /images/compass-connect-uri-detected.rst

source/introduction.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ third parties to develop storage engines for MongoDB.
104104
:titlesonly:
105105

106106
/tutorial/getting-started
107+
/tutorial/atlas-free-tier-setup
107108
/core/databases-and-collections
108109
/core/document
109110
/reference/bson-types
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
:orphan:
2+
3+
.. _create-free-tier-manual:
4+
5+
=================================
6+
Create an Atlas Free Tier Cluster
7+
=================================
8+
9+
.. default-domain:: mongodb
10+
11+
`MongoDB Atlas <https://cloud.mongodb.com?jmp=docs>`_ is a cloud-hosted
12+
service for provisioning, running, monitoring, and maintaining MongoDB
13+
deployments. It is a fast, easy, and free way to get started with
14+
MongoDB. To install and run MongoDB locally, see
15+
:ref:`Install MongoDB<tutorial-installation>`.
16+
17+
.. tabs-drivers::
18+
19+
tabs:
20+
- id: shell
21+
content: |
22+
The following tutorial uses
23+
:program:`mongo` shell to connect to an Atlas free-tier
24+
cluster.
25+
26+
- id: compass
27+
content: |
28+
`MongoDB Compass <https://docs.mongodb.com/compass/current/>`_
29+
is the GUI for MongoDB. The following tutorial uses MongoDB
30+
Compass to connect to an Atlas free-tier cluster.
31+
32+
- id: python
33+
content: |
34+
The following tutorial uses the
35+
`PyMongo <https://api.mongodb.com/python/current/index.html>`_
36+
Python driver to connect to an Atlas free-tier cluster.
37+
38+
- id: nodejs
39+
content: |
40+
The following tutorial uses the
41+
:node-docs:`MongoDB Node.js Driver <>` to connect to an Atlas
42+
free-tier cluster.
43+
44+
.. include:: /includes/steps/getting-started.rst
45+
46+
Next Steps
47+
----------
48+
49+
Follow the :ref:`getting-started` tutorial to insert data into MongoDB
50+
and perform query operations.

0 commit comments

Comments
 (0)