---
title: PingIntelligence Upgrade Guide
description: The guide covers upgrading your PingIntelligence from version 5.0 to 5.1 and other third-party components like Kafka, MongoDB and Elasticsearch.
component: pingintelligence
version: 5.1
page_id: pingintelligence:pingintelligence_upgrade_guide:pingintelligence_upgrade_guide
canonical_url: https://docs.pingidentity.com/pingintelligence/5.1/pingintelligence_upgrade_guide/pingintelligence_upgrade_guide.html
revdate: April 26, 2024
section_ids:
  prerequisites: Prerequisites
  common-upgrade-steps: Common upgrade steps
---

# PingIntelligence Upgrade Guide

The guide covers upgrading your PingIntelligence from version 5.0 to 5.1 and other third-party components like Kafka, MongoDB and Elasticsearch.

PingIntelligence 5.1 introduces a number of new features and improvements.

* The Kafka and Zookeeper third-party components have been introduced for processing event streaming.

* Elasticsearch 7.13.4 is required to support the new dashboard data format and the new improvements, and so there is no upgrade available for the dashboard data.

* The PingIntelligence 5.1 dashboard has significant enhancements over the previous version:

  * New dashboards

  * Per IoA reporting with transaction level data

  * Faster availability of data in the dashboard

  * New API Publish service that publishes the changes made to the discovered APIs from PingIntelligence Dashboard to AI engine

  We recommended following the manual deployment steps for the dashboard, after completing the Kafka installation and the ABS upgrade.

* The new API Publish service, that publishes the changes made to the discovered APIs from PingIntelligence Dashboard to AI engine. As a new component API Publish must be installed manually. API Publish can be installed on the Dashboard server, or on the ABS Reporting Node server.

See the Release Notes [PingIntelligence 5.1 (December 2021)](../release_notes/pingintelligence_release_notes_51.html) for the summary of new features in PingIntelligence 5.1.

## Prerequisites

Complete the following prerequisites before proceeding with upgrade:

* Download PingIntelligence for APIs 5.1 binaries from [Ping download site](https://www.pingidentity.com/en/resources/downloads/pingintelligence/pingintelligence-software.html).

* Access to PingIntelligence for APIs upgrade package - `pi-api-upgrade-5.1.tar.gz`. Contact Ping Identity Sales team for the latest upgrade script package.

* Host machine with RHEL 7.9 or Ubuntu 18.04 LTS. PingIntelligence 5.1 supports RHEL 7.9 or Ubuntu 18.04 LTS operating systems.

* Elasticsearch 7.13.4

* OpenJDK 11.0.2 to OpenJDK 11.0.6.

* Set JAVA\_HOME by adding the following command in`~/.bashrc` file.

  ```
  export JAVA_HOME="/a/b/java"
  ```

* Disable ABS on all ASE nodes by entering the following command on ASE nodes.

  ```
  ./cli.sh -u admin -p admin disable_abs
  ```

* To minimize the impact to live traffic, stop ASE.

|   |                                                                                                                                                                  |
| - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   | Upgrade will be done in-place for all the components. The process will need components to be taken out of live traffic processing till the upgrade is completed. |

## Common upgrade steps

* Extract the PingIntelligence for APIs upgrade package`pi-api-upgrade-5.1.tar.gz` into a temporary directory on the host machine that has either ASE or ABS AI Engine or PingIntelligence Dashboard installed.

  ```
  # mkdir ~/pi-tmp
  # cp pi-api-upgrade-5.1.tar.gz ~/pi-tmp/
  # cd ~/pi-tmp/
  # tar -xvf pi-api-upgrade-5.1.tar.gz
  ```

  Following is the directory structure:

  ```
  └── pingidentity
      └── upgrade
          ├── abs
          │   └── abs-upgrade.sh
          ├── ase
          │   └── ase-upgrade.sh
          ├── dashboard
          ├── mongo
          │   └── mongo_upgrade_tool_5.1.tar.gz
          └── version.txt
  ```

  |   |                                                                                                        |
  | - | ------------------------------------------------------------------------------------------------------ |
  |   | You can copy the upgrade package onto the host machine using utilities like SCP, rsync, SFTP, or curl. |

* Upgrade the components in the following order:

  * [Step-1 Installing Kafka and Zookeeper](pingintelligence_installing_kafka_zookeeper.html)

  * [Step-2 Upgrading MongoDB](pingintelligence_upgrading_mongodb.html) (including Kafka and Zookeeper)

  * [Step-3 Upgrading ABS AI Engine](pingintelligence_upgrading_abs_ai_engine.html)

  * [Step-4 Upgrading ASE](pingintelligence_upgrading_ase.html)

  * [Step-5 Installing API Publish and Dashboard](pingintelligence_installing_api_publish_dashboard.html)

|   |                                                                                                                             |
| - | --------------------------------------------------------------------------------------------------------------------------- |
|   | The upgrade scripts should be run from a user who has read, write, and execute permissions in the installation directories. |