Skip to main content

Restoring the IQ Server

It's important to be able to restore the IQ Server in case of a disaster. In most scenarios, restoring the IQ Server is as simple as transferring the last known usable backup to your production setting.

Restoring the IQ Server

In most situations, if your account with Sonatype qualifies for Support, begin any disaster recovery work by opening a Support Ticket and including a support .zip or, if a support .zip isn't possible, your log files.

Regardless of your deployment method, make sure your IQ Server is shut down before beginning any restore procedure.

Also, whenever possible, restore to the same version of the IQ Server you were previously running. This helps prevent configuration issues, aids in troubleshooting, and prevents unnecessary disruption to workflows. To identify the version of IQ Server you're using, either log in to the browser UI and check the bottom left-hand corner. By default, the name of your IQ Server .jar also contains the version number, e.g. nexus-iq-server-1.150.0-01.jar.

Enterprise deployments with an external Postgres database

To restore the IQ Server:

  1. Contact your Postgres database administrator, if your organization has one.

  2. Identify the last known good backup.

  3. Move that backup's IQ Server .jar, config.yml file, and sonatype-work directory into your production setting.

  4. Restore the Postgres database from the backup that most closely matches the time period of the contents of the sonatype-work directory.

  5. Start the IQ Server.

To restore the Postgres database, refer to the PostgreSQL documentation.

Enterprise deployments with the embedded H2 database

To restore the IQ Server:

  1. Identify the last known good backup.

  2. Move that backup's IQ Server .jar, config.yml file, and sonatype-work directory into your production setting.

  3. Start the IQ Server.

Containerized Deployments

Containerized deployments require persistent volumes. If using the embedded H2 database, your persistent volume contains everything the IQ Server needs to run, including the server .jar, the configuration files, and the embedded H2 database. If using the Postgres database with a containerized deployment, that Postgres database is likely also containerized.

To restore the IQ Server from a containerized deployment, take the last known good persistent volumes and move them into your production environment.

Collaborate with your container management team, if your organization has one. Start your restore procedure by bringing them into your conversation.

Potential Issues

Because the config.yml file is versioned alongside the IQ Server .jar, a mismatch between the .jar file and the config.yml file can cause configuration issues. Avoid this by backing up the IQ Server .jar and config.yml together and restoring them together.

When restoring an enterprise deployment with the external Postgres database, if the sonatype-work folder and the Postgres database are not pulled from the same point in time, some links in the browser UI may appear to be broken. To fix this, scan your apps again.

Sonatype does not recommend that you attempt to simultaneously restore and upgrade the IQ Server. Instead, first, restore the IQ Server, then attempt to upgrade.