Upgrade Procedure

Upgrading Katalogue to a newer version is fairly simple and normally follows the same procedure, as described here. Note that there might be differences depending on your specific deployment.

Caution

It is highly recommended to perform a test upgrade in another environment before upgrading the production environment.

Procedure

This is the general procedure to upgrade Katalogue to a newer version:

1. Check the changelog for any version-specific deviations from this upgrade procedure.

2. Backup the PostgreSQL repository database.

3. Download the new release from the official Katalogue GitHub repo.

4. Upgrade the PostgreSQL repository database by connecting to the database as an admin and execute the /services/db/deltas/<version>.sql scripts in order, starting with the next version relative to the Katalogue instance that is to be upgraded.

   E.g. if you are upgrading from version 0.16.0 to 0.18.0, the 0.17.0.sql script must be executed first, followed by 0.18.0.sql. The delta scripts only contain the differences from one version to another. Note that these delta scripts might introduce breaking changes, meaning that the Katalogue instance might not work correctly until the next step is completed.

5. Replace the api and spa services source code in your local repo with the updated code from the Katalogue GitHub repo and re-deploy the services.

6. Verify that all Katalogue services have the same, and the intended, version.

   • The spa version is displayed when hovering over the info-icon in the upper right corner of the GUI.
   • The api version is displayed when navigating to the api service base url in the browser, e.g. https://demo-api.katalogue.se.
   • The database version is available in the public.version table.

7. Run the Rebuild Search Index task.

8. Verify that everything works by clicking around in the GUI, running a datasource sync job etc.