Add app configuration shortcut info (#904)

This commit is contained in:
pollfly 2024-08-19 14:42:12 +03:00 committed by GitHub
parent 04a7436e1b
commit bc6f88ccc6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 124 additions and 5 deletions

View File

@ -20,6 +20,23 @@ each instance is spun up.
For more information about how autoscalers work, see [Autoscalers Overview](../../cloud_autoscaling/autoscaling_overview.md#autoscaler-applications).
## Autoscaler Instance Configuration
When configuring a new AWS Autoscaler instance, you can start from scratch or reuse an existing configuration.
Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration
prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when
viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance.
To configure a new app instance:
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **AWS Credentials** - Credentials with which the autoscaler can access your AWS account. See [Generating AWS IAM Credentials](#generating-aws-iam-credentials)

View File

@ -21,6 +21,22 @@ when each VM instance is spun up.
For more information about how autoscalers work, see [Autoscalers Overview](../../cloud_autoscaling/autoscaling_overview.md#autoscaler-applications).
## Autoscaler Instance Configuration
When configuring a new GCP Autoscaler instance, you can start from scratch or reuse an existing configuration.
Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration
prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when
viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance.
To configure a new app instance:
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **GCP Configuration**

View File

@ -38,7 +38,24 @@ Once you start a Gradio launcher instance, you can view the following informatio
## Gradio Launcher Instance Configuration
When configuring a new Gradio launcher instance, you can start from scratch or reuse an existing configuration.
Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration
prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when
viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance.
To configure a new app instance:
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **Gradio Instance Name** - Name for the Gradio launcher instance. This will appear in the instance list
* **Project name** - Project where your Gradio launcher app instance task will be stored
* **Task name** - Name of task for your Gradio launcher app instance
@ -50,4 +67,6 @@ Once you start a Gradio launcher instance, you can view the following informatio
* **Docker Image** - Docker image the ClearML Agent will use for running the Gradio app
* **Arguments** - Arguments to be passed to the script
* **Idle Time Limit** (Hours) - Maximum idle time (Period in which no requests are received by the Gradio app) after
which the Gradio app and the launcher instance will shut down.
which the Gradio app and the launcher instance will shut down.
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration

View File

@ -27,8 +27,26 @@ Once you have launched an app instance, you can view the following information i
![Jupyter Lab Dashboard](../../img/apps_jupyter_lab.png)
## Extra Python packages to be installedApp Instance Configuration
## App Instance Configuration
When configuring a new Jupyter Lab instance, you can start from scratch or reuse an existing configuration.
Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration
prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when
viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance.
To configure a new app instance:
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **Git** - To access a git repository remotely, add git information.
* Repository
* Branch
@ -44,5 +62,6 @@ Once you have launched an app instance, you can view the following information i
* Idle Network Threshold (MB/s) - Throughput under which the session will be considered idle
* Idle CPU Threshold (%) - CPU utilization under which the session will be considered idle
* Idle GPU Threshold (%) - GPU utilization under which the session will be considered idle
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration

View File

@ -40,7 +40,7 @@ Each application's page is split into two sections:
## Launching an App Instance
1. Choose the desired app
1. Click the `Launch New` button <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to open the app's configuration wizard
1. Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to open the app's configuration wizard
1. Fill in the configuration details
1. **Launch**

View File

@ -38,7 +38,25 @@ Once you start a Streamlit launcher instance, you can view the following informa
changes
## Streamlit Launcher Instance Configuration
When configuring a new Streamlit launcher instance, you can start from scratch or reuse an existing configuration.
Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration
prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when
viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance.
To configure a new app instance:
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **Streamlit Instance Name** - Name for the Streamlit launcher instance. This will appear in the instance list
* **Project name** - Project where your Streamlit launcher app instance task will be stored
* **Task name** - Name of task for your Streamlit launcher app instance
@ -50,4 +68,6 @@ Once you start a Streamlit launcher instance, you can view the following informa
* **Docker Image** - Docker image the ClearML Agent will use for running the Streamlit app
* **Arguments** - Arguments to be passed to the script
* **Idle Time Limit** (Hours) - Maximum idle time (Period in which no requests are received by the Streamlit app) after
which the Streamlit app and the launcher instance will shut down.
which the Streamlit app and the launcher instance will shut down.
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration

View File

@ -16,6 +16,8 @@ times.
## Scheduler Instance Configuration
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **Scheduled Tasks**
* **Base Task ID** - ID of a ClearML task to clone and enqueue for execution at the specified time.
* **Destination Project** - The project where the task will be cloned to.
@ -28,6 +30,8 @@ times.
* **Time of the Day** - The time(s) (UTC) at which the task should run
* **Add item** - Add another task to schedule
* **Scheduling Job Name** - Name for the Scheduler instance. This will appear in the instance list
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration
![TaskScheduler wizard](../../img/apps_taskscheduler_wizard.png)

View File

@ -21,6 +21,8 @@ The app monitors your workspace for trigger events and will launch copies of the
## Trigger Manager Instance Configuration
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **Name** - Name for the app instance. This will appear in the instance list
* **Triggers** - Events whose occurrence will cause a task to be executed
* Task ID - ID of a ClearML task to clone and enqueue
@ -47,6 +49,8 @@ The app monitors your workspace for trigger events and will launch copies of the
* Threshold - The metric threshold to monitor
* Add item - Add another trigger
* **Polling frequency** - Time period in minutes at which the workspace is polled for trigger events
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration
![Trigger manager wizard](../../img/apps_trigger_manager_wizard.png)

View File

@ -28,7 +28,25 @@ Once you have launched an app instance, you can view the following information i
![VS Code Dashboard](../../img/apps_vs_code.png)
## VS Code App Instance Configuration
When configuring a new VS Code instance, you can start from scratch or reuse an existing configuration.
Launch an app instance with the configuration of a previously launched instance using one of the following options:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration
prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when
viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance.
To configure a new app instance:
* Click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to
open the app's configuration wizard
* Fill in the configuration details listed below
### Configuration Options
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **Git** - To access a git repository remotely, add git information.
* Repository
* Branch
@ -45,5 +63,7 @@ Once you have launched an app instance, you can view the following information i
* Idle Network Threshold (MB/s) - Throughput under which the session will be considered idle
* Idle CPU Threshold (%) - CPU utilization under which the session will be considered idle
* Idle GPU Threshold (%) - GPU utilization under which the session will be considered idle
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration