Skip to content

Commit 9325955

Browse files
sarahsimperssarahsimpers
authored
(DOCSP-22576) Adds atlas setup tutorial (#25)
* (DOCSP-22576) Adds atlas setup tutorial * Removes extra file changes * Source constants, tutorial updates * Readding items after Github blip * Cleanup * Removes other modes and final cleanup * Includes copy and tech review changes: * Incorporates Jakub's feedback
1 parent e64479e commit 9325955

File tree

6 files changed

+199
-9
lines changed

6 files changed

+199
-9
lines changed

‎snooty.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ toc_landing_pages = [
1212
"/atlas-cli-env-variables",
1313
"/atlas-cli-profiles",
1414
"/atlas-cli-quickstart",
15+
"/atlas-cli-tutorials",
1516
"/command/atlas",
1617
"/connect-atlas-cli",
1718
"/install-atlas-cli",
@@ -25,6 +26,8 @@ atlas-cli-full = "MongoDB Atlas CLI"
2526
atlas-cli-version = "1.0.3"
2627
cloudgov = ":atlas:`MongoDB Atlas for Government </government>`"
2728
cloudgov-short = "AtlasGov"
29+
cluster = "cluster"
30+
clusters = "clusters"
2831
data-lake = "Atlas Data Lake"
2932
data-lake-short = "Data Lake"
3033
data-lake-stores = "data stores"

‎source/atlas-cli-getting-started.txt

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
.. _atlas-cli-onboarding:
2+
3+
==========================
4+
Get Started with |service|
5+
==========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can get started with |service| via the {+atlas-cli+} using a single
16+
command: ``atlas setup``.
17+
18+
This tutorial demonstrates how to use ``atlas setup`` to:
19+
20+
1. Sign up for an |service| account.
21+
#. Authenticate with the new |service| account.
22+
#. Create one free database.
23+
#. Load :atlas:`sample data </sample-data/available-sample-datasets/>`
24+
into your |service| database.
25+
#. Add your IP address to your project's IP access list.
26+
#. Create a MongoDB user for your |service| {+database-deployment+}.
27+
#. Connect to your new {+database-deployment+} using the MongoDB Shell,
28+
{+mongosh+}.
29+
30+
You can also run ``atlas setup`` if you have an |service| account and
31+
an organization/project but you haven't set up a {+cluster+}.
32+
33+
.. _atlas-cli-onboarding-reqs:
34+
35+
Complete The Prerequisites
36+
--------------------------
37+
38+
Before you begin, you must :ref:`install the {+atlas-cli+}<install-atlas-cli>`.
39+
40+
Follow These Steps
41+
------------------
42+
43+
Complete the following procedure to get started with |service|.
44+
45+
.. procedure::
46+
47+
.. step:: Run the ``atlas setup`` command in the terminal.
48+
49+
.. code-block:: sh
50+
51+
atlas setup
52+
53+
After you run the command, enter :guilabel:`Y` to open the default browser. A browser window displays the :guilabel:`Create Your Account`
54+
screen.
55+
56+
If you want to log into an existing |service| account, click
57+
:guilabel:`Log in now` and log in.
58+
59+
If you're already logged into an existing |service| account,
60+
proceed to step 3.
61+
62+
.. step:: Sign up and verify your account.
63+
64+
Enter your account information and click :guilabel:`Sign Up`.
65+
Follow the prompts to verify your email or register using
66+
third-party authentication.
67+
68+
.. step:: Verify your {+atlas-cli+} session.
69+
70+
When you reach the :guilabel:`Activation` screen, copy the
71+
verification code from the {+atlas-cli+} and paste it into the
72+
browser. Then, click :guilabel:`Confirm Authorization` and return
73+
to the terminal window.
74+
75+
.. step:: Accept the default {+cluster+} creation settings.
76+
77+
After you verify your {+atlas-cli+} session, ``atlas setup``
78+
creates an ``M0`` cluster. ``M0`` clusters have some operational
79+
:ref:`limitations <atlas-free-tier>`.
80+
81+
If you log into an existing account and have existing
82+
organizations and projects, ``atlas setup`` prompts you to select
83+
a default organization and default project. Select a default
84+
organization and project and press
85+
:guilabel:`Enter`.
86+
87+
When the {+atlas-cli+} prompts ``Do you want to set up``
88+
``your first free database in Atlas with default``
89+
``settings? It's free forever!``, enter :guilabel:`Y` to create your {+cluster+} with the default settings.
90+
91+
The command creates a sample ``M0`` shared-tier cluster with the
92+
following default settings:
93+
94+
- Cluster name: ``Cluster<number>``
95+
- Cloud provider and region: ``AWS - US_EAST_1``
96+
- Database Username: ``Cluster<number>``
97+
- Database User Password: ``abcdef12345``
98+
- Load Sample Data: ``Yes``
99+
- Allow connection from IP: ``<YourIPAddress>``
100+
101+
.. io-code-block::
102+
103+
.. input::
104+
:language: sh
105+
106+
Do you want to set up your first free database in
107+
Atlas with default settings? It's free forever! Y
108+
109+
.. output::
110+
:language: sh
111+
112+
We are deploying Cluster9876543...
113+
114+
Please store your database authentication access details in a secure location.
115+
Database User Username: Cluster9876543
116+
Database User Password: abcdef12345
117+
118+
Creating your cluster... [Its safe to 'Ctrl + C']
119+
120+
121+
.. _atlas-cli-onboarding-summary:
122+
123+
Take the Next Steps
124+
-------------------
125+
126+
Congratulations! You have successfully set up your |service| account.
127+
128+
Use the :manual:`connection string </reference/connection-string/#connection-string-options>`
129+
to connect to your cluster through {+mongosh+} or your application.
130+
131+
To view the status of your cluster, run the :ref:`atlas-clusters`
132+
command.

‎source/atlas-cli-quickstart.txt

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _atlas-cli-quick-start:
22

3-
==========================================
4-
Set Up |service| with ``atlas quickstart``
5-
==========================================
3+
=========================================
4+
Create and Configure an |service| Cluster
5+
=========================================
66

77
.. default-domain:: mongodb
88

@@ -17,10 +17,13 @@ This tutorial demonstrates how to use the ``atlas quickstart`` command to:
1717
1. Create one cluster in your |service| project.
1818
#. Load :atlas:`sample data </sample-data/available-sample-datasets/>`
1919
into your |service| cluster.
20-
#. Add your IP address to your project's IP access list .
20+
#. Add your IP address to your project's IP access list.
2121
#. Create a MongoDB user for your |service| cluster.
2222
#. Connect to your new cluster using the MongoDB Shell, {+mongosh+}.
2323

24+
To perform all of these steps while also creating a new |service|
25+
account, see :ref:`atlas-cli-onboarding`.
26+
2427
.. _atlas-cli-quick-start-reqs:
2528

2629
Prerequisites

‎source/atlas-cli-tutorials.txt

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. _atlas-cli-tutorials:
2+
3+
=======================================
4+
Manage |service| from the {+atlas-cli+}
5+
=======================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Use the following tutorials to learn how to manage |service| using the
16+
{+atlas-cli+}.
17+
18+
To learn the {+atlas-cli+} basics, see :ref:`install-atlas-cli` and
19+
:ref:`connect-atlas-cli`.
20+
21+
You can also go straight to the :doc:`{+atlas-cli+} Commands
22+
</command/atlas>`.
23+
24+
.. list-table::
25+
:header-rows: 1
26+
:widths: 40 60
27+
28+
* - Tutorial
29+
- Objective
30+
31+
* - :ref:`atlas-cli-onboarding`
32+
- Use the ``atlas setup`` command to onboard with |service|,
33+
including creating your account and {+cluster+}. You can also
34+
use this tutorial to create your first {+cluster+} even if you
35+
already have an |service| account.
36+
37+
* - :ref:`atlas-cli-quick-start`
38+
- Use the ``atlas quickstart`` command to create your first
39+
{+cluster+}. This tutorial requires an |service| account and an
40+
existing organization.
41+
42+
.. toctree::
43+
:titlesonly:
44+
45+
/atlas-cli-getting-started
46+
/atlas-cli-quickstart

‎source/connect-atlas-cli.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Connect from the {+atlas-cli+}
1313
Select a Connection Method
1414
--------------------------
1515

16-
When you connect to |service| from the {+atlas-cli+}, you can authenticate with
17-
one of the following commands:
16+
When you connect to an existing |service| account from the
17+
{+atlas-cli+}, you can authenticate with one of the following commands:
1818

1919
.. include:: /includes/list-table-atlas-cli-auth.rst
2020

@@ -24,7 +24,11 @@ one of the following commands:
2424
configuration file. Your |api| keys are like passwords.
2525
Ensure that you secure the configuration file appropriately.
2626

27-
Select a use case below to learn more about the available options:
27+
To create a new |service| account or onboard an existing account that
28+
doesn't have any {+clusters+}, see :ref:`atlas-cli-onboarding`.
29+
30+
Select a use case below to learn more about the available connection
31+
options:
2832

2933
.. tabs::
3034

‎source/index.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,16 @@ Follow these steps to get started using the {+atlas-cli+}:
2727

2828
1. :ref:`Install the {+atlas-cli+} <install-atlas-cli>`
2929
2. :ref:`Connect from the {+atlas-cli+} <connect-atlas-cli>`
30-
3. :doc:`Learn the {+atlas-cli+} commands </command/atlas>`
30+
3. :ref:`See tutorials to manage Atlas from the {+atlas-cli+}
31+
<atlas-cli-tutorials>` or
32+
:doc:`Go straight to the {+atlas-cli+} commands </command/atlas>`
3133

3234
.. toctree::
3335
:titlesonly:
3436

3537
Overview </index>
3638
/install-atlas-cli
3739
/connect-atlas-cli
38-
/atlas-cli-quickstart
40+
/atlas-cli-tutorials
3941
Atlas CLI Commands </command/atlas>
4042
/atlas-cli-changelog

0 commit comments

Comments
 (0)