Upgrading Anyware Manager

When upgrading Anyware Manager there are two options available.

In-place upgrade within the maintenance window: You can run an in-place upgrade through dnf for Anyware Manager. Depending on the configuration you implemented, this will mean a period of downtime which can range from a few seconds to a few minutes.
Zero downtime upgrade via a new VM. The second option involves installing Anyware Manager on a new virtual machine, and configuring it to connect to the same external database and secret storage. If done correctly this can result in zero downtime.

The steps involved in both options are outlined below.

Which Option Should I Choose?¶

The upgrade option you choose depends on the amount of downtime you are willing to experience and how your Anyware Manager instance has been deployed and setup. The following are some use cases that outline which option to use:

If you have a single Anyware Manager server connecting to external database and secret storage, it is recommended to install Anyware Manager on a new virtual machine. If you don't have a new virtual machine then run the in-place upgrade on the existing virtual machine with the understanding that there will be some downtime during this upgrade.
If you have multiple Anyware Manager servers connecting to the same external database and secret storage, it is recommended to run an in-place upgrade on each Anyware Manager server, one at a time. There should not be any downtime as long as one Anyware Manager server is up and running.
If the database and secret storage is on the same virtual machine as Anyware Manager, you must run an in-place upgrade. This is to ensure that the data persists after the upgrade has been completed. There will be some downtime during this upgrade.

Running an In-Place Upgrade¶

Anyware Manager Downtime

The Anyware Manager virtual machine that is undergoing an in-place upgrade will not be available during the upgrade. This can take anywhere from a few seconds to a few minutes, depending on the number of services that need to be upgraded and the speed of download when retrieving new versions from the repo. If this is the only Anyware Manager server you have, the new connections will not be established until the upgrade is completed successfully.

1. Update Anyware Manager dnf Repository¶

There are two cases you need to update Anyware Manager dnf repository:

You want to upgrade to a Anyware Manager version that is on different repo, such as upgrading from a GA version to a beta version
You have installed version 21.03 when EL7 was specified for download.

If your cases are not these, please skip this section and go to 2. Unlocking Anyware Manager Version.

The following section outlines how to update the Anyware Manager dnf repository as part of running an in-place upgrade.

SSH to the Anyware Manager virtual machine.
Remove the existing dnf repo for previous Anyware Manager with the following command.
```
sudo rm /etc/dnf.repos.d/teradici-cas-manager.repo
```
Checking Existing Repositories for Anyware Manager¶

If the Anyware manager was installed previously on your virtual machine, there could be existing repos related to it on your system. Run the command below to check all existing repos related to Anyware Manager (Skip this step if Anyware Manager was never installed on your virtual machine).

dnf repolist teradici-cas-manager*

Check the current Anyware Manager repo to make sure it is the desired repo that you want to use for installation. If there are unwanted repositories on your VM, see Repository Management to remove them.

Adding a Repository¶

To access the scripts and to configure and add the RHEL and Rocky Linux repository, select the Downloads and scripts option here from the Anyware Manager support site.

Run the following command to confirm teradici-cas-manager repos were added into dnf repo.

dnf repolist --enabled teradici-cas-manager*

The output from this command should list the repo id, names as outlined in the example below:

repo id                                             repo name
teradici-cas-manager-beta                           teradici-cas-manager-beta
teradici-cas-manager-beta-noarch                    teradici-cas-manager-beta-noarch
teradici-cas-manager-beta-source                    teradici-cas-manager-beta-source

2. Unlocking Anyware Manager Version¶

If you have skipped above step Update Anyware Manager dnf Repository , make sure the existing Anyware Manager repo is enabled. Follow the command below to unlock the Anyware Manager repo if it was disabled to lock the version before.

The following command will unlock the Anyware Manager version in the dnf repo:

sudo dnf config-manager --set-enable teradici-cas-manager*

You can confirm the settings with the following command:

dnf repolist teradici-cas-manager*

The output from this command should list the repo id, names and their status, as outlined in the example below:

repo id                                         repo name                                        status
teradici-cas-manager                            teradici-cas-manager                             enabled
teradici-cas-manager-noarch                     teradici-cas-manager-noarch                      enabled
teradici-cas-manager-source                     teradici-cas-manager-source                      enabled

3. Upgrade Anyware Manager via dnf¶

The following steps outline how to perform an in-place upgrade of Anyware Manager through dnf:

Before running an in-place upgrade you should backup the entire virtual machine by taking a snapshot. This snapshot will help to rollback if anything wrong happens during the upgrade.
SSH to the Anyware Manager virtual machine.
Run the following command:
```
sudo dnf upgrade -y cas-manager-selinux cas-manager
```
If there is no new version available, and you therefore currently have the latest version, you will see a message outlining this when you run this command.
Once you have run the upgrade command you need to wait until all Anyware Manager services have been updated and are healthy. To manually verify the health status of Anyware Manager run:
```
sudo /usr/local/bin/cas-manager diagnose --health
```
Verify that Anyware Manager has been updated by running the following command:
```
dnf list --installed 'cas-manager*'
```

This will display the current installed Anyware Manager version.

Installing Anyware Manager on a new Virtual Machine¶

The following steps outline how to install Anyware Manager on a new virtual machine, and configure it to connect to the same external database and secret storage application:

Before performing an upgrade you should backup the database and secret storage application you used when installing Anyware Manager. If you intend to install Anyware Manager on a new virtual machine, backup the configuration file so that it can be used on the Anyware Manager instance.
Follow the installation steps outlined here to install a new instance of Anyware Manager in a new virtual machine to replace the existing one. You must configure it to be identical to the old Anyware Manager instance. It needs to connect to the same MongoDB, and secret storage application, as well as having the same certificate and network configurations.
Change your DNS to point to the new Anyware Manager instance.
Reconfigure your Connector to connect to the new Anyware Manager if necessary:
- If you installed your Connector with --cam-url=https://Fully-Qualified-Domain-Name-of-CAS-M:
  - Change your DNS entry for the FQDN to point to the new Anyware Manager's static IP.
  - In the Connector virtual machine, flush the DNS cache to use the latest DNS. This ensures that there will be zero downtime as the Connector will be able to connect to the new Anyware Manager instance:
```
sudo systemd-resolve --flush-caches
```
- If you installed your Connector with --cam-url=https://ip-address-of-cas-manager:
  - Update your Connector to use the latest Anyware Manager's IP address.
  - Log into the Connector virtual machine and run the following command to update the Anyware Manager IP:
```
sudo usr/sbin/cloud-access-connector update --cam-url https://<New CAS-Manager IP>
```
In the Connector, ping the FQDN to verify it can find the new Anyware Manager instance.
Remove the old Anyware Manager virtual machine.

Removing the Anyware Manager Virtual Machine¶

The following steps outline how to remove the Anyware Manager virtual machine:

Save the configuration setting files used in the current version of Anyware Manager. For example, save them as a all-configurations.json file. If the current Anyware Manager has proxy configured, save all the proxy environment variables also.

Run the following commands to remove the Anyware Manager.

sudo dnf remove -y cas-manager-selinux cas-manager
sudo rm -rf /opt/teradici     # Remove the cas-manager files

Delete the Anyware Manager VM.