Skip to content

Commit d8cd195

Browse files
JuliaMongoJuliaMongo
authored
(DOCSP-12786) (DOCSP-12787) Added feature policies mcli commands for ops manager and cloud manager (#404)
* (DOCSP-12786) (DOCSP-12787) Added feature policies mcli commands for ops manager and cloud manager * Continued work, adding includes * copy review feedback and renaming of files for consistency * Third batch of copy review from Kanchana * renaming of files for consistency * Wednesday copy review batch from Kanchana. Getting close. * Resolved merge conflicts, removed files with older obsolete names for maintenance window, and also included one comment from Andrea tech review
1 parent 08afa9a commit d8cd195

31 files changed

+660
-57
lines changed

‎.vscode/settings.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"restructuredtext.linter.disabled": true,
3+
"restructuredtext.confPath": "${workspaceFolder}"
4+
}

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99

1010
* - ``--limit``
1111
- integer
12-
- Number of items per page.
12+
- Number of items per page, up to a maximum of 500. Defaults to ``100`` if not
13+
specified.
1314
- no
1415

1516
* - ``--maxDate``
@@ -34,7 +35,7 @@
3435

3536
* - ``--page``
3637
- integer
37-
- Page number.
38+
- Page number (1-based). Defaults to ``1`` if not specified.
3839
- no
3940

4041
* - ``--profile``, ``-P``

‎source/includes/list-table-feature-policies-list-options.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 20 10 60 10
4+
5+
* - Option
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``--limit``
11+
- integer
12+
- Number of items per page, up to a maximum of 500. Defaults to
13+
``100`` if not specified.
14+
- no
15+
16+
* - ``--output``, ``-o``
17+
- string
18+
- .. include:: /includes/extracts/fact-basic-options-output.rst
19+
- no
20+
21+
* - ``--page``
22+
- integer
23+
- Page number (1-based). Defaults to ``1`` if not specified.
24+
- no
25+
26+
* - ``--profile``, ``-P``
27+
- string
28+
- Name of the profile where the project ID and the |svc-api-key|\s
29+
for the project are saved. If omitted, uses the {+default-profile+}.
30+
To learn more about creating a profile, see :ref:`mcli-configure`.
31+
- no
32+
33+
* - ``--projectId``
34+
- string
35+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
36+
- no

‎source/includes/list-table-feature-policies-update-options.rst‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 25 10 60 5
4+
5+
* - Option
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``--name``
11+
- string
12+
- Name of the external system that
13+
manages this project's deployment.
14+
- yes
15+
16+
* - ``--output``, ``-o``
17+
- string
18+
- .. include:: /includes/extracts/fact-basic-options-output.rst
19+
- no
20+
21+
* - ``--policy``
22+
- strings
23+
- Comma-separated list of policies that the external system applies to this
24+
project. Possible values and their descriptions are:
25+
26+
.. list-table::
27+
:header-rows: 1
28+
:width: 35 65
29+
30+
* - Variable
31+
- Description
32+
33+
* - ``EXTERNALLY_MANAGED_LOCK``
34+
- Users can't use |com| to manage other settings given in the
35+
``policies`` list, and may use a configured external system to
36+
manage these settings.
37+
38+
* - ``DISABLE_USER_MANAGEMENT``
39+
- Users can't manage users or roles.
40+
41+
* - ``DISABLE_AUTHENTICATION_MECHANISMS``
42+
- Users can't change authentication settings.
43+
44+
* - ``DISABLE_SET_MONGOD_CONFIG``
45+
- Users can't change any |mongod| settings
46+
listed in the ``policies[n].disabledParams`` policy.
47+
48+
* - ``DISABLE_SET_MONGOD_VERSION``
49+
- Users can't change the version of any |mongod|
50+
or |mongos|.
51+
52+
* - ``DISABLE_BACKUP_AGENT``
53+
- Users can't enable or disable the agent.
54+
55+
* - ``DISABLE_MONGOD_LOG_MANAGEMENT``
56+
- Users can't change log management settings.
57+
58+
* - ``DISABLE_IMPORT_TO_AUTOMATION``
59+
- Users can't manage deployments using {+aagent+}.
60+
61+
* - ``DISABLE_AGENT_API_KEY_MANAGEMENT``
62+
- Users can't create or update Agent API keys.
63+
64+
* - ``DISABLE_MONGOD_HOST_MANAGEMENT``
65+
- Users can't change the server type of hosts.
66+
67+
- yes
68+
69+
* - ``--profile``, ``-P``
70+
- string
71+
- Name of the profile where the project ID and the |svc-api-key|\s
72+
for the project are saved. If omitted, uses the {+default-profile+}.
73+
To learn more about creating a profile, see :ref:`mcli-configure`.
74+
- no
75+
76+
* - ``--projectId``
77+
- string
78+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
79+
- no
80+
81+
* - ``--systemId``
82+
- string
83+
- Unique identifier of the external system that manages this |onprem| project.
84+
- no
85+
86+
87+

