Skip to content

Commit 0b6ec22

Browse files
Tech & copy review
1 parent 70f5746 commit 0b6ec22

16 files changed

+202
-90
lines changed

conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
'mcli': 'MongoDB CLI',
6262
'mcli-long': 'MongoDB Command Line Interface (``mongocli``)',
6363
'mcli-version': '0.5.0',
64+
'mdbVersion': '4.2',
6465
'mdbagent': 'MongoDB Agent',
6566
'aagent': 'Automation Agent',
6667
'magent': 'Monitoring Agent',

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ mcli = "MongoDB CLI"
55
mcli-long = "MongoDB Command Line Interface (``mongocli``)"
66
mcli-version = "0.5.0"
77
mdbagent = "MongoDB Agent"
8+
mdbVersion = "4.2"
89
aagent = "Automation Agent"

source/configure/configuration-file.txt

Lines changed: 44 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -25,38 +25,57 @@ Configuration File Location
2525
---------------------------
2626

2727
The first time you run the :ref:`mcli-config-command` command, the
28-
{+mcli+} creates a configuration file called ``mongocli.toml`` and grants
29-
you read and write access to the file. The {+mcli+} saves the
30-
configuration file to the folder where your system stores application
31-
configuration files, which is defined by the ``$XDG_CONFIG_HOME``
32-
environment variable. By default, this location is the ``/.config``
33-
folder of your home directory. If this folder doesn't exist, the
34-
{+mcli+} creates the folder and grants you read, write, and execute
35-
permissions.
28+
{+mcli+} creates a configuration file called ``mongocli.toml``. The
29+
{+mcli+} grants the user who ran the command read and write access to
30+
the file. The {+mcli+} saves the configuration file to the folder where
31+
your system stores application configuration files, which is defined by
32+
the ``$XDG_CONFIG_HOME`` environment variable. By default, this location
33+
is the ``/.config`` folder of your home directory. If this folder
34+
doesn't exist, the {+mcli+} creates the folder and grants you read,
35+
write, and execute permissions.
3636

3737
Example
3838
-------
3939

4040
The following example configuration file contains two profiles,
41-
``default`` and ``myOpsManager``. The ``default`` profile contains |api|
42-
keys, an organization ID, and a project ID for an |service| deployment.
43-
The ``myOpsManager`` profile contains |api| keys, the base |url|, an
44-
organization ID, and a project ID for an |onprem| deployment.
41+
``default`` and ``myOpsManager``.
4542

46-
.. code-block:: sh
43+
The ``default`` profile connects to a |service| deployment and contains
44+
the following settings:
45+
46+
- An organization ID
47+
- |api| keys
48+
- A project ID
49+
50+
The ``myOpsManager`` profile connects to an |onprem| deployment and
51+
contains contains the following settings:
52+
53+
- The |onprem| base |url|
54+
- An organization ID
55+
- |api| keys
56+
- A project ID
57+
58+
.. note::
59+
When you run a {+mcli+} command without the ``--profile`` flag, the
60+
{+mcli+} uses the profile named ``default`` by default. To use a
61+
profile with another name, you must specify it in the command with the ``--profile`` flag.
62+
63+
.. code-block:: text
64+
:copyable: false
65+
66+
# ~/.config/mongocli.toml
4767

4868
[default]
49-
service=cloud
50-
public_api_key=ABCDEFG
51-
private_api_key=e750d2bf-1234-4cde-5678-ca4dcbcac9a4
52-
organization_id=qwer5678uiop23jb45lk78mn
53-
project_id=5e2f04ecf10fcd33c7d4077e
69+
organization_id = "qwer5678uiop23jb45lk78mn"
70+
public_api_key = "ABCDEFG"
71+
project_id= "5e2f04ecf10fcd33c7d4077e"
72+
private_api_key = "e750d2bf-1234-4cde-5678-ca4dcbcac9a4"
73+
service = "cloud"
5474

