clearml-docs/docs/deploying_clearml/clearml_server_aws_ec2_ami.md

---
title: 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](#clearml-server-aws-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](upgrade_server_aws_ec2_ami.md).

:::important
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](clearml_server_security.md) 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](#clearml-server-aws-community-amis) 
and see:

* The AWS Knowledge Center page, [How do I launch an EC2 instance from a custom Amazon Machine Image (AMI)?](https://aws.amazon.com/premiumsupport/knowledge-center/launch-instance-custom-ami/)
* Detailed instructions in the AWS Documentation for [Launching an Instance Using the Launch Instance Wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/launching-instance.html).

## 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.
1. 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](clearml_server_config.md#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`:

```bash
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.
1. Replace any existing data with the backup data:
   ```bash
   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
   ```
1. Grant access to the data:
   ```bash
   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.1

* **af-south-1** : ami-04efa6d3850413f44
* **ap-east-1** : ami-0c9e7c16d8d4cab69
* **ap-northeast-1** : ami-00dd0cb01c3b25ed3
* **ap-northeast-2** : ami-0c058a67bf00f75e5
* **ap-northeast-3** : ami-015408b1e7e04ecaa
* **ap-south-1** : ami-05d51f70dce24d51c
* **ap-south-2** : ami-085f86c261d84c768
* **ap-southeast-1** : ami-0e24c25769ea43b24
* **ap-southeast-2** : ami-0ca52ca06ef568c16
* **ap-southeast-3** : ami-0bb76a9ba8c23639d
* **ap-southeast-4** : ami-05c54a10f3c932683
* **ca-central-1** : ami-018b94fe16dbba1e4
* **ca-west-1** : ami-02a6c0c23823e5d49
* **eu-central-1** : ami-02fb9796acd913d73
* **eu-central-2** : ami-0a262efc258244efb
* **eu-north-1** : ami-0fac51ab15b088a6e
* **eu-south-1** : ami-0f660d03e983d5304
* **eu-south-2** : ami-0917518c71cce4966
* **eu-west-1** : ami-00f05408da2674aa0
* **eu-west-2** : ami-027f63a70e70a92b8
* **eu-west-3** : ami-008eb25d0a127d2b9
* **il-central-1** : ami-026173238b4e5e517
* **me-central-1** : ami-0004dc2210c9300cb
* **me-south-1** : ami-01e51a07db860b8c3
* **sa-east-1** : ami-04cdda5744fb22bad
* **us-east-1** : ami-0b7bb8741dac34752
* **us-east-2** : ami-04fc2f5cf9bdc72b6
* **us-west-1** : ami-0b4fef3673433d075
* **us-west-2** : ami-0327adc54a82c8d1d

## Next Step

To keep track of your experiments and/or data, the `clearml` package needs to communicate with your server. 
For instruction to connect the ClearML SDK to the server, see [Getting Started: First Steps](../getting_started/ds/ds_first_steps.md).