PBM-1790 Document PBM user database roles#387
Open
radoslawszulgo wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new documentation reference page describing the MongoDB roles required for Percona Backup for MongoDB (PBM), and links to it from the authentication configuration guide. It also updates the MkDocs navigation to include the new reference.
Changes:
- Added a new reference page documenting required PBM database user roles (
readWrite,backup,clusterMonitor,restore, and custompbmAnyAction). - Linked the authentication configuration page to the new roles reference for additional explanation.
- Added the new reference page to the MkDocs navigation.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| mkdocs-base.yml | Adds the new roles reference page to the “Reference” navigation section. |
| docs/reference/pbm-user-roles.md | Introduces a new reference page describing PBM-required MongoDB roles and their rationale. |
| docs/install/configure-authentication.md | Links readers to the new roles reference from the authentication setup steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request enhances the documentation for Percona Backup for MongoDB by adding a comprehensive reference for the required database user roles. It introduces a new reference page that details each role's purpose, scope, and access, and links to this new resource from the authentication configuration guide. The navigation is also updated to include the new reference page.
Documentation improvements:
pbm-user-roles.mdthat explains all MongoDB roles required by PBM, including built-in and custom roles, their scopes, access types, and justifications for each.configure-authentication.mdto link to the new PBM user roles reference for further explanation of each required role.mkdocs-base.ymlto include the new PBM user roles reference page.