Skip to content

Commit a27cb2d

Browse files
More updates
1 parent 9ecbb1d commit a27cb2d

10 files changed

+56
-69
lines changed

conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
pygments_style = 'sphinx'
5858

5959
source_constants = {
60-
'default-profile': ':ref:`default profile <mcli-config-file>`',
60+
'default-profile': ':ref:`default profile <mcli-profiles>`',
6161
'version': version,
6262
'mcli': 'MongoDB CLI',
6363
'mcli-long': 'MongoDB Command Line Interface (``mongocli``)',

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "mongocli"
22

33
[constants]
4-
default-profile = ":ref:`default profile <mcli-config-file>`"
4+
default-profile = ":ref:`default profile <mcli-profiles>`"
55
mcli = "MongoDB CLI"
66
mcli-long = "MongoDB Command Line Interface (``mongocli``)"
77
mcli-version = "0.5.0"

source/configure/configuration-file.txt

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,7 @@
1212
:depth: 1
1313
:class: singlecol
1414

15-
The {+mcli+} configuration file stores related settings and
16-
|api| keys in groups called *profiles*. You can define multiple profiles
17-
so that you can use the {+mcli+} to access different MongoDB services or
18-
projects from the same terminal. You can update the settings stored in
19-
your configuration file by editing the file with a text editor or
20-
by using the :ref:`mcli-config-set-command` command.
15+
The {+mcli+} configuration file stores your profiles. You can update the settings stored in your configuration file by editing the file with a text editor or by using the :ref:`mcli-config-set-command` command.
2116

2217
.. include:: /includes/admonitions/secure-config-file.rst
2318

@@ -34,14 +29,26 @@ is the ``/.config`` folder of your home directory. If this folder
3429
doesn't exist, the {+mcli+} creates the folder and grants you read,
3530
write, and execute permissions.
3631

32+
.. _mcli-profiles:
33+
34+
Profiles
35+
--------
36+
37+
The {+mcli+} configuration file stores related settings and
38+
|api| keys in groups called *profiles*. You can create or define multiple profiles so that you can use the {+mcli+} to access different MongoDB services or projects from the same terminal.
39+
40+
The {+mcli+} uses the ``default`` profile by default. To run {+mcli+}
41+
commands without the ``--profile`` flag, you must use a profile named
42+
``default``. To use a profile with any other name, you must specify the
43+
``--profile`` flag for every command.
44+
3745
Example
3846
-------
3947

4048
The following example configuration file contains two profiles,
4149
``default`` and ``myOpsManager``.
4250

43-
The ``default`` profile connects to a |service| deployment and contains
44-
the following settings:
51+
The ``default`` profile connects to a |service| deployment and contains the following settings:
4552

4653
- An organization ID
4754
- |api| keys
@@ -55,11 +62,6 @@ contains contains the following settings:
5562
- |api| keys
5663
- A project ID
5764

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-
6365
.. code-block:: text
6466
:copyable: false
6567

@@ -79,3 +81,4 @@ contains contains the following settings:
7981
project_id = "kk12jdn43jd123dkdkf97jg"
8082
private_api_key = "e750d2bf-9101-4cde-1121-ca4dcbcac9a5"
8183
service = "ops-manager"
84+
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. note::
22

33
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>`.
4+
more information, see :atlas:`Atlas M0 (Free Tier) Limitations
5+
</reference/free-shared-limitations/index.html>`.

source/includes/steps-configure-mcli.yaml

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,31 @@ content: |
77
.. tabs::
88
99
.. 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}}
10+
:tabid: default-profile
1711
1812
This command creates a profile called ``default`` in the
1913
:ref:`mcli-config-file`. The {+mcli+} uses this profile by
2014
default.
21-
22-
.. tab:: Named Profile
23-
:tab-id: named-profile
2415
25-
2616
Run the :ref:`mcli-config-command` command:
2717
2818
.. code-block:: sh
2919
30-
mongocli config {{serviceOption}} --profile <profile-name>
20+
mongocli config {{serviceOption}}
21+
22+
.. tab:: Named Profile
23+
:tabid: named-profile
3124
3225
This command creates a profile with a custom name in the
3326
:ref:`mcli-config-file`. To use this profile im subsequent
3427
{+mcli+} commands, you must run the commands with the
3528
``--profile`` flag.
29+
30+
Run the :ref:`mcli-config-command` command:
31+
32+
.. code-block:: sh
33+
34+
mongocli config {{serviceOption}} --profile <profile-name>
3635
3736
---
3837
title: "Enter your |onprem| Base |url|"
@@ -82,7 +81,7 @@ content: |
8281
:hidden:
8382
8483
.. tab:: Default Profile
85-
:tab-id: default-profile
84+
:tabid: default-profile
8685
8786
.. example::
8887
@@ -110,7 +109,7 @@ content: |
110109
service = "{{serviceName}}"
111110
112111
.. tab:: Named Profile
113-
:tab-id: named-profile
112+
:tabid: named-profile
114113
115114
.. example::
116115

source/includes/steps-quick-start-atlas-config-mcli.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
stepnum: 1
22
source:
33
file: steps-quick-start-config-mcli.yaml
4-
ref: quick-atlas-profile
4+
ref: quick-create-profile
5+
replacement:
6+
mdbService: Atlas
7+
serviceOption: ""
58
---
69
stepnum: 2
710
source:

source/includes/steps-quick-start-cm-config-mcli.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ source:
44
ref: quick-create-profile
55
replacement:
66
mdbService: Cloud Manager
7-
serviceName: "cloud-manager"
7+
serviceOption: "--service cloud-manager"
88
---
99
stepnum: 2
1010
source:

source/includes/steps-quick-start-config-mcli.yaml

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,18 @@
11
---
2-
title: "Create a profile for the |service| project."
3-
stepnum: 0
4-
level: 4
5-
ref: quick-atlas-profile
6-
content: |
7-
Run the following command to create the ``default`` profile.
8-
9-
.. code-block:: sh
10-
11-
mongocli config
12-
13-
To learn more about the ``mongocli config`` command, see
14-
:ref:`mcli-config-command` or :ref:`mcli-configure`.
15-
16-
---
17-
title: "Create a profile for the {{mmsService}} project."
2+
title: "Create a profile for the {{service}} project."
183
stepnum: 0
194
level: 4
205
ref: quick-create-profile
216
content: |
22-
Run the following command to create the ``default`` profile.
7+
Run the following command to create the {+default-profile+}.
238
249
.. code-block:: sh
2510
26-
mongocli config --service {{serviceName}} --profile {{profileName}}
11+
mongocli config {{serviceOption}}
2712
28-
To learn more about the ``mongocli config`` command, see
29-
:ref:`mcli-config-command` or :ref:`mcli-configure`.
13+
.. seealso:
14+
- :ref:`mcli-config-command`
15+
- :ref:`mcli-configure`.
3016
3117
---
3218
title: "Set your credentials in your profile."

source/includes/steps-quick-start-om-config-mcli.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ source:
44
ref: quick-create-profile
55
replacement:
66
mdbService: Ops Manager
7-
serviceName: "ops-manager"
7+
serviceOption: "--service ops-manager"
88
---
99
stepnum: 2
1010
source:

source/quick-start.txt

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,9 @@ To learn more about generating the |svc-api-key|, see:
101101
- MongoDB version: ``4.2``
102102
- Replica set members: ``3``
103103

104-
.. example::
104+
.. code-block:: text
105105

106-
.. code-block:: text
107-
108-
mongocli atlas cluster create getStarted --provider AWS --region US_EAST_1 --tier M10 --diskSizeGB 10 --mdbVersion {+mdbVersion+} --members 3
106+
mongocli atlas cluster create getStarted --provider AWS --region US_EAST_1 --tier M10 --diskSizeGB 10 --mdbVersion {+mdbVersion+} --members 3
109107

110108
.. _quick-start-whitelist:
111109

@@ -117,7 +115,8 @@ To learn more about generating the |svc-api-key|, see:
117115
addresses or |cidr| blocks to the project IP whitelist.
118116

119117
|service| supports specifying private IP addresses with VPC peered
120-
connections. For more information, see :ref:`vpc-peering`.
118+
connections. For more information, see
119+
:atlas:`Set up a Network Peering Connection </security-vpc-peering/index.html>`.
121120

122121
Run the following command to add entries to your whitelist.
123122
Replace the IP address with your connection IP address.
@@ -230,14 +229,9 @@ To learn more about generating the |svc-api-key|, see:
230229

231230
.. include:: /includes/quick-start-summary.rst
232231

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>
232+
You can use the |mongo| shell connect to your cluster with the
233+
``srvAddress`` and appropriate :manual:`connection string options
234+
</reference/connection-string/#connection-string-options>`.
241235

242236
.. tab:: Cloud Manager
243237
:tabid: cloud-manager
@@ -252,7 +246,8 @@ To learn more about generating the |svc-api-key|, see:
252246
Create a Cluster
253247
----------------
254248

255-
You can create a cluster on |cloud-short| using the {+mcli+}.
249+
Use the :ref:`mcli-cm-cluster-create-command` command to create
250+
a cluster in |cloud-short|.
256251

257252
.. include:: /includes/quick-start-cm-om-create-cluster-intro.rst
258253
.. include:: /includes/steps/quick-start-cm-cluster-create.rst
@@ -351,7 +346,8 @@ To learn more about generating the |svc-api-key|, see:
351346
Create a Cluster
352347
----------------
353348

354-
You can create a cluster on |mms| using the {+mcli+}.
349+
Use the :ref:`mcli-om-cluster-create-command` command to create
350+
a cluster in |onprem|.
355351

356352
.. include:: /includes/quick-start-cm-om-create-cluster-intro.rst
357353
.. include:: /includes/steps/quick-start-om-cluster-create.rst

0 commit comments

Comments
 (0)