Upgrade SBC SWe on AWS

In this section:

Customer Method to Install Life Cycle Manager

The Ribbon Life Cycle Manager (LCM) provides SBC upgrades in AWS. Once the LCM AMI is launched, files aws_access.yml and upgrade-revert.yml templates (needed for upgrade) are located in the user-specified path.

Example: /home/ec2-user/9.2/iac/management/SBC/upgrade

Prerequisite

Determine a Linux AMI to use for the LCM using the procedure in Locate Linux AMI ID for use in LCM deployments.
Retrieve the RBBN LCM scripts from the Ribbon Support Portal.
- The minimum supported version is iac_sustaining_23.04_b307.tar.gz

Steps

Launch a t2.micro instance with LCM AMI.
Once successfully instantiated, log into the instance as ec2-user and switch to root:
```
ssh -i lcm.pem ec2-user@<LCM instance IP address>
sudo su -
```
Create a directory within /home/ec2-user/ using the command:
```
mkdir /home/ec2-user/iac
```
Copy the LCM tarball IAC package to /home/ec2-user/iac.
Untar the tarball inside /home/ec2-user/iac using the command:
```
tar -xzvf iac_sustaining_*.tar.gz
```
Change to the /home/ec2-user/iac directory and view the README file for any updated instructions.
Install python-pip package using method appropriate for OS - see examples:
1. Amazon Linux 2 AMI (HVM), SSD Volume Type (x86_64): amazon-linux-extras install epel; yum install -y python-pip
2. CentOS7 : yum install -y epel-release; yum install -y python2-pip
3. RHEL7: yum install -y python2-pip
4. Debian9/Ubuntu18: apt-get install python-pip
Install Python virtual environment.
```
pip2 install virtualenv
```
Create virtual environment and provide a name e.g. 'iacenv'.
```
virtualenv -p /usr/bin/python2 iacenv
```
Activate virtual environment.
```
source iacenv/bin/activate
```
Complete the LCM setup by installing the required packages and setup the environment.
```
/setup.py
```
Change directory to /home/ec2-user/iac/management/SBC/upgrade.
List the contents of the directory.
Ensure the following files are present:
1. upgrade.py
2. aws_access.yml
3. upgrade-revert.yml

It is safe to shut down the LCM instance after the process finishes. If you decide to terminate/remove the LCM instance, you must make a backup of /var/log/ribbon which is required for future reversions and debugging.

Customer Methods for Upgrading and Reverting

Prerequisites

The new SBC and LCM AMI must be uploaded and available in AWS.
You must have an AWS Instance (t2.micro) with installed Life Cycle Manager (LCM) AMI. (The default aws_access.yml, upgrade-revert.yml, will be present in the /home/ec2-user/iac/management/SBC/upgrade/ directory of the LCM instance.)

Make sure that the SBC instances' security group setting allow the LCM instances to reach the SBC instances' mgmt IP on ports 22, 443 and 444 for ssh, sftp and http services.
The LCM instance must have enough privileges to access AMI, start/stop instances, make volume, attach, detach volume, show, start, stop, reboot and update instances.

Steps

Open a session to the Life Cycle Manager instance (LCM) and switch to root.
```
ssh -i lcm.pem ec2-user@<LCM instance IP address>
```
Activate virtual environment.
```
source iacenv/bin/activate
```
Change to /home/ec2-user/iac/management/SBC/upgrade and enter the workflow directory:
```
cd /home/ec2-user/iac/management/SBC/upgrade
```

Edit the file /home/ec2-user/iac/management/SBC/upgrade/aws_access.yml to provide AWS access details and HA pairing information. This information is used for mapping HA pairs. An example of a completed aws_access.yml file is shown below.

Note

Use either the private managment IP address or the elastic IP address of instance1/instance2. Whichever you chose, ensure the IP address is reachable from the LCM server to the SBC SWe.

aws_access.yml

