Skip to content

Commit 119d582

Browse files
committed
[docs] Review the Tenant app documentation
* Brush up some formatting * Explain the relations of nested tenants in more detail Signed-off-by: Nick Volynkin <[email protected]>
1 parent 4512673 commit 119d582

1 file changed

Lines changed: 21 additions & 8 deletions

File tree

‎packages/apps/tenant/README.md‎

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,30 +16,43 @@ For example:
1616
- A nested tenant could be named `foo`, which would result in `tenant-foo` in service names and URLs.
1717
- However, a tenant can not be named `foo-bar`, because parsing names such as `tenant-foo-bar` would be ambiguous.
1818

19+
### Unique domains
1920

21+
Each tenant has its own domain.
22+
By default, (unless otherwise specified), it inherits the domain of its parent with a prefix of its name.
23+
For example, if the parent had the domain `example.org`, then `tenant-foo` would get the domain `foo.example.org` by default.
2024

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

2327
Example:
24-
```
28+
```text
2529
tenant-root (example.org)
2630
└── tenant-foo (foo.example.org)
2731
└── kubernetes-cluster1 (kubernetes-cluster1.foo.example.org)
2832
```
2933

30-
### Lower-level tenants can access the cluster services of their parent (provided they do not run their own)
34+
### Nesting tenants and reusing parent services
35+
36+
Tenants can be nested.
37+
A tenant administrator can create nested tenants using the "Tenant" application from the catalogue.
38+
39+
Higher-level tenants can view and manage the applications of all their children tenants.
40+
If a tenant does not run their own cluster services, it can access ones of its parent.
3141

32-
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`.
42+
For example, you create:
43+
- Tenant `tenant-u1` with a set of services like `etcd`, `ingress`, `monitoring`.
44+
- Tenant `tenant-u2` nested in `tenant-u1`.
3345

3446
Let's see what will happen when you run Kubernetes and Postgres under `tenant-u2` namespace.
3547

36-
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.
37-
This in turn means:
48+
Since `tenant-u2` does not have its own cluster services like `etcd`, `ingress`, and `monitoring`,
49+
the applications running in `tenant-u2` will use the cluster services of the parent tenant.
3850

39-
- The Kubernetes cluster data will be stored in etcd for `tenant-u1`.
40-
- Access to the cluster will be through the common ingress of `tenant-u1`.
41-
- Essentially, all metrics will be collected in the monitoring from `tenant-u1`, and only it will have access to them.
51+
This in turn means:
4252

53+
- The Kubernetes cluster data will be stored in `etcd` for `tenant-u1`.
54+
- Access to the cluster will be through the common `ingress` of `tenant-u1`.
55+
- Essentially, all metrics will be collected in the `monitoring` from `tenant-u1`, and only that tenant will have access to them.
4356

4457
Example:
4558
```

0 commit comments

Comments
 (0)