From 793b463f683e5e5b28b7ff070a0d7a37b3c43fd1 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 21 Dec 2023 18:39:19 +0200 Subject: [PATCH] Update AWS Autoscaler UI app (#735) --- .../applications/apps_aws_autoscaler.md | 57 ++++++++++++++++--- 1 file changed, 49 insertions(+), 8 deletions(-) diff --git a/docs/webapp/applications/apps_aws_autoscaler.md b/docs/webapp/applications/apps_aws_autoscaler.md index 082976c7..1e7e0495 100644 --- a/docs/webapp/applications/apps_aws_autoscaler.md +++ b/docs/webapp/applications/apps_aws_autoscaler.md @@ -81,19 +81,60 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.  -:::note Enterprise Feature -You can utilize the [configuration vault](../../webapp/webapp_profile.md#configuration-vault) to configure AWS -credentials for the Autoscaler in the following format: +### Configuration Vault + +:::important Enterprise Feature +The Configuration Vault is available under the ClearML Enterprise plan. +::: + +You can utilize the [configuration vault](../../webapp/webapp_profile.md#configuration-vault) to set the following: +* `aws_region` +* `aws_credentials_key_id` and `aws_secret_access_key` - AWS credentials for the Autoscaler +* `extra_vm_bash_script` - A bash script to execute after launching the EC2 instance. This script will be appended to +the one set in the `Init script` field of the autoscaler wizard +* `extra_clearml_conf` - ClearML configuration to use by the ClearML Agent when executing your experiments. This +configuration will be appended to that set in the `Additional ClearML Configuration` field of the autoscaler wizard + +For example, the following configuration would be applied to all autoscaler instances: ``` -auto_scaler.v1 { - aws { - cloud_credentials_key: "<aws-key>" - cloud_credentials_secret: "<aws-secret>" +auto_scaler.v1.aws { + aws_region: "us-east-1" + aws_access_key_id: "<key>" + aws_secret_access_key: "<secret>" + extra_vm_bash_script: """ + echo "Hello world!" + """ + extra_clearml_conf: """ + agent.docker_force_pull: true + """ +} +``` + +To configure a specific instance(s), add a regular expression to match the autoscaler's `Workers Prefix` under +`auto_scaler.v1.aws.match`. Within this section, input the specific configuration which will be merged to any +matched autoscaler's configuration. + +For example: + +``` +auto_scaler.v1.aws { + # this will be applied to all AWS autoscalers + aws_region: "us-east-2" + + match { + "^aws_test$": { + # this will be applied only to AWS autoscalers who's workers prefix exactly matches aws_test + extra_vm_bash_script: """ echo "Hello world!" """ + } + "^aws_.*$": { + # this will be applied to all AWS autoscalers who's workers prefix starts with aws_ + extra_vm_bash_script: """ echo "Goodbye!" """ + } } } ``` -::: + ## Dashboard Once an autoscaler is launched, the autoscaler's dashboard provides information about available EC2 instances and their