Skip to content

Commit ee267dd

Browse files
melissamahoney-mongodbmelissamahoney-mongodb
authored
(DOCSP-17454): Release v1.18.0 (#540)
* (DOCSP-17454): Release Notes v1.18.0 * Update generated files * Add refs to command pages * Update breaking change to be more specific * copy review
1 parent 3de9e9f commit ee267dd

File tree

529 files changed

+1770
-611
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

529 files changed

+1770
-611
lines changed

‎config/build_conf.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ system:
2929
- 'sphinx_local.yaml'
3030
- htaccess: ['htaccess.yaml']
3131
version:
32-
release: '1.17.1'
32+
release: '1.18.0'
3333
branch: 'master'
3434
assets:
3535
- branch: master

‎snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ data-lake-store = "data store"
174174
default-profile = ":ref:`default profile <mcli-profiles>`"
175175
mcli = "MongoDB CLI"
176176
mcli-long = "MongoDB Command Line Interface (``mongocli``)"
177-
mcli-version = "1.17.0"
177+
mcli-version = "1.18.0"
178178
mdbagent = "MongoDB Agent"
179179
mdbVersion = "4.4"
180180

‎source/command/mongocli-atlas-accessLists-create.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,4 @@ Inherited Options
7575
- false
7676
- Profile to use from your configuration file.
7777

78-
*Auto generated by MongoDB CLI on 29-Jun-2021*
78+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-accessLists-delete.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ Inherited Options
6161
- false
6262
- Profile to use from your configuration file.
6363

64-
*Auto generated by MongoDB CLI on 29-Jun-2021*
64+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-accessLists-describe.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ Inherited Options
6262
- false
6363
- Profile to use from your configuration file.
6464

65-
*Auto generated by MongoDB CLI on 29-Jun-2021*
65+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-accessLists-list.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ Inherited Options
7070
- false
7171
- Profile to use from your configuration file.
7272

73-
*Auto generated by MongoDB CLI on 29-Jun-2021*
73+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-accessLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ Related Commands
6363
describe </command/mongocli-atlas-accessLists-describe>
6464
list </command/mongocli-atlas-accessLists-list>
6565

66-
*Auto generated by MongoDB CLI on 29-Jun-2021*
66+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-acknowledge.txt

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,30 @@ mongocli atlas alerts acknowledge
1212
:depth: 1
1313
:class: singlecol
1414

15-
Acknowledge an alert for your project.
15+
Acknowledges one alert for the specified project.
1616

1717
Syntax
1818
------
1919

2020
.. code-block::
2121

22-
mongocli atlas alerts acknowledge <ID> [options]
22+
mongocli atlas alerts acknowledge <alertID> [options]
23+
24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - alertID
36+
- string
37+
- false
38+
-
2339

2440
Options
2541
-------
@@ -74,4 +90,4 @@ Inherited Options
7490
- false
7591
- Profile to use from your configuration file.
7692

77-
*Auto generated by MongoDB CLI on 29-Jun-2021*
93+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-describe.txt

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,30 @@ mongocli atlas alerts describe
1212
:depth: 1
1313
:class: singlecol
1414

15-
Describe an alert for your project.
15+
Retrieves one alert for the specified project.
1616

1717
Syntax
1818
------
1919

2020
.. code-block::
2121

22-
mongocli atlas alerts describe <ID> [options]
22+
mongocli atlas alerts describe <alertID> [options]
23+
24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - alertID
36+
- string
37+
- false
38+
-
2339

2440
Options
2541
-------
@@ -62,4 +78,4 @@ Inherited Options
6278
- false
6379
- Profile to use from your configuration file.
6480

65-
*Auto generated by MongoDB CLI on 29-Jun-2021*
81+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-global-list.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli atlas alerts global list
1212
:depth: 1
1313
:class: singlecol
1414

15-
List Ops Manager global alerts.
15+
Retrieves all the global alerts for the specified Ops Manager project.
1616

1717
Syntax
1818
------
@@ -70,4 +70,4 @@ Inherited Options
7070
- false
7171
- Profile to use from your configuration file.
7272

73-
*Auto generated by MongoDB CLI on 29-Jun-2021*
73+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-global.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli atlas alerts global
1212
:depth: 1
1313
:class: singlecol
1414

15-
List alerts for your project.
15+
Retrieves all the global alerts for the specified Ops Manager project.
1616

1717
Options
1818
-------
@@ -49,12 +49,12 @@ Inherited Options
4949
Related Commands
5050
----------------
5151

52-
* :ref:`mongocli-atlas-alerts-global-list` - List Ops Manager global alerts.
52+
* :ref:`mongocli-atlas-alerts-global-list` - Retrieves all the global alerts for the specified Ops Manager project.
5353

5454

5555
.. toctree::
5656
:titlesonly:
5757

5858
list </command/mongocli-atlas-alerts-global-list>
5959

60-
*Auto generated by MongoDB CLI on 29-Jun-2021*
60+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-list.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli atlas alerts list
1212
:depth: 1
1313
:class: singlecol
1414

15-
List alerts for your project.
15+
Retrieves all alerts for the specified project.
1616

1717
Syntax
1818
------
@@ -74,4 +74,4 @@ Inherited Options
7474
- false
7575
- Profile to use from your configuration file.
7676

77-
*Auto generated by MongoDB CLI on 29-Jun-2021*
77+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-settings-create.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli atlas alerts settings create
1212
:depth: 1
1313
:class: singlecol
1414

15-
Create an alert configuration for your project.
15+
Creates one alert configuration in the specified project.
1616

1717
Syntax
1818
------
@@ -170,4 +170,4 @@ Inherited Options
170170
- false
171171
- Profile to use from your configuration file.
172172

173-
*Auto generated by MongoDB CLI on 29-Jun-2021*
173+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-settings-delete.txt

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,30 @@ mongocli atlas alerts settings delete
1212
:depth: 1
1313
:class: singlecol
1414

15-
Delete an alert configuration from your project.
15+
Deletes the specified alert configuration in a project.
1616

1717
Syntax
1818
------
1919

2020
.. code-block::
2121

22-
mongocli atlas alerts settings delete <ID> [options]
22+
mongocli atlas alerts settings delete <alertConfigId> [options]
23+
24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - alertConfigId
36+
- string
37+
- false
38+
-
2339

2440
Options
2541
-------
@@ -61,4 +77,4 @@ Inherited Options
6177
- false
6278
- Profile to use from your configuration file.
6379

64-
*Auto generated by MongoDB CLI on 29-Jun-2021*
80+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-settings-fields-type.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ Inherited Options
5858
- false
5959
- Profile to use from your configuration file.
6060

61-
*Auto generated by MongoDB CLI on 29-Jun-2021*
61+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-settings-fields.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ Related Commands
5757

5858
type </command/mongocli-atlas-alerts-settings-fields-type>
5959

60-
*Auto generated by MongoDB CLI on 29-Jun-2021*
60+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-settings-list.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ Inherited Options
7070
- false
7171
- Profile to use from your configuration file.
7272

73-
*Auto generated by MongoDB CLI on 29-Jun-2021*
73+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-settings-update.txt

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,30 @@ mongocli atlas alerts settings update
1212
:depth: 1
1313
:class: singlecol
1414

15-
Update an alert configuration for your project.
15+
Updates one alert configuration in the specified project.
1616

1717
Syntax
1818
------
1919

2020
.. code-block::
2121

22-
mongocli atlas alerts settings update <ID> [options]
22+
mongocli atlas alerts settings update <alertConfigId> [options]
23+
24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - alertConfigId
36+
- string
37+
- false
38+
-
2339

2440
Options
2541
-------
@@ -170,4 +186,4 @@ Inherited Options
170186
- false
171187
- Profile to use from your configuration file.
172188

173-
*Auto generated by MongoDB CLI on 29-Jun-2021*
189+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-settings.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ Inherited Options
5252
Related Commands
5353
----------------
5454

55-
* :ref:`mongocli-atlas-alerts-settings-create` - Create an alert configuration for your project.
56-
* :ref:`mongocli-atlas-alerts-settings-delete` - Delete an alert configuration from your project.
55+
* :ref:`mongocli-atlas-alerts-settings-create` - Creates one alert configuration in the specified project.
56+
* :ref:`mongocli-atlas-alerts-settings-delete` - Deletes the specified alert configuration in a project.
5757
* :ref:`mongocli-atlas-alerts-settings-fields` - Manage alert configuration fields for your project.
5858
* :ref:`mongocli-atlas-alerts-settings-list` - List alert configurations for your project.
59-
* :ref:`mongocli-atlas-alerts-settings-update` - Update an alert configuration for your project.
59+
* :ref:`mongocli-atlas-alerts-settings-update` - Updates one alert configuration in the specified project.
6060

6161

6262
.. toctree::
@@ -68,4 +68,4 @@ Related Commands
6868
list </command/mongocli-atlas-alerts-settings-list>
6969
update </command/mongocli-atlas-alerts-settings-update>
7070

71-
*Auto generated by MongoDB CLI on 29-Jun-2021*
71+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts-unacknowledge.txt

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,30 @@ mongocli atlas alerts unacknowledge
1212
:depth: 1
1313
:class: singlecol
1414

15-
Unacknowledge an alert for your project.
15+
Unacknowledges one alert for the specified project.
1616

1717
Syntax
1818
------
1919

2020
.. code-block::
2121

22-
mongocli atlas alerts unacknowledge <ID> [options]
22+
mongocli atlas alerts unacknowledge <alertID> [options]
23+
24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - alertID
36+
- string
37+
- false
38+
-
2339

2440
Options
2541
-------
@@ -66,4 +82,4 @@ Inherited Options
6682
- false
6783
- Profile to use from your configuration file.
6884

69-
*Auto generated by MongoDB CLI on 29-Jun-2021*
85+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-alerts.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ Inherited Options
4949
Related Commands
5050
----------------
5151

52-
* :ref:`mongocli-atlas-alerts-acknowledge` - Acknowledge an alert for your project.
53-
* :ref:`mongocli-atlas-alerts-describe` - Describe an alert for your project.
54-
* :ref:`mongocli-atlas-alerts-global` - List alerts for your project.
55-
* :ref:`mongocli-atlas-alerts-list` - List alerts for your project.
52+
* :ref:`mongocli-atlas-alerts-acknowledge` - Acknowledges one alert for the specified project.
53+
* :ref:`mongocli-atlas-alerts-describe` - Retrieves one alert for the specified project.
54+
* :ref:`mongocli-atlas-alerts-global` - Retrieves all the global alerts for the specified Ops Manager project.
55+
* :ref:`mongocli-atlas-alerts-list` - Retrieves all alerts for the specified project.
5656
* :ref:`mongocli-atlas-alerts-settings` - Manage alerts configuration for your project.
57-
* :ref:`mongocli-atlas-alerts-unacknowledge` - Unacknowledge an alert for your project.
57+
* :ref:`mongocli-atlas-alerts-unacknowledge` - Unacknowledges one alert for the specified project.
5858

5959

6060
.. toctree::
@@ -67,4 +67,4 @@ Related Commands
6767
settings </command/mongocli-atlas-alerts-settings>
6868
unacknowledge </command/mongocli-atlas-alerts-unacknowledge>
6969

70-
*Auto generated by MongoDB CLI on 29-Jun-2021*
70+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-backups-restores-list.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ Inherited Options
7070
- false
7171
- Profile to use from your configuration file.
7272

73-
*Auto generated by MongoDB CLI on 29-Jun-2021*
73+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-backups-restores-start.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,4 @@ Inherited Options
9494
- false
9595
- Profile to use from your configuration file.
9696

97-
*Auto generated by MongoDB CLI on 29-Jun-2021*
97+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-backups-restores.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ Related Commands
5959
list </command/mongocli-atlas-backups-restores-list>
6060
start </command/mongocli-atlas-backups-restores-start>
6161

62-
*Auto generated by MongoDB CLI on 29-Jun-2021*
62+
*Auto generated by MongoDB CLI on 8-Jul-2021*

‎source/command/mongocli-atlas-backups-snapshots-create.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ Inherited Options
7070
- false
7171
- Profile to use from your configuration file.
7272

73-
*Auto generated by MongoDB CLI on 29-Jun-2021*
73+
*Auto generated by MongoDB CLI on 8-Jul-2021*

0 commit comments

Comments
 (0)