Skip to content

Commit 61ed12b

Browse files
Copy review 2
1 parent ff9a7a5 commit 61ed12b

File tree

9 files changed

+61
-42
lines changed

9 files changed

+61
-42
lines changed

source/configure/configuration-file.txt

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

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.
15+
The {+mcli+} configuration file stores your profiles. You can update the
16+
settings stored in your configuration file by editing the file with a
17+
text editor or by using the :ref:`mcli-config-set-command` command.
1618

1719
.. include:: /includes/admonitions/secure-config-file.rst
1820

@@ -23,9 +25,9 @@ The first time you run the :ref:`mcli-config-command` command, the
2325
{+mcli+} creates a configuration file called ``mongocli.toml``. The
2426
{+mcli+} grants the user who ran the command read and write access to
2527
the file. The {+mcli+} saves the configuration file to the folder where
26-
your system stores application configuration files, which is defined by
28+
the system stores application configuration files, which is defined by
2729
the ``$XDG_CONFIG_HOME`` environment variable. By default, this location
28-
is the ``/.config`` folder of your home directory. If this folder
30+
is the ``/.config`` folder of the user's home directory. If this folder
2931
doesn't exist, the {+mcli+} creates the folder and grants the user read,
3032
write, and execute permissions.
3133

@@ -35,18 +37,23 @@ Profiles
3537
--------
3638

3739
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.
40+
|api| keys in groups called *profiles*. You can create or define
41+
multiple profiles so that you can use the {+mcli+} to access different
42+
MongoDB services or projects from the same terminal.
3943

40-
The {+mcli+} uses the ``default`` profile by default. To run {+mcli+}
41-
commands without the ``--profile`` flag, you must configure a profile named ``default``. To use a profile with any other name, you must specify that profile with the ``--profile`` flag in every command.
44+
To run {+mcli+} with a specific profile, append the ``--profile
45+
<profileName>`` option to the command. If you omit the ``--profile``
46+
parameter, {+mcli+} looks for a profile named ``default`` in the
47+
configuration file.
4248

4349
Example
4450
-------
4551

4652
The following example configuration file contains two profiles,
4753
``default`` and ``myOpsManager``.
4854

49-
The ``default`` profile connects to a |service| deployment and contains the following settings:
55+
The ``default`` profile connects to a |service| deployment and contains
56+
the following settings:
5057

5158
- An organization ID
5259
- |api| keys
@@ -80,3 +87,18 @@ contains contains the following settings:
8087
private_api_key = "e750d2bf-9101-4cde-1121-ca4dcbcac9a5"
8188
service = "ops-manager"
8289

90+
To use {+mcli+} with the ``default`` profile, omit the ``--profile``
91+
option from the command:
92+
93+
.. code-block:: sh
94+
:copyable: false
95+
96+
mongocli <command>
97+
98+
To use {+mcli+} with the ``myOpsManager`` profile, append the
99+
``--profile myOpsManager`` option to the command:
100+
101+
.. code-block:: sh
102+
:copyable: false
103+
104+
mongocli <command> --profile myOpsManager

source/includes/quick-start-intro.rst

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
You can configure {+mcli+} access to your MongoDB service using
22
the :ref:`mcli-config-command` and :ref:`mcli-config-set-command`
3-
commands. In the following steps, the commands:
3+
commands.
44

5-
- Create the {+default-profile+} in the
6-
:ref:`configuration file <mcli-config-file>`.
7-
- Set your programmatic |api| access keys and project ID in the
8-
profile.
9-
10-
You can use this profile with all the other commands in this
11-
tutorial.
5+
The following procedure creates the {+default-profile+} in the
6+
:ref:`configuration file <mcli-config-file>`. You can use this profile with all the other commands in this tutorial.

source/includes/steps-configure-mcli.yaml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ content: |
2424
2525
This command creates a profile with a custom name in the
2626
:ref:`mcli-config-file`. To use this profile, you must specify
27-
it with the ``--profile`` flag in every command.
27+
it with the ``--profile`` flag in every {+mcli+} command.
2828
2929
Run the :ref:`mcli-config-command` command:
3030
@@ -95,9 +95,9 @@ content: |
9595
cat ~/.config/mongocli.toml
9696
9797
The command returns the contents of the configuration file,
98-
which contains the {+default-profile+}. The ``default``
99-
profile has a |svc-api-key| and project ID for an {{service}}
100-
deployment.
98+
which contains the {+default-profile+}. The
99+
{+default-profile+} has a |svc-api-key| and project ID for an
100+
{{service}} deployment.
101101
102102
.. code-block:: sh
103103
:copyable: false
@@ -122,7 +122,10 @@ content: |
122122
123123
cat ~/.config/mongocli.toml
124124
125-
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.
125+
The command returns the contents of the configuration file,
126+
which contains a profile named ``myMongoDB``. The
127+
``myMongoDB`` profile has a |svc-api-key| and project ID for
128+
an {{service}} deployment.
126129
127130
.. code-block:: sh
128131
:copyable: false