5575
[myOpsManager]
56-
service=om
57-
public_api_key=HIJKLMN
58-
private_api_key=e750d2bf-9101-4cde-1121-ca4dcbcac9a5
59-
ops_manager_url=http://localhost:9080
60-
organization_id=jklsa23123dsdf3jj456hs2
61-
project_id=kk12jdn43jd123dkdkf97jg
62-
76+
ops_manager_url = "http://localhost:9080/"
77+
organization_id = "jklsa23123dsdf3jj456hs2"
78+
public_api_key = "HIJKLMN"
79+
project_id = "kk12jdn43jd123dkdkf97jg"
80+
private_api_key = "e750d2bf-9101-4cde-1121-ca4dcbcac9a5"
81+
service = "ops-manager"
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. note::
2+
3+
This feature is not available for ``M0`` (Free Tier) clusters. For
4+
more information, see :ref:`Atlas M0 (Free Tier) Limitations
5+
<atlas-free-tier>`.

source/includes/quick-start-intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ the :ref:`mcli-config-command` and :ref:`mcli-config-set-command`
33
commands. In the following steps, the commands:
44

55
- Create the ``default`` profile in the
6-
``mongocli.toml`` file.
6+
:ref:`configuration file <mcli-config-file>`.
77
- Set your programmatic |api| access keys and project ID in the
88
profile.
99

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
11
Congratulations! You have successfully created a cluster to host your
22
data. You can view your cluster by logging in to the UI.
33

4-
You can also connect to your cluster using the ``mongoURI``. For
5-
example, run the following command to connect using the ``mongoURI``.
6-
Replace ``mongoURI`` with the value of ``mongoURI`` in your ``cluster
7-
describe`` command output.
8-
9-
.. code-block:: sh
10-
11-
mongo <mongoURI>

source/includes/steps-configure-mcli-atlas.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ source:
33
file: steps-configure-mcli.yaml
44
ref: create-profile
55
replacement:
6-
serviceName: "cloud"
6+
serviceOption: ""
77
---
88
stepnum: 2
99
source:

source/includes/steps-configure-mcli-cm.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ source:
33
file: steps-configure-mcli.yaml
44
ref: create-profile
55
replacement:
6-
serviceName: "cloud-manager"
6+
serviceOption: "--service cloud-manager"
77
---
88
stepnum: 2
99
source:

source/includes/steps-configure-mcli-om.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ source:
33
file: steps-configure-mcli.yaml
44
ref: create-profile
55
replacement:
6-
serviceName: "ops-manager"
6+
serviceOption: "--service ops-manager"
77
---
88
stepnum: 2
99
source:

source/includes/steps-configure-mcli.yaml

