Clean up the Cloud Console roles topic #19758
Conversation
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Screenshot showing how the table renders. Note that it currently requires horizontal scrolling on browser windows smaller than fullscreen 1920x1080 which may not be acceptable. 
|
jhlodin
changed the title
jhlodin
force-pushed
the
jl/doc-12238
branch
2 times, most recently
from
7cb8e59 to
e86347f
Compare
| | `Folder` | Applies to clusters within a specific folder. Only available as a selectable scope if folders have been created within the organization by a user with the `Folder Admin` role | `Cluster Creator`, `Cluster Admin`, `Folder Admin`, `Folder Mover` | | ||
| | `Cluster` | Applies to a specific cluster | `Cluster Admin`, `Cluster Operator`, `Cluster Developer` | | ||
|
|
||
| {% if page.name != 'authorization.md' %}For more information on these roles and the specific permissions given, see [Organization user roles]({% link cockroachcloud/authorization.md %}#organization-member).{% endif %} |
There was a problem hiding this comment.
@biplav-crl can you review these roles and permissions and ensure they are correct?
There was a problem hiding this comment.
We need to add which roles can do cluster upgrade/downgrade. Additionally, add PCR whenever we add documentation for PCR. Mention about Terraform for Cluster Creator/Admin. Also bring in details for ccloud. I see network auth, but calling our create private clusters, egress perimeter control would be a good idea. Also, linking these operation to relevant documentation pages will add value.
I was unable to review the pages and have just reviewed the table. Apart from above feedback comments, rest LGTM.
There was a problem hiding this comment.
We must ideally create a similar table for Cloud Console API's. Categories might be similar but listing our APIs instead of permission might be a good idea.
There was a problem hiding this comment.
We must ideally create a similar table for Cloud Console API's. Categories might be similar but listing our APIs instead of permission might be a good idea.
Created a follow-up ticket to address this. DOC-14106
src/current/_includes/cockroachcloud/org-roles/cloud-roles-table.md
Outdated
Show resolved
Hide resolved
src/current/_includes/cockroachcloud/org-roles/cloud-roles-table.md
Outdated
Show resolved
Hide resolved
src/current/_includes/cockroachcloud/cockroachcloud-ask-admin.md
Outdated
Show resolved
Hide resolved
src/current/_includes/cockroachcloud/org-roles/cloud-roles-table.md
Outdated
Show resolved
Hide resolved
src/current/_includes/cockroachcloud/cluster-operator-prereq.md
Outdated
Show resolved
Hide resolved
|
I have reviewed the table and left my comments above. For any remaining changes, will have to look at a deployed version. Thx. |
@biplav-crl Deploy preview can be found here - https://deploy-preview-19758--cockroachdb-docs.netlify.app/docs/cockroachcloud/authorization |
There was a problem hiding this comment.
LGTM from the narrow POV of the terminology change to:
- Cloud users are "assigned" "permissions"
- SQL users are "granted" "privileges"
I think this is a huge improvement in clarity!
@jhlodin is there any chance you'd PR a new 'Controlled Vocabulary' section in our Style Guide and add this terminology there?
|
Convo with Ayushi:
|
There was a problem hiding this comment.
Thanks Joe and Mike - the high level structure and the table in particular looks great and is a significant improvement from the previous version of this page, I prefer having the actions on the rows and the roles as columns just bc I think its easier to start with the question "what is a user trying to accomplish" but I dont have super strong feelings here. Otherwise LGTM!
GRANTand related SQL statements