Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  • Review the Ubuntu release notes and upgrade instructions:
  • Update all packages to the latest versions:
    sudo apt update && apt full-upgrade

  • Ensure that the X-Road software version is 6.20.0/1 or 6.21.0.

  • Recommended: Make sure that you have an up-to-date backup (or virtual machine snapshot) of the server and database.

  • Use the admin UI to take a backup of the security server configuration and download it to a safe location

    • This makes it possible to restore the server configuration if the upgrade fails for some reason.

  • Stop the security server:
    sudo stop xroad-proxy; sudo stop xroad-jetty; sudo stop xroad-confclient; sudo stop xroad-signer; sudo stop xroad-monitor; sudo stop xroad-opmonitor

  • Optionally, take backup of the message log database. Without a backup, a failure in the upgrade process may cause loss of data.

    • See
    • Using pg_dump is a straightforward option, but can be problematic if the database is extremely large:
      sudo -iu postgres pg_dump -d messagelog -F c -f <dump_file>
    • Reducing the size of the message log database dump: By default the message log database keeps 30 days of message records but one can (temporarily) change the retention time in order to reduce the number of records in the database, thus reducing the size of the database dump. Changing the setting has no immediate effect since by default the message log cleanup is run twice a day (noon and midnight). See Security Server User Guide for more information.

  • Optionally, take a backup of the archived message log files.
    • Note that some of the logged messages might not have been archived yet and exist only in the database.
  • Optionally, take backup of the operational monitoring database (if xroad-opmonitoring is installed). Without a backup, a failure in the upgrade process may cause loss of data.