ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Terminology change

Browse Source
This commit is contained in:
revital 2025-03-13 11:15:22 +02:00
parent 0d30852bea
commit 4699667939
9 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/deploying_clearml/enterprise_deploy/appgw.md
View File

@ -30,12 +30,12 @@ their instances:
* [Embedding Model Deployment](../../webapp/applications/apps_embed_model_deployment.md) * [Embedding Model Deployment](../../webapp/applications/apps_embed_model_deployment.md)
* [Llama.cpp Model Deployment](../../webapp/applications/apps_llama_deployment.md) * [Llama.cpp Model Deployment](../../webapp/applications/apps_llama_deployment.md)
The AI Application Gateway requires an additional component to the ClearML Server deployment: The ClearML Task Traffic Router. The AI Application Gateway requires an additional component to the ClearML Server deployment: **The ClearML AI App Gateway Router**.
If your ClearML Deployment does not have the Task Traffic Router properly installed, these application instances may not be accessible. If your ClearML Deployment does not have the AI App Gateway Router properly installed, these application instances may not be accessible.
#### Installation #### Installation
The AI Application Gateway supports two deployment options: The AI Application Gateway Router supports two deployment options:
* [Docker Compose](appgw_install_compose.md) * [Docker Compose](appgw_install_compose.md)
* [Kubernetes](appgw_install_k8s.md) * [Kubernetes](appgw_install_k8s.md)

2
docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md
View File

