diff --git a/docs/deploying_clearml/clearml_server_aws_ec2_ami.md b/docs/deploying_clearml/clearml_server_aws_ec2_ami.md index acf82822..d0edab32 100644 --- a/docs/deploying_clearml/clearml_server_aws_ec2_ami.md +++ b/docs/deploying_clearml/clearml_server_aws_ec2_ami.md @@ -2,15 +2,11 @@ title: AWS EC2 AMIs --- -Deployment of **ClearML Server** on AWS is easily performed using AWS AMIs, which are available in the AWS Marketplace catalog -and in the AWS community AMI catalog. +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. -* AWS Marketplace ClearML Server is coming soon - Preconfigured with unique initial access credentials. Until it arrives, - use [AWS Marketplace Trains Server](https://aws.amazon.com/marketplace/pp/B085D8W5NM) with the instructions on the page. - -* [ClearML Server community AMIs](#clearml-server-aws-community-amis) - Configured by default without authentication to allow quick access and onboarding. - -After deploying either type of AMI, configure the ClearML Server instance to provide the authentication scheme that +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). @@ -30,42 +26,11 @@ 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: -### AWS Community AMIs - -**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). - -### AWS Marketplace AMIs - -**To launch a ClearML Server AWS Marketplace AMI through the AWS Marketplace website:** - -1. Open the AWS Marketplace for the [Allegro AI ClearML Server](https://aws.amazon.com/marketplace/pp/B085D8W5NM). -1. In the heading area, click **Continue to Subscribe**. -1. On the **Subscribe to software** page, click **Accept Terms**, and then click **Continue to Configuration**. -1. On the **Configure this software** page, complete the following: - - 1. In the **Fulfillment Option** list, select **64-bit (x86) Amazon Machine Image (AMI)**. - 1. In the **Software Version** list, select your **ClearML Server** version. For example, **0.13.0 (Mar 02, 2020)**. - 1. In the **Region** list, select your region. - 1. Click **Continue to Launch**. - -1. On the **Launch this software** page, in the **Choose Action** list, select either of following options, and perform the steps for that option: - - * **Launch through EC2**: - - 1. Click **Launch**. - 1. Follow the instructions on the [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/) AWS documentation page. - - * **Launch from Website**: - - 1. Select required settings: EC2 Instance Type, VPC Settings, Subnet Settings, Security Group Settings, and Key Pair Settings. - 1. Click **Launch**. - 1. On the **Launch this software** page, note your Instance ID. You can use it later to search for your instance in the EC2 Console. +* 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 @@ -75,12 +40,12 @@ Once deployed, **ClearML Server** exposes the following services: * API server on `TCP port 8008` * File Server on `TCP port 8081` -**To locate **ClearML Server** address:** +**To locate ClearML Server address:** 1. Go to AWS EC2 Console. -1. In the **Details** tab, **Public DNS (IPv4)** shows the **ClearML Server** address. +1. In the **Details** tab, **Public DNS (IPv4)** shows the ClearML Server address. -**To access **ClearML Server** Web-App (UI):** +**To access ClearML Server Web-App (UI):** * Direct browser to its web server URL: `http://:8080` @@ -88,23 +53,15 @@ Once deployed, **ClearML Server** exposes the following services: * Log into the AWS AMI using the default username `ec2-user`. Control the SSH credentials from the AWS management console. -### Logging in to the Web-App (UI) +### Logging in to the WebApp (UI) -**To log in to the ClearML Web-App (UI):** - -* If **ClearML Server** was launched from an AWS Community AMI, enter any name. -* If **ClearML Server** was launched through the AWS Marketplace, enter the preconfigured default login credentials, which - are: - - * **clearml-user** (the default username). - * The **ClearML Server** EC2 instance ID (the default password). - -If needed, modify the default login behavior to match workflow policy, see [Configuring Web Login Authentication](clearml_server_config.md#web-login-authentication) +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: +The pre-built ClearML Server storage configuration is the following: * MongoDB: `/opt/clearml/data/mongo_4/` * Elasticsearch: `/opt/clearml/data/elastic_7/` @@ -115,7 +72,7 @@ The pre-built **ClearML Server** storage configuration is the following: :::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). +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. @@ -145,7 +102,7 @@ sudo tar czvf ~/clearml_backup_config.tgz -C /opt/clearml/config . ## ClearML Server AWS Community AMIs -The following section contains a list of AMI Image IDs per region for the latest **ClearML Server** version. +The following section contains a list of AMI Image IDs per-region for the latest ClearML Server version.