Replicator

The integrated Replicator instance on a Scrutinizer server/appliance can be enabled at any time by entering a valid license key on the Admin > Plixer > Replicator page in the web interface.

After an active license key has been applied, the Replicator UI tab/page of the Scrutinizer web interface becomes accessible, and the local Replicator instance is automatically added to the Admin > Resources > Replicators management view.

See this section for further information and instructions on setting up and configuring packet replication.

Note

Replicator can also be deployed as a standalone appliance (independent of Scrutinizer) with its own web interface. See these deployment guides for instructions.

Headless instances

Additional Replicator instances (for greater replication capacity, high availability, etc.) can be deployed as “headless” appliances to minimize their resource footprint. These deployments do not include the web interface component; they must be registered and managed from a main Replicator instance (Plixer One/Scrutinizer environment or standalone appliance) and cannot be configured independently.

Registering a headless instance

Before deploying a headless appliance, it must first be registered on the main instance as follows:

Note

Additional Replicator instances must be supported by the current license key. Contact Plixer Technical Support for further details.

View instructions

1. Navigate to Admin > Resources > Replicators in the web interface.

2. Click the Add button.

3. Enter a name to assign to the new Replicator instance, and then click Save.

4. Click on the name of the new instance in the main view and note the authentication token shown in the tray.

Once the instance has been registered, proceed to deploying the headless appliance.

Deploying a headless instance

Follow these steps to deploy a headless Replicator instance after it has been registered:

View instructions

1. Download the latest headless appliance package for your hypervisor from the Plixer Customer Portal.

2. Deploy the VM following the instructions here.

3. Complete the basic appliance configuration.

4. After it reboots, SSH to the appliance as the plixer user again.

5. Enter the following details when prompted:

   • Configuration host

   • Authentication token generated when the instance was registered

   • Name given to the headless instance during registration

The headless instance will now be available for assignment when configuring Replicator profiles. To manage the instance, return to the Admin > Resources > Replicators view.

Profile migrations

Profile configuration data from previous Replicator 19.1.1 can be migrated to Replicator 20.0.0+ instances using the configuration migration tool included with Scrutinizer deployments.

Migration to a Scrutinizer Replicator instance

The following instructions cover profile data migration from a v19.1.1 deployment to a local Replicator instance on Scrutinizer 19.7.0+ (or a standalone Replicator 20.0.0+ appliance).

View guide

Requirements

• Source host - Replicator 19.1.1 appliance

• Destination host - Fully deployed and licensed Scrutinizer 19.7.0+ server (or standalone Replicator 20.0.0+ instance)

• Migration utility (Replicator-19-conf-tool.sh) - Found in /home/plixer/scrutinizer/files/ on the configuration host; can also be downloaded from files.plixer.com.

• Temporary host - A temporary location to use for moving files between the source and destination hosts

• Source and destination IP addresses must be the same

Migration procedure

1. SSH to the source host as the replicator user and shut it down:

   REPLICATOR> system shutdown
   

2. After the source host has been completely shut down, deploy the destination host and assign it the same IP address as the source host.

   Important

   For assistance with managing IP addresses to migrate profile data to a local Replicator instance on an active Scrutinizer server, contact Plixer Technical Support

3. SSH to the destination host as the plixer user and apply the correct permissions to the utility:

   chmod 755 /home/plixer/scrutinizer/files/Replicator-19-conf-tool.sh
   

4. Copy the utility from the destination host to a temporary host:

   scp /home/plixer/scrutinizer/files/Replicator-19-conf-tool.sh USER@TEMP_HOST_IP:/DESTINATION_DIR/Replicator-19-conf-tool.sh
   

5. Shut down the destination host:

   sudo shutdown -p now
   

6. Boot up the source host and create a ‘migration’ directory in /temp:

   mkdir /tmp/migration
   

7. Copy the utility from the temporary host to the source host:

   scp /DESTINATION_DIR/Replicator-19-conf-tool.sh replicator@SOURCE_HOST_IP:/tmp/migration/Replicator-19-conf-tool.sh
   

