From 0e60fd239417ad573abd683d0fbcfebba037f997 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Mon, 6 Jan 2025 14:11:20 -0800 Subject: [PATCH 1/3] DOCSP-45808-atlas-required-roles --- source/create-agg-pipeline.txt | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/source/create-agg-pipeline.txt b/source/create-agg-pipeline.txt index 845c0fabc..a73cf5f0d 100644 --- a/source/create-agg-pipeline.txt +++ b/source/create-agg-pipeline.txt @@ -56,6 +56,15 @@ collection. to perform :atlas:`full-text search` on Atlas collections. +Required Roles +-------------- + +To create an execute aggregation pipelines for an Atlas cluster, you must have +the :authrole:`Project Data Access Read Only` role or higher. + +To utilize the :pipeline:`$out` stage in your pipeline, you must +have the :authrole:`Project Data Access Read/Write` role. + Steps ----- From 4e5d66ba5291f7326f01ed337af643bf8f7a77cd Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Mon, 6 Jan 2025 14:31:19 -0800 Subject: [PATCH 2/3] add Atlas role requirements --- source/collections.txt | 29 ++++++++++++++++++++++++++++ source/create-agg-pipeline.txt | 2 +- source/databases.txt | 29 ++++++++++++++++++++++++++++ source/documents/delete-multiple.txt | 10 ++++++++++ source/documents/delete.txt | 10 ++++++++++ source/documents/insert.txt | 10 ++++++++++ source/documents/modify-multiple.txt | 11 +++++++++++ source/documents/modify.txt | 10 ++++++++++ source/indexes.txt | 13 +++++++++++++ 9 files changed, 123 insertions(+), 1 deletion(-) diff --git a/source/collections.txt b/source/collections.txt index 24e703b3a..7dcbaf576 100644 --- a/source/collections.txt +++ b/source/collections.txt @@ -62,6 +62,35 @@ information for each collection in the selected database: collection. Hover over a :guilabel:`Collation` banner to view the properties for that collection. +Required Roles +-------------- + +The following table describes the roles required to perform +various actions to a database on an Atlas cluster: + +.. list-table:: + :header-rows: 1 + :widths: 30 40 + + * - Action + - Required Roles + + * - Create Collections + - One of the following roles: + + - :authrole:`Project Owner` or :authrole:`Organization Owner` + - :authrole:`Project Data Access Admin` + - :authrole:`Project Data Access Read/Write` + + * - View Collections + - At least the :authrole:`Project Data Access Read Only` role. + + * - Drop Collections + - One of the following roles: + + - :authrole:`Project Owner` + - :authrole:`Project Data Access Admin` + .. _compass-create-collection: .. _compass-create-a-collection: diff --git a/source/create-agg-pipeline.txt b/source/create-agg-pipeline.txt index a73cf5f0d..69a7bdde7 100644 --- a/source/create-agg-pipeline.txt +++ b/source/create-agg-pipeline.txt @@ -59,7 +59,7 @@ collection. Required Roles -------------- -To create an execute aggregation pipelines for an Atlas cluster, you must have +To create and execute aggregation pipelines for an Atlas cluster, you must have the :authrole:`Project Data Access Read Only` role or higher. To utilize the :pipeline:`$out` stage in your pipeline, you must diff --git a/source/databases.txt b/source/databases.txt index 0bd31a855..b9ea9d523 100644 --- a/source/databases.txt +++ b/source/databases.txt @@ -35,6 +35,35 @@ desired database in the left-hand navigation. You can also :ref:`create ` or :ref:`drop databases ` from this view. +Required Roles +-------------- + +The following table describes the roles required to perform various actions to +a database on an Atlas cluster: + +.. list-table:: + :header-rows: 1 + :widths: 30 40 + + * - Action + - Required Roles + + * - Create Databases + - One of the following roles: + + - :authrole:`Project Owner` or :authrole:`Organization Owner` + - :authrole:`Project Data Access Admin` + - :authrole:`Project Data Access Read/Write` + + * - View Databases + - At least the :authrole:`Project Data Access Read Only` role. + + * - Drop Databases + - One of the following roles: + + - :authrole:`Project Owner` + - :authrole:`Project Data Access Admin` + .. _compass-create-database: .. _compass-create-a-db: diff --git a/source/documents/delete-multiple.txt b/source/documents/delete-multiple.txt index 918a84f47..f94527013 100644 --- a/source/documents/delete-multiple.txt +++ b/source/documents/delete-multiple.txt @@ -37,6 +37,16 @@ the latest |compass-short| version, see :ref:`download-install`. .. END-COMPASS-ONLY +Required Roles +-------------- + +To delete multiple documents, you must have access granted through one of the +following roles: + +- :authrole:`Project Owner` or :authrole:`Organization Owner` +- :authrole:`Project Data Access Admin` +- :authrole:`Project Data Access Read/Write` + Steps ----- diff --git a/source/documents/delete.txt b/source/documents/delete.txt index 20b1c8c87..40474274e 100644 --- a/source/documents/delete.txt +++ b/source/documents/delete.txt @@ -21,6 +21,16 @@ Delete Single Document .. END-COMPASS-ONLY +Required Roles +-------------- + +To delete documents on an Atlas cluster, you must have access granted through +one of the following roles: + +- :authrole:`Project Owner` or :authrole:`Organization Owner` +- :authrole:`Project Data Access Admin` +- :authrole:`Project Data Access Read/Write` + Select the appropriate tab based on whether you are viewing your documents in List, JSON, or Table view: diff --git a/source/documents/insert.txt b/source/documents/insert.txt index 74b914888..75530867b 100644 --- a/source/documents/insert.txt +++ b/source/documents/insert.txt @@ -33,6 +33,16 @@ Field-by-Field Editor you to select individual field values and types. This mode only supports inserting one document at a time. +Required Roles +-------------- + +To insert documents on an Atlas cluster, you must have access granted through +one of the following roles: + +- :authrole:`Project Owner` or :authrole:`Organization Owner` +- :authrole:`Project Data Access Admin` +- :authrole:`Project Data Access Read/Write` + Procedure --------- diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index 288496026..52ffc347b 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -43,6 +43,17 @@ the latest |compass-short| version, see :ref:`download-install`. .. END-COMPASS-ONLY +Required Roles +-------------- + +To edit multiple documents, you must have access granted through one of the +following roles: + +- :authrole:`Project Owner` or :authrole:`Organization Owner` +- :authrole:`Project Data Access Admin` +- :authrole:`Project Data Access Read/Write` + + Steps ----- diff --git a/source/documents/modify.txt b/source/documents/modify.txt index 3ccb7e580..01dcef05b 100644 --- a/source/documents/modify.txt +++ b/source/documents/modify.txt @@ -18,6 +18,16 @@ You can edit existing documents in your collection. .. include:: /includes/shared/fact-modify-findOneAndReplace.rst +Required Roles +-------------- + +To edit documents on an Atlas cluster, you must have access granted through one +of the following roles: + +- :authrole:`Project Owner` or :authrole:`Organization Owner` +- :authrole:`Project Data Access Admin` +- :authrole:`Project Data Access Read/Write` + .. BEGIN-COMPASS-ONLY Limitations diff --git a/source/indexes.txt b/source/indexes.txt index 25c7bb7f9..2447fe55f 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -74,6 +74,17 @@ For each index, |compass-short| displays the following information: - Any special properties (such as uniqueness, partial) of the index. +Required Roles +-------------- + +To :ref:`create `, +:ref:`drop `, or :ref:`hide ` +indexes, you must have access provided by at least one of the following roles: + +- :authrole:`Project Owner` or :authrole:`Organization Owner` +- :authrole:`Project Data Access Admin` + + .. _compass-create-index: Create an Index @@ -126,6 +137,8 @@ input. |compass-short| shows the type of your new index as :guilabel:`Wildcard`. +.. _compass-hide-an-index: + Hide or Unhide an Index ----------------------- From 8b38e025799d657305bd11bf4fcbbd34d3fd342e Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Tue, 7 Jan 2025 09:41:47 -0800 Subject: [PATCH 3/3] JP feedback --- source/collections.txt | 2 +- source/create-agg-pipeline.txt | 8 ++++---- source/documents/delete-multiple.txt | 4 ++-- source/documents/delete.txt | 4 ++-- source/documents/insert.txt | 4 ++-- source/documents/modify-multiple.txt | 4 ++-- source/documents/modify.txt | 4 ++-- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/source/collections.txt b/source/collections.txt index 7dcbaf576..b8b9001a1 100644 --- a/source/collections.txt +++ b/source/collections.txt @@ -66,7 +66,7 @@ Required Roles -------------- The following table describes the roles required to perform -various actions to a database on an Atlas cluster: +various actions on an Atlas cluster database: .. list-table:: :header-rows: 1 diff --git a/source/create-agg-pipeline.txt b/source/create-agg-pipeline.txt index 69a7bdde7..dd38e02c5 100644 --- a/source/create-agg-pipeline.txt +++ b/source/create-agg-pipeline.txt @@ -59,11 +59,11 @@ collection. Required Roles -------------- -To create and execute aggregation pipelines for an Atlas cluster, you must have -the :authrole:`Project Data Access Read Only` role or higher. +To create and execute aggregation pipelines for an Atlas cluster, you must at +least have the :authrole:`Project Data Access Read Only` role. -To utilize the :pipeline:`$out` stage in your pipeline, you must -have the :authrole:`Project Data Access Read/Write` role. +To use the :pipeline:`$out` stage in your pipeline, you must have the +:authrole:`Project Data Access Read/Write` role. Steps ----- diff --git a/source/documents/delete-multiple.txt b/source/documents/delete-multiple.txt index f94527013..308bafa5d 100644 --- a/source/documents/delete-multiple.txt +++ b/source/documents/delete-multiple.txt @@ -40,8 +40,8 @@ the latest |compass-short| version, see :ref:`download-install`. Required Roles -------------- -To delete multiple documents, you must have access granted through one of the -following roles: +To delete multiple documents, you must have privileges granted through one of +the following roles: - :authrole:`Project Owner` or :authrole:`Organization Owner` - :authrole:`Project Data Access Admin` diff --git a/source/documents/delete.txt b/source/documents/delete.txt index 40474274e..d49b89947 100644 --- a/source/documents/delete.txt +++ b/source/documents/delete.txt @@ -24,8 +24,8 @@ Delete Single Document Required Roles -------------- -To delete documents on an Atlas cluster, you must have access granted through -one of the following roles: +To delete documents on an Atlas cluster, you must have privileges granted +through one of the following roles: - :authrole:`Project Owner` or :authrole:`Organization Owner` - :authrole:`Project Data Access Admin` diff --git a/source/documents/insert.txt b/source/documents/insert.txt index 75530867b..84728efa9 100644 --- a/source/documents/insert.txt +++ b/source/documents/insert.txt @@ -36,8 +36,8 @@ Field-by-Field Editor Required Roles -------------- -To insert documents on an Atlas cluster, you must have access granted through -one of the following roles: +To insert documents on an Atlas cluster, you must have privileges granted +through one of the following roles: - :authrole:`Project Owner` or :authrole:`Organization Owner` - :authrole:`Project Data Access Admin` diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index 52ffc347b..0de7a1591 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -46,8 +46,8 @@ the latest |compass-short| version, see :ref:`download-install`. Required Roles -------------- -To edit multiple documents, you must have access granted through one of the -following roles: +To edit multiple documents on an Atlas cluster, you must have privileges granted +through one of the following roles: - :authrole:`Project Owner` or :authrole:`Organization Owner` - :authrole:`Project Data Access Admin` diff --git a/source/documents/modify.txt b/source/documents/modify.txt index 01dcef05b..10092f22d 100644 --- a/source/documents/modify.txt +++ b/source/documents/modify.txt @@ -21,8 +21,8 @@ You can edit existing documents in your collection. Required Roles -------------- -To edit documents on an Atlas cluster, you must have access granted through one -of the following roles: +To edit documents on an Atlas cluster, you must have privileges granted through +one of the following roles: - :authrole:`Project Owner` or :authrole:`Organization Owner` - :authrole:`Project Data Access Admin`