source/quick-start.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,9 @@ To learn more about generating the |svc-api-key|, see:
131131
---------------------
132132

133133
If the |service| project does not yet have a MongoDB database user
134-
configured, create one using the
135-
:ref:`mcli-atlas-dbuser-create-command` command. The MongoDB user
136-
can access the database hosted in |service|. Run the following
137-
command to add a MongoDB user.
134+
configured, you must create one in order to access the database.
135+
Run the :ref:`mcli-atlas-dbuser-create-command` command to add a
136+
MongoDB database user.
138137

139138
The command creates a MongoDB user with the following attributes:
140139

source/reference/atlas/dbuser-create.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Example 1
115115
The following command creates a user with the following attributes:
116116

117117
- Username: ``user1``
118-
- Password: ``passW0rd``
118+
- Password: ``ChangeThisToAStrongPassword``
119119
- Role: ``atlasAdmin``
120120

121121
The command uses the {+default-profile+} to access |service| and create the
@@ -124,7 +124,7 @@ user.
124124
.. code-block:: sh
125125
:copyable: false
126126

127-
mongocli atlas dbuser create --username user1 --password passW0rd --role atlasAdmin@admin --projectId 5e2211c17a3e5a48f5497de3
127+
mongocli atlas dbuser create --username user1 --password ChangeThisToAStrongPassword --role atlasAdmin@admin --projectId 5e2211c17a3e5a48f5497de3
128128

129129
The previous command prints the following fields
130130
to the terminal. To learn more about these fields, see
@@ -160,15 +160,15 @@ two privileges separated by a comma.
160160
.. code-block:: sh
161161
:copyable: false
162162

163-
mongocli atlas dbuser create --username egUser --password passW0rd --role readWriteAnyDatabase@admin,clusterMonitor@admin --projectId 5e2211c17a3e5a48f5497de3
163+
mongocli atlas dbuser create --username egUser --password ChangeThisToAStrongPassword --role readWriteAnyDatabase@admin,clusterMonitor@admin --projectId 5e2211c17a3e5a48f5497de3
164164

165165
The following command specifies the ``--role`` option twice,
166166
once for each privilege.
167167

168168
.. code-block:: sh
169169
:copyable: false
170170

171-
mongocli atlas dbuser create --username egUser --password passW0rd --role readWriteAnyDatabase@admin --role clusterMonitor@admin --projectId 5e2211c17a3e5a48f5497de3
171+
mongocli atlas dbuser create --username egUser --password ChangeThisToAStrongPassword --role readWriteAnyDatabase@admin --role clusterMonitor@admin --projectId 5e2211c17a3e5a48f5497de3
172172

173173
The commands print the following fields to the terminal.
174174
To learn more about these fields, see :ref:`Output

source/reference/atlas/dbuser-update.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,14 +104,14 @@ command, it prints the :ref:`Output Fields
104104
Update Password Example
105105
~~~~~~~~~~~~~~~~~~~~~~~
106106

107-
The following command modifies ``egUser``'s password to ``passW0rd``.
107+
The following command modifies ``egUser``'s password to ``ChangeThisToAStrongPassword``.
108108
The command uses the {+default-profile+}, which contains the project ID and
109109
|svc-api-key|\s for accessing the cluster.
110110

111111
.. code-block:: sh
112112
:copyable: false
113113

114-
mongocli atlas dbuser update egUser --password passW0rd
114+
mongocli atlas dbuser update egUser --password ChangeThisToAStrongPassword
115115

116116
The previous command prints the following fields
117117
to the terminal. To learn more about these fields, see
@@ -146,7 +146,7 @@ contains the project ID and |svc-api-key|\s for accessing the cluster.
146146
.. code-block:: sh
147147
:copyable: false
148148

149-
mongocli atlas dbuser update egUser --password passW0rd --role readWriteAnyDatabase@admin,clusterMonitor@admin
149+
mongocli atlas dbuser update egUser --password ChangeThisToAStrongPassword --role readWriteAnyDatabase@admin,clusterMonitor@admin
150150

