Skip to main content

Jama Connect Help

Update the Jama Connect KOTS platform from Longhorn-based deployments to OpenEBS (internet)

Before you can upgrade Jama Connect KOTS platform from 9.0.1–9.0.3 or 8.79.1–8.79.6, you must first run a pre-upgrade script. These versions used Longhorn as the storage solution, while newer versions use OpenEBS.

Running the pre-upgrade script prepares the existing environment for the OpenEBS storage configuration required by the target version. Before you can deploy Jama Connect 9.41.x, you must first update the Jama Connect KOTS platform (referred to as an in-place upgrade) to help ensure the platform storage components transition correctly.

Important considerations

  • Jama Connect now uses OpenSearch for indexing and search instead of Elasticsearch. To ensure a successful update process, you must remove the existing Elasticsearch StatefulSets and PVCs, and delete the existing labels from the Elasticsearch nodes. Make note of the Elasticsearch settings (they are removed as part of the update process), so you can refer to them when you update the OpenSearch settings. Instructions for completing these steps are included in this task.

  • When upgrading from Jama Connect 9.0.1–9.0.3 and 8.79.1–8.79.6, you must first run a pre-upgrade script, then run the Kubernetes (kURL) installer. Only then can new versions of Jama Connect can be deployed from the KOTS Admin Console. When upgrading from Jama Connect 9.04 and later, 8.79.7 and later, or 9.6.0 and later, you don't need to run a pre-upgrade script.

  • After upgrading to Jama Connect 9.41.x, you must perform a reindex.

  • Expect downtime. Upgrade during off hours to minimize the impact.

  • The Kubernetes (kURL) installer is interactive and prompts you to confirm some of the steps. Depending on the number of remote nodes in your environment, expect this part of the upgrade process to take at least two hours.

  • If you have dedicated Elasticsearch nodes, you are prompted to run separate installer commands on the secondary nodes during the installation.

  • Run the install commands inside a terminal multiplexer session to keep the session active in the event that the connection is dropped or the terminal is closed.

To update the Jama Connect KOTS platform for non-supported KOTS version (internet):

  1. Back up your Jama Connect instance.

  2. Download prepare-for-longhorn-to-openebs-upgrade.sh from GitHub.

    Skip this step if you are upgrading from Jama Connect 9.0.4 and later, 8.79.7 and later, or 9.6.0 and later.

  3. On the primary node, run the shell script downloaded in step 2 as a user with adequate privileges:

    bash upgrade-for-longhorn-to-openebs-upgrade.sh

    Important

    Skip this step if you are upgrading from Jama Connect 9.0.4 and later, 8.79.7 and later, or 9.6.0 and later.

  4. Before proceeding, delete all Elasticsearch StatefulSets and PersistentVolumeClaims on all nodes:

    kubectl delete sts elasticsearch
kubectl delete pvc volume-elasticsearch-0
kubectl label node <node-name> jamasoftware.net/service=opensearch

  5. Run the kURL installer:

    Important

    The kURL installer is interactive and prompts you to continue several times throughout the upgrade process. Kubernetes is upgraded incrementally in steps from version 1.31 and requires you to confirm several of the steps before proceeding to the next version.

    1. From the command line on the primary node/application server, enter the following command to initiate the installation:

      curl -sSL https://kurl.sh/jama-k8s-standardkots | sudo bash -s

      Note

      kURL bundles and installs host packages without relying on external package repositories, except on Red Hat Enterprise Linux 9 and Ubuntu 24. If kURL is unable to install a required host package, the output notifies you. It this occurs, manually install the missing package and then re-run the kURL installer to proceed.

    2. Prepare your instance for the new Jama Connect release. This command deletes targeted KOTS resources, which is required before deploying the new version of Jama Connect.

      kubectl delete sts/activemq sts/core sts/diff sts/elasticsearch \
sts/hazelcast sts/oauth sts/saml deployment/oauth deployment/saml \
sts/search sts/nginx sts/core-ingress sts/core-reports sts/core-jobs \
jobs/tenant-manager pvc/volume-oauth-0 pvc/volume-saml-0

  6. Upgrade Jama Connect.

  7. In the KOTS Admin Console, scroll to OpenSearch Settings and enter the new OpenSearch configuration settings.

    Tip

    Refer to the Elasticsearch settings you recorded earlier in this task.

    _usr_jamasoftware_media_ef824cc71789f6390f4d31abe3d5ee72_OpenSearch_Settings.png

  8. Label the new OpenSearch nodes:

    kubectl label nodes <node-name> jamasoftware.net/service=opensearch

  9. Reindex all search items.

Once you've updated the Jama Connect platform, you can upgrade the application.

In this section: