10.4 | Setup and upgrade | Upgrade the server | Performing the upgrade

Performing the server upgrade

Before you start

Consider the following before starting your upgrade:

SonarQube releases come with some specific recommendations for upgrading from the previous version. You should read the release upgrade notes for each version between your current version and the target version.
Database disk usage recommendations: During your upgrade, tables may be duplicated to speed up the migration process. This could cause your database disk usage to temporarily increase to as much as double the normal usage. Because of this, we recommend that your database disk usage is below 50% before starting a migration.

Upgrading a ZIP file instance

Before you upgrade, make sure you know how to install the server from the ZIP file and check that your environment meets the requirements of the version you're upgrading to.

To upgrade from the ZIP file:

Download and unzip the SonarQube distribution of your edition in a fresh directory, let's say <newSonarqubeHome>.
If you're using third-party plugins, Manually install plugins that are compatible with your version of SonarQube. Use the plugin version matrix to ensure that the versions you install are compatible with your server version. Simply copying plugins from the old server to the new is not recommended; incompatible or duplicate plugins could cause startup errors. Analysis of all languages provided by your edition is available by default without plugins.
Update the contents of sonar.properties file (in <newSonarqubeHome>/conf) with the settings in the <oldSonarqubeHome>/conf directory (web server URL, database, ldap settings, etc.). Do not copy-paste the old files. If you are using the Oracle DB, copy its JDBC driver into <newSonarqubeHome>/extensions/jdbc-driver/oracle.
Stop your old SonarQube Server.
Start your new SonarQube Server.
Browse to http://yourSonarQubeServerURL/setup and follow the setup instructions.
Reanalyze your projects to get fresh data.

Upgrading a Docker image instance

If you're upgrading with an Oracle database or you're using plugins, you can reuse your extensions volume from the previous version to avoid moving plugins or drivers. Use the Plugin version matrix to ensure that your plugins are compatible with your version. Analysis of all languages provided by your edition is available by default without plugins.
If upgrading from 8.9.x LTS to 9.9.x LTS: Please note that the lts tag on Docker images is replaced with every new LTS release. If you want to avoid an automatic major upgrade, we recommend using the corresponding 9.9-<edition> tag instead of relying on the lts-<edition> tag.
Unless you intend to delete the database and start new when running your image, be careful not to use -v to docker-compose down and, be careful when running commands like docker system prune or docker volume prune; regardless if you use an external: true parameter, your database volumes will not persist beyond the initial startup and shutdown of SonarQube.

To upgrade SonarQube using the Docker image:

Stop and remove the existing SonarQube container (a restart from the UI is not enough as the environment variables are only evaluated during the first run, not during a restart):

$ docker stop <container_id>
$ docker rm <container_id>

2. Run Docker.

$> docker run -d --name sonarqube \
    -p 9000:9000 \
    -e SONAR_JDBC_URL=... \
    -e SONAR_JDBC_USERNAME=... \
    -e SONAR_JDBC_PASSWORD=... \
    -v sonarqube_data:/opt/sonarqube/data \
    -v sonarqube_extensions:/opt/sonarqube/extensions \
    -v sonarqube_logs:/opt/sonarqube/logs \
    <image_name>

3. Go to http://yourSonarQubeServerURL/setup and follow the setup instructions.

4. Reanalyze your projects to get fresh data.

Upgrading a Helm chart instance

If you're upgrading with an Oracle database or you're using plugins, you can reuse your extensions PVC from the previous version to avoid moving plugins or drivers. Use the Plugin Version Matrix to ensure that your plugins are compatible with your version. Analysis of all languages provided by your edition is available by default without plugins.

Please verify that any custom configurations or custom values.yaml files contain only parameters that are still compatible with the targeted chart, and adjust them if needed. Some default parameters may have changed between versions of the chart.

Standard procedure

Change the SonarQube version on your values.yaml.
Redeploy SonarQube with the same helm chart:

helm upgrade --install -f values.yaml -n <your namespace> <your release name> <path to sonarqube helm chart>

3. If you're upgrading a Data Center Edition: after SonarQube search pods are running and ready, only one application (app) replica will be running and ready. You can confirm that it's because of the ongoing upgrade by inspecting the logs of the pod for this text: The database must be manually upgraded. Please backup the database and browse /setup.

4. Go to http://yourSonarQubeServerURL/setup and follow the setup instructions.

5. Reanalyze your projects to get fresh data.

If upgrading from 8.9.x LTS to 9.9.x LTS

Upgrade from 8.9.x LTS to 9.9.x LTS

To install SonarQube 9.9 LTS, use the sonarqube Helm chart. The sonarqube-lts Helm chart is no longer maintained and cannot be used to install the new LTS.

For SonarQube 9.9 LTS Community, Developer, and Enterprise Editions, the Helm chart version to use is 8.x.x . See sonarqube ArtifactHub for more information.
For SonarQube 9.9 LTS Data Center Edition, the Helm chart version to use is 7.x.x . See sonarqube-dce ArtifactHub for more information.

As SonarQube only requires to persist the database, the general upgrade process will consist of uninstalling your instance before installing the new LTS.

If you are using an external database, you don't have any persistent data inside kubernetes. Therefore, there is no action required.

Instead, if you rely on the embedded PostgreSQL chart (not recommended), uninstalling the chart will keep the PVC alive. The PVC can then be reused either:

by specifying postgresql.existingClaim in the values.yaml file
by not changing parameter values, but making sure you install the new chart in the same namespace (auto-generated name will be the same).

Upgrading from a ZIP file instance to a Docker instance

To migrate from the ZIP file to Docker:

Configure your Docker instance to point to your existing database.
Shut down your ZIP instance.
Start your Docker instance.

Was this page helpful?