Lines changed: 79 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,36 @@ stepnum: 0
33
level: 4
44
ref: create-profile
55
content: |
6-
7-
Run the :ref:`mcli-config-command` command:
86
9-
.. code-block:: sh
7+
.. tabs::
8+
9+
.. tab:: Default Profile
10+
:tab-id: default-profile
11+
12+
Run the :ref:`mcli-config-command` command:
13+
14+
.. code-block:: sh
15+
16+
mongocli config {{serviceOption}}
17+
18+
This command creates a profile called ``default`` in the
19+
:ref:`mcli-config-file`. The {+mcli+} uses this profile by
20+
default.
1021
11-
mongocli config --service {{serviceName}}
22+
.. tab:: Named Profile
23+
:tab-id: named-profile
1224
13-
This command creates a profile called ``default``.
25+
26+
Run the :ref:`mcli-config-command` command:
1427
15-
.. tip::
28+
.. code-block:: sh
29+
30+
mongocli config {{serviceOption}} --profile <profile-name>
1631
17-
To create a profile with a custom name, specify ``--profile
18-
<profile-name>``. If you create a profile with a custom name, you
19-
must specify ``--profile <profile-name>`` every time you run
20-
a {+mcli+} command.
32+
This command creates a profile with a custom name in the
33+
:ref:`mcli-config-file`. To use this profile im subsequent
34+
{+mcli+} commands, you must run the commands with the
35+
``--profile`` flag.
2136
2237
---
2338
title: "Enter your |onprem| Base |url|"
@@ -63,28 +78,60 @@ content: |
6378
6479
.. include:: /includes/admonitions/secure-config-file.rst
6580
66-
.. example::
67-
68-
In this example, the configuration file is stored in the
69-
``/.config`` folder of your home directory. View the file using the
70-
``cat`` command:
71-
72-
.. code-block:: sh
73-
:copyable: false
74-
75-
cat ~/.config/mongocli.toml
76-
77-
The command returns the contents of the configuration file, which
78-
contains a ``default`` profile that has a |svc-api-key| for an
79-
{{service}} deployment.
80-
81-
.. code-block:: sh
82-
:copyable: false
81+
.. tabs::
82+
:hidden:
83+
84+
.. tab:: Default Profile
85+
:tab-id: default-profile
86+
87+
.. example::
88+
89+
In this example, the configuration file is stored in the
90+
``/.config`` folder of your home directory. View the file
91+
using the ``cat`` command:
92+
93+
.. code-block:: sh
94+
:copyable: false
95+
96+
cat ~/.config/mongocli.toml
97+
98+
The command returns the contents of the configuration file,
99+
which contains the ``default`` profile. The ``default``
100+
profile has a |svc-api-key| and project ID for an {{service}}
101+
deployment.
102+
103+
.. code-block:: sh
104+
:copyable: false
105+
106+
[default]
107+
private_api_key = "abcdef"
108+
public_api_key = "d5199648-abcd-1234-efgh-3ed4396a3096"
109+
project_id = "7ehf04abc10defb66c7d1234c"
110+
service = "{{serviceName}}"
111+
112+
.. tab:: Named Profile
113+
:tab-id: named-profile
83114
84-
[default]
85-
private_api_key = "abcdef"
86-
public_api_key = "d5199648-abcd-1234-efgh-3ed4396a3096"
87-
project_id = "7ehf04abc10defb66c7d1234c"
88-
service = "{{serviceName}}"
115+
.. example::
116+
117+
In this example, the configuration file is stored in the
118+
``/.config`` folder of your home directory. View the file
119+
using the ``cat`` command:
120+
121+
.. code-block:: sh
122+
:copyable: false
123+
124+
cat ~/.config/mongocli.toml
125+
126+
The command returns the contents of the configuration file, which contains a profile named ``myMongoDB``. The ``myMongoDB`` profile has a |svc-api-key| and project ID for an {{service}} deployment.
127+
128+
.. code-block:: sh
129+
:copyable: false
130+
131+
[myMongoDB]
132+
private_api_key = "abcdef"
133+
public_api_key = "d5199648-abcd-1234-efgh-3ed4396a3096"
134+
project_id = "7ehf04abc10defb66c7d1234c"
135+
service = "{{serviceName}}"
89136
90137
...

source/quick-start.txt

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,12 @@ To learn more about generating the |svc-api-key|, see:
8686
Create a Cluster
8787
----------------
8888

89-
You can create a cluster on |service| using the
90-
:ref:`mcli-atlas-cluster-create-command` command.
89+
Use the :ref:`mcli-atlas-cluster-create-command` command to create
90+
a cluster in |service|.
91+
92+
.. include:: /includes/admonitions/note-atlas-api-free-tier-limits.rst
9193

92-
The following command creates a sample cluster with the following settings:
94+
The following command creates a sample paid-tier cluster with the following settings:
9395

9496
- Cluster name: ``getStarted``
9597
- Service provider: ``AWS``
@@ -103,18 +105,21 @@ To learn more about generating the |svc-api-key|, see:
103105

104106
.. code-block:: text
105107

106-
mongocli atlas cluster create getStarted --provider AWS --region US_EAST_1 --tier M10 --diskSizeGB 10 --mdbVersion 4.2 --members 3
108+
mongocli atlas cluster create getStarted --provider AWS --region US_EAST_1 --tier M10 --diskSizeGB 10 --mdbVersion {+mdbVersion+} --members 3
107109

108110
.. _quick-start-whitelist:
109111

110112
Whitelist Your IP Address
111113
-------------------------
112114

