Skip to content

DOCS-4232 - backup role clarification #2133

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

Closed
wants to merge 1 commit into from
Closed

DOCS-4232 - backup role clarification #2133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions source/includes/access-mongodump-collections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
To backup all the databases in a cluster via :program:`mongodump`, you
should have the :authrole:`backup` role. The :authrole:`backup` role provides
all the needed privileges for backing up all database. The role confers no
the necessary privileges for backing up all databases. The role confers no
additional access, in keeping with the policy of :term:`least privilege`.

To backup a given database, you must have ``read`` access on the database.
Several roles provide this access, including the :authrole:`backup` role.

To backup the ``system.profile`` collection in a database, you must have
``read`` access on certain system collections in the database. Several roles
provide this access, including the :authrole:`clusterAdmin` and
To backup the :data:`system.profile <<database>.system.profile>`
collection, which is created when :ref:`database profiling
<database-profiling>` is activated, you must have **additional**
``read`` access on certain system collections in the database. Several
roles provide this access, including the :authrole:`clusterAdmin` and
:authrole:`dbAdmin` roles.
7 changes: 7 additions & 0 deletions source/reference/built-in-roles.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,13 @@ restoring data:
backup agent, or to use :program:`mongodump` to back up an entire
:program:`mongod` instance.

To backup the :data:`system.profile <<database>.system.profile>`
collection, which is created when :ref:`database profiling
<database-profiling>` is activated, you must have **additional**
``read`` access on certain system collections in the database. Several
roles provide this access, including the :authrole:`clusterAdmin` and
:authrole:`dbAdmin` roles.

.. todo: should we document the mms.backup collection in the
system-collections document?

Expand Down