Search


Cloud customer?
Upgrade in MyJFrog >

Working with an older version?

JFrog Artifactory 6.x
JFrog Xray 2.x
JFrog Mission Control 3.x
JFrog Distribution 1.x
JFrog Enterprise+ (Pre-Platform Release)




Skip to end of metadata
Go to start of metadata

Overview

The procedure to upgrade Distribution depends on your installation type. We strongly recommend reading through this page before proceeding with your upgrade.

Before you upgrade Distribution please refer to additional information on supported platforms, browsers and other requirements, and the system architecture.

Note: Make sure to use the same upgrade method (RPM, Debian, Docker, etc.) as the one you initially used to install Distribution.

Upgrading to 2.x for the first time?

It is recommended that you first review what's new with the latest JFrog Platform. Review the breaking changes, deprecated features and more.

To ensure you can restore your Distribution and database in case you encounter any issues during the upgrade process, we strongly recommend that you make sure your system and database backups are up to date.

Artifactory and Distribution Pairing

The upgrade to the JFrog Platform requires mapping a source Artifactory to a single Distribution service. If you are creating and distributing release bundles from multiple source Artifactory instances and one Distribution instance, you will now need to deploy a Distribution service in every JPD that contains these source Artifactory instances. If your Mission Control instance is part of another JPD, you'll need to register it in the new Distribution instance. See details here.


Upgrade Steps

The upgrade procedure involves the following main steps:

  1. Download Distribution (Docker Compose, RPM, Debian).
  2. Stop the Distribution service
  3. Install Distribution 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 v2.x).
  5. Start the service using the start scripts or OS service management.
  6. Check the Distribution Log for the status of the service.

Default Home Directory / $JFROG_HOME

The default Distribution home directory is defined according to the installation type. For additional details see the Product Directory Structure page.

Note: This guide uses $JFROG_HOME to represent the JFrog root directory containing the deployed product.

Page Contents

Upgrading from Version Below 1.6

To upgrade from a version below 1.6.x, you first need to upgrade to version 1.6.x as described in the Upgrading Distribution 1.x documentation, and then continue to upgrading from version 1.6 to 2.x.

Upgrading from Version 1.6 to 2.x

JFrog Distribution v2.x is only compatible with JFrog Artifactory v7.x. To upgrade, you must first install JFrog Artifactory 7.x.

There are several new concepts introduced in Distribution 2.x, improving the installation and customization process.

The following upgrade methods are supported:

Interactive Script Upgrade (recommended)

The installer script works with all supported upgrade methods (RPM, Debian and Docker Compose). It provides you an interactive way to install Distribution and its dependencies.

  1. Download Distribution

  2. Stop the service.

    Docker - Stop and remove old containers
    distribution stop
docker ps -a --format '{{.Names}}' | grep ^distribution_* | xargs docker rm -f
    Linux
    cd /opt/jfrog/distribution/scripts
./distribution.sh stop

  3. Extract the contents of the compressed archive and go to the extracted folder.

    tar -xvf jfrog-distribution-<version>-<compose|rpm|deb>.tar.gz
cd jfrog-distribution-<version>-<compose|rpm|deb>

    .env file included within the Docker-Compose archive

    This .env file is used by docker-compose and is updated during installations and upgrades.

    Notice that some operating systems do not display dot files by default. If you make any changes to the file, remember to backup before an upgrade.

  4. Run the installer script.
    Note: the script will prompt you with a series of mandatory inputs, including the jfrogURL (custom base URL) and joinKey.

    Compose
    ./config.sh
    RPM/DEB
    ./install.sh

  5. Check that the migration has completed successfully, by reviewing the following files:

    1. migration log: $JFROG_HOME/distribution/var/log/migration.log file.

    2. system.yaml configuration: $JFROG_HOME/distribution/var/etc/system.yaml
      This newly created file will contain your current custom configurations in the new format.

  6. Start and manage the Distribution service.

    systemd OS
    systemctl start|stop distribution.service
    systemv OS
    service distribution start|stop
    Docker Compose
    cd jfrog-distribution-<version>-compose