151151
The following command specifies the ``--role`` option twice,
152152
once for each privilege. The command uses the {+default-profile+} where
@@ -155,7 +155,7 @@ the project ID and |svc-api-key|\s for accessing the cluster are saved.
155155
.. code-block:: sh
156156
:copyable: false
157157

158-
mongocli atlas dbuser update egUser --password passW0rd --role readWriteAnyDatabase@admin --role clusterMonitor@admin
158+
mongocli atlas dbuser update egUser --password ChangeThisToAStrongPassword --role readWriteAnyDatabase@admin --role clusterMonitor@admin
159159

160160
The commands print the following fields to the terminal.
161161
To learn more about these fields, see :ref:`Output

source/reference/cloud-manager/dbuser-create.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Example 1
121121
The following command creates a user with the following attributes:
122122

123123
- Username: ``user1``
124-
- Password: ``passW0rd``
124+
- Password: ``ChangeThisToAStrongPassword``
125125
- Role: ``readWrite@test``
126126
- Authentication mechanism: ``SCRAM-SHA-256``
127127

@@ -131,7 +131,7 @@ The command uses the {+default-profile+} to access
131131
.. code-block:: sh
132132

133133
mongocli cloud-manager dbuser create --username user1 \
134-
--password passW0rd \
134+
--password ChangeThisToAStrongPassword \
135135
--role readWrite@test \
136136
--mechanisms SCRAM-SHA-256
137137

@@ -150,7 +150,7 @@ authentication mechanism enabled.
150150
.. code-block:: sh
151151

152152
mongocli cloud-manager dbuser create --username user2 \
153-
--password passW0rd \
153+
--password ChangeThisToAStrongPassword \
154154
--role clusterMonitor,readWriteAnyDatabase
155155

156156
The following command specifies the ``--role`` option twice,
@@ -159,6 +159,6 @@ once for each privilege.
159159
.. code-block:: sh
160160

161161
mongocli cloud-manager dbuser create --username user2 \
162-
--password passW0rd \
162+
--password ChangeThisToAStrongPassword \
163163
--role clusterMonitor \
164164
--role readWriteAnyDatabase

source/reference/ops-manager/dbuser-create.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Example 1
115115
The following command creates a user with the following attributes:
116116

117117
- Username: ``user1``
118-
- Password: ``passW0rd``
118+
- Password: ``ChangeThisToAStrongPassword``
119119
- Role: ``readWrite@test``
120120
- Authentication mechanism: ``SCRAM-SHA-256``
121121

@@ -125,7 +125,7 @@ The command uses the {+default-profile+} to access
125125
.. code-block:: sh
126126

127127
mongocli ops-manager dbuser create --username user1 \
128-
--password passW0rd \
128+
--password ChangeThisToAStrongPassword \
129129
--role readWrite@test \
130130
--mechanisms SCRAM-SHA-256
131131

@@ -144,7 +144,7 @@ authentication mechanism enabled.
144144
.. code-block:: sh
145145

146146
mongocli ops-manager dbuser create --username user2 \
147-
--password passW0rd \
147+
--password ChangeThisToAStrongPassword \
148148
--role clusterMonitor,readWriteAnyDatabase
149149

150150
The following command specifies the ``--role`` option twice,
@@ -153,6 +153,6 @@ once for each privilege.
153153
.. code-block:: sh
154154

155155
mongocli cloud-manager dbuser create --username user2 \
156-
--password passW0rd \
156+
--password ChangeThisToAStrongPassword \
157157
--role clusterMonitor \
158158
--role readWriteAnyDatabase

source/reference/ops-manager/owner-create.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ first user for |mms| with the following attributes:
164164

165165
- First name: ``Jane``
166166
- Last name: ``Doe``
167-
- Password: ``p@s$w0rD``
167+
- Password: ``ChangeThisToAStrongPassword``
168168
- Email address: ``[email protected]``
169169
- IP address for whitelist: ``123.456.78.9``
170170

@@ -173,7 +173,7 @@ It uses the profile named ``omProfile`` for the |mms| base URL.
173173
.. code-block:: sh
174174
:copyable: false
175175

176-
mongocli ops-manager owner create --firstName Jane --lastName Doe --password p@ssw0rD --email [email protected] --whitelistIps 123.456.78.9 --profile ``omProfile``
176+
mongocli ops-manager owner create --firstName Jane --lastName Doe --password CHangeThisToAStrongPassword --email [email protected] --whitelistIps 123.456.78.9 --profile ``omProfile``
177177

178178
.. _om-owner-create-example2:
179179

0 commit comments

Comments
 (0)