############################################################################
# This file has 2 blocks of information:
#   1) AWS access details
#   2) SBC Instance/group details
# Update this file as per the directions provided at respective fields
#############################################################################
#AWS access details should be sourced as environment variables as follows:
#export AWS_ACCESS_KEY_ID=my-aws-access-key
#export AWS_SECRET_ACCESS_KEY=my-aws-secret-key
#############################################################################
#
# Update AWS region and zone
#
provider: "aws"
region: "ap-southeast-1"
zone: "ap-southeast-1c"
 
#
# Update SBC instance's CLI login details, user must be Administrator group, e.g. default user 'admin'
#
login_details:
      username: "admin"
      password: "myAdminPassword"
#
# Update redundancy group details
#    1) In case of active/standby (1:1) configuration, provide details of both the instances in a redundancy group. Order doesn't matter.
#    2) In case of standalone (single node) configuration, a redundancy group will have info of the single instance only.
# If username and password are same for all the instances and same as in "login_details" above,
# can remove those lines, e.g. a simpler version looks like this:
#      instance1:
#            instance_id: "i-my-instance-id-1"
#            instance_ip: "1.2.3.4"
#
# Note: The script is limited to support just 1 redundancy group. Please dont add other redundancy group to this file else it will fail.
redundancy_group:
      instance1:
            instance_id: "i-my-instance-id-1"
            instance_ip: "1.2.3.4"
            login_details:
                  username: "admin"
                  password: "myAdminPassword"
 
      instance2:
            instance_id: "i-my-instance-id-2"
            instance_ip: "1.2.3.5"
            login_details:
                  username: "admin"
                  password: "myAdminPassword"

Upgrading

Edit the file /home/ec2-user/iac/management/SBC/upgrade/upgrade-revert.yml to provide AMI ID, Upgrade Tag and order of instance upgrade to the new SBC version. The following example provides the AMI version to use for the upgrade and specifies to upgrade instance i-0987654321dcba and then instance i-0123456789abcd.

upgrade-revert.yml

########################################################################
# This file defines which instances to upgrade and in which order
# Update this file as per the directions provided at respective fields
########################################################################
 
#
# image_id - new image to use for upgrade. Use it as follows for different providers:
# aws       - AMI id with new SBC image
# gcp       - Name of the new SBC  image
# openstack - image id with new SBC image
# vmware    - Absolute path to vmdk with new SBC image
# rhv/kvm   - Absolute path to qcow2 image
# azure     - Snapshot name
#
image_id: "image_or_ami_use-for-upgrade"
#
# A tag to uniquely identify this upgrade. Logs and directory structure of logs are tagged
# with these so that future reference to these will be easier with appropriate tag.
# When the same system goes through multiple upgrades, this becomes a very handy way to jump to right set of logs.
#
# If multiple upgrades are done by using same upgrade-revert.yml file, use different upgrade_tag each time. Refer
# the corresponding upgrade_tag while doing the revert.
upgrade_tag: "IAC_TEST"
#
# Order of upgrade:
# All the instances listed under one group gets upgraded in parallel, so they get stopped, rebuilt and started in parallel.
#
# WARNING: If both active and standby of a HA pair are listed in the same upgrade group, that will impact service.
#
# On successful upgrade of instances in one group, instances in next group will be picked.
# Example Usecases:
#   1) While upgrading a 1:1(active/standby), list standby in first group and active in second group
#   2) If want to upgrade just standby, list that in first group and remove group 2
#   3) While upgrading a standalone, list instance in first group and remove group 2
#
tasks:
      # Each upgrade group should have a list of instance that will be upgraded in parallel
      upgradeGroup1:
            tag: "test1"
            instances:
                  - "i-instance-id-2"
                  - "i-instance-id-4"
      upgradeGroup2:
            tag: "test2"
            instances:
                  - "i-instance-id-1"
                  - "i-instance-id-3"

