How To Update ER Cloud

This section covers the following topics:

• Overview
• Requirements
• Update the Master Server
• Update the Amazon Operating System
• Update the Amazon Machine Image (AMI)
• Features that Require AMI Updates

Overview

With each new release of ER Cloud, you are recommended to:

1. Create a backup of the Master Server.
2. Update the Master Server to access new features and benefit from improvements made to the software.
3. (If applicable) Update the Amazon Machine Image (AMI) to use the features available in the updated version of the AMI. For the list of changes that require an AMI update, refer to Features that Require AMI Updates below.
4. (Optional) Perform an Agent Upgrade if a feature available in an updated version of the Agent is required.

To keep the Amazon Linux OS up to date, refer to Update the Amazon Operating System below.

Requirements

To perform an upgrade of ER Cloud, the Master Server needs access to the internet.

Update the Master Server

1. Create a backup of the Master Server datastore.

2. Run the following commands:

   # SSH to the EC2 instance ssh -i <path-to-the-sshkey.pem-file> ec2-user@<IP address or public DNS name>
# Run the ER Cloud update command /home/ec2-user/er-cloud.sh update

3. Update the Amazon Operating System.

Update the Amazon Operating System

1. Identify the volume ID of the root partition of the operating system.

   # SSH to the EC2 instance ssh -i <path-to-the-sshkey.pem-file> ec2-user@<IP address or public DNS name>
# Get the volume ID of the root partition sudo /sbin/ebsnvme-id -v $(findmnt -n -o SOURCE /) This command returns the volume ID that you must back up in the next step.

2. Create a backup using an Amazon EBS Snapshot of the volume ID identified in the previous step above.

3. After creating a snapshot of the volume, update the operating system to the latest version of Amazon Linux.

   sudo dnf update --releasever=latest This command checks for and displays all available updates for the underlying operating system.

4. Enter y to install available updates.

5. Verify if restarting your system is required, and restart (if needed).

   # Check if a restart is required sudo needs-restarting -r
# If required, restart the system sudo shutdown -r now

   If it returns a “command not found” error, install the dnf-utils by running the command sudo dnf install -y dnf-utils.

Update the Amazon Machine Image (AMI)

1. Log in to the AWS IAM console.
2. On the upper left part of the screen, click Services > All Services > EC2.
3. In the left navigation panel of the EC2 Dashboard, under Instances section, click Instances.
4. From the list of instances on the Instances page, select the EC2 instance.
5. On the upper right side of the page, from the Instances state dropdown, select Stop instance.
6. When prompted for confirmation, click Stop.
   It may take a few minutes for the instance status to change to “Stopped”.
7. Log in to your AWS Marketplace account (or simply click Services > All Services > AWS Marketplace on the upper left part of the screen from your EC2 dashboard).
8. In the left navigation panel, click Manage subscriptions.
9. On the upper right side of the page, click Actions > Launch CloudFormation stack.
10. For the Fulfillment option field, select the same option as your existing ER Cloud deployment.
11. For the Software version field, select the latest version available.
12. For the Region field, select the same region as your existing ER Cloud deployment.
13. Click Continue to Launch.
14. From the dropdown menu under Choose Action, select Launch CloudFormation.
15. Click Launch. The page redirects to the CloudFormation console.
16. In the Create stack page, copy the contents of the Amazon S3 URL field and click Cancel to return to the CloudFormation stack list.
17. From the stack list, select your existing ER Cloud stack and click Update.
18. Select Replace existing template.
19. In the Template source section, select Amazon S3 URL.
20. In the Amazon S3 URL field, paste the template source URL you copied in the step above, and click Next.
21. Click Next again until you reach the review page.
22. On the Review <stack-name> page, review the changes and click Submit.
    It may take a while for the stack to be updated.

23. Remove the old EC2 instance from the SSH known hosts file to be able to log in to your updated instance.

    ssh-keygen -R "<ER Cloud IP address>"

For the list of changes that require an AMI update, refer to Features that Require AMI Updates below.

Features that Require AMI Updates

To upgrade the AMI, refer to the Update the Amazon Machine Image (AMI) section.

AMI updates are not required unless a feature available in an updated version of the AMI is required. Otherwise, older versions of the AMI are compatible with newer versions of the Master Server.

Upgrade the AMI to the corresponding version below to use the features and/or apply the changes.