Skip to content

kubectl-auth: add page #17207

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 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions pages/common/kubectl-auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# kubectl auth

> Inspect access permissions in a Kubernetes cluster.
> More information: <https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#auth>.

- Check if the current user can perform all actions on all resources in a specific namespace:

`kubectl auth can-i '*' '*' -n {{namespace}}`

- Check if the current user can perform a specific verb on a specific resource:

`kubectl auth can-i {{verb}} {{resource}} -n {{namespace}}`

- Check if a specific user or service account can perform an action on a resource:

`kubectl auth can-i {{verb}} {{resource}} -n {{namespace}} --as {{user_or_sa}}`

- List all actions the current user is allowed to perform in a namespace:

`kubectl auth can-i --list -n {{namespace}}`
Comment on lines +8 to +20
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`kubectl auth can-i '*' '*' -n {{namespace}}`
- Check if the current user can perform a specific verb on a specific resource:
`kubectl auth can-i {{verb}} {{resource}} -n {{namespace}}`
- Check if a specific user or service account can perform an action on a resource:
`kubectl auth can-i {{verb}} {{resource}} -n {{namespace}} --as {{user_or_sa}}`
- List all actions the current user is allowed to perform in a namespace:
`kubectl auth can-i --list -n {{namespace}}`
`kubectl auth can-i '*' '*' {{[-n|--namespace]}} {{namespace}}`
- Check if the current user can perform a specific verb on a specific resource:
`kubectl auth can-i {{verb}} {{resource}} {{[-n|--namespace]}} {{namespace}}`
- Check if a specific user or service account can perform an action on a resource:
`kubectl auth can-i {{verb}} {{resource}} {{[-n|--namespace]}} {{namespace}} --as {{user_or_sa}}`
- List all actions the current user is allowed to perform in a namespace:
`kubectl auth can-i --list {{[-n|--namespace]}} {{namespace}}`

Either use long options by themselves or use option placeholders like this.