Skip to content

Commit dfb22b7

Browse files
authored
Add Configuring Options per tenant
2 parents 0a8f880 + 57c98aa commit dfb22b7

File tree

1 file changed

+53
-5
lines changed

1 file changed

+53
-5
lines changed

docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md

+53-5
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ metadata:
268268
spec:
269269
podSelector: {}
270270
policyTypes:
271-
- Ingress
271+
- Ingress
272272
ingress:
273273
- from:
274274
- podSelector: {}
@@ -337,7 +337,7 @@ must be substituted with valid domain names or values from responses.
337337
APISERVER_SECRET="<APISERVER_SECRET>"
338338
```
339339

340-
2. Create a *Tenant* (company):
340+
2. Create a **Tenant** (company):
341341

342342
```
343343
curl $APISERVER_URL/system.create_company \\
@@ -352,7 +352,7 @@ must be substituted with valid domain names or values from responses.
352352
curl -u $APISERVER_KEY:$APISERVER_SECRET $APISERVER_URL/system.get_companies
353353
```
354354

355-
3. Create an *Admin User*:
355+
3. Create an **Admin User**:
356356

357357
```
358358
curl $APISERVER_URL/auth.create_user \\
@@ -363,7 +363,7 @@ must be substituted with valid domain names or values from responses.
363363

364364
This returns the new User ID (`<USER_ID>`).
365365

366-
4. Generate *Credentials* for the new Admin User:
366+
4. Generate **Credentials** for the new Admin User:
367367

368368
```
369369
curl $APISERVER_URL/auth.create_credentials \\
@@ -374,7 +374,7 @@ must be substituted with valid domain names or values from responses.
374374

375375
This returns a set of key and secret credentials associated with the new Admin User.
376376

377-
5. Create an SSO Domain *Whitelist*. The `<USERS_EMAIL_DOMAIN>` is the email domain setup for users to access through SSO.
377+
5. Create an SSO Domain **Whitelist**. The `<USERS_EMAIL_DOMAIN>` is the email domain setup for users to access through SSO.
378378

379379
```
380380
curl $APISERVER_URL/login.set_domains \\
@@ -541,3 +541,51 @@ Install the App Gateway Router in your Kubernetes cluster, allowing it to manage
541541
-f overrides.yaml
542542
```
543543

544+
## Configuring Options per Tenant
545+
546+
### Override Options When Creating a New Tenant
547+
548+
When creating a new tenant company, you can specify several tenant options. These include:
549+
550+
* `features` - Add features to a company
551+
* `exclude_features` - Exclude features from a company.
552+
* `allowed_users` - Set the maximum number of users for a company.
553+
554+
#### Example: Create a New Tenant with a Specific Feature Set
555+
556+
```
557+
curl $APISERVER_URL/system.create_company \
558+
-H "Content-Type: application/json" \
559+
-u $APISERVER_KEY:$APISERVER_SECRET \
560+
-d '{"name":"<TENANT_NAME>", "defaults": { "allowed_users": "10", "features": ["experiments"], "exclude_features": ["app_management", "applications", "user_management"] }}'
561+
```
562+
563+
**Note**: make sure to replace the `<TENANT_NAME>` placeholder.
564+
565+
### Limit Features for all Users
566+
567+
This Helm Chart value in the `overrides.yaml` will have priority over all tenants, and will limit the features
568+
available to any user in the system. This means that even if the feature is enabled for the tenant, if it;s not in this
569+
list, the user will not see it.
570+
571+
Example: all users will only have the `applications` feature enabled.
572+
573+
```
574+
apiserver:
575+
extraEnvs:
576+
- name: CLEARML__services__auth__default_groups__users__features
577+
value: "[\"applications\"]"
578+
```
579+
580+
**Available Features**:
581+
582+
* `applications` - Viewing and running applications
583+
* `data_management` - Working with hyper-datasets and dataviews
584+
* `experiments` - Viewing experiment table and launching experiments
585+
* `queues` - Viewing the queues screen
586+
* `queue_management` - Creating and deleting queues
587+
* `pipelines` - Viewing/managing pipelines in the system
588+
* `reports` - Viewing and managing reports in the system
589+
* `show_dashboard` - Show the dashboard screen
590+
* `show_projects` - Show the projects menu option
591+
* `resource_dashboard` - Display the resource dashboard in the orchestration page

0 commit comments

Comments
 (0)