From 9e2dee498e5cb1c5b6790a594c5513e6b01815c3 Mon Sep 17 00:00:00 2001 From: revital Date: Mon, 10 Mar 2025 13:46:39 +0200 Subject: [PATCH] EditS --- .../enterprise_deploy/multi_tenant_k8s.md | 7 ++++--- .../enterprise_deploy/on_prem_ubuntu.md | 13 ++++++++----- docs/deploying_clearml/enterprise_deploy/vpc_aws.md | 6 +++--- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md b/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md index fd6caf6d..7ab41ef4 100644 --- a/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md @@ -100,9 +100,10 @@ Install the ClearML chart with the required configuration: 1. Prepare the `overrides.yaml` file and input the following content. Make sure to replace `` and `` with a valid domain that will have records pointing to the ingress controller accordingly. The credentials specified in `` and `` can be used to log in as the - supervisor user in the web UI. + supervisor user in the web UI. + Note that the `` value must be explicitly quoted. To do so, put `\\"` around the quoted value. - For example `"\\"email@example.com\\””` + For example `"\\"email@example.com\\””`. ``` imageCredentials: @@ -192,7 +193,7 @@ Install the ClearML chart with the required configuration: enabled: true ``` -2. Install ClearML +2. Install ClearML: ``` helm install -n clearml \\ diff --git a/docs/deploying_clearml/enterprise_deploy/on_prem_ubuntu.md b/docs/deploying_clearml/enterprise_deploy/on_prem_ubuntu.md index 2739b382..749f5066 100644 --- a/docs/deploying_clearml/enterprise_deploy/on_prem_ubuntu.md +++ b/docs/deploying_clearml/enterprise_deploy/on_prem_ubuntu.md @@ -43,7 +43,7 @@ should be reviewed and modified prior to the server installation ## Installing ClearML Server ### Preliminary Steps -1. Install Docker CE +1. Install Docker CE: ``` https://docs.docker.com/install/linux/docker-ce/ubuntu/ @@ -113,10 +113,10 @@ should be reviewed and modified prior to the server installation sudo systemctl enable disable-thp ``` -1. Restart the machine +1. Restart the machine. ### Installing the Server -1. Remove any previous installation of ClearML Server +1. Remove any previous installation of ClearML Server: ``` sudo rm -R /opt/clearml/ @@ -141,7 +141,7 @@ should be reviewed and modified prior to the server installation sudo mkdir -pv /opt/allegro/config/onprem_poc ``` -1. Copy the following ClearML configuration files to `/opt/allegro` +1. Copy the following ClearML configuration files to `/opt/allegro`: * `constants.env` * `docker-compose.override.yml` * `docker-compose.yml` @@ -171,7 +171,7 @@ should be reviewed and modified prior to the server installation sudo docker-compose --env-file constants.env up -d ``` -1. Verify web access by browsing to your URL (IP address) and port 8080. +1. Verify web access by browsing to your URL (IP address) and port 8080: ``` http://:8080 @@ -194,7 +194,10 @@ the following subdomains should be forwarded to the corresponding ports on the s * `https://app.` should be forwarded to port 8080 * `https://files.` should be forwarded to port 8081 + +:::warning **Critical: Ensure no other ports are open to maintain the highest level of security.** +::: Additionally, ensure that the following URLs are correctly configured in the server's environment file: diff --git a/docs/deploying_clearml/enterprise_deploy/vpc_aws.md b/docs/deploying_clearml/enterprise_deploy/vpc_aws.md index d6c385fa..37fa7f28 100644 --- a/docs/deploying_clearml/enterprise_deploy/vpc_aws.md +++ b/docs/deploying_clearml/enterprise_deploy/vpc_aws.md @@ -117,10 +117,10 @@ Instance requirements: ## Load Balancer 1. Create a TLS certificate: - 1. Choose a domain name to be used with the server. The main URL that will be used by the system’s users will be app.\ + 1. Choose a domain name to be used with the server. The main URL that will be used by the system’s users will be `app.` 2. Create a certificate, with the following DNS names: - 1. \ - 2. \*.\ + 1. `` + 2. `*.` 2. Create the `envoy` target group for the server: 1. Port: 10000