Skip to content

Commit 261876b

Browse files
committed
docs: documenting new support for dynamic tenant owners clusterrole
1 parent ab75014 commit 261876b

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/content/general/tutorial.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,41 @@ capsule-oil-2-readonly ClusterRole/readonly 2s
6666

6767
> The pattern for the annotation is `clusterrolenames.capsule.clastix.io/${KIND}.${NAME}`.
6868
> The placeholders `${KIND}` and `${NAME}` are referring to the Tenant Owner specification fields, both lower-cased.
69+
>
70+
> In the case of users that are identified using their email address, the symbol `@` wouldn't be supported by the RFC 1123.
71+
> For such cases, the `@` symbol can be replaced with the placeholder `__AT__`.
72+
>
73+
> ```yaml
74+
> apiVersion: capsule.clastix.io/v1beta1
75+
> kind: Tenant
76+
> metadata:
77+
> annotations:
78+
> clusterrolenames.capsule.clastix.io/alice__AT__clastix.io: editor,manager
79+
> spec:
80+
> owners:
81+
> - kind: User
82+
83+
> - kind: User
84+
85+
> ```
86+
>
87+
> Instead, with the resulting annotation key exceeding 63 characters length, the zero-based index of the owner can be specified as follows:
88+
>
89+
> ```yaml
90+
> apiVersion: capsule.clastix.io/v1beta1
91+
> kind: Tenant
92+
> metadata:
93+
> annotations:
94+
> clusterrolenames.capsule.clastix.io/1: editor,manager
95+
> spec:
96+
> owners:
97+
> - kind: User
98+
99+
> - kind: User
100+
101+
> ```
102+
>
103+
> This latter example will assign the roles `editor` and `manager`, assigned to the user `[email protected]`.
69104
70105
### User as tenant owner
71106
Bill, the cluster admin, receives a new request from Acme Corp.'s CTO asking for a new tenant to be onboarded and Alice user will be the tenant owner. Bill then assigns Alice's identity of `alice` in the Acme Corp. identity management system. Since Alice is a tenant owner, Bill needs to assign `alice` the Capsule group defined by `--capsule-user-group` option, which defaults to `capsule.clastix.io`.

0 commit comments

Comments
 (0)