Version upgrades

Version upgrades#

Version upgrades may include additional functionality, performance enhancements, and/or other improvements over previous versions. Fixes for certain types of issues will also be included in these updates.

Upgrading to v20.1.0#

The Replicator 20.1.0 upgrade requires the target VM or hardware appliance to be running v19.1.1+ and have at least 2 CPU cores and 8 GB of RAM. For older versions, follow this guide to upgrade to v19.1.1.

Important

Replicator 19.1.1 appliances that are upgraded to v20.0.0+ default to standalone/configuration host mode.

If an appliance needs to be converted to a headless instance, refer to these instructions before starting the upgrade process.

Note

The upgrade will take about one hour to complete.
Due to an increase in minimum specs, older VMs with 2 GB of RAM should be provisioned with 8 GB RAM before the upgrade.
The upgrade requires a minimum of 16 GB free space on root (/). There may be older logs (sudo rm /var/log/messages-*) that can be deleted to free up space.
The primary appliance in a high-availability pair must be upgraded before the secondary/backup. See this section for instructions.

Contact Plixer Technical Support for assistance or clarifications.

Pre-upgrade preparation#

[Upgrades from 19.1.1] Create a backup of the v19.1.1 profile configuration data by downloading and running this utility (hardware appliances) or taking a VM snapshot (virtual appliances).
Confirm the current password for the replicator SSH user (run passwd replicator).

Verify that root login is disabled by running:

sudo sed -i 's/^#PermitRootLogin.*/PermitRootLogin no/g' /etc/ssh/sshd_config

Confirm that the Replicator server has access to https://files.plixer.com. This check can be performed by downloading the upgrade checksum file using the following command:
```
curl -O https://files.plixer.com/plixer-repo/scrutinizer/19.8.0/replicator-install.run.sha256
```
For Replicator servers that do not have internet access, download the file from the REPO_HOST_IP for the offline yum/dnf repository instead.

Upgrade procedure#

Once all preparation steps have been completed, follow these steps to upgrade the appliance:

Offline upgrades#

To upgrade a Replicator 19.1.1 server that is unable to access the default yum/dnf repository on https://files.plixer.com/plixer-repo/scrutinizer/19.8.0, an offline repository will need to be set up on the local network. This repository can be hosted on the Replicator standalone/configuration instance or a Plixer One/Scrutinizer server.

Important

Before starting, verify that var/db/big on the repo host has at least 84 GB of free disk space:

df -h --output='avail' /var/db/big

Add more storage if necessary, or deploy a temporary standalone Replicator instance or Scrutinizer server to serve as the offline repository host.

Follow these steps to set up the offline repository on a Replicator configuration instance (with IP address REPO_HOST_IP):

Upgrading and converting Replicator 19.1.1 appliances to headless instances#

If another Replicator 20.0.0+ instance (or Plixer One/Scrutinizer 19.8.0+) is going to be used as the configuration host, additional v19.1.1 appliances can be converted to headless instances after they are upgraded.

Note

Hardware appliances upgraded to v20.0.0+ and converted to a headless instances will no longer have their own web interface and must be managed from a remote configuration host.

Backing up v19.1.1 configuration data#

If the the Replicator 19.1.1 VM or hardware appliance has configuration data (profiles, collectors, or exporters) that needs to be migrated to the new configuration host, follow the steps below to create a backup file:

Important

Profile configuration data must be backed up before a Replicator 19.1.1 hardware appliance is upgraded.

Upgrade and conversion#

To upgrade a Replicator 19.1.1 appliance and convert it to a v20.1.0 headless instance:

Follow this guide to upgrade the v19.1.1 hardware appliance to 20.1.0.
After the upgrade is complete, SSH to the upgraded instance as the plixer user:
```
ssh plixer@REPLICATOR_IP
```
Run the setup script to demote the instance to headless:
```
MAKE_HEADLESS=1 /usr/share/replicator/util/setup.sh
```
When prompted, provide the configuration host IP address, name assigned, and authentication token generated when the headless instance was registered.
In the configuration host web interface, navigate to Admin > Resources > Replicators again and verify that the upgraded instance has self-registered.

