Skip to content

DOC-12511 morpheus role changes #3798

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.

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

Open
wants to merge 14 commits into
base: release/8.0
Choose a base branch
from

Conversation

ggray-cb
Copy link
Contributor

@ggray-cb ggray-cb commented Apr 10, 2025

This PR covers changes to the Roles page. It does the following:

  • Remove the "checkmark and red X" privileges tables. These were too ambiguous (what does "execute" mean for a bucket?) and too limited. We have plenty of corner cases where you can perform some actions but with minor limitations. For example, some Administrator roles let you edit users and assign them roles, except you cannot assign them some of the more powerful administrator roles.
  • Update the language to meet our company style guide.
  • Add in some missing roles. Specifically, there were two roles that were added in 7.6 whose JIRA tickets lacked the necessary settings to flag the need for documentation (query_use_sequences, query_manage_sequences).
  • Handle new and changed roles for Morpheus. These include:
    • DOC-12511 Changes to user admin roles that only allows privileges for administering local and external users.
    • The Application Telemetry Writer role added in MB-64960 for the SDK Telemetry Collection in Server
    • DOC-12794 Documentation for Create RBAC role for Management of Query System Catalogs
    • MB-65045 adding Query List Index.

The following pages changed in this PR (links lead to a preview build):

  • The Roles page was heavily edit.
  • Added an entry for the Roles updated to the What's New page.

There's also a quickly thrown together Python script with help from ChatGPT here that checks the list of roles in the roles.adoc file against the results of calling the server REST API to get the current list of roles. This helped spotting the missing 7.6 roles. Not sure it needs any sort of code review, as it's not for public consumption.

There is some remaining work to be done through out the doc to ensure all references to the old roles are eliminated. That will be in a follow up PR.

* Added roles for local and external user admin.
* Added placeholder role for telemetry.
* In progress overhaul of the privilege tables.
…endpoint with the roles.adoc file to see if there are missing or extra roles in the doc.

* Added role covering DOC-12794 for Morpheus.
* Added roles introduced by MB-58036, a 7.6 featuer that was not marked as doc-impacting and got missed.
* Finished general cleanup of doc, rearraged content to be more or less like the order the roles appear in in the Web Console.
…dditional information to the user admin roles to note how they changed in 8.0.
Copy link
Contributor

@hyunjuV hyunjuV left a comment

Choose a reason for hiding this comment

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

Couple of minor changes and typos seen while reading the preview pages.

…. Moves some content to be in the right section based on the order in the User Edit dialog.

For detailed information on scopes and collections, see xref:learn:data/scopes-and-collections.adoc[Scopes and Collections].
NOTE: THe majority of roles are only available in Couchbase Server Enterprise Edition.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: "THe"

^| image:introduction/no.png[]
| *Search*
| Can use search indexes in the buckets they have access to
| Cannot add, drop, or change set4tings for search indexes
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: "set4tings"

^h| *Execute*
^h| *Manage*
| *XDCR*
| All
Copy link
Contributor

Choose a reason for hiding this comment

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

This should match the External User Admin

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants