diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md index 1b170b93..63c663eb 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md @@ -67,7 +67,7 @@ tcpSession: **Configuration options:** * `imageCredentials.password`: ClearML DockerHub Access Token. -* `clearml.apiKey` and `clearml.apiSecret`: API credentials created in the ClearML web UI by an Admin user or Service +* `clearml.apiKey` and `clearml.apiSecret`: [API credentials](../../webapp/settings/webapp_settings_profile.md#clearml-api-credentials) created in the ClearML web UI by an Admin user or Service Account with admin privileges. Make sure to label these credentials clearly, so that they will not be revoked by mistake. * `clearml.apiServerUrlReference`: ClearML API server URL starting with `https://api.`. * `clearml.authCookieName`: Cookie used by the ClearML server to store the ClearML authentication cookie. @@ -95,7 +95,7 @@ helm upgrade --install -n clearml-enterprise Replace the placeholders with the following values: * `` - Unique name for the App Gateway within the K8s namespace. This is a required parameter in - Helm, which identifies a specific installation of the chart. The release name also defines the App Gateway’s name and + Helm, which identifies a specific installation of the chart. The release name also defines the App Gateway's name and appears in the UI within AI workload application URLs (e.g. Remote IDE URLs). This can be customized to support multiple installations within the same namespace by assigning different release names. * `` - [Kubernetes Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) diff --git a/docs/deploying_clearml/enterprise_deploy/k8s.md b/docs/deploying_clearml/enterprise_deploy/k8s.md index c5385fdd..fa9f7620 100644 --- a/docs/deploying_clearml/enterprise_deploy/k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/k8s.md @@ -2,17 +2,17 @@ title: Kubernetes --- -This guide provides step-by-step instructions for installing the ClearML Enterprise control-plane setup in a Kubernetes cluster. +This guide provides step-by-step instructions for installing the ClearML Enterprise Server (control-plane) in a Kubernetes cluster. -ClearML Enterprise is the main ClearML Server, comprising the ClearML `apiserver`, `fileserver`, and `webserver` components. +The ClearML Enterprise Server includes the ClearML `apiserver`, `fileserver`, and `webserver` components. The package also includes MongoDB, ElasticSearch, and Redis as Helm dependencies. ## Prerequisites -To deploy ClearML Enterprise, ensure the following components and configurations are in place: +To deploy a ClearML Server, ensure the following components and configurations are in place: -- Kubernetes Cluster: A vanilla Kubernetes cluster is preferred for optimal GPU support. +- Kubernetes Cluster: A standard Kubernetes cluster is preferred for optimal GPU support. - CLI Tools: `kubectl` and `helm` must be installed and configured. - Ingress Controller: An Ingress controller (e.g., `nginx-ingress`) is required. If exposing services externally, a LoadBalancer-capable solution (e.g. `MetalLB`) should also be configured.