@@ -9,9 +9,8 @@ content: |
9
9
.. tab:: Default Profile
10
10
:tabid: default-profile
11
11
12
- This command creates a profile called ``default`` in the
13
- :ref:`mcli-config-file`. The {+mcli+} uses this profile by
14
- default.
12
+ This command creates a :ref:`profile <mcli-profiles>` called
13
+ ``default`` in the :ref:`mcli-config-file`.
15
14
16
15
Run the :ref:`mcli-config-command` command:
17
16
@@ -22,48 +21,117 @@ content: |
22
21
.. tab:: Named Profile
23
22
:tabid: named-profile
24
23
25
- This command creates a profile with a custom name in the
26
- :ref:`mcli-config-file`. To use this profile, you must specify
27
- it with the ``--profile`` flag in every {+mcli+} command.
24
+ This command creates a :ref:`profile <mcli-profiles>` with a
25
+ custom name in the :ref:`mcli-config-file`. To use this profile
26
+ in a command, you must specify the profile with the
27
+ ``--profile`` flag.
28
28
29
29
Run the :ref:`mcli-config-command` command:
30
30
31
31
.. code-block:: sh
32
32
33
33
mongocli config {{serviceOption}} --profile <profile-name>
34
-
34
+
35
35
---
36
- title : " Enter your |onprem| Base |url|"
36
+ title : " Create a profile for the {{service}} project."
37
+ stepnum : 0
38
+ level : 4
39
+ ref : quick-create-profile
40
+ content : |
41
+ Run the following :ref:`command <mcli-config-command>` to create a
42
+ :ref:`profile <mcli-profiles>` called ``default``.
43
+
44
+ .. code-block:: sh
45
+
46
+ mongocli config {{serviceOption}}
47
+
48
+ ---
49
+ title : " Enter the :opsmgr:`URL you use to access Ops Manager </reference/config/ui-settings/#URL-to-Access-Ops-Manager>`."
37
50
stepnum : 0
38
51
level : 4
39
52
ref : enter-base-url
40
53
content : |
41
- The |onprem| Base |url| is the :opsmgr:`URL you use to access Ops
42
- Manager </reference/config/ui-settings/#URL-to-Access-Ops-Manager>`.
43
54
44
55
.. code-block:: sh
56
+ :copyable: false
45
57
46
- ? Ops Manager Base URL : http://mms.example.com:8080
58
+ ? URL to Access Ops Manager : http://mms.example.com:8080
47
59
48
60
---
49
- title : " Enter your {{apiKeys}} and {{projectId}} ."
61
+ title : " Enter your {{apiKeys}}."
50
62
stepnum : 0
51
63
level : 4
64
+ optional : true
52
65
ref : enter-api-key
53
66
content : |
54
67
55
- When prompted, enter the ``Public API Key``, ``Private API Key``, and
56
- ``Project ID`` for your {{service}} deployment.
68
+ When prompted, enter the ``Public API Key`` and ``Private API Key``
69
+ for your {{service}} deployment.
57
70
58
71
.. code-block:: sh
59
72
:copyable: false
60
73
61
74
? Public API Key: abcdef
62
- ? Private API Key: [? for help] ************************************
63
- ? Project ID [optional]: 7ehf04abc10defb66c7d1234c
75
+ ? Private API Key: [? for help]
76
+ ************************************
77
+
78
+ ---
79
+ title : " Choose your default organization."
80
+ stepnum : 0
81
+ level : 4
82
+ ref : enter-orgid
83
+ content : |
84
+
85
+ If you entered |api| keys, the command displays the name and ID of organizations that your |api| key can access.
86
+
87
+ a. Select your organization:
88
+
89
+ - Press the :kbd:`Down Arrow` and :kbd:`Up Arrow`
90
+ keys to highlight the desired organization, or
91
+ - Type the organization name to filter the available
92
+ organizations.
93
+
94
+ .. code-block:: sh
95
+ :copyable: false
96
+
97
+ ? Choose a default organization: [Use arrows to move, type to filter]
98
+ > Org1 (5e39bf1212121e685774c81c)
64
99
65
- If you don't save your project ID in your profile, you must specify
66
- the ``--projectId`` option every time you run a {+mcli+} command.
100
+ #. Press :kbd:`Enter`.
101
+
102
+ If you didn't enter |api| keys, the command prompts you to enter your
103
+ ``Default Project ID``.
104
+
105
+ ---
106
+ title : " Choose your default project."
107
+ stepnum : 0
108
+ level : 4
109
+ ref : enter-projectid
110
+ content : |
111
+
112
+ If you entered |api| keys, the command displays the name and ID of
113
+ projects that your |api| key can access.
114
+
115
+ a. Select your project:
116
+
117
+ - Press the :kbd:`Down Arrow` and :kbd:`Up Arrow`
118
+ keys to highlight the desired project, or
119
+ - Type the project name to filter the available
120
+ projects.
121
+
122
+ .. code-block:: sh
123
+ :copyable: false
124
+
125
+ ? Choose a default project: [Use arrows to move, type to filter]
126
+ Project1 (5e5ebffd0c04a97009061234)
127
+ Project2 (5cfacee6014b761b07f15678)
128
+ > Project3 (5e39bf4979358e6857741212)
129
+ Project4 (5c815cc7014b768fb67e3434)
130
+
131
+ #. Press :kbd:`Enter`.
132
+
133
+ If you didn't enter |api| keys, the command prompts you to enter your
134
+ ``Default Organization ID``.
67
135
68
136
---
69
137
title : " Verify your profile."
@@ -85,49 +153,51 @@ content: |
85
153
86
154
.. example::
87
155
88
- In this example, the following command returns the settings
156
+ The following command returns the settings
89
157
in the {+default-profile+}:
90
158
91
159
.. code-block:: sh
92
160
:copyable: false
93
161
94
162
mongocli config describe default
95
163
96
- The command returns the following settings. The {+default-profile+}
97
- has a |svc-api-key|, which is redacted in the command output for
98
- security purposes, and project ID for an {{service}} deployment.
164
+ The command returns the following settings. For security
165
+ purposes, the command redacts |api| keys in the output.
99
166
100
167
.. code-block:: sh
101
168
:copyable: false
102
169
170
+ {{opsMgrUrl}}
171
+ org_id = 5f1f39ffc902201990f12345
103
172
private_api_key = redacted
104
- public_api_key = redacted
105
173
project_id = 7ehf04abc10defb66c7d1234c
174
+ public_api_key = redacted
106
175
service = {{serviceName}}
107
176
108
177
.. tab:: Named Profile
109
178
:tabid: named-profile
110
179
111
180
.. example::
112
181
113
- In this example, the following command returns the settings
182
+ The following command returns the settings
114
183
in the profile named ``myMongoDB``:
115
184
116
185
.. code-block:: sh
117
186
:copyable: false
118
187
119
188
mongocli config describe myMongoDB
120
189
121
- The command returns following settings. The ``myMongoDB`` profile
122
- has a |svc-api-key|, which is redacted in the command output for
123
- security purposes, and project ID for an {{service}} deployment.
190
+ The command returns following settings. For security
191
+ purposes, the command redacts |api| keys in the output.
124
192
125
193
.. code-block:: sh
126
194
:copyable: false
127
195
196
+ {{opsMgrUrl}}
197
+ org_id = 5f1f39ffc902201990f12345
128
198
private_api_key = redacted
129
- public_api_key = redacted
130
199
project_id = 7ehf04abc10defb66c7d1234c
200
+ public_api_key = redacted
131
201
service = {{serviceName}}
132
202
133
203
0 commit comments