You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 9411ea6
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: content/en/docs/guides/tenants.md
+21-5Lines changed: 21 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,29 @@ A **tenant** is the main unit of security on the platform. The closest analogy w
11
11
12
12
Tenants can be created recursively and are subject to the following rules:
13
13
14
-
### Higher-level tenants can access lower-level ones.
14
+
### Tenant naming
15
15
16
-
Higher-level tenants can view and manage the applications of all their children.
16
+
Tenant names must be alphanumeric.
17
+
Using dashes (`-`) in tenant names is not allowed, unlike with other services.
18
+
This limitation exists to keep consistent naming in tenants, nested tenants, and services deployed in them.
17
19
18
-
### Each tenant has its own domain
20
+
For example:
19
21
20
-
By default (unless otherwise specified), it inherits the domain of its parent with a prefix of its name, for example, if the parent had the domain `example.org`, then `tenant-foo` would get the domain `foo.example.org` by default.
22
+
- The root tenant is named `root`, but internally it's referenced as `tenant-root`.
23
+
- A nested tenant could be named `foo`, which would result in `tenant-foo` in service names and URLs.
24
+
- However, a tenant can not be named `foo-bar`, because parsing names such as `tenant-foo-bar` would be ambiguous.
25
+
26
+
### Nested tenants
27
+
28
+
Tenants can be nested.
29
+
A tenant administrator can create nested tenants using the "Tenant" application from the catalogue.
30
+
Higher-level tenants can view and manage the applications of all their children tenants.
31
+
32
+
### Unique domains
33
+
34
+
Each tenant has its own domain.
35
+
By default, (unless otherwise specified), it inherits the domain of its parent with a prefix of its name.
36
+
For example, if the parent had the domain `example.org`, then `tenant-foo` would get the domain `foo.example.org` by default.
21
37
22
38
Kubernetes clusters created in this tenant namespace would get domains like: `kubernetes-cluster.foo.example.org`
23
39
@@ -39,5 +55,5 @@ This in turn means:
39
55
40
56

41
57
42
-
See the reference for the application implementing tenant management: [`tenant`]({{% ref "/docs/reference/applications/tenant" %}})
58
+
See the reference for the application implementing tenant management: [`tenant`]({{% ref "/docs/reference/applications/tenant#parameters" %}})
Copy file name to clipboardExpand all lines: content/en/docs/reference/applications/tenant.md
+32-12Lines changed: 32 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,36 +8,55 @@ A tenant is the main unit of security on the platform. The closest analogy would
8
8
9
9
Tenants can be created recursively and are subject to the following rules:
10
10
11
-
### Higher-level tenants can access lower-level ones.
11
+
### Tenant naming
12
12
13
-
Higher-level tenants can view and manage the applications of all their children.
13
+
Tenant names must be alphanumeric.
14
+
Using dashes (`-`) in tenant names is not allowed, unlike with other services.
15
+
This limitation exists to keep consistent naming in tenants, nested tenants, and services deployed in them.
14
16
15
-
### Each tenant has its own domain
17
+
For example:
16
18
17
-
By default (unless otherwise specified), it inherits the domain of its parent with a prefix of its name, for example, if the parent had the domain `example.org`, then `tenant-foo` would get the domain `foo.example.org` by default.
19
+
- The root tenant is named `root`, but internally it's referenced as `tenant-root`.
20
+
- A nested tenant could be named `foo`, which would result in `tenant-foo` in service names and URLs.
21
+
- However, a tenant can not be named `foo-bar`, because parsing names such as `tenant-foo-bar` would be ambiguous.
22
+
23
+
### Unique domains
24
+
25
+
Each tenant has its own domain.
26
+
By default, (unless otherwise specified), it inherits the domain of its parent with a prefix of its name.
27
+
For example, if the parent had the domain `example.org`, then `tenant-foo` would get the domain `foo.example.org` by default.
18
28
19
29
Kubernetes clusters created in this tenant namespace would get domains like: `kubernetes-cluster.foo.example.org`
### Lower-level tenants can access the cluster services of their parent (provided they do not run their own)
38
+
### Nesting tenants and reusing parent services
39
+
40
+
Tenants can be nested.
41
+
A tenant administrator can create nested tenants using the "Tenant" application from the catalogue.
29
42
30
-
Thus, you can create `tenant-u1` with a set of services like `etcd`, `ingress`, `monitoring`. And create another tenant namespace `tenant-u2` inside of `tenant-u1`.
43
+
Higher-level tenants can view and manage the applications of all their children tenants.
44
+
If a tenant does not run their own cluster services, it can access ones of its parent.
45
+
46
+
For example, you create:
47
+
- Tenant `tenant-u1` with a set of services like `etcd`, `ingress`, `monitoring`.
48
+
- Tenant `tenant-u2` nested in `tenant-u1`.
31
49
32
50
Let's see what will happen when you run Kubernetes and Postgres under `tenant-u2` namespace.
33
51
34
-
Since `tenant-u2` does not have its own cluster services like `etcd`, `ingress`, and `monitoring`, the applications will use the cluster services of the parent tenant.
35
-
This in turn means:
52
+
Since `tenant-u2` does not have its own cluster services like `etcd`, `ingress`, and `monitoring`,
53
+
the applications running in `tenant-u2` will use the cluster services of the parent tenant.
36
54
37
-
- The Kubernetes cluster data will be stored in etcd for `tenant-u1`.
38
-
- Access to the cluster will be through the common ingress of `tenant-u1`.
39
-
- Essentially, all metrics will be collected in the monitoring from `tenant-u1`, and only it will have access to them.
55
+
This in turn means:
40
56
57
+
- The Kubernetes cluster data will be stored in `etcd` for `tenant-u1`.
58
+
- Access to the cluster will be through the common `ingress` of `tenant-u1`.
59
+
- Essentially, all metrics will be collected in the `monitoring` from `tenant-u1`, and only that tenant will have access to them.
0 commit comments