From cf47d251bfaf376931c580c4c57f59f90cf903ee Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 11 Apr 2024 16:10:41 +0300 Subject: [PATCH] Update autoscaler application configuration (#824) --- docs/webapp/applications/apps_aws_autoscaler.md | 9 ++++++++- docs/webapp/applications/apps_gcp_autoscaler.md | 3 ++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/webapp/applications/apps_aws_autoscaler.md b/docs/webapp/applications/apps_aws_autoscaler.md index 76741b93..2fe9ccc7 100644 --- a/docs/webapp/applications/apps_aws_autoscaler.md +++ b/docs/webapp/applications/apps_aws_autoscaler.md @@ -72,13 +72,20 @@ For more information about how autoscalers work, see [Autoscalers Overview](../. * Arn - Amazon Resource Name specifying 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 -* **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 instances are running the same task. In most cases, this indicates an issue. * **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 * **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when 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 a new instance with the same configuration diff --git a/docs/webapp/applications/apps_gcp_autoscaler.md b/docs/webapp/applications/apps_gcp_autoscaler.md index b0415898..283bac38 100644 --- a/docs/webapp/applications/apps_gcp_autoscaler.md +++ b/docs/webapp/applications/apps_gcp_autoscaler.md @@ -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 * **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 -* **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 instances are running the same task. In most cases, this indicates an issue. * **Exclude .bashrc script** - Select in order to skip `.bashrc` script execution * **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 +* **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 a new instance with the same configuration.