Logo Sonatype CLM Sonatype CLM - Upgrade Instructions
Documentation Index
Sonatype CLM Downloads
Release Notes
Document Descriptions and PDFs
Upgrade Instructions
Requirements

Sonatype CLM Server
Installation and Configuration
Security Administration
Policy Management
Dashboard
Application Composition Report
REST APIs

Sonatype CLM for...
Bamboo
CLI
Hudson and Jenkins
IDE
Maven
Nexus
SonarQube

The CLM Book (All Guides)
Optimized Component Lifecycle Management with Sonatype CLM

Sonatype CLM - Upgrade Instructions

Chapter 1. General Upgrade Instructions

As the Sonatype CLM Server is the central element of the Sonatype CLM suite of products, it is often referred to synonymously as Sonatype CLM. The latest version of the Sonatype CLM Server can be downloaded from the Sonatype support site.

The instructions below cover general upgrading instructions. However, depending on the version you are upgrading from, there may be additional steps needed to complete your unique upgrade path. Please review these accordingly.

Finally, before starting any upgrade, always start by checking our compatibility matrix, Knowledge Base article, and making a backup.

[Tip]

Before attempting an upgrade, it’s best to review all upgrade instructions provided for your current version, as well as any versions that followed.
CLM Server Upgrade
  1. Download the Sonatype CLM Server bundle.
  2. Backup the existing sonatype-work folder and config.yml file contained in the CLM Server installation directory.
  3. Extract the contents of the CLM Server bundle to the CLM server installation directory.
  4. Merge the changes in the backed up version of config.yml into the new config.yml.
  5. Modify any start/stop scripts with new server jar file name
  6. Restart the CLM Server.
  7. Restart your browser or clear browser cache.
[Note]

Be sure to delete your cache, or fully restart your browser whenever upgrading to the latest version of Sonatype CLM.
Jenkins CI Plugin Update
  1. Download the Jenkins CI plugin
  2. Shutdown Jenkins
  3. Delete the <jenkins-home>/plugins/sonatype-clm-ci folder
  4. Delete the <jenkins-home>plugins/sonatype-clm-ci.hpi file
  5. Copy the downloaded hpi file to <jenkins-home>/plugins/
  6. Rename the hpi file to sonatype-clm-ci.hpi
  7. Start Jenkins
Eclipse IDE Plugin Update
Use the Eclipse Check for Updates to update the Sonatype CLM IDE plugin.
[Warning]

Users of Sonatype CLM 1.8x and earlier (includes 1.5x, 1.6x, and 1.7x) will need to ensure all applications have a parent organization. Failure to assign an organization to an application will result in failure of the Sonatype CLM Server to start.