ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-10 06:01:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update autoscaler application configuration (#824)

Browse Source
This commit is contained in:
pollfly 2024-04-11 16:10:41 +03:00 committed by GitHub
parent 73dbfe2df7
commit cf47d251bf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/webapp/applications/apps_aws_autoscaler.md
View File

@ -72,13 +72,20 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.
* Arn - Amazon Resource Name specifying the instance profile * Arn - Amazon Resource Name specifying the instance profile
* Name - Name identifying the instance profile * Name - Name identifying the instance profile
* **Autoscaler Instance Name** (optional) - Name for the Autoscaler instance. This will appear in the instance list * **Autoscaler Instance Name** (optional) - Name for the Autoscaler instance. This will appear in the instance list
* **Apply Task Owner Vault Configuration** - Select to apply values from the task owner's [ClearML vault](../webapp_profile.md#configuration-vault) when executing the task * **Apply Task Owner Vault Configuration** - Select to apply values from the task owner's [ClearML vault](../webapp_profile.md#configuration-vault) when executing the task (available under ClearML Enterprise Plan)
* **Warn if more than one instance is executing the same task** - Select to print warning to console when multiple * **Warn if more than one instance is executing the same task** - Select to print warning to console when multiple
instances are running the same task. In most cases, this indicates an issue. instances are running the same task. In most cases, this indicates an issue.
* **Exclude .bashrc script** - Select in order to skip `.bashrc` script execution * **Exclude .bashrc script** - Select in order to skip `.bashrc` script execution
* **Ignore vault parsing errors** - If not selected, the autoscaler will abort if encountering errors when loading vaults
on startup. This only applies to vaults loaded by the autoscaler itself, not to vaults loaded on cloud instances or by
tasks run by the autoscaler. For more information, see [Configuration Vault](#configuration-vault) (available under ClearML Enterprise Plan).
* **Init script** (optional) - A bash script to execute after launching the EC2 instance * **Init script** (optional) - A bash script to execute after launching the EC2 instance
* **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when * **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when
executing your experiments executing your experiments
* **Custom Launch Spec** - Custom AWS EC2 launch specification in JSON format. This will be used as the basis for
creating the instances launch spec. See [boto3 EC2.client.run_instances Request Syntax](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/run_instances.html)
and [AWS API Reference: RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) (available under ClearML Enterprise Plan)
* **Run with Service Account** - Select to allow running the application under a [Service Account](../webapp_profile.md#service-accounts) identity instead of under your own identity (available under ClearML Enterprise Plan)
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create * **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 a new instance with the same configuration

3
docs/webapp/applications/apps_gcp_autoscaler.md
View File

@ -54,12 +54,13 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.
* **Max Idle Time** (optional) - Maximum time in minutes that a VM instance can be idle before the autoscaler spins it down * **Max Idle Time** (optional) - Maximum time in minutes that a VM instance can be idle before the autoscaler spins it down
* **Workers Prefix** (optional) - A Prefix added to workers' names, associating them with this autoscaler * **Workers Prefix** (optional) - A Prefix added to workers' names, associating them with this autoscaler
* **Polling Interval** (optional) - Time period in minutes at which the designated queue is polled for new tasks * **Polling Interval** (optional) - Time period in minutes at which the designated queue is polled for new tasks
* **Apply Task Owner Vault Configuration** - Select to apply values from the task owner's [ClearML vault](../webapp_profile.md#configuration-vault) when executing the task * **Apply Task Owner Vault Configuration** - Select to apply values from the task owner's [ClearML vault](../webapp_profile.md#configuration-vault) when executing the task (available under ClearML Enterprise Plan)
* **Warn if more than one instance is executing the same task** - Select to print warning to console when multiple * **Warn if more than one instance is executing the same task** - Select to print warning to console when multiple
instances are running the same task. In most cases, this indicates an issue. instances are running the same task. In most cases, this indicates an issue.
* **Exclude .bashrc script** - Select in order to skip `.bashrc` script execution * **Exclude .bashrc script** - Select in order to skip `.bashrc` script execution
* **Init Script** (optional) - A bash script to execute after launching the VM instance * **Init Script** (optional) - A bash script to execute after launching the VM instance
* **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when executing your experiments * **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when executing your experiments
* **Run with Service Account** - Select to allow running the application under a [Service Account](../webapp_profile.md#service-accounts) identity instead of under your own identity (available under ClearML Enterprise Plan)
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create * **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. a new instance with the same configuration.