mirror of
https://github.com/clearml/clearml-docs
synced 2025-05-21 12:36:42 +00:00
Add App Gateway Settings Page
This commit is contained in:
parent
739ac4e7cf
commit
3b976cb303
@ -6,6 +6,14 @@ title: Docker-Compose Deployment
|
||||
The Application Gateway is available under the ClearML Enterprise plan.
|
||||
:::
|
||||
|
||||
The AI Application Gateway enables external HTTP(S) or direct TCP access to ClearML tasks and applications running on
|
||||
nodes. The gateway is configured with an endpoint or external address, making these services accessible from the user's
|
||||
machine, outside the workload’ network.
|
||||
|
||||
This guide describes how to install and run the ClearML AI Application Gateway using docker-compose for environments
|
||||
where you manage both the ClearML Server and the workload nodes.
|
||||
|
||||
|
||||
## Requirements
|
||||
|
||||
* Linux OS (x86) machine
|
||||
@ -155,3 +163,11 @@ Each router's `runtime.env` file should include:
|
||||
```
|
||||
|
||||
Make sure `LISTEN_QUEUE_NAME` is set in the [`docker-compose` environment variables](#docker-compose-file) for each router instance.
|
||||
|
||||
## Monitoring and Testing the Gateway
|
||||
|
||||
Once your gateway is deployed, you can monitor its status, view routed tasks, and run connectivity tests in
|
||||
ClearML WebApp, under **Settings > Application Gateway**.
|
||||
|
||||

|
||||

|
@ -163,4 +163,12 @@ to `false` in the `runtime.env` file.
|
||||
LISTEN_QUEUE_NAME=queue3,queue4
|
||||
```
|
||||
|
||||
Make sure `LISTEN_QUEUE_NAME` is set in the [`docker-compose` environment variables](#docker-compose-file) for each router instance.
|
||||
Make sure `LISTEN_QUEUE_NAME` is set in the [`docker-compose` environment variables](#docker-compose-file) for each router instance.
|
||||
|
||||
## Monitoring and Testing the Gateway
|
||||
|
||||
Once your gateway is deployed, you can monitor its status, view routed tasks, and run connectivity tests in
|
||||
ClearML WebApp, under **Settings > Application Gateway**.
|
||||
|
||||

|
||||

|
@ -104,4 +104,12 @@ Replace the placeholders with the following values:
|
||||
namespace. The App Gateway monitors the same namespace for AI workloads (e.g. remote IDE applications). The App Gateway has a
|
||||
namespace-limited scope, meaning it can only detect and manage tasks within its
|
||||
assigned namespace.
|
||||
* `<CHART_VERSION>` - Version recommended by the ClearML Support Team.
|
||||
* `<CHART_VERSION>` - Version recommended by the ClearML Support Team.
|
||||
|
||||
## Monitoring and Testing the Gateway
|
||||
|
||||
Once your gateway is deployed, you can monitor its status, view routed tasks, and run connectivity tests in
|
||||
ClearML WebApp, under **Settings > Application Gateway**.
|
||||
|
||||

|
||||

|
BIN
docs/img/settings_app_gateway.png
Normal file
BIN
docs/img/settings_app_gateway.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 59 KiB |
BIN
docs/img/settings_app_gateway_dark.png
Normal file
BIN
docs/img/settings_app_gateway_dark.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 61 KiB |
BIN
docs/img/settings_app_gateway_info.png
Normal file
BIN
docs/img/settings_app_gateway_info.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 85 KiB |
BIN
docs/img/settings_app_gateway_info_dark.png
Normal file
BIN
docs/img/settings_app_gateway_info_dark.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 86 KiB |
BIN
docs/img/settings_app_gateway_test.png
Normal file
BIN
docs/img/settings_app_gateway_test.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 102 KiB |
BIN
docs/img/settings_app_gateway_test_dark.png
Normal file
BIN
docs/img/settings_app_gateway_test_dark.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 101 KiB |
66
docs/webapp/settings/webapp_settings_app_gw.md
Normal file
66
docs/webapp/settings/webapp_settings_app_gw.md
Normal file
@ -0,0 +1,66 @@
|
||||
---
|
||||
title: Application Gateway
|
||||
---
|
||||
|
||||
The ClearML [AI Application Gateway](../../deploying_clearml/enterprise_deploy/appgw.md) facilitates setting up secure,
|
||||
authenticated access to jobs running on your compute nodes from external networks (see application gateway installation
|
||||
for [Kubernetes](../../deploying_clearml/enterprise_deploy/appgw_install_k8s.md), [Docker-Compose Self-Hosted Deployment](../../deploying_clearml/enterprise_deploy/appgw_install_compose.md)
|
||||
or [Docker-Compose Hosted Deploynment](../../deploying_clearml/enterprise_deploy/appgw_install_compose_hosted.md)).
|
||||
|
||||
The **Application Gateway** table lets you monitor all active application gateway routers, as well as verify gateway functionality. The table shows each router’s:
|
||||
* Name
|
||||
* Externally accessible URL
|
||||
* Test Status: The result of the most recent connectivity test
|
||||
* Last Tested: The time the router was last tested
|
||||
|
||||

|
||||

|
||||
|
||||
Click on a router to open its details panel, which includes:
|
||||
* **Info**: General router information
|
||||
* Router details
|
||||
* Uptime
|
||||
* Last update time
|
||||
* Router version
|
||||
* Routed Tasks table: ClearML tasks currently available for access through the router
|
||||
* Task name: Click to navigate to the task page
|
||||
* Endpoint: Exposed application URL
|
||||
* Owner: User who initiated the task
|
||||
|
||||

|
||||

|
||||
|
||||
* **Test Details**: Administrators can run a test to verify that a gateway is functioning correctly: Identifying routed
|
||||
tasks and creating accessible network endpoints for them. The test launches a small task in the target network
|
||||
(specified through the desired ClearML queue), and checks that the router successfully creates a route to that task,
|
||||
and routes the network traffic to it.
|
||||
|
||||
To run a test:
|
||||
1. Hover over the **Test Details** panel **>** Click **Test**
|
||||
1. Input a queue that is serviced by agents in the network environment the router should provide access to
|
||||
1. Click **Test**
|
||||
|
||||
<br/>
|
||||
|
||||
:::note
|
||||
Testing is only supported when both the ClearML WebApp and the gateway endpoint are served over secure (HTTPS) protocols.
|
||||
:::
|
||||
|
||||
The **Test Details** tab displays:
|
||||
* Status - Result of the most recent test
|
||||
* Status message
|
||||
* Status reason
|
||||
* Started time
|
||||
* Completed time
|
||||
* Run time
|
||||
* Queue - Queue where test task was enqueued for execution
|
||||
* Worker - ClearML Agent that executed the test task
|
||||
* Test Task name
|
||||
* Task ID
|
||||
* Browser endpoint
|
||||
* Endpoint
|
||||
|
||||

|
||||

|
||||
|
||||
* **Test log**: Console output of the most recent router test.
|
@ -24,6 +24,8 @@ The Settings page consists of the following sections:
|
||||
* [Identity Providers](webapp_settings_id_providers.md) (ClearML Enterprise Server) - Manage server identity providers
|
||||
* [Resource Configuration](webapp_settings_resource_configs.md) (ClearML Enterprise Server) - Define the available resources and the way in which they
|
||||
will be allocated to different workloads
|
||||
* [Application Gateway](webapp_settings_app_gw.md) (ClearML Enterprise Server) - Monitor all active application
|
||||
gateways, and verify gateway functionality
|
||||
* [Billing & Usage](webapp_settings_usage_billing.md) (ClearML Hosted Service) - View current billing details and usage information
|
||||
* [Storage Cleanup](webapp_settings_storage_credentials.md) (ClearML Enterprise Server) - Configure storage provider access credentials to
|
||||
enable ClearML to delete artifacts stored in cloud storage when tasks and models are deleted
|
@ -581,6 +581,7 @@ module.exports = {
|
||||
'webapp/settings/webapp_settings_access_rules',
|
||||
'webapp/settings/webapp_settings_id_providers',
|
||||
'webapp/settings/webapp_settings_resource_configs',
|
||||
'webapp/settings/webapp_settings_app_gw',
|
||||
'webapp/settings/webapp_settings_usage_billing',
|
||||
'webapp/settings/webapp_settings_storage_credentials'
|
||||
]
|
||||
|
Loading…
Reference in New Issue
Block a user