Have a question? Want to report an issue? Contact JFrog support

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This page describes the process to upgrade your Artifactory Enterprise HA cluster.   

Tip
titleNo down time

 Since your cluster contains more than one node, you may complete the upgrade process without incurring any down time to the Artifactory service your organization is using.

Note
titleBefore You Begin
  1. Backup your system: As a precaution, before you begin the upgrade process, we strongly recommend performing a complete Complete System Backup
  2. Read through the process: The backup procedure may vary slightly depending on your current version and your installation type (ZIP, RPM, Debian or Docker). To familiarize yourself with the specific backup process that you should use, we recommend reading through all the steps of the process before you begin.
Panel
titlePage Contents

Table of Contents
maxLevel4
minLevel2
excludeZIP Installation|RPM Installation|Debian Installation|Docker Installation|YUM
 

 


The Upgrade Process

Upgrading Artifactory HA depends on which version you are starting from. Read the sections below carefully to make sure you complete the process correctly. 

Info
titleUpgrading to 5.x for the first time? NFS is no longer required

From version 5.0, Artifactory HA does not require a network file system (NFS) to store data. If you wish to migrate your filestore to alternative storage locations, please refer to Migrating Data from NFS.

Upgrading from Version 4.x or 5.x

Upgrading to the latest version is conducted in three phases:
  1. Upgrading the primary node
  2. Upgrading the secondary nodes
  3. Verifying the HA installation and configuration

 

Tip
titleWant to stop using NFS?

If you want to stop using a shared NFS once the upgrade procedure is complete (this is optional), please refer to Migrating Data from NFS to migrate to alternative storage.

Upgrading the Primary Node

  1. Remove the primary node from the load balancer, so all requests are directed to the secondary nodes. You may look at  $ARTIFACTORY_NODE_HOME/logs/request.log and ARTIFACTORY_URL/api/tasks (search for "running") to ensure that Artifactory is completely inactive.
  2. Perform a graceful shutdown of the primary node. While the primary node is down, the load balancer should redirect all queries to the secondary nodes.
  3. Continue with the upgrade according to the instructions for your installation type.

    Note
    titleUpgrading from 3.x?

     If your current version is 3.5 or higher, you first need to upgrade to the latest version 4.x using the procedure in this link and then upgrade to 5.x.

    Upgrading Artifactory HA from a version below 3.5 to version 5.x directly is not supported. To upgrade to version 5.x, you first need to upgrade your system to v3.5+, and then upgrade again to the final version 4.x, and then finally to 5.x.

    Excerpt Include
    Upgrading Artifactory
    Upgrading Artifactory
    nopaneltrue

  4. Start up the primary node. When the primary node starts up, it will recognize that the HA cluster nodes are not all running the same version of Artifactory, and consequently, the system will be limited to allowing uploads and downloads. 

    Any attempt to perform other actions such as changing the DB schema, modifying permissions, changing repository configuration and more, are strictly blocked. This limitation will continue until all the cluster nodes are once again running the same version.

    Note
    titleVersion inconsistency generates exceptions

    Running the HA cluster nodes with different versions generates exceptions. These can be seen in the log files and reflect the temporary inconsistent state during the upgrade process. This is normal and should be ignored until all the cluster nodes are, once again, running the same version.

  5. Put the primary node back to the load balancer.
  6. [Required ONLY if upgrading fromto Artifactory version 5.2.0 and below] Create the bootstrap bundle in the primary node using the Create Bootstrap Bundle REST API call.

Upgrading the Secondary Node

For each secondary node in your HA cluster, perform the following steps:

  1. Remove the node from the load balancer, so all requests are directed to the other nodes. You may look at  $ARTIFACTORY_NODE_HOME/logs/request.log and ARTIFACTORY_URL/api/tasks (search for "running") to ensure that Artifactory is completely inactive.
  2. Perform a graceful shutdown of the node. While the node is down, the load balancer should redirect all queries to the other nodes.
  3. [Required ONLY if upgrading from to Artifactory version 5.2.0 and below] Copy the bootstrap bundle (created in step 7 above), bootstrap.bundle.tar.gz, from the primary node's $ARTIFACTORY_NODE_HOME/etc directory into the corresponding location in the secondary node.

    Warning
    titleBootstrap bundle and db.properties

    This is a critical step in the upgrade process. The bootstrap bundle must be installed in the secondary node before you start it up for it to operate correctly in the cluster.

    Note also, if the $ARTIFACTORY_NODE_HOME/etc folder in your secondary node already contains a db.properties file, make sure to remove it. Presence of this file will prevent the bootstrap bundle from being properly extracted when you start up the secondary node causing the upgrade to fail.

  4. Continue with the upgrade according to the instructions for your installation type.

    Note

    If your current version is 3.5 or higher, you first need to upgrade to the latest version 4.x using the following procedure and then upgrade to 5.x.

    Upgrading Artifactory HA from a version below 3.5 to version 5.x directly is not supported. To upgrade to version 5.x, you first need to upgrade your system to v3.5+, and then upgrade again to the final version 4.x, and then finally to 5.x.

    Excerpt Include
    Upgrading Artifactory
    Upgrading Artifactory
    nopaneltrue

  5. Start up the secondary node.
  6. Add the secondary node back to the load balancer.
  7. Repeat this process for each secondary node.

Tip
titleCheck your installation

 After starting up each secondary node, we recommend inspecting the ha-node.properties, db.properties and binarystore.xml files (under $ARTIFACTORY_NODE_HOME/etc) to ensure they are correctly configured 

Verify the HA Installation and Configuration

Once you have completed upgrading your HA cluster, you can verify that your cluster has been installed and configured correctly use the following series of tests:

Excerpt Include
HA Installation and Setup
HA Installation and Setup
nopaneltrue

 

Tip
titleWant to stop using NFS?

If you want to stop using a shared NFS once the upgrade procedure is complete (this is optional), please refer to Migrating Data from NFS to migrate to alternative storage.