Small edits (#322)

This commit is contained in:
pollfly
2022-09-04 10:17:44 +03:00
committed by GitHub
parent 910ab6303b
commit 8f17f96c59
11 changed files with 27 additions and 27 deletions

View File

@@ -106,7 +106,7 @@ The host URLs for the ClearML Server are required:
* ClearML Server API server
* ClearML Server file server
These may be localhost, the domain, or a sub-domain of the domain.
These may be localhost, the domain, or a subdomain of the domain.
**To add ClearML settings to an existing ClearML configuration file:**

View File

@@ -34,7 +34,7 @@ ClearML Server also comes with a [services agent](../clearml_agent.md#services-m
## Deployment
The ClearML Server can be deployed in any of the formats listed below. Once deployed, configure the server for web login
authentication, sub-domains, and load balancers, and use any of its many configuration settings.
authentication, subdomains, and load balancers, and use any of its many configuration settings.
**To deploy your own ClearML Server:**
@@ -46,7 +46,7 @@ authentication, sub-domains, and load balancers, and use any of its many configu
[Windows 10](clearml_server_win.md)
* [Kubernetes using Helm](clearml_server_kubernetes_helm.md)
1. Optionally, [configure ClearML Server](clearml_server_config.md) for additional features, including sub-domains and load balancers,
1. Optionally, [configure ClearML Server](clearml_server_config.md) for additional features, including subdomains and load balancers,
web login authentication, and the non-responsive task watchdog.
1. [Configure ClearML for ClearML Server](clearml_config_for_clearml_server.md)

View File

@@ -8,7 +8,7 @@ This documentation page applies to deploying your own open source ClearML Server
This page describes the ClearML Server [deployment](#clearml-server-deployment-configuration) and [feature](#clearml-server-feature-configurations) configurations. Namely, it contains instructions on how to configure ClearML Server for:
* [Sub-domains and load balancers](#sub-domains-and-load-balancers) - An AWS load balancing example
* [Subdomains and load balancers](#subdomains-and-load-balancers) - An AWS load balancing example
* [Opening Elasticsearch, MongoDB, and Redis for External Access](#opening-elasticsearch-mongodb-and-redis-for-external-access)
* [Web login authentication](#web-login-authentication) - Create and manage users and passwords
* [Using hashed passwords](#using-hashed-passwords) - Option to use hashed passwords instead of plain-text passwords
@@ -23,7 +23,7 @@ Using the latest version of ClearML Server is recommended.
## ClearML Server Deployment Configuration
ClearML Server supports two deployment configurations: single IP (domain) and sub-domains.
ClearML Server supports two deployment configurations: single IP (domain) and subdomains.
### Single IP (Domain) Configuration
@@ -33,23 +33,23 @@ Single IP (domain) with the following open ports:
* API service on port `8008`
* File storage service on port `8081`
### Sub-domain Configuration
### Subdomain Configuration
Sub-domain configuration with default http/s ports (`80` or `443`):
Subdomain configuration with default http/s ports (`80` or `443`):
* Web application on sub-domain: `app.*.*`
* API service on sub-domain: `api.*.*`
* File storage service on sub-domain: `files.*.*`
* Web application on subdomain: `app.*.*`
* API service on subdomain: `api.*.*`
* File storage service on subdomain: `files.*.*`
When [configuring sub-domains](#sub-domains-and-load-balancers) for ClearML Server, they will map to the ClearML Server's
When [configuring subdomains](#subdomains-and-load-balancers) for ClearML Server, they will map to the ClearML Server's
internally configured ports for the Dockers. As a result, ClearML Server Dockers remain accessible if, for example,
some type of port forwarding is implemented.
:::important
``app``, ``api``, and ``files`` as the sub-domain labels must be used.
``app``, ``api``, and ``files`` as the subdomain labels must be used.
:::
For example, a domain is called `mydomain.com`, and a sub-domain named `clearml.mydomain.com` is created, use the following:
For example, a domain is called `mydomain.com`, and a subdomain named `clearml.mydomain.com` is created, use the following:
* `app.clearml.mydomain.com` (web server)
* `api.clearml.mydomain.com` (API server)
@@ -156,7 +156,7 @@ the default secret for the system's apiserver component can be overridden by set
### Sub-domains and Load Balancers
### Subdomains and Load Balancers
The following example, which is based on AWS load balancing, demonstrates the configuration: