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

Small edits (#1020)
Some checks are pending
CI / build (push) Waiting to run
Details

Browse Source
This commit is contained in:
pollfly
2025-01-28 10:22:37 +02:00
committed by GitHub
parent 10c44dd4a1
commit 7388083880
5 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/webapp/applications/apps_ssh_session.md
View File

@@ -61,25 +61,25 @@ to open the app's instance launch form.
### Configuration Options
* Import Configuration - Import an app instance configuration file. This will fill the instance launch form with the
* **Import Configuration** - Import an app instance configuration file. This will fill the instance launch form with the
values from the file, which can be modified before launching the app instance
* Git - The details for a git repository to optionally clone into your remote environment:
* **Git** - The details for a git repository to optionally clone into your remote environment:
* Repository
* Branch
* Commit
* Docker - Input details to run the session in Docker container
* **Docker** - Input details to run the session in Docker container
* Image - Docker image to launch
* Docker Arguments - Additional arguments for the Docker image
* Init Script - Bash script that is executed upon container boot (comments are supported only at the beginning of the
line)
* Extra Packages - Specify Python packages to install when setting up the remote environment
* Persistent Workspace Path - Specify your workspace root directory, it will be automatically stored when the session is
* **Extra Packages** - Specify Python packages to install when setting up the remote environment
* **Persistent Workspace Path** - Specify your workspace root directory, it will be automatically stored when the session is
closed and restored into a new instance when the session app instance is cloned (example: `~/workspace`)
* Queue - The [ClearML Queue](../../fundamentals/agents_and_queues.md#what-is-a-queue) to which the SSH Session app
* **Queue** - The [ClearML Queue](../../fundamentals/agents_and_queues.md#what-is-a-queue) to which the SSH Session app
instance task will be enqueued (make sure an agent is assigned to that queue)
* Maximum idle time (in hours) - Maximum idle time after which the app instance will shut down
* Interactive Session Name - Name your current interactive session
* Advanced Options
* **Maximum idle time** (in hours) - Maximum idle time after which the app instance will shut down
* **Interactive Session Name** - Name your current interactive session
* **Advanced Options**
* Interactive Session Project - The project in which the interactive session is created. If left empty, the default
project `Interactive Session` is used
* Interactive Session Tags - Comma separated list of tags to add to your interactive session
@@ -89,7 +89,7 @@ closed and restored into a new instance when the session app instance is cloned
* Idle Network Threshold (MB) - Network 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
* **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
![SSH Session form](../../img/apps_ssh_session_wizard.png)