How to Upgrade a Central Server to Ubuntu 22.04 Using a Configuration Backup?

This document describes the steps required for migrating Central Server from an existing Ubuntu 20.04 LTS host to a new Ubuntu 22.04 LTS host. The migration is done taking a backup of the central server configuration and restoring the backup on the Ubuntu 22.04 LTS host. Please read carefully through the whole document and Central Server installation instructions before starting the upgrade process.

Preparation

Connecting a hardware security module (HSM) to a new server may require additional steps that are not covered by these instructions. Check the HSM documentation and verify that it supports Ubuntu 22.04.

  • Ensure that the current central server's software is updated to version 7.2.0.

    • In case of a central server cluster, ensure that all nodes have the same X-Road software version.

  • Review the Central Server Installation Guide.

  • If you are upgrading a cluster, review the Central Server High Availability Installation Guide

  • On the current server, use the admin UI to take a backup of the central server configuration and download it to a safe location.

    • Note that the backup does not include X-Road admin user account(s) or the database admin credentials (/etc/xroad.properties)

    • In a clustered setup, take a configuration backup from each server.

  • Prepare to update your network configuration.

    •  After the upgrade, you may need to change the upgraded server's IP address(es) to match the old addresses and/or update DNS,  firewall, NAT, or other network configuration so that security servers and configuration proxies can reach the upgraded server.

    • The exact steps depend on your network setup and are not covered in this guide.

Upgrade process

Stand-alone central server

  • Set up a Ubuntu 22.04 server

  • Do a clean install of central server software version 7.2.0 on Ubuntu 22.04 (see the X-Road Central Server Installation Guide)

  • Restore the central server configuration from the backup

  • Verify that the central server services are running and the system is functioning.

  • Switch over to the new server

    •  e.g. change the new server's IP address(es) to match the old addresses and/or update DNS,  firewall, NAT, or other network configuration.

Clustered central server

The cluster upgrade can be done one node at a time.

  • Set up an Ubuntu 22.04 server

  • Stop the old central server node

  • Install Central Server software and restore the backup

  • Verify that the central server services are running and the system is functioning.

  • Switch over to the new server

    •  e.g. change the new server's IP address(es) to match the old addresses and/or update DNS,  firewall, NAT, or other network configuration.