8. SSH to the source host as the root user and run the utility:

   cd /tmp/migration
   ./Replicator-19-conf-tool.sh backup <BACKUP_NAME>
   

   This will create the profile data backup file BACKUP_NAME.tar.gz.

9. Verify the contents of the backup file:

   tar -vztf BACKUP_NAME.tar.gz
   ls -l /home/replicator/v19_backup
   

   The files should be the same size and not be empty.

10. Copy the backup file to the temporary host, and then shut down the source host:

    scp BACKUP_NAME.tar.gz USER@TEMP_HOST_IP:/DESTINATION_DIR/BACKUP_NAME.tar.gz
    shutdown -p now
    

11. Boot up the destination host and copy the backup file from the temporary host to the destination host:

    scp /DESTINATION_DIR/BACKUP_NAME.tar.gz plixer@DESTINATION_HOST_IP:/home/plixer/scrutinizer/files/BACKUP_NAME.tar.gz
    

12. Use the utility to restore the backup file on the configuration host:

    cd /home/plixer/scrutinizer/files/
    ./Replicator-19-conf-tool.sh restore BACKUP_NAME.tar.gz
    

13. Navigate to the Replicator UI on the destination host and verify that the profile data was successfully restored.

After the migration has been completed, the Replicator service should be updated with the new profile configuration data and start replication within one minute.

Migration to a headless Replicator instance

The following instructions cover profile data migration from a v19.1.1 deployment to a headless Replicator 20.0.0+ instance.

View guide

Requirements

• Source host - v19.1.1 Replicator appliance

• Destination host - Headless Replicator 20.0.0+ instance registered and deployed with the same IP address as the migration source after the latter has been backed up and shut down

• Configuration host - Fully deployed and licensed standalone Replicator 20.0.0+ deployment with at least an evaluation license; license must support at least two instances (configuration host and destination headless instance)

• Migration utility (Replicator-19-conf-tool.sh) - Located in /home/plixer/scrutinizer/files/ on the configuration host

Migration procedure

1. SSH to the configuration host as the plixer user and apply the correct permissions for the utility:

   chmod 755 /home/plixer/scrutinizer/files/Replicator-19-conf-tool.sh
   

2. Copy Replicator-19-conf-tool.sh to the migration source:

   scp /home/plixer/scrutinizer/files/Replicator-19-conf-tool.sh replicator@SOURCE_HOST_IP:/tmp/migration/
   

3. SSH to the source host as the root user and use the utility to create a backup of its profile data (BACKUP_NAME.tar.gz):

   cd /tmp/migration
   ./Replicator-19-conf-tool.sh backup <BACKUP_NAME>
   

4. Verify the contents of the backup file:

   tar -vztf BACKUP_NAME.tar.gz
   ls -l /home/replicator/v19_backup
   

   The files should be the same size and not be empty.

5. Copy the backup file to the configuration host, and then shut down the source host:

   scp BACKUP_NAME.tar.gz plixer@DESTINATION_HOST_IP:/home/plixer/scrutinizer/files/
   shutdown -p now
   

6. On the configuration host, navigate to Admin > Resources > Replicators and register the destination host.

7. Deploy the destination host appliance and assign it the same IP address previously used by the source host.

8. Navigate to Admin > Resources > Replicators again and verify that the destination Replicator instance has self-registered and has the correct IP address.

9. Restore the backup file on the configuration host:

   cd /home/plixer/scrutinizer/files/
   ./Replicator-19-conf-tool.sh restore BACKUP_NAME.tar.gz
   

10. Navigate to the Replicator UI on the configuration host and verify that the restored profile data was correctly associated with the destination Replicator instance.

After the migration has been completed, the Replicator service should be updated with the new profile configuration data and start replication within one minute.

Hint

Profile data from multiple v19.1.1 Replicator instances can be migrated to new Replicator 20.0.0+ headless instances by repeating the steps above and deploying each destination host with an IP address matching a source.