Skip to content

DOCS-11092 - Update Atlas Free Tier setup and move it from Getting St… #3172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 19, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/images/atlas-create-cluster-add-user.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. figure:: /images/atlas-create-cluster-add-user.png
:alt: Screenshot of admin username and password fields that appear only when
admin user doesn't exist.
:figwidth: 658px
:figwidth: 630px
Binary file modified source/images/atlas-create-cluster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion source/images/atlas-create-cluster.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.. figure:: /images/atlas-create-cluster.png
:alt: Screenshot of cluster config options during creation.
:figwidth: 750px
:figwidth: 634px

Binary file removed source/images/atlas-create-group.png
Binary file not shown.
3 changes: 0 additions & 3 deletions source/images/atlas-create-group.rst

This file was deleted.

Binary file added source/images/atlas-create-organization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions source/images/atlas-create-organization.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /images/atlas-create-organization.png
:alt: Screeenshot of the Atlas organization creation form.
:figwidth: 750px
Binary file added source/images/atlas-create-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions source/images/atlas-create-project.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /images/atlas-create-project.png
:alt: Screeenshot of the Atlas project creation form.
:figwidth: 750px
Binary file added source/images/atlas-project-add-members.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions source/images/atlas-project-add-members.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. figure:: /images/atlas-project-add-members.png
:alt: Screeenshot of the adding members to an Atlas project.
:figwidth: 750px
21 changes: 21 additions & 0 deletions source/includes/atlas-connection-string-drivers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
1. Click the :guilabel:`Connect` button from the :guilabel:`Clusters`
view.
2. Verify the IP address added earlier appears under the
:guilabel:`Check the IP Whitelist` section. You may also
add additional IP addresses via the :guilabel:`Add Entry`
button.
3. Click :guilabel:`Connect Your Application`.
4. Specify which driver version you are using for the
:guilabel:`Copy a connection string` section.
5. Copy the :ref:`URI Connection String<mongodb-uri>` to the
clipboard.
6. Paste the clipboard contents into your preferred text editor and
replace ``<PASSWORD>`` with the password for the user created
earlier. The sample connects to the ``test`` database
which the following examples use. If you wish to connect
to a different database, change ``test`` to whichever
database you wish to connect to.

.. include:: /includes/atlas-connection-string-user.rst

7. Copy the modified connection string to the clipboard.
5 changes: 5 additions & 0 deletions source/includes/atlas-connection-string-user.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. note::

Atlas automatically chooses a username from the list of the project's
configured MongoDB users. Replace the username with another MongoDB
user in that project if necessary.
163 changes: 125 additions & 38 deletions source/includes/steps-getting-started.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,86 @@ level: 3
ref: create-account
content: |
To get started with `MongoDB Atlas <https://cloud.mongodb.com?jmp=docs>`_,
create your user account and log in to Atlas.
create your user account or log in using your existing MongoDB Cloud
Manager or JIRA credentials.

---
title: "Create an Atlas Group."
title: "Create an Atlas Organization."
level: 3
ref: create-group
ref: create-organization
content: |
Choose a name for your group.
Choose a name for your organization and click :guilabel:`Next`.

.. include:: /images/atlas-create-group.rst
.. include:: /images/atlas-create-organization.rst
post: |
Groups manage related MongoDB deployments. To create additional Atlas groups,
click on your user name in the upper-right hand corner and select
:guilabel:`My Groups`. Click the :guilabel:`Add Group` button.
Organizations are top-level hierarchy structures. You configure
alerts and billing for paid clusters at the organization level, and
all projects and clusters part of that organization inherit those
settings.
---
title: "Create an Atlas Project."
level: 3
ref: create-project
content: |
Choose a name for your project and click :guilabel:`Next`.

.. include:: /images/atlas-create-project.rst

post: |
Projects manage related MongoDB deployments, or "clusters" in Atlas.
An organization can contain multiple projects. To create additional
Atlas Projects, click :guilabel:`Projects` on the left-hand navigation
pane then :guilabel:`New Project`. For more information, see
:ref:`Projects<projects>`.
---
title: "Add Members to the Project."
level: 3
ref: project-add-members
content: |
*Optional:* Add additional Atlas members by entering their email
address, pressing enter, and assigning them a role. For more
information on roles, see :ref:`Project Roles<project-roles>`. When
you are finished adding users, click the :guilabel:`Create Project`
button.

