Skip to content

Commit 45192c2

Browse files
kanchana-mongodbkanchana-mongodb
authored
DOCSP-12127 doc for atlas integrations create and update commands (#261)
* DOCSP-12127 doc for atlas integrations create and update commands * DOCSP-12127 updates for copy review feedback
1 parent 91abcd8 commit 45192c2

13 files changed

+766
-0
lines changed

‎source/includes/extracts-basic-options.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,9 @@ content: |
1515
Name of the profile where the public and private keys for the project are
1616
set. If omitted, uses the {+default-profile+}. To learn more about creating a
1717
profile, see :ref:`mcli-configure`.
18+
---
19+
ref: fact-basic-options-project-id
20+
content: |
21+
Unique identifier of the project. If omitted, uses the project ID in the
22+
profile or :ref:`environment variable <mcli-env-var>`.
1823
...

‎source/includes/extracts-integrations-cmd-syntax.yaml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
ref: fact-datadog-syntax
2+
content: |
3+
.. code-block:: shell
4+
5+
mongocli atlas integrations create DATADOG|datadog
6+
--apiKey <api-key>
7+
[ --output|-o <output-format> ]
8+
[ --profile|-P <profile-name> ]
9+
[ --projectId <project-ID> ]
10+
--region <api-region>
11+
12+
---
13+
ref: fact-flowdock-syntax
14+
content: |
15+
.. code-block:: shell
16+
17+
mongocli atlas integrations create FLOWDOCK|flowdock
18+
--apiToken <api-token>
19+
--flowName <flow-name>
20+
--orgName <organization-name>
21+
[ --output|-o <output-format> ]
22+
[ --profile|-P <profile-name> ]
23+
[ --projectId <project-ID> ]
24+
25+
---
26+
ref: fact-newrelic-syntax
27+
content: |
28+
.. code-block:: shell
29+
30+
mongocli atlas integrations create NEW_RELIC|newRelic|new_relic
31+
--accountId <account-ID>
32+
--licenseKey <license-key>
33+
[ --output|-o <output-format> ]
34+
[ --profile|-P <profile-name> ]
35+
[ --projectId <project-ID> ]
36+
--readToken <query-key>
37+
--writeToken <insert-key>
38+
39+
---
40+
ref: fact-opsgenie-syntax
41+
content: |
42+
.. code-block:: shell
43+
44+
mongocli atlas integrations create OPS_GENIE|opsGenie|ops_genie
45+
--apiKey <api-key>
46+
[ --output|-o <output-format> ]
47+
[ --profile|-P <profile-name> ]
48+
[ --projectId <project-ID> ]
49+
--region <api-region>
50+
51+
---
52+
ref: fact-pagerduty-syntax
53+
content: |
54+
.. code-block:: shell
55+
56+
mongocli atlas integrations create PAGER_DUTY|pagerDuty|pager_duty
57+
[ --output|-o <output-format> ]
58+
[ --profile|-P <profile-name> ]
59+
[ --projectId <project-ID> ]
60+
--serviceKey <service-key>
61+
62+
---
63+
ref: fact-victorops-syntax
64+
content: |
65+
.. code-block:: shell
66+
67+
mongocli atlas integrations create VICTOR_OPS|victorOps|victor_ops
68+
--apiKey <api-key>
69+
[ --output|-o <output-format> ]
70+
[ --profile|-P <profile-name> ]
71+
[ --projectId <project-ID> ]
72+
[ --routingKey <routing-key> ]
73+
74+
---
75+
ref: fact-webhook-syntax
76+
content: |
77+
.. code-block:: shell
78+
79+
mongocli atlas integrations create WEBHOOK|webhook
80+
[ --output|-o <output-format> ]
81+
[ --profile|-P <profile-name> ]
82+
[ --projectId <project-ID> ]
83+
[ --secret <webhook-secret> ]
84+
--url <webhook-url>
85+
86+
...

‎source/includes/list-table-datadog-options.rst‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 20 10 60 10
4+
5+
* - Option
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``--apiKey``
11+
- string
12+
- |api| key for `Datadog <https://www.datadoghq.com/>`__.
13+
- yes
14+
15+
* - ``--output``, ``-o``
16+
- string
17+
- .. include:: /includes/extracts/fact-basic-options-output.rst
18+
- no
19+
20+
* - ``--profile``, ``-P``
21+
- string
22+
- Name of the profile where the public and private
23+
keys for the project are saved. If omitted, uses the
24+
{+default-profile+}. To learn more about creating a
25+
profile, see :ref:`mcli-configure`.
26+
- no
27+
28+
* - ``--projectId``
29+
- string
30+
- Unique identifier of the project. If omitted, uses the
31+
project ID in the profile or :ref:`environment variable
32+
<mcli-env-var>`.
33+
- no
34+
35+
* - ``--region``
36+
- string
37+
- |api| |url| region to use. Value can be one of the
38+
following:
39+
40+
- ``EU`` for Europe
41+
- ``US`` for United States
42+
43+
The default value is ``US``.
44+
- yes

‎source/includes/list-table-flowdock-options.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 20 10 60 10
4+
5+
* - Option
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``--apiToken``
11+
- string
12+
- |api| token for `Flowdock
13+
<https://www.broadcom.com/info/agile/flowdock>`__.
14+
- yes
15+
16+
* - ``--flowName``
17+
- string
18+
- Name of the `Flowdock flow
19+
<https://www.flowdock.com/api/flows>`__.
20+
- no
21+
22+
* - ``--orgName``
23+
- string
24+
- Name of the `Flowdock organization
25+
<https://www.flowdock.com/api/organizations>`__.
26+
- yes
27+
28+
* - ``--output``, ``-o``
29+
- string
30+
- .. include:: /includes/extracts/fact-basic-options-output.rst
31+
- no
32+
33+
* - ``--profile``, ``-P``
34+
- string
35+
- .. include:: /includes/extracts/fact-basic-options-profile.rst
36+
- no
37+
38+
* - ``--projectId``
39+
- string
40+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
41+
- no

‎source/includes/list-table-newrelic-options.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 20 10 60 10
4+
5+
* - Option
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``--accountId``
11+
- string
12+
- Unique identifier of your `New Relic
13+
<https://newrelic.com/>`__ account.
14+
- yes
15+
16+
* - ``--licenseKey``
17+
- string
18+
- `License key <https://docs.newrelic.com/docs/accounts/accounts-billing/account-setup/new-relic-license-key>`__
19+
for your New Relic account.
20+
- no
21+
22+
* - ``--output``, ``-o``
23+
- string
24+
- .. include:: /includes/extracts/fact-basic-options-output.rst
25+
- no
26+
27+
* - ``--profile``, ``-P``
28+
- string
29+
- .. include:: /includes/extracts/fact-basic-options-profile.rst
30+
- no
31+
32+
* - ``--projectId``
33+
- string
34+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
35+
- no
36+
37+
* - ``--readToken``
38+
- string
39+
- Insights query key.
40+
- yes
41+
42+
* - ``--writeToken``
43+
- string
44+
- Insights insert key.
45+
- yes

‎source/includes/list-table-opsgenie-options.rst‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 20 10 60 10
4+
5+
* - Option
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``--apiKey``
11+
- string
12+
- |api| key for `Opsgenie
13+
<https://www.atlassian.com/software/opsgenie>`__.
14+
- yes
15+
16+
* - ``--output``, ``-o``
17+
- string
18+
- .. include:: /includes/extracts/fact-basic-options-output.rst
19+
- no
20+
21+
* - ``--profile``, ``-P``
22+
- string
23+
- .. include:: /includes/extracts/fact-basic-options-profile.rst
24+
- no
25+
26+
* - ``--projectId``
27+
- string
28+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
29+
- no
30+
31+
* - ``--region``
32+
- string
33+
- |api| |url| region to use. Value can be one of the
34+
following:
35+
36+
- ``EU`` for Europe
37+
- ``US`` for United States
38+
39+
The default value is ``US``.
40+
- yes

‎source/includes/list-table-pagerduty-options.rst‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 20 10 60 10
4+
5+
* - Option
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``--output``, ``-o``
11+
- string
12+
- .. include:: /includes/extracts/fact-basic-options-output.rst
13+
- no
14+
15+
* - ``--profile``, ``-P``
16+
- string
17+
- .. include:: /includes/extracts/fact-basic-options-profile.rst
18+
- no
19+
20+
* - ``--projectId``
21+
- string
22+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
23+
- no
24+
25+
* - ``--serviceKey``
26+
- string
27+
- `Service key <https://support.pagerduty.com/docs/generating-api-keys>`__
28+
for PagerDuty.
29+
30+
.. note::
31+
32+
`PagerDuty <http://www.pagerduty.com/?utm_source=mongodb&utm_medium=docs&utm_campaign=partner>`_
33+
`decommissioned <https://developer.pagerduty.com/docs/rest-api-v1/v1-rest-api-decommissioning-faq/>`__
34+
their v1 |api| key in October 2018. If you have a v1 key, you can
35+
continue to use that key with |service|. All new PagerDuty keys use
36+
their v2 |api|, but |service| does not support their v2 key. If you
37+
don't have their v1 key, use Webhook instead of PagerDuty.
38+
39+
- yes

‎source/includes/list-table-victorops-options.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 20 10 60 10
4+
5+
* - Option
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``--apiKey``
11+
- string
12+
- |api| key for `VictorOps <https://victorops.com/>`__.
13+
- yes
14+
15+
* - ``--output``, ``-o``
16+
- string
17+
- .. include:: /includes/extracts/fact-basic-options-output.rst
18+
- no
19+
20+
* - ``--profile``, ``-P``
21+
- string
22+
- .. include:: /includes/extracts/fact-basic-options-profile.rst
23+
- no
24+
25+
* - ``--projectId``
26+
- string
27+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
28+
- no
29+
30+
* - ``--routingKey``
31+
- string
32+
- Alert `routing keys
33+
<https://help.victorops.com/knowledge-base/routing-keys/>`__
34+
for VictorOps.
35+
- no

‎source/includes/list-table-webhook-options.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 20 10 60 10
4+
5+
* - Option
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``--output``, ``-o``
11+
- string
12+
- .. include:: /includes/extracts/fact-basic-options-output.rst
13+
- no
14+
15+
* - ``--profile``, ``-P``
16+
- string
17+
- .. include:: /includes/extracts/fact-basic-options-profile.rst
18+
- no
19+
20+
* - ``--projectId``
21+
- string
22+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
23+
- no
24+
25+
* - ``--secret``
26+
- string
27+
- Webhook secret.
28+
- yes
29+
30+
* - ``--url``
31+
- string
32+
- Webhook URL.
33+
- yes

0 commit comments

Comments
 (0)