Skip to content

Minor and major upgrade procedure#

Use this procedure to upgrade MSR to a new minor or major version. The procedure preserves your existing configuration and data by reusing your current harbor.yml file with the target release installer.

  1. Connect to the host running MSR over SSH.

    ssh <USER>@<MSR-HOST-IP>
    
  2. Locate your harbor.yml configuration file.

    Verify that you have the harbor.yml file used for the current installation. This file contains your MSR configuration, including hostname, TLS certificates, database settings, and any external service references. Change to the directory containing this file.

    cd <PATH-TO-MSR-DIRECTORY>
    ls harbor.yml
    

    If your deployment uses external PostgreSQL or Redis, their connection details are configured in the external_database and external_redis sections of harbor.yml. Confirm that these remain correct before you proceed.

  3. Download the target MSR installer package.

    Locate the .tgz installer package for the latest MSR release at Mirantis Packages. The release is available as a single bundle and is suitable only for offline installations.

    Copy the download link for the installer package, then download it to your instance:

    wget https://s3-us-east-2.amazonaws.com/packages-mirantis.com/msr/msr-offline-installer-<VERSION>.tgz
    
    4. Rename the MSR old version directory.

    mv msr msr-<PREVIOUS-PATCH-VERSION>
    
  4. Extract the package.

    tar xvf msr-offline-installer-<VERSION>.tgz
    
  5. Navigate to the extracted folder.

    cd msr
    
  6. Copy the harbor.yml file used for the current installation to the newly extracted folder.

    cp -p <PATH-TO-MSR-OLD-DIRECTORY>/harbor.yml .
    
  7. Compare your harbor.yml against the new harbor.yml.tmpl file included in the target installer package. New MSR versions can introduce additional configuration fields. Add any new required fields to your harbor.yml before you run the installer.

    diff harbor.yml harbor.yml.tmpl
    
  8. Stop running MSR services.

    cd <PATH-TO-MSR-OLD-DIRECTORY>
    docker-compose down
    

    Do not use the -v flag

    Do not run docker-compose down -v. The -v flag removes named volumes and results in data loss. Use docker-compose down without flags to stop and remove containers while preserving volumes.

  9. Run the new installer.

    Change to the new installer directory and run install.sh. The script regenerates docker-compose.yml and all supporting configuration files from your harbor.yml, then starts the updated services.

    cd msr-offline-installer-<TARGET-VERSION>
    sudo ./install.sh
    

    If your deployment includes Trivy for vulnerability scanning, pass the --with-trivy flag:

    sudo ./install.sh --with-trivy
    

    The installer applies required database migrations automatically on startup. Review the output for errors before you proceed.

  10. Verify the upgrade.

    docker-compose ps
    

    Log in to the MSR web UI at your configured externalURL and verify that the deployment functions as expected.