docker-compose -p distribution up -d
docker-compose -p distribution ps
docker-compose -p distribution down
  7. Access Distribution from your browser at: http://<jfrogUrl>/ui/, go the Distribution tab in the Application module in the UI.

  8. Check Distribution Log.

    Linux
    tail -f $Product Directory Structure/var/log/console.log

Manual RPM Upgrade

The RPM installation bundles Distribution and all its dependencies. It is provided as native RPM packages, where Distribution and its dependencies must be installed separately. Use this if you are automating installations.

  1. Download Distribution.

  2. Stop the current server.

    cd /opt/jfrog/distribution/scripts
./distribution.sh stop

  3. Extract the contents of the compressed archive and go to the extracted folder.

    tar -xvf jfrog-distribution-<version>-rpm.tar.gz
cd jfrog-distribution-<version>-rpm

  4. Install Distribution as a service on Red Hat compatible Linux distributions, as a root user.

    yum -y install ./distribution/distribution.rpm

  5. Check that the migration has completed successfully, by reviewing the following files:

    1. migration log: $JFROG_HOME/distribution/var/log/migration.log file.

    2. system.yaml configuration: $JFROG_HOME/distribution/var/etc/system.yaml
      This newly created file will contain your current custom configurations in the new format.

  6. Set the Artifactory connection details.
  7. Make sure the third party services are running.

  8. Start and manage Distribution.

    systemd OS
    systemctl start|stop distribution.service
    systemv OS
    service distribution start|stop

  9. Access Distribution from your browser at: http://<jfrogUrl>/ui/, go the Distribution tab in the Application module in the UI.

  10. Check Distribution Log.

    tail -f $JFROG_HOME/distribution/var/log/console.log

Manual Debian Upgrade

The Debian upgrade bundles Distribution and all its dependencies. It is provided as native Debian packages, where Distribution and its dependencies must be installed separately. Use this if you are automating installations.

  1. Download Distribution.

  2. Stop the current server.

    cd /opt/jfrog/distribution/scripts
./distribution.sh stop

  3. Extract the contents of the compressed archive and go to the extracted folder.

    tar -xvf jfrog-distribution-<version>-deb.tar.gz
cd jfrog-distribution-<version>-deb

  4. Install Distribution as a service on a Debian compatible Linux distributions, as a root user.

    Run Installation
    dpkg -i ./distribution/distribution.deb

  5. Check that the migration has completed successfully, by reviewing the following files:

    1. migration log: $JFROG_HOME/distribution/var/log/migration.log file.

    2. system.yaml configuration: $JFROG_HOME/distribution/var/etc/system.yaml
      This newly created file will contain your current custom configurations in the new format.

  6. Set the Artifactory connection details.
  7. Make sure the third party services are running.

  8. Start and manage Distribution.

    service distribution start|stop
  9. Access Distribution from your browser at: http://<jfrogUrl>/ui/, go the Distribution tab in the Application module in the UI.

  10. Check Distribution Log.

    tail -f $JFROG_HOME/distribution/var/log/console.log

Post-Upgrade Steps

Once the upgrade is complete.

Migrating Release Bundle Metadata to the Distribution Services

The new JFrog Platform requires Distribution to be connected to a single Source Artifactory instance, as part of a JPD. 

If you had one Distribution instance connected to more than one Source Artifactory instances, use the Export and Import Release Bundle Metadata REST API commands to move to this new requirement after the upgrade process. For more information, see Upgrading Distribution.

Upgrading from Version 2.x to 2.x

The following upgrade methods are supported:

Interactive Script Upgrade (recommended)

The installer script works with all supported upgrade methods (RPM, Debian and Docker Compose). It provides you an interactive way to install Distribution and its dependencies.

  1. Download Distribution (RPM, Debian or Docker Compose).

  2. Stop the service.

    Systemd OS
    systemctl stop distribution.service
    Systemv OS
    service distribution stop
    Docker - Stop and remove old containers
    cd jfrog-distribution-<version>-compose
