Basic Upgrade Steps

This procedure describes how to do a basic Horizon upgrade. You may need to complete additional steps to upgrade in a more complex setup (for example, if you run more than one OpenNMS instance, have more complex database migration requirements, and/or depending on the age of current version).

Make sure you complete the tasks in the before you begin section before starting. In addition, if the system requirements for the new version require you to upgrade your PostgreSQL database, you must do this before the Horizon upgrade.

Update and verify the Horizon repository

CentOS/RHEL
Debian/Ubuntu

Your Horizon repository is defined in your /etc/yum.repos.d/ directory.

The file may be named opennms-repo-stable-<OSversion>.repo, but it is not guaranteed to be.

Sudo to root.

Enable auto updates:

yum -y install yum-utils
yum-config-manager --enable opennms-repo-stable-*

Purge any cached yum data:
```
yum clean all
```

Make a backup copy of your OpenNMS config:

rsync -Ppav ${OPENNMS_HOME}/etc /tmp/etc.orig
rsync -Ppav${OPENNMS_HOME}/jetty-webapps/opennms/WEB-INF /tmp/opennms-web-inf

Upgrade the Horizon packages to the newest version:
```
yum -y upgrade opennms
```

Disable auto updates:

yum-config-manager --disable opennms-repo-stable-*

Upgrade Java 11 to the latest release:

yum -y install java-11-openjdk java-11-openjdk-devel

Execute runjava to set the JVM that Horizon will use:
```
${OPENNMS_HOME}/bin/runjava -s
```

Check for configuration file changes, and update accordingly using the files you backed up in identify changed configuration files.

If you upgrade in place, OpenNMS renames any shipped config that conflicts with an existing user-modified config to .rpmnew or .rpmsave. Inspect these files manually and reconcile any differences. Use diff -Bbw and diff -y to look for changes. If any .rpmnew or .rpmsave files exist within the configuration directory, services will not start.

Run the Horizon installer:
```
${OPENNMS_HOME}/bin/install -dis
```
The upgrade may take some time. An Updgrade completed successfully! message confirms that the upgrade has completed. If you do not get this message, check the output of the install command for any errors.

Clear the Karaf cache:

yes | ${OPENNMS_HOME}/bin/fix-karaf-setup.sh

Start OpenNMS Horizon:
```
systemctl start opennms.service
```
tail -F ${OPENNMS_HOME}/logs/manager.log illustrates the Horizon startup progress.
The upgrade completes and operation resumes.

Make sure you clear your browser’s cache before using the Horizon web UI against the upgraded version. This is especially important for pages that use JavaScript heavily (for example, the Requisitions UI).

Your Horizon repository is defined in your /etc/apt/sources.list directory.

The file may be named opennms-repo-stable-<OSversion>.repo, but it is not guaranteed to be.

Sudo to root.

Enable auto updates:

sudo apt-mark unhold libopennms-java \
              libopennmsdeps-java \
              opennms-common \
              opennms-db

Purge any cached data:
```
apt-get clean
```

Make a backup copy of your OpenNMS config:

rsync -Ppav ${OPENNMS_HOME}/etc /tmp/etc.orig
rsync -Ppav ${OPENNMS_HOME}/jetty-webapps/opennms/WEB-INF /tmp/opennms-web-inf

Upgrade Horizon packages to the newest version:
```
apt-get upgrade opennms
```

Disable auto updates:

sudo apt-mark hold libopennms-java \
              libopennmsdeps-java \
              opennms-common \
              opennms-db

Upgrade Java 11 to the latest release:

apt-get install java-11-openjdk java-11-openjdk-devel

Execute runjava to set the JVM that Horizon will use:
```
${OPENNMS_HOME}/bin/runjava -s
```
Check for configuration file changes, and update accordingly using the files you backed up in idenfity changed configuration files.

Debian prompts you to keep or overwrite your files during the apt upgrade process. Inspect these files manually and reconcile any differences. Use diff -Bbw and diff -y to look for changes.
Run the Horizon installer:
```
${OPENNMS_HOME}/bin/install -dis
```
The upgrade may take some time. An Updgrade completed successfully! message confirms that the upgrade has completed. If you do not get this message, check the output of the install command for any errors.

Clear the Karaf cache:

yes | ${OPENNMS_HOME}/bin/fix-karaf-setup.sh

Start OpenNMS Horizon:
```
systemctl start opennms.service
```
tail -F ${OPENNMS_HOME}/logs/manager.log illustrates the Horizon startup progress.
The upgrade completes and operation resumes.

PostgreSQL upgrade and configuration

Refer to the PostgreSQL documentation for information on how to upgrade a PostgreSQL database. You may also find the Upgrading PostgreSQL article on Discourse useful.

You must stop the OpenNMS service while doing maintenance on database services.