Skip to content
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

RBAC Documentation improvements #3279

Closed
spencergilbert opened this issue Mar 24, 2020 · 2 comments
Closed

RBAC Documentation improvements #3279

spencergilbert opened this issue Mar 24, 2020 · 2 comments
Labels
component:rbac Issues related to Openshift and Racher enhancement New feature or request type:docs Missing or incomplete documentation

Comments

@spencergilbert
Copy link
Contributor

Summary

Improve documentation around RBAC configuration. The current documentation doesn't go into detail on what each "action" does.

Motivation

Without checking the source code/tests (and even after) it wasn't clear to me what the action action would give permissions to. Similarly for update vs override, and while override is mentioned on another documentation page the information should be centralized for discoverability.

Proposal

Write down the knowledge 😄

Copied reponse from @jessesuen in slack channel

Actions are the customized actions you can define for a resource. We have a built-in “restart” action for Deployments, StatefulSets, which simply update a pod template annotation. We also have a built-in “resume” action for Rollouts which will unpause the Argo Rollout.
These actions are not grated by default, and must use the RBAC rules to give these actions to users.

p, role:tech, applications, action/*, example/*, allow
p, role:tech, applications, action/apps/Deployment/restart, example/*, allow

@spencergilbert spencergilbert added the enhancement New feature or request label Mar 24, 2020
@jannfis jannfis added component:rbac Issues related to Openshift and Racher type:docs Missing or incomplete documentation labels May 14, 2020
@dbeckham
Copy link

dbeckham commented Jul 8, 2020

An additional issue related to RBAC documentation is that the comments in the example argocd-cm-rbac.yaml ConfigMap file do not match the RBAC documentation

Specifically the policy rule form in the ConfigMap file:
p, subject, resource, action, object, effect

Does not match the one in the documenation:
p, <role/user/group>, <resource>, <action>, <object>

There is no mention of "effect" in the online documentation.

@agaudreault
Copy link
Member

Closed by #18124

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:rbac Issues related to Openshift and Racher enhancement New feature or request type:docs Missing or incomplete documentation
Projects
None yet
Development

No branches or pull requests

4 participants