The upgraded and converted Replicator 20.1.0 instance can be further configured via the Replicator page on the configuration host.

Restoring v19.1.1 configuration data#

If a backup of the v19.1.1 appliance was created before it was upgraded to v20.0.0+, the backup file can be restored on the standalone/configuration host as follows:

Important

Backup data can only be successfully restored if the configuration host has a registered headless instance with the same IP address as the backup (HEADLESS_IP in these steps) and no profile, collector, or exporter data configured.

High-availability pairs#

To upgrade a Replicator 19.1.1 high-availability (HA) pair to v20.1.0, follow these steps:

Note

To set up a new v20.0.0+ HA pair, follow this guide.

View instructions

Important

If the HA pair to be upgraded is using a virtual IP address (VIP), note the address being used (can be found in /etc/keepalived/keepalived.conf or by running ip addr show) before starting the upgrade process. The VIP will be required to complete several of the steps below.

Stop and disable the keepalived service.

sudo systemctl stop keepalived
sudo systemctl disable keepalived

Verify that the VIP was released by the primary and has been taken over by the secondary instance (run on both):
```
ip a
```
Upgrade the primary instance following this guide.
After the upgrade, log into the web interface and verify that profiles were successfully migrated to the upgraded primary instance.
Apply a new license (must support at least two Replicator instances).
Register a new instance under Admin > Resources > Replicators and note the API authentication token.
Reboot the primary instance, and then upgrade the secondary instance following the same steps as before.
After the upgrade, run the following on the secondary instance to set it up as a headless instance:
```
MAKE_HEADLESS=1 /usr/share/replicator/util/setup.sh
```
Enter the following details when prompted:
- Configuration host (primary instance) IP address
- API authentication token created when the new instance was created (step 6)
- Name assigned to the new instance
Restart the secondary instance, and then return to Admin > Resources > Replicators in the web interface to verify that the secondary instance has successfully registered itself with the primary (IP address should be displayed).
On the same page, click on the primary instance name (usually ‘Local’), and configure high availability using the primary and secondary instances (enter the original VIP if necessary).
Click the Save button, and then wait two minutes.

Verify that /etc/keepalived/keepalived_replicator.conf contains the following (on both devices):

# this file is automatically generated do not edit
global_defs {
        script_user plixer
        enable_script_security
}
vrrp_instance VI_1 {
        state BACKUP
        interface eth0
        virtual_router_id 51
        priority 90
        advert_int 1
        preempt_delay 5
        notify  /usr/share/replicator/bin/notify.sh
        authentication {
                auth_type PASS
                auth_pass zhO2brnVF2byl4+zL/ssTaCPmHFr5IMQJEIVDkJiFCCvBIttqjBptwm8c8PWbjqqN4BVieKunkVqPWIRp4fG0Q==
        }
        virtual_ipaddress {
                10.42.150.17
        }
}

Modify /etc/keepalived/keepalived.conf on both instances:

sudo bash -c 'echo "include /etc/keepalived/keepalived_replicator.conf" > /etc/keepalived/keepalived.conf' 

Restart the keepalived service on both instances:
```
sudo systemctl restart keepalived
```

Both Replicator instances should now be running v20.1.0 and set up as a high-availability pair using the same (pre-upgrade) configuration.

Upgrading to v19.1.1#

Upgrading the server#

Once all preparation steps have been completed, follow these steps to upgrade the appliance:

Offline upgrades to v19.1.1#

The following instructions for setting up an offline repo are intended for upgrading to Replicator v19.1.1 only:

Version upgrades

Contents

Version upgrades#

Upgrading to v20.1.0#

Pre-upgrade preparation#

Upgrade procedure#

Offline upgrades#

Upgrading and converting Replicator 19.1.1 appliances to headless instances#

Backing up v19.1.1 configuration data#

Upgrade and conversion#

Restoring v19.1.1 configuration data#

High-availability pairs#

Upgrading to v19.1.1#

Upgrading the server#

Offline upgrades to v19.1.1#

Upgrading to v19.0.1#

Upgrading to v18.14#