Skip to main content

AWS EC2 AMIs

Deployment of ClearML Server on AWS is easily performed using AWS AMIs, which are available in the AWS community AMI catalog. The ClearML Server community AMIs are configured by default without authentication to allow quick access and onboarding.

After deploying the AMI, configure the ClearML Server instance to provide the authentication scheme that best matches the workflow.

For information about upgrading a ClearML Server in an AWS instance, see here.

info

If ClearML Server is being reinstalled, clearing browser cookies for ClearML Server is recommended. For example, for Firefox, go to Developer Tools > Storage > Cookies, and for Chrome, go to Developer Tools > Application > Cookies, and delete all cookies under the ClearML Server URL.

Launching​

caution

By default, ClearML Server deploys as an open network. To restrict ClearML Server access, follow the instructions in the Security page.

The minimum recommended amount of RAM is 8 GB. For example, a t3.large or t3a.large EC2 instance type would accommodate the recommended RAM size.

To launch a ClearML Server AWS community AMI, use one of the ClearML Server AWS community AMIs and see:

Accessing ClearML Server​

Once deployed, ClearML Server exposes the following services:

  • Web server on TCP port 8080
  • API server on TCP port 8008
  • File Server on TCP port 8081

To locate ClearML Server address:

  1. Go to AWS EC2 Console.
  2. In the Details tab, Public DNS (IPv4) shows the ClearML Server address.

To access ClearML Server WebApp (UI):

  • Direct browser to its web server URL: http://<Server Address>:8080

To SSH into ClearML Server:

  • Log into the AWS AMI using the default username ec2-user. Control the SSH credentials from the AWS management console.

Logging in to the WebApp (UI)​

Enter any name to log in to the ClearML WebApp (UI). If needed, modify the default login behavior to match workflow policy, see Configuring Web Login Authentication on the "Configuring Your Own ClearML Server" page.

Storage Configuration​

The pre-built ClearML Server storage configuration is the following:

  • MongoDB: /opt/clearml/data/mongo_4/
  • Elasticsearch: /opt/clearml/data/elastic_7/
  • File Server: /opt/clearml/data/fileserver/

Backing Up and Restoring Data and Configuration​

caution

Stop your server before backing up or restoring data and configuration

note

If data is being moved between a Trains Server and a ClearML Server installation, make sure to use the correct paths for backup and restore (/opt/trains and /opt/clearml respectively).

The commands in this section are examples for backing up and restoring data and configuration.

If data and configuration folders are in /opt/clearml, then archive all data into ~/clearml_backup_data.tgz, and configuration into ~/clearml_backup_config.tgz:

sudo tar czvf ~/clearml_backup_data.tgz -C /opt/clearml/data .
sudo tar czvf ~/clearml_backup_config.tgz -C /opt/clearml/config .

If data and configuration need to be restored:

  1. Verify you have the backup files.
  2. Replace any existing data with the backup data:
    sudo rm -fR /opt/clearml/data/* /opt/clearml/config/*
    sudo tar -xzf ~/clearml_backup_data.tgz -C /opt/clearml/data
    sudo tar -xzf ~/clearml_backup_config.tgz -C /opt/clearml/config
  3. Grant access to the data:
    sudo chown -R 1000:1000 /opt/clearml

ClearML Server AWS Community AMIs​

The following section contains a list of AMI Image IDs per-region for the latest ClearML Server version.

Latest Version​

v1.15.0​

  • af-south-1 : ami-00588db413be68efe
  • ap-east-1 : ami-0799044c29fded34e
  • ap-northeast-1 : ami-02d65fcc0f55994a0
  • ap-northeast-2 : ami-080dfab2b5bb0d8b9
  • ap-northeast-3 : ami-057dffc8f2f2735dd
  • ap-south-1 : ami-0012e733c8554ab05
  • ap-south-2 : ami-02c8bf629d03f98ac
  • ap-southeast-1 : ami-0ab7f1a25112a1780
  • ap-southeast-2 : ami-0788dd3fb6731f7bc
  • ap-southeast-3 : ami-0b8e4e04ac9126d6f
  • ap-southeast-4 : ami-058bd99267f35cfbb
  • ca-central-1 : ami-08ea8ff364f8ec570
  • ca-west-1 : ami-0bccef2cd4f66e37b
  • eu-central-1 : ami-0deab56eb3e29826c
  • eu-central-2 : ami-008c21960dc713d91
  • eu-north-1 : ami-054542654592e7ca0
  • eu-south-1 : ami-0a322333fe24d90f6
  • eu-south-2 : ami-0983b0c11666333cf
  • eu-west-1 : ami-05c86376e6913f6c2
  • eu-west-2 : ami-0bd8a72170a908c9d
  • eu-west-3 : ami-099c539ede777e53c
  • il-central-1 : ami-0f9389e102a4947f1
  • me-central-1 : ami-0e0c482f6befaed52
  • me-south-1 : ami-075a22f8360c056df
  • sa-east-1 : ami-065b4d41a975945ea
  • us-east-1 : ami-04f41d5829c505e9d
  • us-east-2 : ami-07b81aabb1f4eeca4
  • us-west-1 : ami-094720a8f0c14570c
  • us-west-2 : ami-044daba414cfcd7f6

Next Step​