Skip to content

Commit 63fd1e2

Browse files
jocelyn-mendezJocelyn Mendez
jocelyn-mendez
and
Jocelyn Mendez
authored
(DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings (#120)
* (DOCSP-10816) Added description for new '--deleteAfter' flag * (DOCSP-10816) Added description for new '--deleteAfter' flag * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings * (DOCSP-10816)(DOCSP-10726) Added --deleteAfter flag and changed alert config to alert settings Co-authored-by: Jocelyn Mendez <[email protected]>
1 parent 475caff commit 63fd1e2

24 files changed

+231
-216
lines changed

‎source/includes/alert-configs-fields-type-output.rst renamed to ‎source/includes/alert-settings-fields-type-output.rst

File renamed without changes.

‎source/includes/atlas-whitelist-output-fields.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
* - ``ipAddress``
2222
- Whitelisted IP address. Mutually exclusive with ``awsSecurityGroup`` and ``ciderBlock``.
2323

24+
* - ``deleteAfter``
25+
- Date in |iso8601| format after which |service| deletes the
26+
whitelist entry.
27+
2428
* - ``awsSecurityGroup``
2529
- Whitelisted ID of an |aws| security group. Mutually exclusive with ``cidrBlock`` and ``ipAddress``.
2630

‎source/includes/list-table-alert-config-response-atlas.rst renamed to ‎source/includes/list-table-alert-settings-response-atlas.rst

File renamed without changes.

‎source/includes/list-table-alert-config-response-cm.rst renamed to ‎source/includes/list-table-alert-settings-response-cm.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
- Name of the field in the target object to match on.
3737

3838
Use the :ref:`List alert configuration matcher fields
39-
<mcli-cm-alert-config-fields-type-command>` to return the
39+
<mcli-cm-alert-settings-fields-type-command>` to return the
4040
possible values.
4141

4242
* - matchers.operator

‎source/includes/list-table-alert-config-response-om.rst renamed to ‎source/includes/list-table-alert-settings-response-om.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
- Name of the field in the target object to match on.
3737

3838
Use the :ref:`List alert configuration matcher fields
39-
<mcli-om-alert-config-fields-type-command>` to return the
39+
<mcli-om-alert-settings-fields-type-command>` to return the
4040
possible values.
4141

4242
* - matchers.operator

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Atlas ``alert`` Commands
99
.. toctree::
1010
:titlesonly:
1111

12-
List Alert Configurations </reference/atlas/list-alerts-configs>
13-
Create One Alert Configuration </reference/atlas/alerts-configs-create>
14-
Update One Alert Configuration </reference/atlas/alerts-configs-update>
15-
Delete One Alert Configuration </reference/atlas/alerts-configs-delete>
16-
List Alert Configuration Matcher Fields </reference/atlas/alerts-configs-fields-type>
12+
List Alert Configurations </reference/atlas/list-alerts-settings>
13+
Create One Alert Configuration </reference/atlas/alerts-settings-create>
14+
Update One Alert Configuration </reference/atlas/alerts-settings-update>
15+
Delete One Alert Configuration </reference/atlas/alerts-settings-delete>
16+
List Alert Configuration Matcher Fields </reference/atlas/alerts-settings-fields-type>
1717
List Alerts </reference/atlas/alerts-list>
1818
Describe an Alert </reference/atlas/alerts-describe>
1919
Acknowledge an Alert </reference/atlas/alerts-ack>

‎source/reference/atlas/alerts-configs-create.txt renamed to ‎source/reference/atlas/alerts-settings-create.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _mcli-atlas-create-alerts-config-command:
1+
.. _mcli-atlas-create-alerts-settings-command:
22

3-
====================================
4-
mongocli atlas alerts configs create
5-
====================================
3+
=====================================
4+
mongocli atlas alerts settings create
5+
=====================================
66

77
.. default-domain:: mongodb
88

@@ -13,19 +13,19 @@ mongocli atlas alerts configs create
1313
:class: singlecol
1414

1515

16-
The ``alerts configs create`` command creates one alert configuration
16+
The ``alerts settings create`` command creates one alert configuration
1717
in the specified |service| project. You can also create one alert
1818
configuration in a project through the |service| :atlas:`API
1919
</reference/api/alert-configurations-create-config/>`.
2020

21-
.. _atlas-create-alerts-configs-syntax:
21+
.. _atlas-create-alerts-settings-syntax:
2222

2323
Syntax
2424
------
2525

2626
.. code-block:: text
2727

28-
mongocli atlas alert|alerts config|configs create
28+
mongocli atlas alert|alerts settings|configs create
2929
[ --event <event> ]
3030
[ --enabled ]
3131
[ --matcherField <fieldName> ]
@@ -35,7 +35,7 @@ Syntax
3535
[ --projectId <id-of-project> ]
3636
[ --profile|-P <profile-name> ]
3737

38-
.. _atlas-crete-alerts-configs-options:
38+
.. _atlas-crete-alerts-settings-options:
3939

4040
Options
4141
-------
@@ -74,7 +74,7 @@ Options
7474
- Name of the field in the target object to match on.
7575

7676
Use the :ref:`List alert configuration matcher fields
77-
<mcli-atlas-alert-config-fields-type-command>` to return the
77+
<mcli-atlas-alert-settings-fields-type-command>` to return the
7878
accepted values.
7979
- no
8080

@@ -271,7 +271,7 @@ Options
271271
.. include:: /includes/admonitions/note-get-project-id.rst
272272
- yes
273273

274-
.. _atlas-create-alerts-configs-output:
274+
.. _atlas-create-alerts-settings-output:
275275

276276
Output
277277
------
@@ -281,27 +281,27 @@ the terminal in |json| format that describes the alert configuration.
281281
If the command returns an error, see :ref:`Troubleshooting
282282
<troubleshooting>` for recommended solutions.
283283

284-
.. include:: /includes/list-table-alert-config-response-atlas.rst
284+
.. include:: /includes/list-table-alert-settings-response-atlas.rst
285285

286286
Examples
287287
--------
288288

289-
The following example uses the ``mongocli atlas alerts configs create``
289+
The following example uses the ``mongocli atlas alerts settings create``
290290
command to create one alert configuration the specified
291291
project. It uses the {+default-profile+} to access the
292292
|service| project.
293293

294294
.. code-block:: text
295295
:copyable: false
296296

297-
mongocli atlas alert configs create --event JOINED_GROUP --enabled \
297+
mongocli atlas alert settings create --event JOINED_GROUP --enabled \
298298
--notificationType USER --notificationEmailEnabled \
299299
--notificationUsername [email protected] \
300300
--projectId 5df90590f10fab5e33de2305
301301

302302
The above command prints the following fields in |json| format to
303303
the terminal. To learn more about these fields, see
304-
:ref:`atlas-create-alerts-configs-output`.
304+
:ref:`atlas-create-alerts-settings-output`.
305305

306306
.. code-block:: json
307307
:copyable: false

‎source/reference/atlas/alerts-configs-delete.txt renamed to ‎source/reference/atlas/alerts-settings-delete.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _mcli-atlas-alerts-configs-delete-cmd:
1+
.. _mcli-atlas-alerts-settings-delete-cmd:
22

33
====================================
4-
mongocli atlas alerts configs delete
4+
mongocli atlas alerts settings delete
55
====================================
66

77
.. default-domain:: mongodb
@@ -12,7 +12,7 @@ mongocli atlas alerts configs delete
1212
:depth: 1
1313
:class: singlecol
1414

15-
The ``alerts configs delete`` command deletes the specified alert
15+
The ``alerts settings delete`` command deletes the specified alert
1616
configuration in a |service| project. You must confirm the operation
1717
when you run this command without the ``--force`` option.
1818

@@ -22,20 +22,20 @@ You can also delete a alert configuration using the |service|
2222
:atlas:`UI <configure-alerts/#delete-an-alert>`.
2323

2424

25-
.. _alerts-config-delete-command-syntax:
25+
.. _alerts-settings-delete-command-syntax:
2626

2727
Syntax
2828
------
2929

3030
.. code-block:: text
3131
:copyable: false
3232

33-
mongocli atlas alerts configs delete|rm|Delete|Remove <alert-id>
33+
mongocli atlas alerts settings|configs delete|rm|Delete|Remove <alert-id>
3434
[ --force ]
3535
[ --profile|-p <profile-name> ]
3636
[ --projectId <project-ID> ]
3737

38-
.. _alerts-config-delete-command-options:
38+
.. _alerts-settings-delete-command-options:
3939

4040
Options
4141
-------
@@ -76,7 +76,7 @@ Options
7676
- no
7777

7878

79-
.. _alerts-config-delete-command-output:
79+
.. _alerts-settings-delete-command-output:
8080

8181
Output
8282
------
@@ -99,22 +99,22 @@ a message similar to the following:
9999

100100
Alert config not deleted
101101

102-
.. _alerts-config-delete-command-examples:
102+
.. _alerts-settings-delete-command-examples:
103103

104104
Examples
105105
--------
106106

107107
Basic Example
108108
~~~~~~~~~~~~~
109109

110-
The following ``alerts configs delete`` command deletes
110+
The following ``alerts settings delete`` command deletes
111111
an alert configuration with the ID ``5ec4518ce4a7ba70e03dbf13`` after
112112
prompting for a confirmation. The command uses the {+default-profile+}.
113113

114114
.. code-block:: text
115115
:copyable: false
116116

117-
mongocli atlas alerts configs delete 5ec4518ce4a7ba70e03dbf13
117+
mongocli atlas alerts settings delete 5ec4518ce4a7ba70e03dbf13
118118

119119
The command prints the following to the terminal:
120120

@@ -127,14 +127,14 @@ The command prints the following to the terminal:
127127
Force Example
128128
~~~~~~~~~~~~~
129129

130-
The following ``alerts configs delete`` command deletes
130+
The following ``alerts settings delete`` command deletes
131131
an alert configuration with the ID ``5ec4518ce4a7ba70e03dbf13`` without
132132
requiring confirmation. The command uses the {+default-profile+}.
133133

134134
.. code-block:: text
135135
:copyable: false
136136

137-
mongocli atlas alerts configs delete 5ec4518ce4a7ba70e03dbf13 --force
137+
mongocli atlas alerts settings delete 5ec4518ce4a7ba70e03dbf13 --force
138138

139139
The command prints the following to the terminal:
140140

‎source/reference/atlas/alerts-configs-fields-type.txt renamed to ‎source/reference/atlas/alerts-settings-fields-type.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _mcli-atlas-alert-config-fields-type-command:
1+
.. _mcli-atlas-alert-settings-fields-type-command:
22

3-
=========================================
4-
mongocli atlas alerts configs fields type
5-
=========================================
3+
==========================================
4+
mongocli atlas alerts settings fields type
5+
==========================================
66

77

88
.. default-domain:: mongodb
@@ -14,23 +14,23 @@ mongocli atlas alerts configs fields type
1414
:class: singlecol
1515

1616

17-
The ``alerts configs fields type`` command retrieves all
17+
The ``alerts settings fields type`` command retrieves all
1818
field names that the ``matchers.fieldName`` option accepts
1919
when you create or update an alert configuration.
2020

2121
.. todo: add links when create and update alert configuration commands are available
2222

23-
.. _atlas-alerts-configs-fields-type-syntax:
23+
.. _atlas-alerts-settings-fields-type-syntax:
2424

2525
Syntax
2626
------
2727

2828
.. code-block:: text
2929

30-
mongocli atlas alert|alerts config|configs fields type|types
30+
mongocli atlas alert|alerts settings|config fields type|types
3131
[ --profile|-P <profile-name> ]
3232

33-
.. _atlas-alerts-configs-fields-type-options:
33+
.. _atlas-alerts-settings-fields-type-options:
3434

3535
Options
3636
-------
@@ -51,7 +51,7 @@ Options
5151
profile, see :ref:`mcli-configure`.
5252
- no
5353

54-
.. _atlas-alerts-configs-fields-type-output:
54+
.. _atlas-alerts-settings-fields-type-output:
5555

5656
Output
5757
------
@@ -60,7 +60,7 @@ The command prints the following array to the terminal if the command
6060
succeeds. If the command returns an error, see :ref:`Troubleshooting
6161
<troubleshooting>` for recommended solutions.
6262

63-
.. include:: /includes/alert-configs-fields-type-output.rst
63+
.. include:: /includes/alert-settings-fields-type-output.rst
6464

6565
When you create or update an alert configuration:
6666

@@ -87,7 +87,7 @@ Example
8787
-------
8888

8989
The following example uses the
90-
``mongocli atlas alerts configs fields type`` command to retrieve all
90+
``mongocli atlas alerts settings fields type`` command to retrieve all
9191
field names that the ``matchers.fieldName`` option accepts when you
9292
create or update an alert configuration. It uses the profile named
9393
``myprofile`` for accessing |service|.
@@ -96,10 +96,10 @@ create or update an alert configuration. It uses the profile named
9696

9797
.. code-block:: text
9898

99-
mongocli atlas alerts configs fields type --profile myprofile
99+
mongocli atlas alerts settings fields type --profile myprofile
100100

101101
The previous command prints the following fields in |json| format to
102102
the terminal. To learn more about these fields, see
103-
:ref:`atlas-alerts-configs-fields-type-output`.
103+
:ref:`atlas-alerts-settings-fields-type-output`.
104104

105-
.. include:: /includes/alert-configs-fields-type-output.rst
105+
.. include:: /includes/alert-settings-fields-type-output.rst

0 commit comments

Comments
 (0)