diff --git a/docs/deploying_clearml/enterprise_deploy/appgw.md b/docs/deploying_clearml/enterprise_deploy/appgw.md index 85ce6fef..f556c23c 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw.md @@ -30,12 +30,12 @@ their instances: * [Embedding Model Deployment](../../webapp/applications/apps_embed_model_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. -If your ClearML Deployment does not have the Task Traffic Router properly installed, these application instances may not be accessible. +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 AI App Gateway Router properly installed, these application instances may not be accessible. #### Installation -The AI Application Gateway supports two deployment options: +The AI Application Gateway Router supports two deployment options: * [Docker Compose](appgw_install_compose.md) * [Kubernetes](appgw_install_k8s.md) diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md index e4acc3b8..b9da9362 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md @@ -89,7 +89,7 @@ TCP_PORT_END= ``` 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_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. diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md index e23b191e..8626af2d 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md @@ -6,12 +6,12 @@ title: Kubernetes Deployment The AI Application Gateway is available under the ClearML Enterprise plan. ::: -This guide details the installation of the ClearML AI Application Gateway. -The AI Application Gateway enables access to session-based applications like VSCode and Jupyter. +This guide details the installation of the ClearML AI App Gateway Router. +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. :::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. ::: @@ -44,7 +44,7 @@ Replace `` with your valid GitHub token that has access to the Cle ### 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: @@ -74,7 +74,7 @@ Edit it according to these guidelines: * `clearml.apiServerSecret`: ClearML server secret key. * `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.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. * `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`. @@ -103,6 +103,6 @@ allegroai-enterprise/clearml-enterprise-task-traffic-router \ Replace the placeholders with the following values: -* `` - Unique name for the AI Application Gateway within the namespace. This name will appear in the UI and be used for the redirection URL. +* `` - 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. * `` - Namespace that will be shared with a dedicated ClearML Agent. * `` - Version recommended by the ClearML Support Team. \ No newline at end of file diff --git a/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md b/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md index a177ba5b..cd205eee 100644 --- a/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md @@ -513,9 +513,9 @@ Create a `NetworkPolicy` in the tenant namespace with the following configuratio - 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: @@ -531,7 +531,7 @@ Install the [AI App Gateway](appgw.md) in your Kubernetes cluster, allowing it t hostName: "" ``` -2. Install Task Traffic Router in the specified tenant namespace: +2. Install AI App Gateway Router in the specified tenant namespace: ``` helm install -n \\ diff --git a/docs/webapp/applications/apps_embed_model_deployment.md b/docs/webapp/applications/apps_embed_model_deployment.md index 83ba71a6..4743ee24 100644 --- a/docs/webapp/applications/apps_embed_model_deployment.md +++ b/docs/webapp/applications/apps_embed_model_deployment.md @@ -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. :::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. If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. diff --git a/docs/webapp/applications/apps_gradio.md b/docs/webapp/applications/apps_gradio.md index 31e48b92..59ba538c 100644 --- a/docs/webapp/applications/apps_gradio.md +++ b/docs/webapp/applications/apps_gradio.md @@ -16,7 +16,7 @@ The Gradio launcher monitors the Gradio app activity and shuts down if it is ina :::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. If the ClearML AI application Gateway is not available, the Gradio app might not be accessible. diff --git a/docs/webapp/applications/apps_llama_deployment.md b/docs/webapp/applications/apps_llama_deployment.md index 375ff0b1..93548c2b 100644 --- a/docs/webapp/applications/apps_llama_deployment.md +++ b/docs/webapp/applications/apps_llama_deployment.md @@ -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. :::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. If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. diff --git a/docs/webapp/applications/apps_model_deployment.md b/docs/webapp/applications/apps_model_deployment.md index 250ef0ae..7b043fd7 100644 --- a/docs/webapp/applications/apps_model_deployment.md +++ b/docs/webapp/applications/apps_model_deployment.md @@ -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. :::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. If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. diff --git a/docs/webapp/applications/apps_streamlit.md b/docs/webapp/applications/apps_streamlit.md index 4741a3e5..f93905c5 100644 --- a/docs/webapp/applications/apps_streamlit.md +++ b/docs/webapp/applications/apps_streamlit.md @@ -17,7 +17,7 @@ time. :::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. If the ClearML AI application Gateway is not available, the Streamlit app might not be accessible.