Skip to content

Commit cb4814b

Browse files
steverensteveren
authored
DOCSP-12175: [mongocli] atlas maintenanceWindow commands (#254)
1 parent 9f712ef commit cb4814b

9 files changed

+522
-1
lines changed

‎_mcli-atlas-backup-snapshots-list-cmd:

Whitespace-only changes.

‎source/includes/fact-urgent-maintenance.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. admonition:: Maintenance Window Considerations
2+
:class: important
3+
4+
Urgent Maintenance Activities
5+
Urgent maintenance activities such as security patches cannot
6+
wait for your chosen window. |service| will start those
7+
maintenance activities when needed.
8+
9+
Ongoing Maintenance Operations
10+
Once maintenance is scheduled for your cluster, you cannot change
11+
your maintenance window until the current maintenance efforts have
12+
completed.
13+
14+
Maintenance Requires Replica Set Elections
15+
|service| performs maintenance the same way as the maintenance
16+
procedure described in the
17+
:manual:`MongoDB Manual
18+
</tutorial/perform-maintence-on-replica-set-members/>`. This
19+
procedure requires at least one
20+
:manual:`replica set election </core/replica-set-elections>`
21+
during the maintenance window per replica set.
22+
23+
Maintenance Starts As Close to the Hour As Possible
24+
Maintenance always begins as close to the scheduled hour as
25+
possible, but in-progress cluster updates or unexpected system
26+
issues could delay the start time.

‎source/reference/atlas.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ Atlas ``mongocli`` Commands
2828
:ref:`log <mcli-reference-atlas-log>`
2929
Retrieve various log types for a specified host.
3030

31+
:ref:`maintenance window <mcli-reference-atlas-maintenanceWindow>`
32+
Manage your |service| :atlas:`maintenance window
33+
</tutorial/cluster-maintenance-window/>`.
34+
3135
:ref:`metrics <mcli-reference-atlas-metric>`
3236
List metrics for MongoDB processes on a specified host.
3337

@@ -60,6 +64,7 @@ Atlas ``mongocli`` Commands
6064
Data Lakes </reference/atlas/datalake-commands>
6165
Events </reference/atlas/event-commands>
6266
Logs </reference/atlas/log-commands>
67+
Maintenance Window </reference/atlas/maintenanceWindow-commands>
6368
Metrics </reference/atlas/metric-commands>
6469
Networking </reference/atlas/networking-commands>
6570
Private Endpoints </reference/atlas/privateendpoint-commands>

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

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
.. _mcli-atlas-cluster-maintenanceWindow-clear-command:
2+
3+
======================================
4+
mongocli atlas maintenanceWindow clear
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 ``maintenanceWindow clear`` command removes the
16+
:atlas:`maintenance window </tutorial/cluster-maintenance-window/>`
17+
for the specified |service| project. You can also remove a
18+
maintenance window through the |service| :atlas:`UI
19+
</tutorial/cluster-maintenance-window/>` or :atlas:`API
20+
</reference/api/maintenance-window-clear/>`.
21+
22+
.. include:: /includes/fact-urgent-maintenance.rst
23+
24+
.. _mcli-atlas-cluster-maintenanceWindow-clear-syntax:
25+
26+
Syntax
27+
------
28+
29+
.. code-block:: text
30+
31+
mongocli atlas maintenanceWindow clear|rm|delete
32+
[ --force ]
33+
[ --profile|-P <profile-name> ]
34+
[ --projectId <project-ID> ]
35+
36+
.. _mcli-atlas-cluster-maintenanceWindow-clear-options:
37+
38+
Options
39+
-------
40+
41+
.. list-table::
42+
:header-rows: 1
43+
:widths: 20 10 60 10
44+
45+
* - Option
46+
- Type
47+
- Description
48+
- Required?
49+
50+
* - ``--force``
51+
-
52+
- Flag that indicates that the maintenance window can be removed without
53+
requiring confirmation.
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 that contains the
67+
cluster. If omitted, uses the project ID in the profile or
68+
:ref:`environment variable <mcli-env-var>`.
69+
- no
70+
71+
.. _mcli-atlas-cluster-maintenanceWindow-clear-output:
72+
73+
Output
74+
------
75+
76+
.. code-block:: none
77+
:copyable: false
78+
79+
Maintenance window removed.
80+
81+
Example
82+
-------
83+
84+
The following example uses the ``mongocli atlas maintenanceWindow
85+
clear`` command to remove the maintenance window configured for the
86+
project specified in the {+default-profile+}.
87+
88+
.. code-block:: none
89+
90+
mongocli atlas maintenanceWindow clear

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _mcli-reference-atlas-maintenanceWindow:
2+
3+
=================================
4+
Atlas Maintenance Window Commands
5+
=================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. toctree::
10+
:titlesonly:
11+
12+
Describe a Maintenance Window </reference/atlas/maintenanceWindow-describe>
13+
Update a Maintenance Window </reference/atlas/maintenanceWindow-update>
14+
Clear a Maintenance Window </reference/atlas/maintenanceWindow-clear>
15+
Defer a Maintenance Window </reference/atlas/maintenanceWindow-defer>

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

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
.. _mcli-atlas-cluster-maintenanceWindow-defer-command:
2+
3+
======================================
4+
mongocli atlas maintenanceWindow defer
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 ``maintenanceWindow defer`` command defers scheduled
16+
maintenance on an |service| project for one week. You can also defer a
17+
maintenance window through the |service| :atlas:`UI
18+
</tutorial/cluster-maintenance-window/>` or :atlas:`API
19+
</reference/api/maintenance-windows/>`.
20+
21+
.. include:: /includes/fact-urgent-maintenance.rst
22+
23+
.. _mcli-atlas-cluster-maintenanceWindow-defer-syntax:
24+
25+
Syntax
26+
------
27+
28+
.. code-block:: text
29+
30+
mongocli atlas maintenanceWindow defer
31+
[ --profile|-P <profile-name> ]
32+
[ --projectId <project-ID> ]
33+
34+
.. note::
35+
36+
If the specified project has no upcoming scheduled maintenance, this
37+
command returns an error.
38+
39+
.. _mcli-atlas-cluster-maintenanceWindow-defer-options:
40+
41+
Options
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+
* - ``--profile``, ``-P``
54+
- string
55+
- Name of the profile where the public and private
56+
keys for the project are saved. If omitted, uses the
57+
{+default-profile+}. To learn more about creating a
58+
profile, see :ref:`mcli-configure`.
59+
- no
60+
61+
* - ``--projectId``
62+
- string
63+
- Unique identifier of the project that contains the
64+
cluster. If omitted, uses the project ID in the profile or
65+
:ref:`environment variable <mcli-env-var>`.
66+
- no
67+
68+
.. _mcli-atlas-cluster-maintenanceWindow-defer-output:
69+
70+
Output
71+
------
72+
73+
.. code-block:: none
74+
:copyable: false
75+
76+
Maintenance window deferred.
77+
78+
Example
79+
-------
80+
81+
The following example uses the ``mongocli atlas maintenanceWindow
82+
defer`` command to defer scheduled maintenance for one week for the
83+
project specified in the {+default-profile+}.
84+
85+
.. code-block:: none
86+
87+
mongocli atlas maintenanceWindow defer

0 commit comments

Comments
 (0)