Skip to content

Commit 4e5d66b

Browse files
committed
add Atlas role requirements
1 parent 0e60fd2 commit 4e5d66b

File tree

9 files changed

+123
-1
lines changed

9 files changed

+123
-1
lines changed

source/collections.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,35 @@ information for each collection in the selected database:
6262
collection. Hover over a :guilabel:`Collation` banner to view
6363
the properties for that collection.
6464

65+
Required Roles
66+
--------------
67+
68+
The following table describes the roles required to perform
69+
various actions to a database on an Atlas cluster:
70+
71+
.. list-table::
72+
:header-rows: 1
73+
:widths: 30 40
74+
75+
* - Action
76+
- Required Roles
77+
78+
* - Create Collections
79+
- One of the following roles:
80+
81+
- :authrole:`Project Owner` or :authrole:`Organization Owner`
82+
- :authrole:`Project Data Access Admin`
83+
- :authrole:`Project Data Access Read/Write`
84+
85+
* - View Collections
86+
- At least the :authrole:`Project Data Access Read Only` role.
87+
88+
* - Drop Collections
89+
- One of the following roles:
90+
91+
- :authrole:`Project Owner`
92+
- :authrole:`Project Data Access Admin`
93+
6594
.. _compass-create-collection:
6695
.. _compass-create-a-collection:
6796

source/create-agg-pipeline.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ collection.
5959
Required Roles
6060
--------------
6161

62-
To create an execute aggregation pipelines for an Atlas cluster, you must have
62+
To create and execute aggregation pipelines for an Atlas cluster, you must have
6363
the :authrole:`Project Data Access Read Only` role or higher.
6464

6565
To utilize the :pipeline:`$out` stage in your pipeline, you must

source/databases.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,35 @@ desired database in the left-hand navigation.
3535
You can also :ref:`create <compass-create-database>` or
3636
:ref:`drop databases <compass-drop-database>` from this view.
3737

38+
Required Roles
39+
--------------
40+
41+
The following table describes the roles required to perform various actions to
42+
a database on an Atlas cluster:
43+
44+
.. list-table::
45+
:header-rows: 1
46+
:widths: 30 40
47+
48+
* - Action
49+
- Required Roles
50+
51+
* - Create Databases
52+
- One of the following roles:
53+
54+
- :authrole:`Project Owner` or :authrole:`Organization Owner`
55+
- :authrole:`Project Data Access Admin`
56+
- :authrole:`Project Data Access Read/Write`
57+
58+
* - View Databases
59+
- At least the :authrole:`Project Data Access Read Only` role.
60+
61+
* - Drop Databases
62+
- One of the following roles:
63+
64+
- :authrole:`Project Owner`
65+
- :authrole:`Project Data Access Admin`
66+
3867
.. _compass-create-database:
3968
.. _compass-create-a-db:
4069

source/documents/delete-multiple.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,16 @@ the latest |compass-short| version, see :ref:`download-install`.
3737

3838
.. END-COMPASS-ONLY
3939

40+
Required Roles
41+
--------------
42+
43+
To delete multiple documents, you must have access granted through one of the
44+
following roles:
45+
46+
- :authrole:`Project Owner` or :authrole:`Organization Owner`
47+
- :authrole:`Project Data Access Admin`
48+
- :authrole:`Project Data Access Read/Write`
49+
4050
Steps
4151
-----
4252

source/documents/delete.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,16 @@ Delete Single Document
2121

2222
.. END-COMPASS-ONLY
2323

24+
Required Roles
25+
--------------
26+
27+
To delete documents on an Atlas cluster, you must have access granted through
28+
one of the following roles:
29+
30+
- :authrole:`Project Owner` or :authrole:`Organization Owner`
31+
- :authrole:`Project Data Access Admin`
32+
- :authrole:`Project Data Access Read/Write`
33+
2434
Select the appropriate tab based on whether you are viewing your
2535
documents in List, JSON, or Table view:
2636

source/documents/insert.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ Field-by-Field Editor
3333
you to select individual field values and types. This mode only
3434
supports inserting one document at a time.
3535

36+
Required Roles
37+
--------------
38+
39+
To insert documents on an Atlas cluster, you must have access granted through
40+
one of the following roles:
41+
42+
- :authrole:`Project Owner` or :authrole:`Organization Owner`
43+
- :authrole:`Project Data Access Admin`
44+
- :authrole:`Project Data Access Read/Write`
45+
3646
Procedure
3747
---------
3848

source/documents/modify-multiple.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,17 @@ the latest |compass-short| version, see :ref:`download-install`.
4343

4444
.. END-COMPASS-ONLY
4545

46+
Required Roles
47+
--------------
48+
49+
To edit multiple documents, you must have access granted through one of the
50+
following roles:
51+
52+
- :authrole:`Project Owner` or :authrole:`Organization Owner`
53+
- :authrole:`Project Data Access Admin`
54+
- :authrole:`Project Data Access Read/Write`
55+
56+
4657
Steps
4758
-----
4859

source/documents/modify.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ You can edit existing documents in your collection.
1818

1919
.. include:: /includes/shared/fact-modify-findOneAndReplace.rst
2020

21+
Required Roles
22+
--------------
23+
24+
To edit documents on an Atlas cluster, you must have access granted through one
25+
of the following roles:
26+
27+
- :authrole:`Project Owner` or :authrole:`Organization Owner`
28+
- :authrole:`Project Data Access Admin`
29+
- :authrole:`Project Data Access Read/Write`
30+
2131
.. BEGIN-COMPASS-ONLY
2232

2333
Limitations

source/indexes.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,17 @@ For each index, |compass-short| displays the following information:
7474
- Any special properties (such as uniqueness, partial) of the
7575
index.
7676

77+
Required Roles
78+
--------------
79+
80+
To :ref:`create <compass-create-index>`,
81+
:ref:`drop <compass-drop-an-index>`, or :ref:`hide <compass-hide-an-index>`
82+
indexes, you must have access provided by at least one of the following roles:
83+
84+
- :authrole:`Project Owner` or :authrole:`Organization Owner`
85+
- :authrole:`Project Data Access Admin`
86+
87+
7788
.. _compass-create-index:
7889

7990
Create an Index
@@ -126,6 +137,8 @@ input.
126137
|compass-short| shows the type of your new index as
127138
:guilabel:`Wildcard`.
128139

140+
.. _compass-hide-an-index:
141+
129142
Hide or Unhide an Index
130143
-----------------------
131144

0 commit comments

Comments
 (0)