Skip to Content

Upgrade or Uninstall a Linux Private Agent

Overview

These are the instructions on upgrading or uninstalling a Linux Private Agent on Debian and RPM based Linux distributions.

For additional information on Linux Private Agents, see these resources:

For documentation on how to accomplish certain tasks with Harmony Private Agents, see Private Agent How-tos.

For documentation on overcoming challenges with Harmony Private Agents, see Private Agent Troubleshooting.

Upgrading an Agent

Warning

Upgrading from a 32-bit to a 64-bit Linux Private Agent

  • Existing 32-bit agent versions must be uninstalled prior to upgrading (see instructions for Linux Uninstall).
  • Existing PostgreSQL and PostgreSQL driver (psqlODBC or pODBC) installations must be uninstalled.
  • Existing 32-bit ODBC drivers are not supported.

Note

If you are upgrading an existing 64-bit version agent to a higher 64-bit version agent, you do not need to uninstall the existing agent before upgrading.

Note

If you are upgrading from version 10.37 to 10.38, see 10.38 Linux Private Agents on Private Agent Known Issues for information on a known issue that occurs during the Private Agent upgrade.

Upgrading the Private Agent package on Linux can be performed by using the same commands used during initial installation. You do not need to run the configuration script when upgrading an existing Private Agent. Linux Private Agents can be upgraded to 11.x from any 10.x agent version without any additional commands.

When upgrading a Linux Private Agent from a pre-10.37 version to a version that is 10.37 or later, the PostgreSQL database will be reinitialized as it is upgraded to version 9.6. This upgrade will recreate the database on your Private Agent and your data will be recovered during this upgrade process. After the upgrade, any backups created using an earlier PostgreSQL version will not be compatible. The upgrade process can take more than 30 minutes depending on the number of projects and the size of the environments associated with your Private Agent group. Any pending jobs will be put in a pending queue to be run after the upgrade is complete.

A Private Agent takes a short time to upgrade—approximately three minutes—depending on the server. If having an outage is a concern, you can use high availability (two or more agents) and have no downtime. If your current subscription does not have additional agents available for this, contact your Customer Success Manager (CSM).

To upgrade a Private Agent, follow these steps:

  1. Check if you need to uninstall the agent first, based on the installed Private Agent type: is it 32-bit or 64-bit? (optional; see Determining Installed Agent Type and Uninstall Agent below)

  2. Install the new version of the agent. For more information, see Installing a Harmony Linux Agent (Debian or RPM)

    Note

    All configuration files are retained during a Private Agent upgrade.

Determining the Installed Agent Type

To determine the type of agent that you have installed (either a 32-bit or a 64-bit), you can use a command to check which packages are installed. If you are upgrading from 32-bit to 64-bit Private Agent, you must uninstall the current agent first.

Use the dpkg command to check the installed jitterbit-agent package:

$ dpkg -l | grep 'jitterbit-agent'

This will return output that includes either i386 (for 32-bit) or amd64 (for 64-bit), such as:

ii  jitterbit-agent:i386      10.xx.x.x      i386       Jitterbit Agent
ii  jitterbit-agent:amd64     10.xx.x.x      amd64      Jitterbit Agent

Use the rpm command to check the installed jitterbit-agent package:

$ rpm -qi `rpm -qa | grep jitterbit-agent` | grep Architecture:

This will return output that includes either i386 (for 32-bit) or amd64 (for 64-bit), such as:

Architecture: i386
Architecture: amd64

Rolling Back an Agent

It is not expected to be required to revert to a previous version of a Private Agent. However, should it be required, these are the steps:

  1. Back up the configuration files and security certificates for reference (optional; see Uninstall Agent below).
  2. Uninstall the agent (see Uninstall Agent below).
  3. Remove all Jitterbit-related files (see Uninstall Agent below).
  4. Install the selected version of the agent. See Installing a Harmony Linux Agent (Debian or RPM).
  5. To use your backup files (optional):

    1. Stop agent services (see Restarting a Linux Private Agent).

    2. Place your saved security certificates in the installation directory. Manually update the newly installed configuration files based on the settings in your saved files.

      Warning

      Directly copying over saved configuration files after an agent version change can cause errors. Instead, use tools like the Notepad++ Compare plugin to help you manually compare and update configuration settings. Do not change settings with defined passwords or ports such as those found in the credentials.txt file and under the [DbInfo] section of the jitterbit.conf file.

    3. Start agent services (see Restarting a Linux Private Agent).

Uninstalling an Agent

Before uninstalling, it is recommended to save the configuration files and security certificates for your current installation for referential purposes. These are typically located at:

Files
/opt/jitterbit/jitterbit.conf
/opt/jitterbit/apache/conf/httpd.conf
/opt/jitterbit/JdbcDrivers.conf
/opt/jitterbit/Resources/jitterbit-agent-config.properties
/opt/jitterbit/Resources/credentials.txt
Directories
/opt/jitterbit/apache/conf/extra/
/opt/jitterbit/apache/conf/ssl.crt/
/opt/jitterbit/apache/conf/ssl.key/

Caution

To be able to use your backup files in a future installation, you must stop services while you move the files over, then restart services once completed (see Restarting a Linux Private Agent).

Warning

Directly copying over saved configuration files after an agent version change can cause errors. Instead, use tools like the Notepad++ Compare plugin to help you manually compare and update configuration settings. Do not change settings with defined passwords or ports such as those found in the credentials.txt file and under the [DbInfo] section of the jitterbit.conf file.

Use this dpkg command to uninstall the Harmony Private Agent:

$ sudo dpkg --remove jitterbit-agent

You can also use the apt-get command to uninstall the Harmony Private Agent:

$ sudo apt-get remove jitterbit-agent

Use this yum command to uninstall the Harmony Private Agent:

$ yum remove jitterbit-agent

You can also use this rpm command to uninstall the Harmony Private Agent:

$ rpm --erase jitterbit-agent

The uninstall will remove the files installed during the installation. The /opt/jitterbit directory and Harmony Private Agent database are not automatically erased, and may include log files and application files generated when running operations. To completely remove all Jitterbit-related files, use these two commands:

$ sudo rm -rf /opt/jitterbit
$ sudo rm -rf /tmp/jitterbit

Next Steps

For additional information on Linux Private Agents, see these resources:

For documentation on how to accomplish certain tasks with Harmony Private Agents, see Private Agent How-tos.

For documentation on overcoming challenges with Harmony Private Agents, see Private Agent Troubleshooting.