.. include:: /images/atlas-project-add-members.rst
---
title: "Create a cluster."
level: 3
ref: create-cluster
content: |
MongoDB deployments, or "clusters" in Atlas, can be either a
:term:`replica set` or a :term:`sharded cluster`.
MongoDB clusters can be either a :term:`replica set` or a
:term:`sharded cluster`.

To create a cluster, go to the :guilabel:`Clusters` view and click the
:guilabel:`Add New Cluster` or :guilabel:`Build a New Cluster` button.

.. include:: /images/atlas-create-cluster.rst
:guilabel:`Build a New Cluster` button.

1. Enter a :guilabel:`Cluster Name`.
2. Click the :guilabel:`Select` button for :guilabel:`Instance Size` ``M0``
2. Select :guilabel:`Amazon Web Services` as the
:guilabel:`Cloud Provider`.
3. For :guilabel:`Region`, chose either ``US-EAST-1`` or
``EU-CENTRAL-1``.
4. Click the :guilabel:`Select` button for :guilabel:`Instance Size` ``M0``
for Atlas Free Tier.
3. Enter a :guilabel:`Username` and :guilabel:`Password`.

.. include:: /images/atlas-create-cluster.rst

5. Enter a :guilabel:`Username` and :guilabel:`Password`.

.. include:: /images/atlas-create-cluster-add-user.rst

These fields appear only if no MongoDB user exists for your Atlas group. If
you created users in the group beforehand these fields will not appear.
These fields appear only if no MongoDB user exists for your Atlas
project. If you created users in the project beforehand these
fields will not appear.

4. Click :guilabel:`Confirm & Deploy`.
6. Click :guilabel:`Confirm & Deploy`.
---
title: "Setup security."
level: 3
ref: setup-cluster-security
content: |
Atlas only allows client connections to the cluster from entries in
the group's whitelist. To add an entry to the whitelist:
the projects's whitelist. To add an entry to the whitelist:

.. include:: /images/atlas-setup-cluster-security.rst

Expand All @@ -70,21 +105,35 @@ content: |

1. Click the :guilabel:`Connect` button from the :guilabel:`Clusters`
view.
2. Under the :guilabel:`Connect with the Mongo Shell` section, select
your operating system from the dropdown and click :guilabel:`Download Shell`.
3. Extract the download to the desired location or install the
2. Verify the IP address added in the previous step appears
under the :guilabel:`Check the IP Whitelist` section.
You may also add additional IP addresses via the
:guilabel:`Add Entry` button.
3. Click :guilabel:`Connect with the Mongo Shell`, select
your operating system, and click the :guilabel:`Download`
button.
4. Extract the download to the desired location or install the
:program:`mongo` shell depending on your operating system.
4. Optionally, add the ``<mongodb-install-directory>/bin`` to your
5. Optionally, add the ``<mongodb-install-directory>/bin`` to your
operating system's ``PATH`` or environment variables.

For more operating system specific installation information, see
:ref:`Installation<tutorial-installation>`.

- id: compass
content: |
Download MongoDB Compass from the
`download center <https://www.mongodb.com/download-center?filter=enterprise#compass>`_
and install it.
To download MongoDB Compass:

1. Click the :guilabel:`Connect` button from the :guilabel:`Clusters`
view.
2. Verify the IP address added in the previous step appears
under the :guilabel:`Check the IP Whitelist` section.
You may also add additional IP addresses via the
:guilabel:`Add Entry` button.
3. Click :guilabel:`Connect with MongoDB Compass`, select
your operating system, and click the :guilabel:`Download`
button.
4. Run the installer.

- id: python
content: |
Expand Down Expand Up @@ -116,22 +165,60 @@ title: "Get the URI connection string."
level: 3
ref: get-connection-string
content: |
From the MongoDB Atlas :guilabel:`Clusters` view:

