Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLOUDP-196976: Publish compliancePolicy commands #2494

Merged
merged 2 commits into from
Dec 5, 2023
Merged

CLOUDP-196976: Publish compliancePolicy commands #2494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6659e52
Publish compliancePolicy commands
blva Dec 5, 2023
a01de91
Update docs
blva Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-disable.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
.. _atlas-backups-compliancePolicy-copyProtection-disable:

=====================================================
atlas backups compliancePolicy copyProtection disable
=====================================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Disable copy protection of the backup compliance policy for your project.

Syntax
------

.. code-block::
:caption: Command Syntax

atlas backups compliancePolicy copyProtection disable [options]

.. Code end marker, please don't delete this comment

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -h, --help
-
- false
- help for disable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- help for disable
- Help information for disable command.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is also automatically generated format is help for and its the same pattern across all commands

* - -o, --output
- string
- false
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
* - --projectId
- string
- false
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
* - -w, --watch
-
- false
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
- Flag that indicates whether to watch the command until it completes its execution or the time out and stop watching the command.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI: The flag --watch is used across other commands and has been reviewed in the past. Updating this will update docs for all related commands.

I think "and stop watching the command" seems a bit more confusing here and would prefer to keep as is.


Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

70 changes: 70 additions & 0 deletions docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-enable.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
.. _atlas-backups-compliancePolicy-copyProtection-enable:

====================================================
atlas backups compliancePolicy copyProtection enable
====================================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Enable copy protection of the backup compliance policy for your project.

Syntax
------

.. code-block::
:caption: Command Syntax

atlas backups compliancePolicy copyProtection enable [options]

.. Code end marker, please don't delete this comment

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -h, --help
-
- false
- help for enable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- help for enable
- Help information for enable command.

* - -o, --output
- string
- false
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
* - --projectId
- string
- false
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file and the environment variable.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI: This flag is used in all projects, and it will get updated in all docs and we'll have many updates. if we really want to update the copy of this flag we should do in another PR

* - -w, --watch
-
- false
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
- Flag that indicates whether to watch the command until it completes its execution or time out and stop watching the command.


Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

61 changes: 61 additions & 0 deletions docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
.. _atlas-backups-compliancePolicy-copyProtection:

=============================================
atlas backups compliancePolicy copyProtection
=============================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Manage copy protection of the backup compliance policy for your project. Learn more: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/#-optional--keep-all-snapshots-when-removing-additional-snapshot-regions.

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -h, --help
-
- false
- help for copyProtection
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- help for copyProtection
- Help information for copyProtection command.


Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Related Commands
----------------

* :ref:`atlas-backups-compliancePolicy-copyProtection-disable` - Disable copy protection of the backup compliance policy for your project.
* :ref:`atlas-backups-compliancePolicy-copyProtection-enable` - Enable copy protection of the backup compliance policy for your project.


.. toctree::
:titlesonly:

disable </command/atlas-backups-compliancePolicy-copyProtection-disable>
enable </command/atlas-backups-compliancePolicy-copyProtection-enable>

66 changes: 66 additions & 0 deletions docs/atlascli/command/atlas-backups-compliancePolicy-describe.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
.. _atlas-backups-compliancePolicy-describe:

=======================================
atlas backups compliancePolicy describe
=======================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Return the backup compliance policy for your project.

Syntax
------

.. code-block::
:caption: Command Syntax

atlas backups compliancePolicy describe [options]

.. Code end marker, please don't delete this comment

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -h, --help
-
- false
- help for describe
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- help for describe
- Help information for describe command.

* - -o, --output
- string
- false
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
* - --projectId
- string
- false
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file and the environment variable.


Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

86 changes: 86 additions & 0 deletions docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
.. _atlas-backups-compliancePolicy-enable:

=====================================
atlas backups compliancePolicy enable
=====================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Enable Backup Compliance Policy without any configuration.

Syntax
------

.. code-block::
:caption: Command Syntax

atlas backups compliancePolicy enable [options]

.. Code end marker, please don't delete this comment

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - --authorizedEmail
- string
- true
- Email address of a security or legal representative.
* - --authorizedUserFirstName
- string
- true
- First name of the user who is authorized to update the Backup Compliance Policy settings.
* - --authorizedUserLastName
- string
- true
- Last name of the user who is authorized to update the Backup Compliance Policy settings.
* - --force
-
- false
- Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.
* - -h, --help
-
- false
- help for enable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- help for enable
- Help information for enable command.

* - -o, --output
- string
- false
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
* - --projectId
- string
- false
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file and the environment variable.

* - -w, --watch
-
- false
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
- Flag that indicates whether to watch the command until it completes its execution or time out and stop watching the command.


Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Loading