docker-compose -p distribution down

  3. Extract the contents of the compressed archive and go to the extracted folder. The installer script is located in the extracted folder.
    Note: For Docker Compose upgrades, make sure to merge your customizations in your current docker-compose.yaml file to the new extracted version of the     docker-compose.yaml file.

    tar -xvf jfrog-distribution-<version>-<compose|rpm|deb>.tar.gz
cd jfrog-distribution-<version>-<compose|rpm|deb>

    Copy the contents of the .env file in a previous installation (regardless if it has changed or not ) to the newly created .env file in this archive.

  4. Run the installer script.
    Note: if needed, the script will prompt you with a series of mandatory inputs, including the jfrogURL (custom base URL) and joinKey.

    Compose
    ./config.sh
    RPM/DEB
    ./install.sh

  5. Start and manage the Distribution service.

    systemd OS
    systemctl start|stop

    distribution.service


    systemv OS
    service distribution start|stop
    Docker Compose
    cd jfrog-distribution-<version>-compose
docker-compose -p distribution up -d
docker-compose -p distribution ps
docker-compose -p distribution down
  6. Access Distribution from your browser at: http://<jfrogUrl>/ui/, go the Distribution tab in the Application module in the UI.

  7. Check Distribution Log.

    tail -f $JFROG_HOME/distribution/var/log/console.log

Manual RPM/Debian Upgrade

  1. Download Distribution (RPM or Debian)

  2. Stop the current server.

    systemd OS
    systemctl stop distribution.service
    systemv OS
    sservice distribution stop

  3. Extract the contents of the compressed archive and go to the extracted folder.

    tar -xvf jfrog-distribution-<version>-<rpm|deb>.tar.gz
cd jfrog-distribution-<version>-<rpm|deb>

  4. Install Distribution as a service on Red Hat compatible Linux distributions, as a root user.

    rpm
    yum -y install ./distribution/distribution.rpm
    Debian
    dpkg -i ./distribution/distribution.deb

  5. Start and manage Distribution.

    systemd OS
    systemctl start|stop distribution.service
    systemv OS
    service distribution start|stop

  6. Access Distribution from your browser at: http://<jfrogUrl>/ui/, go the Distribution tab in the Application module in the UI.

  7. Check Distribution Log.

    tail -f $JFROG_HOME/distribution/var/log/console.log

Linux Archive Upgrade 

  1. Stop the current server.

    Stop Distribution
    # Export variables to simplify commands - set JFROG_HOME to current installed directory
export JFROG_HOME=/opt/jfrog
cd $JFROG_HOME/distribution/app/bin
./distribution.sh stop

  2. Extract the contents of the compressed archive and go to the extracted folder.

    Untar
    mv jfrog-distribution-<version>-linux.tar.gz /opt/jfrog/
cd /opt/jfrog
tar -xf jfrog-distribution-<version>-linux.tar.gz

  3. Replace the existing $JFROG_HOME/distribution/app with the new app folder.

    Upgrade
    export JF_NEW_VERSION=/opt/jfrog/jfrog-distribution-<version>-linux

# Remove app
rm -rf $JFROG_HOME/distribution/app

# Copy new app
cp -fr $JF_NEW_VERSION/app $JFROG_HOME/distribution/

# Remove extracted new version
rm -rf $JF_NEW_VERSION

  4. Manage Distribution.

    $JFROG_HOME/distribution/app/bin/distribution.sh start|stop
  5. Access Distribution from your browser at: http://<jfrogUrl>/ui/, go the Dashboard tab in the Application module in the UI.

  6. Check Distribution Log.

    tail -f $JFROG_HOME/distribution/var/log/console.log

Third Party Applications

PostgreSQL

If you have installed the PostgreSQL database packaged as part of 1.x, you can continue to use it. Use the following command to start and stop your PostgreSQL service.
Notice: the ./distribution.sh stop all command, used in Distribution 1.x versions cannot be used in version 2.x.

service postgresql-9.6 start|stop|status

Redis

This will be available from the previous install. Use the following commands to start and stop your service.

Red Hat / CentOS
service redis start|stop|status
Debian / Ubuntu
service redis-server start|stop|status
  • No labels
Copyright © 2020 JFrog Ltd.