Skip to content

Commit 4512673

Browse files
committed
[docs] Tenants cannot have dashes in the names
Gave examples of tenant naming. Part of #971 Signed-off-by: Nick Volynkin <[email protected]>
1 parent 609e7ed commit 4512673

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

‎packages/apps/tenant/README.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,19 @@ A tenant is the main unit of security on the platform. The closest analogy would
44

55
Tenants can be created recursively and are subject to the following rules:
66

7-
### Higher-level tenants can access lower-level ones.
7+
### Tenant naming
88

9-
Higher-level tenants can view and manage the applications of all their children.
9+
Tenant names must be alphanumeric.
10+
Using dashes (`-`) in tenant names is not allowed, unlike with other services.
11+
This limitation exists to keep consistent naming in tenants, nested tenants, and services deployed in them.
12+
13+
For example:
14+
15+
- The root tenant is named `root`, but internally it's referenced as `tenant-root`.
16+
- A nested tenant could be named `foo`, which would result in `tenant-foo` in service names and URLs.
17+
- However, a tenant can not be named `foo-bar`, because parsing names such as `tenant-foo-bar` would be ambiguous.
1018

11-
### Each tenant has its own domain
1219

13-
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.
1420

1521
Kubernetes clusters created in this tenant namespace would get domains like: `kubernetes-cluster.foo.example.org`
1622

0 commit comments

Comments
 (0)