Skip to content

Commit d046201

Browse files
DOCSP-15095/15212/15289 doc for mongocli atlas quickStart (#494)
* DOCSP-15095 doc for mongocli atlas quickStart * DOCSP-15095 updates for copy review feedback * Apply suggestions from code review Melissa's feedback Co-authored-by: Melissa Mahoney <[email protected]> * DOCSP-15095 updates for tech review feedback * DOCSP-15095 updates for DOCSP-15289 Co-authored-by: Melissa Mahoney <[email protected]>
1 parent 908255f commit d046201

File tree

4 files changed

+307
-61
lines changed

4 files changed

+307
-61
lines changed

source/index.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,6 @@ services from the command line for easier testing and scripting.
2727
Configure {+mcli+} settings through the command line, configuration
2828
file, or environment variables.
2929

30-
:ref:`mcli-quick-start`
31-
Get started with the {+mcli+} and create a deployment and database
32-
users.
33-
3430
:ref:`mcli-reference`
3531
Review the {+mcli+} commands and options.
3632

source/quick-start.txt

Lines changed: 41 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ To learn more about generating the |svc-api-key|, see:
7171
- :cloudmgr:`Cloud Manager API Access </tutorial/configure-public-api-access>`
7272
- :opsmgr:`Ops Manager API Acess </tutorial/configure-public-api-access>`
7373

74-
7574
Procedure
7675
---------
7776

@@ -92,75 +91,60 @@ Procedure
9291

9392
.. include:: /includes/steps/quick-start-atlas-config-mcli.rst
9493

95-
.. _quick-start-atlas-create-cluster:
96-
97-
Create a Cluster
98-
~~~~~~~~~~~~~~~~
99-
100-
Use the :ref:`mcli-atlas-cluster-create-command` command to create
101-
a cluster in |service|.
102-
103-
.. include:: /includes/admonitions/note-atlas-api-free-tier-limits.rst
104-
105-
The following command creates a sample paid-tier cluster with the following settings:
106-
107-
- Cluster name: ``getStarted``
108-
- Service provider: ``AWS``
109-
- Provider region: ``US_EAST-1``
110-
- Cluster tier: ``M10``
111-
- Disk size: ``2`` GB
112-
- MongoDB version: ``4.4``
113-
- Replica set members: ``3``
114-
115-
.. code-block:: sh
116-
117-
mongocli atlas cluster create getStarted --provider AWS --region US_EAST_1 --tier M10 --diskSizeGB 10 --mdbVersion {+mdbVersion+} --members 3
94+
Configure an |service| Cluster
95+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11896

119-
.. _quick-start-whitelist:
97+
Use the :ref:`mcli-atlas-quick-start-cmd` command to create an
98+
``M2`` cluster in |service|, add your IP addresses or |cidr|
99+
blocks to the project IP access list, and create a MongoDB
100+
database user to access the database.
120101

121-
Configure Your IP Access List
122-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123-
124-
|service| only allows incoming connections to the cluster from
125-
entries in the project’s access list. You can add individual IP
126-
addresses or |cidr| blocks to the project IP access list.
102+
You can run this command in two ways:
127103

128-
|service| supports specifying private IP addresses with VPC peered
129-
connections. For more information, see :atlas:`Set up a Network
130-
Peering Connection </security-vpc-peering/index.html>`.
104+
- Interactive mode - the command prompts you for the cluster settings
105+
- Non-interactive mode - you run the command with the cluster settings
131106

132-
Run the following command to add entries to your IP access list.
133-
Replace the IP address with your connection IP address.
107+
Click the tab to see the command for your preferred
108+
mode.
109+
110+
.. tabs::
134111

135-
.. code-block:: sh
136-
137-
mongocli atlas accesslist create <your-IP-address> --type ipAddress
112+
.. tab:: Interactive Mode
113+
:tabid: interactive
138114

139-
.. _quick-start-create-mdb-user:
115+
The command prompts you for the following
116+
settings. Enter the corresponding value when prompted:
140117

141-
Create a MongoDB User
142-
~~~~~~~~~~~~~~~~~~~~~
118+
- Cluster name: ``getStarted``
119+
- Service provider: ``AWS``
120+
- Provider region: ``US_EAST-1``
121+
- MongoDB DB username: ``testUser``
122+
- Password: ``<changeMe>``
123+
- IP address to add to the Access List:
124+
``<your-IP-address>``
125+
- Download and install MongoDB Shell: ``N``
143126

144-
If the |service| project does not yet have a MongoDB database user
145-
configured, you must create one in order to access the database.
146-
Run the :ref:`mcli-atlas-dbuser-create-command` command to add a
147-
MongoDB database user.
148-
149-
The command creates a MongoDB user with the following attributes:
127+
.. code-block:: sh
150128

151-
- Username: ``User1``
152-
- Password: ``ChangeThisPasswordToSomethingSecure``
129+
mongocli atlas quickstart
153130

154-
.. note::
131+
.. tab:: Non-Interactive Mode
132+
:tabid: noninteractive
155133

156-
The tutorial uses the password ``ChangeThisPasswordToSomethingSecure``. Replace this
157-
password with a strong password.
134+
The command creates a sample shared-tier cluster
135+
with the following settings:
158136

159-
- Role: |service| admin
137+
- Cluster name: ``getStarted``
138+
- Service provider: ``AWS``
139+
- Provider region: ``US_EAST-1``
140+
- Cluster tier: ``M2``
141+
- Disk size: ``2`` GB
142+
- MongoDB version: ``4.4``
143+
- Replica set members: ``3``
160144

161-
.. code-block:: sh
162-
163-
mongocli atlas dbuser create --username User1 --password ChangeThisPasswordToSomethingSecure --role atlasAdmin@admin
145+
.. code-block:: sh
146+
147+
mongocli atlas quickstart --clusterName getStarted --provider AWS --region US_EAST_1 --username testUser --password changeMe accessListIp <192.0.2.15>
164148

165149
.. _quick-start-atlas-monitor-cluster:
166150

source/reference/atlas.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ Atlas ``mongocli`` Commands
5555
Retrieve information about MongoDB processes running on a specified
5656
|service| project.
5757

58+
:ref:`mcli-quick-start`
59+
Get started with the {+mcli+} and create a deployment and database
60+
users.
61+
5862
:ref:`security <mcli-reference-atlas-security>`
5963
Manage |service| security features.
6064

@@ -64,6 +68,7 @@ Atlas ``mongocli`` Commands
6468
.. toctree::
6569
:titlesonly:
6670

71+
Get Started with Atlas </reference/atlas/quick-start>
6772
Alerts </reference/atlas/alert-commands>
6873
Backups </reference/atlas/backup-commands>
6974
Clusters </reference/atlas/cluster-commands>

0 commit comments

Comments
 (0)