Upgrading Artifactory

JFrog Installation & Setup Documentation
Content Type
Installation & Setup

The procedure to upgrade Artifactory depends on your installation type. We strongly recommend reading through this page before proceeding with your upgrade and reviewing the Artifactory Release Notes for breaking changes and deprecated features.

Important

Make sure to use the same upgrade method (Helm, Docker, RPM, Debian, Linux Archive, and Windows Archive) as the one you initially used to install Artifactory.

Before You Upgrade Artifactory

  • Backups: Ensure your system and database backups are up to date so you can restore them if you encounter issues.

Artifactory Upgrade Versions

The upgrade instructions vary based on your current Artifactory version:

  • Below Artifactory 6.10.x

  • From Artifactory 6.10.x onwards to Artifactory 7.x

  • From Artifactory 7.x to Artifactory 7.x

  • Artifactory HA Upgrade

  • Artifactory Upgrade with Xray

Upgrade Steps

The upgrade procedure involves the following main steps. $JFROG_HOME represents the JFrog root directory containing the deployed product. The default home directory is defined according to the installation type. For more information, see System Directories.

  1. Download the package to upgrade (Helm, Docker, RPM, Debian, Linux Archive, and Windows Archive).

  2. Stop the current server.

  3. Extract/Install the package according to the installer distribution type.

  4. Check the Migration Log and review system.yaml to validate the migration was successful (only for upgrading from v6.x).

  5. Start the service using the start scripts or OS service management.

  6. Check the Artifactory Log for the status of the service.

If necessary, refer to this Knowledge Base Article to resolve common issues that may occur during installation or upgrade.

Upgrading an Artifactory Enterprise HA Cluster

This section describes the process to upgrade your Artifactory Enterprise High Availability cluster. Since your cluster contains more than one node, you may complete the upgrade process without incurring any downtime.

Warning

Before you upgrade, ensure that the operating system version you use is supported. For more information, see System Requirements.

The upgrade process includes three phases:

  1. Upgrading the first node.

  2. Upgrading the additional nodes.

  3. Verifying the HA installation and configuration.

Using NFS Data Folders with the JFrog Router: If your HA cluster uses an NFS as its filestore, you need to verify that after the upgrade, the only shared folder is the $JFROG_HOME/data/artifactory directory. The $JFROG_HOME/data/router folder must be unique to each node. This warning does not apply if you are using a different folder for your NFS.

Upgrade the First Artifactory Node

  1. Remove the first node from the load balancer. All requests are directed to the additional nodes. Check $HOME/log/artifactory-request.log and ARTIFACTORY_URL/artifactory/api/tasks (search for running) to ensure Artifactory is completely inactive.

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

  3. Start up the first node. It will recognize that the HA cluster nodes are not all running the same version. The system will be limited to allowing uploads and downloads, and other actions like changing the DB schema or repository configuration will be strictly blocked. This limitation continues until all cluster nodes are running the same version.

    Version inconsistency generates exceptions: Running the HA cluster nodes with different versions generates exceptions in the log files. This is normal and should be ignored until all nodes are running the same version.

  4. Put the first node back into the load balancer.

Upgrade the Additional Artifactory Node

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

  1. Remove the node from the load balancer. All requests are directed to the other nodes. Check the $HOME/logs/request.log and ARTIFACTORY_URL/api/tasks (search for "running") to ensure the node is completely inactive.

  2. Perform a graceful shutdown of the node.

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

  4. Start up the additional node.

  5. Add the additional node back to the load balancer.

  6. Repeat this process for each additional node.

  7. Check your installation: After starting up each additional node, we recommend inspecting the system.yaml and binarystore.xml files (under $JFROG_HOME/artifactory/var/etc/) to ensure they are correctly configured.

Verify the HA Installation and Configuration

Once you have completed upgrading your HA cluster, you can verify the installation and configuration using the following tests.

  • Access Artifactory: Access Artifactory through your load balancer and log in as an Admin.

  • Service Status: In the Admin module, go to Monitoring | Service Status. A table with details on all the Artifactory nodes in your cluster should be displayed.

  • Custom URL Base: In the Admin module, under General | Settings, verify that the Custom URL Base field is correctly configured to the URL of the Load Balancer.

  • Direct Access: Directly access the Artifactory UI for the server you just configured.

  • System Logs: In the Admin module, go to Service | Artifactory | System Logs to view the log and verify that you see an entry for HA Node ID.