rbac: docs for aggregated cluster roles (#6474)
This commit is contained in:
committed by
Zach Corleissen
parent
802eb482ff
commit
125910e50c
@@ -191,6 +191,76 @@ Because resource names are not present in the URL for create, list, watch, and d
|
|||||||
those verbs would not be allowed by a rule with resourceNames set, since the resourceNames portion of the
|
those verbs would not be allowed by a rule with resourceNames set, since the resourceNames portion of the
|
||||||
rule would not match the request.
|
rule would not match the request.
|
||||||
|
|
||||||
|
### Aggregated ClusterRoles
|
||||||
|
|
||||||
|
As of 1.9, ClusterRoles can be created by combining other ClusterRoles using an `aggregationRule`. The
|
||||||
|
permissions of aggregated ClusterRoles are controller-managed, and filled in by unioning the rules of any
|
||||||
|
ClusterRole that matches the provided label selector. An example aggregated ClusterRole:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
kind: ClusterRole
|
||||||
|
apiVersion: rbac.authorization.k8s.io/v1
|
||||||
|
metadata:
|
||||||
|
name: monitoring
|
||||||
|
aggregationRule:
|
||||||
|
clusterRoleSelectors:
|
||||||
|
- matchLabels:
|
||||||
|
rbac.example.com/aggregate-to-monitoring: "true"
|
||||||
|
rules: [] # Rules are automatically filled in by the controller manager.
|
||||||
|
```
|
||||||
|
|
||||||
|
Creating a ClusterRole that matches the label selector will add rules to the aggregated ClusterRole. In this case
|
||||||
|
rules can be added to the "monitoring" ClusterRole by creating another ClusterRole that has the label
|
||||||
|
`rbac.example.com/aggregate-to-monitoring: true`.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
kind: ClusterRole
|
||||||
|
apiVersion: rbac.authorization.k8s.io/v1
|
||||||
|
metadata:
|
||||||
|
name: monitoring-endpoints
|
||||||
|
labels:
|
||||||
|
rbac.example.com/aggregate-to-monitoring: "true"
|
||||||
|
# These rules will be added to the "monitoring" role.
|
||||||
|
rules:
|
||||||
|
- apiGroups: [""]
|
||||||
|
Resources: ["services", "endpoints", "pods"]
|
||||||
|
verbs: ["get", "list", "watch"]
|
||||||
|
```
|
||||||
|
|
||||||
|
The default user-facing roles (described below) use ClusterRole aggregation. This lets admins include rules
|
||||||
|
for custom resources, such as those served by CustomResourceDefinitions or Aggregated API servers, on the
|
||||||
|
default roles.
|
||||||
|
|
||||||
|
For example, the following ClusterRoles let the "admin" and "edit" default roles manage the custom resource
|
||||||
|
"CronTabs" and the "view" role perform read-only actions on the resource.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
kind: ClusterRole
|
||||||
|
apiVersion: rbac.authorization.k8s.io/v1
|
||||||
|
metadata:
|
||||||
|
name: aggregate-cron-tabs-edit
|
||||||
|
labels:
|
||||||
|
# Add these permissions to the "admin" and "edit" default roles.
|
||||||
|
rbac.authorization.k8s.io/aggregate-to-admin: "true"
|
||||||
|
rbac.authorization.k8s.io/aggregate-to-edit: "true"
|
||||||
|
rules:
|
||||||
|
- apiGroups: ["stable.example.com"]
|
||||||
|
resources: ["crontabs"]
|
||||||
|
verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
|
||||||
|
---
|
||||||
|
kind: ClusterRole
|
||||||
|
apiVersion: rbac.authorization.k8s.io/v1
|
||||||
|
metadata:
|
||||||
|
name: aggregate-cron-tabs-view
|
||||||
|
labels:
|
||||||
|
# Add these permissions to the "view" default role.
|
||||||
|
rbac.authorization.k8s.io/aggregate-to-view: "true"
|
||||||
|
rules:
|
||||||
|
- apiGroups: ["stable.example.com"]
|
||||||
|
resources: ["crontabs"]
|
||||||
|
verbs: ["get", "list", "watch"]
|
||||||
|
```
|
||||||
|
|
||||||
#### Role Examples
|
#### Role Examples
|
||||||
|
|
||||||
Only the `rules` section is shown in the following examples.
|
Only the `rules` section is shown in the following examples.
|
||||||
@@ -402,6 +472,18 @@ They include super-user roles (`cluster-admin`),
|
|||||||
roles intended to be granted cluster-wide using ClusterRoleBindings (`cluster-status`),
|
roles intended to be granted cluster-wide using ClusterRoleBindings (`cluster-status`),
|
||||||
and roles intended to be granted within particular namespaces using RoleBindings (`admin`, `edit`, `view`).
|
and roles intended to be granted within particular namespaces using RoleBindings (`admin`, `edit`, `view`).
|
||||||
|
|
||||||
|
As of 1.9, user-facing roles use [ClusterRole Aggregation](#aggregated-clusterroles) to allow admins to include
|
||||||
|
rules for custom resources on these roles. To add rules to the "admin", "edit", or "view" role, create a
|
||||||
|
ClusterRole with one or more of the following labels:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
rbac.authorization.k8s.io/aggregate-to-admin: "true"
|
||||||
|
rbac.authorization.k8s.io/aggregate-to-edit: "true"
|
||||||
|
rbac.authorization.k8s.io/aggregate-to-view: "true"
|
||||||
|
```
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<colgroup><col width="25%"><col width="25%"><col></colgroup>
|
<colgroup><col width="25%"><col width="25%"><col></colgroup>
|
||||||
<tr>
|
<tr>
|
||||||
|
|||||||
Reference in New Issue
Block a user