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

DOCSP-45808-atlas-required-roles #707

Closed
wants to merge 3 commits into from
Closed

DOCSP-45808-atlas-required-roles #707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e60fd2
DOCSP-45808-atlas-required-roles
ajhuh-mdb Jan 6, 2025
4e5d66b
add Atlas role requirements
ajhuh-mdb Jan 6, 2025
8b38e02
JP feedback
ajhuh-mdb Jan 7, 2025
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
29 changes: 29 additions & 0 deletions source/collections.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 on an Atlas cluster database:

.. 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:

Expand Down
9 changes: 9 additions & 0 deletions source/create-agg-pipeline.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,15 @@ collection.
to perform :atlas:`full-text search</atlas-search/atlas-search-overview>`
on Atlas collections.

Required Roles
--------------

To create and execute aggregation pipelines for an Atlas cluster, you must at
least have the :authrole:`Project Data Access Read Only` role.

To use the :pipeline:`$out` stage in your pipeline, you must have the
:authrole:`Project Data Access Read/Write` role.

Steps
-----

Expand Down
29 changes: 29 additions & 0 deletions source/databases.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,35 @@ desired database in the left-hand navigation.
You can also :ref:`create <compass-create-database>` or
:ref:`drop databases <compass-drop-database>` 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`
Comment on lines +54 to +56
Copy link

Choose a reason for hiding this comment

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

Do organization and project owner roles imply that these users are able to do the same things as the other roles? Would it be enough to say "at least" Project Data Access Read/Write and Project Data Access Admin? (Genuine question, I'm not sure if there's a standard we need to follow here to also include the owner roles)

This applies to all other relevant places in the PR as well


* - 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:

Expand Down
10 changes: 10 additions & 0 deletions source/documents/delete-multiple.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 privileges 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
-----

Expand Down
10 changes: 10 additions & 0 deletions source/documents/delete.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ Delete Single Document

.. END-COMPASS-ONLY

Required 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`
- :authrole:`Project Data Access Read/Write`

Select the appropriate tab based on whether you are viewing your
documents in List, JSON, or Table view:

Expand Down
10 changes: 10 additions & 0 deletions source/documents/insert.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 privileges 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
---------

Expand Down
11 changes: 11 additions & 0 deletions source/documents/modify-multiple.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ the latest |compass-short| version, see :ref:`download-install`.

.. END-COMPASS-ONLY

Required 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`
- :authrole:`Project Data Access Read/Write`


Steps
-----

Expand Down
10 changes: 10 additions & 0 deletions source/documents/modify.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 privileges 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
Expand Down
13 changes: 13 additions & 0 deletions source/indexes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <compass-create-index>`,
:ref:`drop <compass-drop-an-index>`, or :ref:`hide <compass-hide-an-index>`
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`
Comment on lines +77 to +85
Copy link

Choose a reason for hiding this comment

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

It's possible to view indexes with the Project Data Access Read/Write, Project Data Access Read Only, and Project Data Access Admin roles as well. Is that worth calling out separately?



.. _compass-create-index:

Create an Index
Expand Down Expand Up @@ -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
-----------------------

Expand Down
Loading