mirror of
https://github.com/clearml/clearml-docs
synced 2025-05-09 15:11:25 +00:00
Update k8s deployment instructions
This commit is contained in:
commit
911bf7e7c0
@ -58,11 +58,10 @@ that will have records pointing to the cluster’s ingress controller (see ingre
|
|||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
imageCredentials:
|
imageCredentials:
|
||||||
password: "<clearml_enterprise_DockerHub_TOKEN>"
|
password: "<clearml_enterprise_DockerHub_TOKEN>"
|
||||||
|
|
||||||
|
|
||||||
clearml:
|
clearml:
|
||||||
cookieDomain: "<BASE_DOMAIN>"
|
cookieDomain: "<BASE_DOMAIN>"
|
||||||
# Set values for improved security
|
# Set values for improved security
|
||||||
@ -74,37 +73,12 @@ clearml:
|
|||||||
testUserKey: "<GENERATED_TEST_USER_KEY>"
|
testUserKey: "<GENERATED_TEST_USER_KEY>"
|
||||||
testUserSecret: "<GENERATED_TEST_USER_SECRET>"
|
testUserSecret: "<GENERATED_TEST_USER_SECRET>"
|
||||||
|
|
||||||
|
|
||||||
apiserver:
|
apiserver:
|
||||||
ingress:
|
ingress:
|
||||||
enabled: true
|
enabled: true
|
||||||
hostName: "api.<BASE_DOMAIN>"
|
hostName: "api.<BASE_DOMAIN>"
|
||||||
service:
|
service:
|
||||||
type: ClusterIP
|
type: ClusterIP
|
||||||
extraEnvs:
|
|
||||||
- name: CLEARML__services__organization__features__user_management_advanced
|
|
||||||
value: "true"
|
|
||||||
- name: CLEARML__services__auth__ui_features_per_role__user__show_datasets
|
|
||||||
value: "false"
|
|
||||||
- name: CLEARML__services__auth__ui_features_per_role__user__show_orchestration
|
|
||||||
value: "false"
|
|
||||||
- name: CLEARML__services__workers__resource_usages__supervisor_company
|
|
||||||
value: "<SUPERVISOR_TENANT_ID>"
|
|
||||||
- name: CLEARML__secure__credentials__supervisor__role
|
|
||||||
value: "system"
|
|
||||||
- name: CLEARML__secure__credentials__supervisor__allow_login
|
|
||||||
value: "true"
|
|
||||||
- name: CLEARML__secure__credentials__supervisor__user_key
|
|
||||||
value: "<SUPERVISOR_USER_KEY>"
|
|
||||||
- name: CLEARML__secure__credentials__supervisor__user_secret
|
|
||||||
value: "<SUPERVISOR_USER_SECRET>"
|
|
||||||
- name: CLEARML__secure__credentials__supervisor__sec_groups
|
|
||||||
value: "[\"users\", \"admins\", \"queue_admins\"]"
|
|
||||||
- name: CLEARML__secure__credentials__supervisor__email
|
|
||||||
value: "\"<SUPERVISOR_USER_EMAIL>\""
|
|
||||||
- name: CLEARML__apiserver__company__unique_names
|
|
||||||
value: "true"
|
|
||||||
|
|
||||||
|
|
||||||
fileserver:
|
fileserver:
|
||||||
ingress:
|
ingress:
|
||||||
@ -113,7 +87,6 @@ fileserver:
|
|||||||
service:
|
service:
|
||||||
type: ClusterIP
|
type: ClusterIP
|
||||||
|
|
||||||
|
|
||||||
webserver:
|
webserver:
|
||||||
ingress:
|
ingress:
|
||||||
enabled: true
|
enabled: true
|
||||||
@ -121,20 +94,10 @@ webserver:
|
|||||||
service:
|
service:
|
||||||
type: ClusterIP
|
type: ClusterIP
|
||||||
|
|
||||||
|
|
||||||
clearmlApplications:
|
clearmlApplications:
|
||||||
enabled: true
|
enabled: true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
The credentials specified in `<SUPERVISOR_USER_KEY>` and `<SUPERVISOR_USER_SECRET>` can be used to log in as the
|
|
||||||
supervisor user from the ClearML Web UI accessible using the URL `app.<BASE_DOMAIN>`.
|
|
||||||
|
|
||||||
|
|
||||||
Note that the `<SUPERVISOR_USER_EMAIL>` value must be explicitly quoted. To do so, put `\"` around the quoted value.
|
|
||||||
For example `"\"email@example.com\""`.
|
|
||||||
|
|
||||||
|
|
||||||
#### Additional Configuration Options
|
#### Additional Configuration Options
|
||||||
##### Fixed Users (Simple Login)
|
##### Fixed Users (Simple Login)
|
||||||
|
|
||||||
@ -181,7 +144,7 @@ Substitute all `<PLACEHOLDER>`s with the correct value for your configuration.
|
|||||||
##### Auth0 Identity Provider
|
##### Auth0 Identity Provider
|
||||||
|
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
apiserver:
|
apiserver:
|
||||||
extraEnvs:
|
extraEnvs:
|
||||||
- name: CLEARML__secure__login__sso__oauth_client__auth0__client_id
|
- name: CLEARML__secure__login__sso__oauth_client__auth0__client_id
|
||||||
@ -202,7 +165,7 @@ apiserver:
|
|||||||
##### Keycloak Identity Provider
|
##### Keycloak Identity Provider
|
||||||
|
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
apiserver:
|
apiserver:
|
||||||
extraEnvs:
|
extraEnvs:
|
||||||
- name: CLEARML__secure__login__sso__oauth_client__keycloak__client_id
|
- name: CLEARML__secure__login__sso__oauth_client__keycloak__client_id
|
||||||
@ -217,8 +180,6 @@ apiserver:
|
|||||||
value: "<KC_URL>/realms/<REALM_NAME>/protocol/openid-connect/token"
|
value: "<KC_URL>/realms/<REALM_NAME>/protocol/openid-connect/token"
|
||||||
- name: CLEARML__services__login__sso__oauth_client__keycloak__idp_logout
|
- name: CLEARML__services__login__sso__oauth_client__keycloak__idp_logout
|
||||||
value: "true"
|
value: "true"
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -247,7 +208,7 @@ To configure the agent you will need to choose a Redis password and use that whe
|
|||||||
The Helm Chart must be installed with `overrides.yaml`:
|
The Helm Chart must be installed with `overrides.yaml`:
|
||||||
|
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
imageCredentials:
|
imageCredentials:
|
||||||
password: "<CLEARML_DOCKERHUB_TOKEN>"
|
password: "<CLEARML_DOCKERHUB_TOKEN>"
|
||||||
clearml:
|
clearml:
|
||||||
@ -264,7 +225,7 @@ agentk8sglue:
|
|||||||
#### Installing the Chart
|
#### Installing the Chart
|
||||||
|
|
||||||
|
|
||||||
```
|
```bash
|
||||||
helm install -n <WORKLOAD_NAMESPACE> \
|
helm install -n <WORKLOAD_NAMESPACE> \
|
||||||
clearml-agent \
|
clearml-agent \
|
||||||
clearml-enterprise/clearml-enterprise-agent \
|
clearml-enterprise/clearml-enterprise-agent \
|
||||||
@ -276,7 +237,7 @@ helm install -n <WORKLOAD_NAMESPACE> \
|
|||||||
To create a queue by API:
|
To create a queue by API:
|
||||||
|
|
||||||
|
|
||||||
```
|
```bash
|
||||||
curl $APISERVER_URL/queues.create \
|
curl $APISERVER_URL/queues.create \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-H "X-Clearml-Impersonate-As:<USER_ID>" \
|
-H "X-Clearml-Impersonate-As:<USER_ID>" \
|
||||||
@ -294,7 +255,7 @@ curl $APISERVER_URL/queues.create \
|
|||||||
The Helm Chart must be installed with `overrides.yaml`:
|
The Helm Chart must be installed with `overrides.yaml`:
|
||||||
|
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
imageCredentials:
|
imageCredentials:
|
||||||
password: "<DOCKERHUB_TOKEN>"
|
password: "<DOCKERHUB_TOKEN>"
|
||||||
clearml:
|
clearml:
|
||||||
@ -330,7 +291,7 @@ tcpSession:
|
|||||||
### Installing the Chart
|
### Installing the Chart
|
||||||
|
|
||||||
|
|
||||||
```
|
```bash
|
||||||
helm install -n <WORKLOAD_NAMESPACE> \
|
helm install -n <WORKLOAD_NAMESPACE> \
|
||||||
clearml-ttr \
|
clearml-ttr \
|
||||||
clearml-enterprise/clearml-enterprise-task-traffic-router \
|
clearml-enterprise/clearml-enterprise-task-traffic-router \
|
||||||
@ -429,7 +390,7 @@ This example configures a specific queue, but you can include this setting in th
|
|||||||
apply it to all tasks.
|
apply it to all tasks.
|
||||||
|
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
agentk8sglue:
|
agentk8sglue:
|
||||||
queues:
|
queues:
|
||||||
GPUshm:
|
GPUshm:
|
||||||
|
Loading…
Reference in New Issue
Block a user