@ -89,7 +89,7 @@ TCP_PORT_END=
``` ```
Edit it according to the following guidelines: Edit it according to the following guidelines:
* `PROXY_TAG`: AI Application Gateway Proxy tag. * `PROXY_TAG`: AI Application Gateway proxy tag.
* `ROUTER_TAG`: AI Application Gateway Router tag. * `ROUTER_TAG`: AI Application Gateway Router tag.
* `ROUTER_NAME`: Unique name for this router, needed in case of [multiple routers on the same tenant](#install-multiple-routers-for-the-same-tenant). * `ROUTER_NAME`: Unique name for this router, needed in case of [multiple routers on the same tenant](#install-multiple-routers-for-the-same-tenant).
* `ROUTER__WEBSERVER__SERVER_PORT`: Webserver port. Default is 8080 but can be set differently based on network needs. * `ROUTER__WEBSERVER__SERVER_PORT`: Webserver port. Default is 8080 but can be set differently based on network needs.

12
docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md
View File

@ -6,12 +6,12 @@ title: Kubernetes Deployment
The AI Application Gateway is available under the ClearML Enterprise plan. The AI Application Gateway is available under the ClearML Enterprise plan.
::: :::
This guide details the installation of the ClearML AI Application Gateway. This guide details the installation of the ClearML AI App Gateway Router.
The AI Application Gateway enables access to session-based applications like VSCode and Jupyter. The AI App Gateway Router enables access to session-based applications like VSCode and Jupyter.
It acts as a proxy, discovering ClearML Tasks running within its namespace and configuring them for user access. It acts as a proxy, discovering ClearML Tasks running within its namespace and configuring them for user access.
:::important :::important
AI Application Gateway must be installed in the same namespace as a dedicated ClearML Agent. The AI App Gateway Router must be installed in the same namespace as a dedicated ClearML Agent.
It can only discover ClearML Tasks within its own namespace. It can only discover ClearML Tasks within its own namespace.
::: :::
@ -44,7 +44,7 @@ Replace `<GITHUB_TOKEN>` with your valid GitHub token that has access to the Cle
### Prepare Values ### Prepare Values
Before installing the AI Application Gateway, create a Helm override file: Before installing the AI App Gateway Router, create a Helm override file:
``` ```
imageCredentials: imageCredentials:
@ -74,7 +74,7 @@ Edit it according to these guidelines:
* `clearml.apiServerSecret`: ClearML server secret key. * `clearml.apiServerSecret`: ClearML server secret key.
* `clearml.apiServerUrlReference`: ClearML API server URL usually starting with `https://api.`. * `clearml.apiServerUrlReference`: ClearML API server URL usually starting with `https://api.`.
* `clearml.authCookieName`: Cookie name used by the ClearML server to store the ClearML authentication cookie. * `clearml.authCookieName`: Cookie name used by the ClearML server to store the ClearML authentication cookie.
* `clearml.sslVerify`: Enable or disable SSL certificate validation on apiserver calls check. * `clearml.sslVerify`: Enable or disable SSL certificate validation on `apiserver` calls check.
* `ingress.hostName`: Hostname of router used by the ingress controller to access it. * `ingress.hostName`: Hostname of router used by the ingress controller to access it.
* `tcpSession.routerAddress`: The external router address (can be an IP, hostname, or load balancer address) depending on your network setup. Ensure this address is accessible for TCP connections. * `tcpSession.routerAddress`: The external router address (can be an IP, hostname, or load balancer address) depending on your network setup. Ensure this address is accessible for TCP connections.
* `tcpSession.service.type`: Service type used to expose TCP functionality, default is `NodePort`. * `tcpSession.service.type`: Service type used to expose TCP functionality, default is `NodePort`.
@ -103,6 +103,6 @@ allegroai-enterprise/clearml-enterprise-task-traffic-router \
Replace the placeholders with the following values: Replace the placeholders with the following values:
* `<RELEASE_NAME>` - Unique name for the AI Application Gateway within the namespace. This name will appear in the UI and be used for the redirection URL. * `<RELEASE_NAME>` - Unique name for the AI App Gateway Router within the namespace. This name will appear in the UI and be used for the redirection URL.
* `<WORKLOAD_NAMESPACE>` - Namespace that will be shared with a dedicated ClearML Agent. * `<WORKLOAD_NAMESPACE>` - Namespace that will be shared with a dedicated ClearML Agent.
* `<CHART_VERSION>` - Version recommended by the ClearML Support Team. * `<CHART_VERSION>` - Version recommended by the ClearML Support Team.

6
docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md
View File

@ -513,9 +513,9 @@ Create a `NetworkPolicy` in the tenant namespace with the following configuratio
- podSelector: {} - podSelector: {}
``` ```
### Install AI Application Gateway Chart ### Install AI App Gateway Router Chart
Install the [AI App Gateway](appgw.md) in your Kubernetes cluster, allowing it to manage and route tasks: Install the AI App Gateway Router in your Kubernetes cluster, allowing it to manage and route tasks:
1. Prepare the `overrides.yaml` file with the following content: 1. Prepare the `overrides.yaml` file with the following content:
@ -531,7 +531,7 @@ Install the [AI App Gateway](appgw.md) in your Kubernetes cluster, allowing it t
hostName: "<unique url in same domain as apiserver/webserver>" hostName: "<unique url in same domain as apiserver/webserver>"
``` ```
2. Install Task Traffic Router in the specified tenant namespace: 2. Install AI App Gateway Router in the specified tenant namespace:
``` ```
helm install -n <TENANT_NAMESPACE> \\ helm install -n <TENANT_NAMESPACE> \\

2
docs/webapp/applications/apps_embed_model_deployment.md
View File

@ -13,7 +13,7 @@ running, it serves your embedding model through a secure, publicly accessible ne
endpoint activity and shuts down if the model remains inactive for a specified maximum idle time. endpoint activity and shuts down if the model remains inactive for a specified maximum idle time.
:::info AI Application Gateway :::info AI Application Gateway
The Embedding Model Deployment app makes use of the AI Application Gateway which implements a secure, authenticated The Embedding Model Deployment app makes use of the AI App Gateway Router which implements a secure, authenticated
network endpoint for the model. network endpoint for the model.
If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. If the ClearML AI application Gateway is not available, the model endpoint might not be accessible.

2
docs/webapp/applications/apps_gradio.md
View File

@ -16,7 +16,7 @@ The Gradio launcher monitors the Gradio app activity and shuts down if it is ina
<a id="traffic_router"/> <a id="traffic_router"/>
:::important AI Application Gateway :::important AI Application Gateway
The Gradio Launcher relies on the ClearML Traffic Router which implements user authentication, and redirects requests The Gradio Launcher relies on the ClearML AI App Gateway Router which implements user authentication, and redirects requests
to the IP/port served by the Gradio app. to the IP/port served by the Gradio app.
If the ClearML AI application Gateway is not available, the Gradio app might not be accessible. If the ClearML AI application Gateway is not available, the Gradio app might not be accessible.

2
docs/webapp/applications/apps_llama_deployment.md
View File

@ -12,7 +12,7 @@ running, it serves your model through a secure, publicly accessible network endp
and shuts down if the model remains inactive for a specified maximum idle time. and shuts down if the model remains inactive for a specified maximum idle time.
:::important AI Application Gateway :::important AI Application Gateway
The llama.cpp Model Deployment app makes use of the AI Application Gateway which implements a secure, authenticated The llama.cpp Model Deployment app makes use of the AI App Gateway Router which implements a secure, authenticated
network endpoint for the model. network endpoint for the model.
If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. If the ClearML AI application Gateway is not available, the model endpoint might not be accessible.

2
docs/webapp/applications/apps_model_deployment.md
View File

@ -13,7 +13,7 @@ it serves your model through a secure, publicly accessible network endpoint. The
shuts down if the model remains inactive for a specified maximum idle time. shuts down if the model remains inactive for a specified maximum idle time.
:::info AI Application Gateway :::info AI Application Gateway
The vLLM Model Deployment app makes use of the AI Application Gateway which implements a secure, authenticated The vLLM Model Deployment app makes use of the AI App Gateway Router which implements a secure, authenticated
network endpoint for the model. network endpoint for the model.
If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. If the ClearML AI application Gateway is not available, the model endpoint might not be accessible.

2
docs/webapp/applications/apps_streamlit.md
View File

@ -17,7 +17,7 @@ time.
<a id="traffic_router"/> <a id="traffic_router"/>
:::important AI Application Gateway :::important AI Application Gateway
The Streamlit Launcher relies on the ClearML Traffic Router which implements user authentication, and redirects requests The Streamlit Launcher relies on the ClearML AI App Gateway Router which implements user authentication, and redirects requests
to the IP/port served by the Streamlit app. to the IP/port served by the Streamlit app.
If the ClearML AI application Gateway is not available, the Streamlit app might not be accessible. If the ClearML AI application Gateway is not available, the Streamlit app might not be accessible.