Skip to content

Commit 4d5572d

Browse files
kanchana-mongodbjwilliams-mongo
kanchana-mongodb
and
jwilliams-mongo
authored
DOCSP-12125 doc for atlas integrations list and describe commands (#262)
* DOCSP-12125 doc for atlas integrations list and describe commands * Apply suggestions from code review Co-authored-by: jwilliams-mongo <[email protected]> * DOCSP-12125 updates for copy review feedback Co-authored-by: jwilliams-mongo <[email protected]>
1 parent 45192c2 commit 4d5572d

File tree

4 files changed

+377
-2
lines changed

4 files changed

+377
-2
lines changed

‎source/reference/atlas/integration-commands.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ Atlas ``integrations`` Commands
1111

1212
Integrate with Third-Party Service </reference/atlas/integration-create>
1313
Update Third-Party Service Integration </reference/atlas/integration-update>
14+
List Third-Party Service Integrations </reference/atlas/integration-list>
15+
Describe a Third-Party Service Integration </reference/atlas/integration-describe>

‎source/reference/atlas/integration-describe.txt

Lines changed: 223 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
.. _mcli-atlas-integration-describe-cmd:
2+
3+
====================================
4+
mongocli atlas integrations describe
5+
====================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
The ``integrations describe`` command retrieves the settings for one
16+
third-party service integrated with |service|. You can also retrieve
17+
the settings of a third-party service integrated with |service| using
18+
the :atlas:`UI </tutorial/third-party-service-integrations/>` and
19+
:atlas:`API
20+
</reference/api/third-party-integration-settings-get-one/>`.
21+
22+
You must have :atlas:`Organization Owner
23+
</reference/user-roles/#Organization-Owner>` or :atlas:`Project
24+
Owner </reference/user-roles/#Project-Owner>` role to retrieve the
25+
third-party integration settings.
26+
27+
.. _mcli-atlas-integration-describe-syntax:
28+
29+
Syntax
30+
------
31+
32+
.. code-block:: sh
33+
34+
mongocli atlas integrations describe <third-party-service>
35+
[ --output|-o <output-format> ]
36+
[ --profile|-P <profile-name> ]
37+
[ --projectId <project-ID> ]
38+
39+
.. _mcli-atlas-integration-describe-args:
40+
41+
Arguments
42+
---------
43+
44+
.. list-table::
45+
:header-rows: 1
46+
:widths: 20 10 60 10
47+
48+
* - Option
49+
- Type
50+
- Description
51+
- Required?
52+
53+
* - <third-party-service>
54+
- string
55+
- Name of the third-party service integrated with |service|.
56+
Valid values are:
57+
58+
- ``DATADOG``
59+
- ``FLOWDOCK``
60+
- ``NEW_RELIC``
61+
- ``OPS_GENIE``
62+
- ``PAGER_DUTY``
63+
- ``SLACK``
64+
- ``VICTOR_OPS``
65+
- ``WEBHOOK``
66+
67+
- yes
68+
69+
.. _mcli-atlas-integration-describe-options:
70+
71+
Options
72+
-------
73+
74+
.. list-table::
75+
:header-rows: 1
76+
:widths: 20 10 60 10
77+
78+
* - Option
79+
- Type
80+
- Description
81+
- Required?
82+
83+
* - ``--output``, ``-o``
84+
- string
85+
- .. include:: /includes/extracts/fact-basic-options-output.rst
86+
- no
87+
88+
* - ``--profile``, ``-P``
89+
- string
90+
- Name of the profile where the public and private
91+
keys for the project are saved. If omitted, uses the
92+
{+default-profile+}. To learn more about creating a
93+
profile, see :ref:`mcli-configure`.
94+
- no
95+
96+
* - ``--projectId``
97+
- string
98+
- Unique identifier of the project. If omitted, uses the
99+
project ID in the profile or :ref:`environment variable
100+
<mcli-env-var>`.
101+
- no
102+
103+
.. _mcli-atlas-integration-describe-output:
104+
105+
Output
106+
------
107+
108+
The command prints the following fields to the terminal if
109+
the command succeeds. If the command prints an error, see
110+
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended
111+
solutions.
112+
113+
.. tabs::
114+
115+
.. tab:: Datadog
116+
117+
.. code-block:: sh
118+
:copyable: false
119+
120+
TYPE API KEY REGION
121+
DATADOG <API-key> <API-region>
122+
123+
.. tab:: Flowdock
124+
125+
.. code-block:: sh
126+
:copyable: false
127+
128+
TYPE API TOKEN FLOW NAME ORGANIZATION
129+
FLOWDOCK <API-token> <flow-name> <organization-name>
130+
131+
.. tab:: New Relic
132+
133+
.. code-block:: sh
134+
:copyable: false
135+
136+
TYPE ACCOUNT ID LICENSE KEY WRITE TOKEN READ TOKEN
137+
NEW_RELIC <account-ID> <license-key> <write-token> <read-token>
138+
139+
.. tab:: Opsgenie
140+
141+
.. code-block:: sh
142+
:copyable: false
143+
144+
TYPE API KEY REGION
145+
OPS_GENIE <API-key> <API-region>
146+
147+
.. tab:: PagerDuty
148+
149+
.. code-block:: sh
150+
:copyable: false
151+
152+
TYPE SERVICE KEY
153+
PAGER_DUTY <service-key>
154+
155+
.. tab:: Slack
156+
157+
.. code-block:: sh
158+
:copyable: false
159+
160+
TYPE API TOKEN TEAM CHANNEL
161+
SLACK <API-token> <team-name> <channel-name>
162+
163+
.. tab:: VictorOps
164+
165+
.. code-block:: sh
166+
:copyable: false
167+
168+
TYPE API KEY
169+
VICTOR_OPS <API-key>
170+
171+
.. tab:: Webhooks
172+
173+
.. code-block:: sh
174+
:copyable: false
175+
176+
TYPE URL SECRET
177+
WEBHOOK <webhooks-URL> <webhooks-secret>
178+
179+
The above default output is a subset of the fields returned by
180+
this command. For the complete describe of |json| fields returned by
181+
this command, see the |api| :atlas:`reference
182+
</reference/api/third-party-integration-settings-get-one/#response-elements>`.
183+
184+
.. _mcli-atlas-integration-describe-egs:
185+
186+
Example
187+
-------
188+
189+
The following ``mongocli atlas integrations describe`` command
190+
describes the specified third-party service integrated with |service|.
191+
It uses the {+default-profile+} for accessing |service|.
192+
193+
.. tabs::
194+
195+
.. tab:: Default output
196+
197+
.. code-block:: sh
198+
199+
mongocli atlas integrations describe FLOWDOCK
200+
201+
The previous command prints the following to the terminal:
202+
203+
.. code-block:: sh
204+
:copyable: false
205+
206+
TYPE API TOKEN FLOW NAME ORGANIZATION
207+
FLOWDOCK a1234b5678c9d1e23b437784b4ec3XXX Sample MONGODB
208+
209+
.. tab:: JSON output
210+
211+
.. code-block:: sh
212+
213+
mongocli atlas integrations describe PAGER_DUTY --output json
214+
215+
The previous command prints the following to the terminal:
216+
217+
.. code-block:: json
218+
:copyable: false
219+
220+
{
221+
"type": "PAGER_DUTY",
222+
"serviceKey": "7fd036a6860e41469fe1fabcdefgh"
223+
}

‎source/reference/atlas/integration-list.txt

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
.. _mcli-atlas-integration-list-cmd:
2+
3+
================================
4+
mongocli atlas integrations list
5+
================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
The ``integrations list`` command retrieves the list of third-party
16+
services integrated with |service|. You can also retrieve the list
17+
of third-party services integrated with |service| using the
18+
:atlas:`UI </tutorial/third-party-service-integrations/>` and
19+
:atlas:`API </reference/api/third-party-integration-settings-get-all/>`.
20+
21+
You must have :atlas:`Organization Owner
22+
</reference/user-roles/#Organization-Owner>` or :atlas:`Project
23+
Owner </reference/user-roles/#Project-Owner>` role to retrieve the
24+
third-party integrations.
25+
26+
.. _mcli-atlas-integration-list-syntax:
27+
28+
Syntax
29+
------
30+
31+
.. code-block:: sh
32+
33+
mongocli atlas integrations list|ls
34+
[ --output|-o <output-format> ]
35+
[ --profile|-P <profile-name> ]
36+
[ --projectId <project-ID> ]
37+
38+
.. _mcli-atlas-integration-list-options:
39+
40+
Options
41+
-------
42+
.. list-table::
43+
:header-rows: 1
44+
:widths: 20 10 60 10
45+
46+
* - Option
47+
- Type
48+
- Description
49+
- Required?
50+
51+
* - ``--output``, ``-o``
52+
- string
53+
- .. include:: /includes/extracts/fact-basic-options-output.rst
54+
- no
55+
56+
* - ``--profile``, ``-P``
57+
- string
58+
- Name of the profile where the public and private
59+
keys for the project are saved. If omitted, uses the
60+
{+default-profile+}. To learn more about creating a
61+
profile, see :ref:`mcli-configure`.
62+
- no
63+
64+
* - ``--projectId``
65+
- string
66+
- Unique identifier of the project. If omitted, uses the
67+
project ID in the profile or :ref:`environment variable
68+
<mcli-env-var>`.
69+
- no
70+
71+
.. _mcli-atlas-integration-list-output:
72+
73+
Output
74+
------
75+
76+
The command prints the following field to the terminal if
77+
the command succeeds. If the command prints an error, see
78+
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended
79+
solutions.
80+
81+
.. code-block:: sh
82+
:copyable: false
83+
84+
TYPE
85+
<third-party-service>
86+
87+
The above default output is a subset of the fields returned by
88+
this command. For the complete list of |json| fields returned by
89+
this command, see the |api| :atlas:`reference
90+
</reference/api/third-party-integration-settings-get-all/#response-elements>`.
91+
92+
.. _mcli-atlas-integration-list-egs:
93+
94+
Example
95+
-------
96+
97+
The following ``mongocli atlas integrations list`` command
98+
retrieves the list of third-party services that you
99+
integrate with |service|. It uses the {+default-profile+}
100+
for accessing |service|.
101+
102+
.. tabs::
103+
104+
.. tab:: Default output
105+
106+
.. code-block:: sh
107+
108+
mongocli atlas integrations list
109+
110+
The previous command prints the following to the terminal:
111+
112+
.. code-block:: sh
113+
:copyable: false
114+
115+
TYPE
116+
PAGER_DUTY
117+
FLOWDOCK
118+
119+
.. tab:: JSON output
120+
121+
.. code-block:: sh
122+
123+
mongocli atlas integrations list --output json
124+
125+
The previous command prints the following to the terminal:
126+
127+
.. code-block:: json
128+
:copyable: false
129+
130+
{
131+
"links": [
132+
{
133+
"rel": "self",
134+
"href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5e2211c17a3e5a48f5497de3/integrations?pageNum=1\u0026itemsPerPage=100"
135+
}
136+
],
137+
"results": [
138+
{
139+
"type": "PAGER_DUTY",
140+
"serviceKey": "wAbbTNGcSHyAqOSr4xyv"
141+
},
142+
{
143+
"type": "FLOWDOCK",
144+
"apiToken": "112233",
145+
"flowName": "mySampleFlow",
146+
"orgName": "mySampleOrg"
147+
}
148+
],
149+
"totalCount": 2
150+
}

‎source/reference/atlas/maintenanceWindow-describe.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ Output
141141
upon receiving this request.
142142

143143
To use ``startASAP : true``, you need to have
144-
:ref:`scheduled maintenance and set your own maintenance window
145-
<atlas-modify-project-settings>`.
144+
:atlas:`scheduled maintenance and set your own maintenance window
145+
</tutorial/manage-project-settings>`.
146146

147147
After you set ``startASAP : true``, the project's
148148
maintenance starts immediately. ``startASAP`` resets to

0 commit comments

Comments
 (0)