Skip to content

Commit e6634c2

Browse files
authored
DOCSP-24990 Removes old version callouts for Built-in Roles (#1781) (#1871)
* DOCSP-24990 Removes old version callouts * DOCSP-24990 Removes old version callouts, deprecates YAML callouts * DOCSP-24990 Removes old version callouts, deprecates YAML callouts * DOCSP-24990 Removes old version callouts * DOCSP-24990 Fixes old typos * DOCSP-24990 Removes old version callouts * DOCSP-24990 Version cleanup for All-Database Roles * DOCSP-24990 Clears last version notice * DOCSP-24990 Clears LDAP
1 parent 17cd694 commit e6634c2

7 files changed

+38
-120
lines changed

source/includes/extracts-4.2-changes.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -741,12 +741,12 @@ content: |
741741
ref: 4.2-changes-libldap
742742
content: |
743743
744-
For MongoDB 4.2 (and 4.0.9) Enterprise binaries linked against
744+
For MongoDB 4.2 Enterprise binaries linked against
745745
``libldap`` (such as when running on RHEL), access to the
746746
``libldap`` is synchronized, incurring some performance/latency
747747
costs.
748748
749-
For MongoDB 4.2 (and 4.0.9) Enterprise binaries linked against
749+
For MongoDB 4.2 Enterprise binaries linked against
750750
``libldap_r``, there is no change in behavior from earlier MongoDB
751751
versions.
752752
---

source/includes/extracts-built-in-roles.yaml

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,8 @@ content: |
8787
---
8888
ref: built-in-roles-restore
8989
content: |
90-
.. versionchanged:: 3.6
9190
92-
Provides :authaction:`convertToCapped` on non-system collections.
91+
Provides :authaction:`convertToCapped` on non-system collections.
9392
9493
Provides the necessary privileges to restore data from backups *if* the data
9594
does not include :data:`system.profile <<database>.system.profile>` collection
@@ -99,7 +98,6 @@ content: |
9998
---
10099
ref: built-in-roles-all-database-roles
101100
content: |
102-
.. versionchanged:: 3.4
103101
104102
The following roles are available on the ``admin`` database and provide
105103
privileges which apply to all databases except ``local`` and
@@ -111,13 +109,6 @@ content: |
111109
except ``local`` and ``config``. The role also provides the
112110
:authaction:`listDatabases` action on the cluster as a whole.
113111
---
114-
ref: built-in-roles-readAnyDatabase-prior
115-
content: |
116-
Prior to 3.4, :authrole:`readAnyDatabase` includes ``local`` and
117-
``config`` databases. To provide ``read`` privileges on the
118-
``local`` database, create a user in the ``admin`` database with
119-
:authrole:`read` role in the ``local`` database.
120-
---
121112
ref: built-in-roles-readWriteAnyDatabase
122113
content: |
123114
Provides the same privileges as :authrole:`readWrite` on
@@ -128,13 +119,6 @@ content: |
128119
whole
129120
- the :authaction:`compactStructuredEncryptionData` action
130121
---
131-
ref: built-in-roles-readWriteAnyDatabase-prior
132-
content: |
133-
Prior to 3.4, :authrole:`readWriteAnyDatabase` includes ``local``
134-
and ``config`` databases. To provide ``readWrite`` privileges on
135-
the ``local`` database, create a user in the ``admin`` database
136-
with :authrole:`readWrite` role in the ``local`` database.
137-
---
138122
ref: built-in-roles-dbAdminAnyDatabase
139123
content: |
140124
Provides the same privileges as :authrole:`dbAdmin` on

source/includes/extracts-listDatabases-auth.yaml

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -97,32 +97,4 @@ content: |
9797
- If the user does not have :authaction:`listDatabases` action on
9898
the cluster, :dbcommand:`listDatabases` command errors with
9999
insufficient permissions.
100-
---
101-
ref: listDatabases-auth-4.0.0-4.0.4
102-
content: |
103-
For MongoDB 4.0.0-4.0.4:
104-
If the user does not have the :authaction:`listDatabases`
105-
privilege action, users can run the :dbcommand:`listDatabases`
106-
command to return a list of databases for which the user has the
107-
:authaction:`find` action privilege.
108-
---
109-
ref: listDatabases-auth-4.0.5
110-
content: |
111-
For MongoDB 4.0.5:
112-
If the user does not have the :authaction:`listDatabases`
113-
privilege action, users can run the :dbcommand:`listDatabases`
114-
command to return a list of databases for which the user has the
115-
:authaction:`find` action privilege if the command is run with
116-
``authorizedDatabases`` option unspecified or set to ``true``.
117-
---
118-
ref: listDatabases-auth-4.0.6
119-
content: |
120-
For MongoDB 4.0.6+:
121-
If the user does not have the :authaction:`listDatabases`
122-
privilege action, users can run the :dbcommand:`listDatabases`
123-
command to return a list of databases for which the user has
124-
privileges (including databases for which the user has privileges
125-
on specific collections) if the command is run with
126-
``authorizedDatabases`` option unspecified or set to ``true``.
127-
128100
...
Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
.. versionchanged:: 3.2.1
21

3-
The :authrole:`backup` role provides additional privileges to back
4-
up the :data:`system.profile <<database>.system.profile>`
5-
collection that exists when running with :ref:`database profiling
6-
<database-profiling>`. Previously, users required
7-
``read`` access on this collection.
2+
The :authrole:`backup` role provides additional privileges to back
3+
up the :data:`system.profile <<database>.system.profile>`
4+
collection that exists when running with :ref:`database profiling
5+
<database-profiling>`.
6+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
If the user does not have the :authaction:`listDatabases`
3+
privilege action, users can run the :dbcommand:`listDatabases`
4+
command to return a list of databases for which the user has
5+
privileges (including databases for which the user has privileges
6+
on specific collections) if the command is run with
7+
``authorizedDatabases`` option unspecified or set to ``true``.
8+

source/reference/built-in-roles.txt

Lines changed: 20 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,8 @@ Every database includes the following client roles:
5858
- :authaction:`killCursors`
5959
- :authaction:`listIndexes`
6060
- :authaction:`listCollections`
61-
62-
63-
.. include:: /includes/extracts/listDatabases-auth-4.0.6.rst
64-
65-
.. include:: /includes/extracts/listDatabases-auth-4.0.5.rst
66-
67-
.. include:: /includes/extracts/listDatabases-auth-4.0.0-4.0.4.rst
61+
62+
.. include:: /includes/listDatabases-auth
6863

6964
.. authrole:: readWrite
7065

@@ -227,8 +222,6 @@ Cluster Administration Roles
227222

228223
.. authrole:: clusterManager
229224

230-
.. versionchanged:: 3.4
231-
232225
.. include:: /includes/extracts/built-in-roles-clusterManager.rst
233226

234227
.. list-table::
@@ -249,7 +242,7 @@ Cluster Administration Roles
249242
- :authaction:`cleanupOrphaned`
250243
- :authaction:`flushRouterConfig`
251244
- :authaction:`getDefaultRWConcern` (New in version 4.4)
252-
- :authaction:`listSessions` (New in version 3.6)
245+
- :authaction:`listSessions`
253246
- :authaction:`listShards`
254247
- :authaction:`removeShard`
255248
- :authaction:`replSetConfigure`
@@ -266,7 +259,7 @@ Cluster Administration Roles
266259
- .. hlist::
267260
:columns: 1
268261

269-
- :authaction:`clearJumboFlag` (New in 4.2.3 and 4.0.15)
262+
- :authaction:`clearJumboFlag` (New in 4.2.3)
270263
- :authaction:`enableSharding`
271264
- :authaction:`refineCollectionShardKey` (New in 4.4)
272265
- :authaction:`moveChunk`
@@ -375,16 +368,14 @@ Cluster Administration Roles
375368

376369
.. authrole:: clusterMonitor
377370

378-
.. versionchanged:: 3.4
379-
380371
.. include:: /includes/extracts/built-in-roles-clusterMonitor.rst
381372

382373
Permits the following actions on the cluster as a whole:
383374

384375
.. hlist::
385376
:columns: 2
386377

387-
- :authaction:`checkFreeMonitoringStatus` (New in version 4.0)
378+
- :authaction:`checkFreeMonitoringStatus`
388379
- :authaction:`connPoolStats`
389380
- :authaction:`getCmdLineOpts`
390381
- :authaction:`getDefaultRWConcern` (New in version 4.4)
@@ -394,13 +385,13 @@ Cluster Administration Roles
394385
- :authaction:`hostInfo`
395386
- :authaction:`inprog`
396387
- :authaction:`listDatabases`
397-
- :authaction:`listSessions` (New in version 3.6)
388+
- :authaction:`listSessions`
398389
- :authaction:`listShards`
399390
- :authaction:`netstat`
400391
- :authaction:`replSetGetConfig`
401392
- :authaction:`replSetGetStatus`
402393
- :authaction:`serverStatus`
403-
- :authaction:`setFreeMonitoring` (New in version 4.0)
394+
- :authaction:`setFreeMonitoring`
404395
- :authaction:`shardingState`
405396
- :authaction:`top`
406397

@@ -410,7 +401,7 @@ Cluster Administration Roles
410401
- :authaction:`dbStats`
411402
- :authaction:`getShardVersion`
412403
- :authaction:`indexStats`
413-
- :authaction:`useUUID` (New in version 3.6)
404+
- :authaction:`useUUID`
414405

415406
Permits the :authaction:`find` action on all :data:`system.profile
416407
<<database>.system.profile>` collections in the cluster.
@@ -538,8 +529,8 @@ Cluster Administration Roles
538529
- :authaction:`flushRouterConfig`
539530
- :authaction:`fsync`
540531
- :authaction:`invalidateUserCache`
541-
- :authaction:`killAnyCursor` (New in version 4.0)
542-
- :authaction:`killAnySession` (New in version 3.6)
532+
- :authaction:`killAnyCursor`
533+
- :authaction:`killAnySession`
543534
- :authaction:`killop`
544535
- :authaction:`logRotate`
545536
- :authaction:`oidReset`
@@ -603,11 +594,11 @@ Backup and Restoration Roles
603594
:data:`system.js <<database>.system.js>`, and
604595
:data:`system.profile <<database>.system.profile>`
605596

606-
- the :data:`admin.system.users` and :data:`admin.system.roles` collections
597+
- The :data:`admin.system.users` and :data:`admin.system.roles` collections
607598

608-
- the :data:`config.settings` collection
599+
- The :data:`config.settings` collection
609600

610-
- legacy ``system.users`` collections from versions of MongoDB prior to 2.6
601+
- Legacy ``system.users`` collections from versions of MongoDB prior to 2.6
611602

612603
.. todo: Also provides the :authaction:`find` action on:
613604
- system.new_users
@@ -738,21 +729,13 @@ All-Database Roles
738729

739730
.. include:: /includes/extracts/built-in-roles-readAnyDatabase.rst
740731

741-
.. versionchanged:: 3.4
742-
743-
.. include:: /includes/extracts/built-in-roles-readAnyDatabase-prior.rst
744-
745-
.. include:: /includes/seealso-cluster-manager.rst
732+
.. include:: /includes/seealso-cluster-manager.rst
746733

747734
.. authrole:: readWriteAnyDatabase
748735

749736
.. include:: /includes/extracts/built-in-roles-readWriteAnyDatabase.rst
750737

751-
.. versionchanged:: 3.4
752-
753-
.. include:: /includes/extracts/built-in-roles-readWriteAnyDatabase-prior.rst
754-
755-
.. include:: /includes/seealso-cluster-manager.rst
738+
.. include:: /includes/seealso-cluster-manager.rst
756739

757740
.. authrole:: userAdminAnyDatabase
758741

@@ -765,7 +748,7 @@ All-Database Roles
765748
- :authaction:`invalidateUserCache`
766749
- :authaction:`listDatabases`
767750

768-
The role also provides the following privilege actions on the
751+
The role provides the following privilege actions on the
769752
:data:`system.users <admin.system.users>` and
770753
:data:`system.roles <admin.system.roles>` collections on the
771754
``admin`` database, and on legacy ``system.users`` collections from
@@ -777,14 +760,8 @@ All-Database Roles
777760
- :authaction:`find`
778761
- :authaction:`killCursors`
779762
- :authaction:`planCacheRead`
780-
781-
.. versionchanged:: 2.6.4
782-
:authrole:`userAdminAnyDatabase` added the following privilege
783-
actions on the :data:`admin.system.users` and
784-
:data:`admin.system.roles` collections:
785-
786-
- :authaction:`createIndex`
787-
- :authaction:`dropIndex`
763+
- :authaction:`createIndex`
764+
- :authaction:`dropIndex`
788765

789766
The :authrole:`userAdminAnyDatabase` role does not restrict the privileges
790767
that a user can grant. As a result, :authrole:`userAdminAnyDatabase` users
@@ -793,22 +770,13 @@ All-Database Roles
793770
role does not explicitly authorize privileges beyond user administration.
794771
This role is effectively a MongoDB system :ref:`superuser <superuser>`.
795772

796-
.. versionchanged:: 3.4
797-
798-
:authrole:`userAdminAnyDatabase` no longer
799-
applies to the ``local`` and ``config`` databases.
800-
801-
.. include:: /includes/seealso-cluster-manager.rst
773+
.. include:: /includes/seealso-cluster-manager.rst
802774

803775
.. authrole:: dbAdminAnyDatabase
804776

805777
.. include:: /includes/extracts/built-in-roles-dbAdminAnyDatabase.rst
806778

807-
.. versionchanged:: 3.4
808-
809-
.. include:: /includes/extracts/built-in-roles-dbAdminAnyDatabase-prior.rst
810-
811-
.. include:: /includes/seealso-cluster-manager.rst
779+
.. include:: /includes/seealso-cluster-manager.rst
812780

813781
Starting in MongoDB 5.0, :authrole:`dbAdminAnyDatabase` includes the
814782
:ref:`applyOps<internal-actions>` privilege action.
@@ -836,11 +804,6 @@ The following role provides full privileges on all resources:
836804

837805
.. include:: /includes/extracts/built-in-roles-root.rst
838806

839-
.. versionchanged:: 3.4
840-
841-
The :authrole:`root` role includes privileges from the
842-
:authrole:`backup` and :authrole:`restore` roles.
843-
844807
.. versionchanged:: 6.0
845808

846809
The :authrole:`root` role includes :authaction:`find` and

source/reference/privilege-actions.txt

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,7 @@ Query and Write Actions
6060
and :dbcommand:`renameCollection` commands and the
6161
:method:`db.collection.renameCollection()` helper method.
6262

63-
.. include:: /includes/extracts/listDatabases-auth-4.0.6.rst
64-
65-
.. include:: /includes/extracts/listDatabases-auth-4.0.5.rst
66-
67-
.. include:: /includes/extracts/listDatabases-auth-4.0.0-4.0.4.rst
63+
.. include:: /includes/listDatabases-auth
6864

6965
Apply this action to database or collection resources.
7066

@@ -806,11 +802,7 @@ Diagnostic Actions
806802
User can perform the :dbcommand:`listDatabases` command. Apply this
807803
action to the ``cluster`` resource.
808804

809-
.. include:: /includes/extracts/listDatabases-auth-4.0.6.rst
810-
811-
.. include:: /includes/extracts/listDatabases-auth-4.0.5.rst
812-
813-
.. include:: /includes/extracts/listDatabases-auth-4.0.0-4.0.4.rst
805+
.. include:: /includes/listDatabases-auth
814806

815807
.. authaction:: listCollections
816808

0 commit comments

Comments
 (0)