1. Click the :guilabel:`Connect` button to view the
:ref:`URI Connection String<mongodb-uri>`.
2. Copy the connection string to the clipboard.
3. Paste the connection string somewhere and replace ``<PASSWORD>`` with the
password for the user created earlier, and ``<DATABASE>`` with the name of
the database to which you wish to connect. In the following examples, the
``test`` database is used.
4. Copy the modified URI to the clipboard.
.. tabs-drivers::

tabs:
- id: shell
content: |
From the :guilabel:`Connect with the Mongo Shell` modal:

1. Beneath the :guilabel:`Download` button from the previous
step, specify which version of the Mongo Shell you are
using for the :guilabel:`2. Connect via the Mongo Shell`
section.
2. Copy the :ref:`URI Connection String<mongodb-uri>` to the
clipboard.
3. Paste the connection string somewhere and replace
``<PASSWORD>`` with the password for the user created
earlier. The sample connection string connects to the
``test`` database which is used by the following examples.
If you wish to connect to a different database, change
``test`` to whichever database you wish to connect to.

.. include:: /includes/atlas-connection-string-user.rst

4. Copy the modified connection string to the clipboard.

- id: compass
content: |
From the :guilabel:`Connect to Compass` modal:

1. Copy the :ref:`URI Connection String<mongodb-uri>` to the
clipboard located below the :guilabel:`Download` button
from the previous step.
2. Paste the connection string somewhere and replace
``<PASSWORD>`` with the password for the user created
earlier.

.. include:: /includes/atlas-connection-string-user.rst

3. Copy the modified connection string to the clipboard.

- id: python
content: |
.. include:: /includes/atlas-connection-string-drivers.rst

- id: nodejs
content: |
.. include:: /includes/atlas-connection-string-drivers.rst

---
title: "Connect to the cluster."
level: 3
ref: connect-cluster-shell
content: |
Using the **URI string** from the previous step, connect to the Atlas cluster:
Using the connection string from the previous step, connect to the
Atlas cluster:

.. tabs-drivers::

Expand Down Expand Up @@ -161,7 +248,7 @@ content: |

- id: compass
content: |
1. Launch MongoDB Compass with the URI from the previous step copied to the clipboard.
1. Launch MongoDB Compass with the connection string from the previous step copied to the clipboard.
2. A dialog box will prompt you to use the URI to fill out the connect form. Click :guilabel:`Yes`.

.. include:: /images/compass-connect-uri-detected.rst
Expand Down
1 change: 1 addition & 0 deletions source/introduction.txt
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ third parties to develop storage engines for MongoDB.
:titlesonly:

/tutorial/getting-started
/tutorial/atlas-free-tier-setup
/core/databases-and-collections
/core/document
/reference/bson-types
Expand Down
50 changes: 50 additions & 0 deletions source/tutorial/atlas-free-tier-setup.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
:orphan:

.. _create-free-tier-manual:

=================================
Create an Atlas Free Tier Cluster
=================================

.. default-domain:: mongodb

`MongoDB Atlas <https://cloud.mongodb.com?jmp=docs>`_ is a cloud-hosted
service for provisioning, running, monitoring, and maintaining MongoDB
deployments. It is a fast, easy, and free way to get started with
MongoDB. To install and run MongoDB locally, see
:ref:`Install MongoDB<tutorial-installation>`.

.. tabs-drivers::

tabs:
- id: shell
content: |
The following tutorial uses
:program:`mongo` shell to connect to an Atlas free-tier
cluster.

- id: compass
content: |
`MongoDB Compass <https://docs.mongodb.com/compass/current/>`_
is the GUI for MongoDB. The following tutorial uses MongoDB
Compass to connect to an Atlas free-tier cluster.

- id: python
content: |
The following tutorial uses the
`PyMongo <https://api.mongodb.com/python/current/index.html>`_
Python driver to connect to an Atlas free-tier cluster.

- id: nodejs
content: |
The following tutorial uses the
:node-docs:`MongoDB Node.js Driver <>` to connect to an Atlas
free-tier cluster.

.. include:: /includes/steps/getting-started.rst

Next Steps
----------

Follow the :ref:`getting-started` tutorial to insert data into MongoDB
and perform query operations.
Loading