‎source/reference/atlas.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Atlas ``mongocli`` Commands
3232
:ref:`log <mcli-reference-atlas-log>`
3333
Retrieve various log types for a specified host.
3434

35-
:ref:`maintenance window <mcli-reference-atlas-maintenanceWindow>`
35+
:ref:`maintenance window <mcli-reference-atlas-maintenance-window-commands>`
3636
Manage your |service| :atlas:`maintenance window
3737
</tutorial/cluster-maintenance-window/>`.
3838

@@ -72,7 +72,7 @@ Atlas ``mongocli`` Commands
7272
Events </reference/atlas/event-commands>
7373
Integrations </reference/atlas/integration-commands>
7474
Logs </reference/atlas/log-commands>
75-
Maintenance Window </reference/atlas/maintenanceWindow-commands>
75+
Maintenance Window </reference/atlas/maintenance-window-commands>
7676
Metrics </reference/atlas/metric-commands>
7777
Networking </reference/atlas/networking-commands>
7878
Performance Advisor </reference/atlas/performanceadvisor-commands>

‎source/reference/atlas/maintenanceWindow-clear.txt‎ renamed to ‎source/reference/atlas/maintenance-window-clear.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _mcli-atlas-cluster-maintenanceWindow-clear-command:
1+
.. _mcli-atlas-cluster-maintenance-window-clear-command:
22

33
======================================
44
mongocli atlas maintenanceWindow clear
@@ -21,7 +21,7 @@ maintenance window through the |service| :atlas:`UI
2121

2222
.. include:: /includes/fact-urgent-maintenance.rst
2323

24-
.. _mcli-atlas-cluster-maintenanceWindow-clear-syntax:
24+
.. _mcli-atlas-cluster-maintenance-window-clear-syntax:
2525

2626
Syntax
2727
------
@@ -33,7 +33,7 @@ Syntax
3333
[ --profile|-P <profile-name> ]
3434
[ --projectId <project-ID> ]
3535

36-
.. _mcli-atlas-cluster-maintenanceWindow-clear-options:
36+
.. _mcli-atlas-cluster-maintenance-window-clear-options:
3737

3838
Options
3939
-------
@@ -66,7 +66,7 @@ Options
6666
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
6767
- no
6868

69-
.. _mcli-atlas-cluster-maintenanceWindow-clear-output:
69+
.. _mcli-atlas-cluster-maintenance-window-clear-output:
7070

7171
Output
7272
------

‎source/reference/atlas/maintenance-window-commands.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _mcli-reference-atlas-maintenance-window-commands:
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/maintenance-window-describe>
13+
Update a Maintenance Window </reference/atlas/maintenance-window-update>
14+
Clear a Maintenance Window </reference/atlas/maintenance-window-clear>
15+
Defer a Maintenance Window </reference/atlas/maintenance-window-defer>

‎source/reference/atlas/maintenanceWindow-defer.txt‎ renamed to ‎source/reference/atlas/maintenance-window-defer.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _mcli-atlas-cluster-maintenanceWindow-defer-command:
1+
.. _mcli-atlas-cluster-maintenance-window-defer-command:
22

33
======================================
44
mongocli atlas maintenanceWindow defer
@@ -20,7 +20,7 @@ maintenance window through the |service| :atlas:`UI
2020