113-
For each project, you can create a list of trusted IP addresses,
114-
referred to as a whitelist, and connect to the clusters in the
115-
project from a trusted IP address. Run the following command to
116-
add IP addresses to your whitelist.
117-
115+
|service| only allows incoming connections to the cluster from
116+
entries in the project’s whitelist. You can add individual IP
117+
addresses or |cidr| blocks to the project IP whitelist.
118+
119+
|service| supports specifying private IP addresses with VPC peered
120+
connections. For more information, see :ref:`vpc-peering`.
121+
122+
Run the following command to add entries to your whitelist.
118123
Replace the IP address with your connection IP address.
119124

120125
.. code-block:: sh
@@ -126,34 +131,34 @@ To learn more about generating the |svc-api-key|, see:
126131
Create a MongoDB User
127132
---------------------
128133

129-
You must create a MongoDB user for your |service| cluster with the
134+
If the |service| project does not yet have a MongoDB database user
135+
configured, create one using the
130136
:ref:`mcli-atlas-dbuser-create-command` command. The MongoDB user
131137
can access the database hosted in |service|. Run the following
132138
command to add a MongoDB user.
133139

134140
The command creates a MongoDB user with the following attributes:
135141

136142
- Username: ``User1``
137-
- Password: ``P@ssw0rd!``
143+
- Password: ``ChangeThisPasswordToSomethingSecure``
138144

139145
.. note::
140146

141-
The tutorial uses the password ``P@ssw0rd!``. Replace this
147+
The tutorial uses the password ``ChangeThisPasswordToSomethingSecure``. Replace this
142148
password with a strong password.
143149

144150
- Role: |service| admin
145151

146152
.. code-block:: sh
147153

148-
mongocli atlas dbuser create --username User1 --password P@ssw0rd! --role atlasAdmin@admin
154+
mongocli atlas dbuser create --username User1 --password ChangeThisPasswordToSomethingSecure --role atlasAdmin@admin
149155

150156
.. _quick-start-atlas-retrieve-cluster:
151157

152158
Retrieve Your Cluster
153159
---------------------
154160

155-
You can check whether your cluster was successfully created by
156-
retrieving the cluster details using the
161+
To check your cluster's deployment status, issue the
157162
:ref:`mcli-atlas-cluster-describe-command` command.
158163

159164
.. code-block:: sh
@@ -181,7 +186,7 @@ To learn more about generating the |svc-api-key|, see:
181186
"groupId": "<project-ID>",
182187
"mongoDBVersion": "4.2.3",
183188
"mongoDBMajorVersion": "4.2",
184-
"mongoURI": "mongodb://getstarted-shard-00-00-7hgjn.mongodb.net:27017,getstarted-shard-00-01-7hgjn.mongodb.net:27017,getstarted-shard-00-02-7hgjn.mongodb.net:27017",
189+
"mongoURI": "mongodb://getstarted.mongodb.example.net:27017,getstarted.mongodb.example.net:27017,getstarted.mongodb.example.net:27017",
185190
"name": "getStarted",
186191
"numShards": 1,
187192
"paused": false,
@@ -216,7 +221,7 @@ To learn more about generating the |svc-api-key|, see:
216221
}
217222
}
218223
],
219-
"srvAddress": "mongodb+srv://getstarted-7hgjn.mongodb.net",
224+
"srvAddress": "mongodb+srv://getstarted.mongodb.example.net",
220225
"stateName": "IDLE"
221226
}
222227

@@ -225,6 +230,15 @@ To learn more about generating the |svc-api-key|, see:
225230

226231
.. include:: /includes/quick-start-summary.rst
227232

233+
You can also connect to your cluster using the ``mongoURI``. For
234+
example, run the following command to connect using the
235+
``mongoURI``. Replace ``mongoURI`` with the value of ``mongoURI``
236+
in your ``cluster describe`` command output.
237+
238+
.. code-block:: sh
239+
240+
mongo <mongoURI>
241+
228242
.. tab:: Cloud Manager
229243
:tabid: cloud-manager
230244

0 commit comments

Comments
 (0)