diff --git a/docs/deploying_clearml/enterprise_deploy/k8s.md b/docs/deploying_clearml/enterprise_deploy/k8s.md index 67127b24..d4052918 100644 --- a/docs/deploying_clearml/enterprise_deploy/k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/k8s.md @@ -58,83 +58,46 @@ that will have records pointing to the cluster’s ingress controller (see ingre ::: -``` +```yaml imageCredentials: - password: "" - + password: "" clearml: - cookieDomain: "" - # Set values for improved security - apiserverKey: "" - apiserverSecret: "" - fileserverKey: "" - fileserverSecret: "" - secureAuthTokenSecret: "" - testUserKey: "" - testUserSecret: "" - + cookieDomain: "" + # Set values for improved security + apiserverKey: "" + apiserverSecret: "" + fileserverKey: "" + fileserverSecret: "" + secureAuthTokenSecret: "" + testUserKey: "" + testUserSecret: "" apiserver: - ingress: - enabled: true - hostName: "api." - service: - 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: "" - - 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: "" - - name: CLEARML__secure__credentials__supervisor__user_secret - value: "" - - name: CLEARML__secure__credentials__supervisor__sec_groups - value: "[\"users\", \"admins\", \"queue_admins\"]" - - name: CLEARML__secure__credentials__supervisor__email - value: "\"\"" - - name: CLEARML__apiserver__company__unique_names - value: "true" - + ingress: + enabled: true + hostName: "api." + service: + type: ClusterIP fileserver: - ingress: - enabled: true - hostName: "file." - service: - type: ClusterIP - + ingress: + enabled: true + hostName: "file." + service: + type: ClusterIP webserver: - ingress: - enabled: true - hostName: "app." - service: - type: ClusterIP - + ingress: + enabled: true + hostName: "app." + service: + type: ClusterIP clearmlApplications: - enabled: true + enabled: true ``` - -The credentials specified in `` and `` can be used to log in as the -supervisor user from the ClearML Web UI accessible using the URL `app.`. - - -Note that the `` value must be explicitly quoted. To do so, put `\"` around the quoted value. -For example `"\"email@example.com\""`. - - #### Additional Configuration Options ##### Fixed Users (Simple Login) @@ -181,7 +144,7 @@ Substitute all ``s with the correct value for your configuration. ##### Auth0 Identity Provider -``` +```yaml apiserver: extraEnvs: - name: CLEARML__secure__login__sso__oauth_client__auth0__client_id @@ -202,7 +165,7 @@ apiserver: ##### Keycloak Identity Provider -``` +```yaml apiserver: extraEnvs: - name: CLEARML__secure__login__sso__oauth_client__keycloak__client_id @@ -217,8 +180,6 @@ apiserver: value: "/realms//protocol/openid-connect/token" - name: CLEARML__services__login__sso__oauth_client__keycloak__idp_logout value: "true" - - ``` @@ -247,24 +208,24 @@ 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`: -``` +```yaml imageCredentials: - password: "" + password: "" clearml: - agentk8sglueKey: "" - agentk8sglueSecret: "" + agentk8sglueKey: "" + agentk8sglueSecret: "" agentk8sglue: - apiServerUrlReference: "https://api." - fileServerUrlReference: "https://files." - webServerUrlReference: "https://app." - defaultContainerImage: "python:3.9" + apiServerUrlReference: "https://api." + fileServerUrlReference: "https://files." + webServerUrlReference: "https://app." + defaultContainerImage: "python:3.9" ``` #### Installing the Chart -``` +```bash helm install -n \ clearml-agent \ clearml-enterprise/clearml-enterprise-agent \ @@ -276,7 +237,7 @@ helm install -n \ To create a queue by API: -``` +```bash curl $APISERVER_URL/queues.create \ -H "Content-Type: application/json" \ -H "X-Clearml-Impersonate-As:" \ @@ -294,22 +255,22 @@ curl $APISERVER_URL/queues.create \ The Helm Chart must be installed with `overrides.yaml`: -``` +```yaml imageCredentials: - password: "" + password: "" clearml: - apiServerKey: "" - apiServerSecret: "" - apiServerUrlReference: "https://api." - authCookieName: "" + apiServerKey: "" + apiServerSecret: "" + apiServerUrlReference: "https://api." + authCookieName: "" ingress: - enabled: true - hostName: "task-router.dev" + enabled: true + hostName: "task-router.dev" tcpSession: - routerAddress: "" - portRange: - start: - end: + routerAddress: "" + portRange: + start: + end: ``` @@ -330,7 +291,7 @@ tcpSession: ### Installing the Chart -``` +```bash helm install -n \ clearml-ttr \ clearml-enterprise/clearml-enterprise-task-traffic-router \ @@ -429,20 +390,20 @@ This example configures a specific queue, but you can include this setting in th apply it to all tasks. -``` +```yaml agentk8sglue: - queues: - GPUshm: - templateOverrides: - env: - - name: VLLM_SKIP_P2P_CHECK - value: "1" - volumeMounts: - - name: dshm - mountPath: /dev/shm - volumes: - - name: dshm - emptyDir: - medium: Memory - sizeLimit: Gi + queues: + GPUshm: + templateOverrides: + env: + - name: VLLM_SKIP_P2P_CHECK + value: "1" + volumeMounts: + - name: dshm + mountPath: /dev/shm + volumes: + - name: dshm + emptyDir: + medium: Memory + sizeLimit: Gi ```