2121
.. include:: /includes/fact-urgent-maintenance.rst
2222

23-
.. _mcli-atlas-cluster-maintenanceWindow-defer-syntax:
23+
.. _mcli-atlas-cluster-maintenance-window-defer-syntax:
2424

2525
Syntax
2626
------
@@ -36,7 +36,7 @@ Syntax
3636
If the specified project has no upcoming scheduled maintenance, this
3737
command returns an error.
3838

39-
.. _mcli-atlas-cluster-maintenanceWindow-defer-options:
39+
.. _mcli-atlas-cluster-maintenance-window-defer-options:
4040

4141
Options
4242
-------
@@ -63,7 +63,7 @@ Options
6363
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
6464
- no
6565

66-
.. _mcli-atlas-cluster-maintenanceWindow-defer-output:
66+
.. _mcli-atlas-cluster-maintenance-window-defer-output:
6767

6868
Output
6969
------

‎source/reference/atlas/maintenanceWindow-describe.txt‎ renamed to ‎source/reference/atlas/maintenance-window-describe.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _mcli-atlas-cluster-maintenanceWindow-describe-command:
1+
.. _mcli-atlas-cluster-maintenance-window-describe-command:
22

33
=========================================
44
mongocli atlas maintenanceWindow describe
@@ -21,7 +21,7 @@ maintenance window through the |service| :atlas:`UI
2121

2222
.. include:: /includes/fact-urgent-maintenance.rst
2323

24-
.. _mcli-atlas-cluster-maintenanceWindow-describe-syntax:
24+
.. _mcli-atlas-cluster-maintenance-window-describe-syntax:
2525

2626
Syntax
2727
------
@@ -33,7 +33,7 @@ Syntax
3333
[ --profile|-P <profile-name> ]
3434
[ --projectId <project-ID> ]
3535

36-
.. _mcli-atlas-cluster-maintenanceWindow-describe-options:
36+
.. _mcli-atlas-cluster-maintenance-window-describe-options:
3737

3838
Options
3939
-------
@@ -65,7 +65,7 @@ Options
6565
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
6666
- no
6767

68-
.. _mcli-atlas-cluster-maintenanceWindow-describe-output:
68+
.. _mcli-atlas-cluster-maintenance-window-describe-output:
6969

7070
Output
7171
------
@@ -160,7 +160,7 @@ default format.
160160

161161
The previous command prints the following fields in the specified format to
162162
the terminal. To learn more about these fields, see
163-
:ref:`mcli-atlas-cluster-maintenanceWindow-describe-output`.
163+
:ref:`mcli-atlas-cluster-maintenance-window-describe-output`.
164164

165165
.. code-block:: none
166166
:copyable: false

‎source/reference/atlas/maintenanceWindow-update.txt‎ renamed to ‎source/reference/atlas/maintenance-window-update.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _mcli-atlas-cluster-maintenanceWindow-update-command:
1+
.. _mcli-atlas-cluster-maintenance-window-update-command:
22

33
=======================================
44
mongocli atlas maintenanceWindow update
@@ -21,7 +21,7 @@ maintenance window through the |service| :atlas:`UI
2121

2222
.. include:: /includes/fact-urgent-maintenance.rst
2323

24-
.. _mcli-atlas-cluster-maintenanceWindow-update-syntax:
24+
.. _mcli-atlas-cluster-maintenance-window-update-syntax:
2525

2626
Syntax
2727
------
@@ -34,7 +34,7 @@ Syntax
3434
[ --profile|-P <profile-name> ]
3535
[ --projectId <project-ID> ]
3636

37-
.. _mcli-atlas-cluster-maintenanceWindow-update-options:
37+
.. _mcli-atlas-cluster-maintenance-window-update-options:
3838

3939
Options
4040
-------
@@ -102,7 +102,7 @@ Options
102102
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
103103
- no
104104

105-
.. _mcli-atlas-cluster-maintenanceWindow-update-output:
105+
.. _mcli-atlas-cluster-maintenance-window-update-output:
106106

107107
Output
108108
------

0 commit comments

Comments
 (0)