From the LCM session /home/ec2-user/iac/management/SBC/upgrade, run the upgrade command with aws_access.yml and upgrade-revert.yml as inputs:
```
./upgrade.py -a aws_access.yml -u upgrade-revert.yml
```
For an offline upgrade, use the command: ./upgrade.py -a aws_access.yml -u upgrade-revert.yml -o

Upgrade progress and logs are shown on-screen and also logged in /home/ec2-user/9.2/iac/management/log/SBC/upgrade/aws/latest.
After successfully upgrading all nodes listed in upgrade-revert.yml, timestamped logs are moved to /home/ec2-user/9.2/iac/management/log/SBC/upgrade/aws/history.

Volumes with older software versions are left intact on AWS in case they are needed for future reversions. Information about these volumes is stored in the file with instance-id as part of its name. Do not delete these older volumes – you must have these volumes in order to perform a reversion.

Reverting

Edit the file /home/ec2-user/iac/management/SBC/upgrade/upgrade-revert.yml by designating the instances to revert. The following example provides a list of instances.

The reversion process runs in parallel on all the instances, and could impact service.
Make sure that all the instances of a redundancy group get reverted to same SBC version, failure to maintain the same version within a group will cause unknown behavior and could cause a service outage.

upgrade-revert.yml

########################################################################
# This file defines which instances to upgrade and in which order
# Update this file as per the directions provided at respective fields
########################################################################
 
#
# image_id - new image to use for upgrade. Use it as follows for different providers:
# aws       - AMI id with new SBC image
# gcp       - Name of the new SBC  image
# openstack - image id with new SBC image
# vmware    - Absolute path to vmdk with new SBC image
# rhv/kvm   - Absolute path to qcow2 image
# azure     - Snapshot name
#
image_id: "image_or_ami_use-for-upgrade"
#
# A tag to uniquely identify this upgrade. Logs and directory structure of logs are tagged
# with these so that future reference to these will be easier with appropriate tag.
# When the same system goes through multiple upgrades, this becomes a very handy way to jump to right set of logs.
#
# If multiple upgrades are done by using same upgrade-revert.yml file, use different upgrade_tag each time. Refer
# the corresponding upgrade_tag while doing the revert.
upgrade_tag: "IAC_TEST"
#
# Order of upgrade:
# All the instances listed under one group gets upgraded in parallel, so they get stopped, rebuilt and started in parallel.
#
# WARNING: If both active and standby of a HA pair are listed in the same upgrade group, that will impact service.
#
# On successful upgrade of instances in one group, instances in next group will be picked.
# Example Usecases:
#   1) While upgrading a 1:1(active/standby), list standby in first group and active in second group
#   2) If want to upgrade just standby, list that in first group and remove group 2
#   3) While upgrading a standalone, list instance in first group and remove group 2
#
tasks:
      # Each upgrade group should have a list of instance that will be upgraded in parallel
      upgradeGroup1:
            tag: "test1"
            instances:
                  - "i-instance-id-2"
                  - "i-instance-id-4"
      upgradeGroup2:
            tag: "test2"
            instances:
                  - "i-instance-id-1"
                  - "i-instance-id-3"

From the LCM session //home/ec2-user/iac/management/SBC/upgrade/, run the revert command with aws_access.yml and upgrade-revert.yml as inputs:
```
 ./revert.py -a aws_access.yml -u upgrade-revert.yml
```
Reversion progress and logs are shown on-screen and also logged in /home/ec2-user/9.2/iac/management/log/SBC/revert/aws/latest.
After successfully reverting all nodes listed in upgrade-revert.yml, timestamped logs are moved to /home/ec2-user/9.2/iac/management/log/SBC/revert/aws/history.

Volumes with older software versions are left intact on AWS in case they are needed for future reversions. Information about these volumes is stored in the file with instance-id as part of its name. Do not delete these older volumes – you must have these volumes in order to perform a reversion.

Space shortcuts

Page tree

Customer Method to Install Life Cycle Manager

Prerequisite

Customer Methods for Upgrading and Reverting

Prerequisites

Steps

Upgrading

Reverting