Clustered upgrade during a service break - SSO

These are the upgrade instructions to the latest release: SSO 9.1. If you are upgrading from a SSO 8.x.x version, ensure the upgrade steps to SSO 9.0 (Java11, systemd service management, and OpenLDAP MDB) have been considered.

Overview

This page specifies the steps for updating a clustered deployment of Ubisecure SSO during a service break. If service breaks are not allowed or the system must all the time be operational for other reasons, please see instructions from Clustered upgrade on Windows - SSO.

Preliminary tasks

If you are using Windows operating system, find out which SSO node is the schema master (see step 1 from Clustered upgrade on Windows - SSO) and update Ubisecure SSO on the schema master node first. The schema master node is referred as SSO node 1 below.

Update procedure

Start the service break e.g. by forwarding all traffic from the reverse proxy to a service break information page.
On both SSO nodes, stop the Ubisecure SSO process and Accounting Service if it has been installed and is running, keep Ubisecure Directory running.
Windows:
```
net stop ubiloginserver
net stop ubisecureaccounting
```
Linux (version 8.x.x):
```
systemctl stop ubilogin-server
systemctl stop ubisecure-accounting
```
On SSO node 1, update Ubisecure SSO according to update instructions in SSO Upgrade on Windows or SSO Upgrade On Linux.
Linux: Optionally reconfigure LDAP failover on SSO node 1 as instructed here: Install SSO node 2.
Test all functionality including possible customizations by using the updated SSO node 1.
On SSO node 2, update Ubisecure SSO according to the following steps. Note that possible directory schema changes are replicated from node 1 and therefore no actions are needed for Ubisecure Directory on node 2.
1. Make sure you have Java installed and JRE_HOME and JAVA_HOME set according to System Recommendations and Supported Platforms
2. Remove the existing services (SSO and Accounting Service):
  Windows:
```
cd /d "C:\Program Files\Ubisecure\ubilogin-sso\ubilogin"
config\tomcat\remove.cmd
```
  Linux:
```
cd /usr/local/ubisecure/ubilogin-sso/ubilogin
./config/tomcat/remove.sh
```
3. Rename the ubilogin-sso directory to ubilogin-sso-old
4. Copy the ubilogin-sso directory from node 1 to node 2
  1. If you want to preserve the logs of node 2 replace the log files with ubilogin-sso-old/ubilogin/logs and ubilogin-sso-old/accounting/logs with the files in the respective ubilogin-sso directories
5. Windows: Fix local URL to refer to the node 2 host in C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\accounting\config\application-install.properties
```
ubisecure.ids.accounting.server.url = <scheme>\://<node2host>\:<accounting-port>
```
6. Linux: Fix LDAP_LISTEN_URLS to refer to the node 2 host in /usr/local/ubisecure/ubilogin-sso/ubilogin/config/settings.sh as instructed here: Install SSO node 2 so that it matches with the version in ubilogin-sso-old:
```
vi /usr/local/ubisecure/ubilogin-sso/ubilogin/config/settings.sh
```
7. Tune the Accounting Service scheduled job settings in node 2, see Accounting Service additional configuration / Recommended changes
  Windows edit the file in this location:
```
ubilogin-sso\ubilogin\custom\accounting\config\application.yaml
```
  Linux:
```
vi ubilogin-sso/ubilogin/custom/accounting/config/application.yaml
```
8. Update SSO and Accounting Service configurations by reinstalling them - NOTE do not run setup script setup.cmd/setup.sh on SSO node 2 because it will override the secrets which need to match those on node 1
  
  Windows:
```
cd /d "C:\Program Files\Ubisecure\ubilogin-sso\ubilogin"
config\tomcat\install.cmd
```
  Linux, also start the services, about Accounting Service (ubisecure-accounting) start see also Linux single node installation:
```
cd /usr/local/ubisecure/ubilogin-sso/ubilogin
./config/tomcat/install.sh
systemctl start ubisecure-accounting
systemctl start ubilogin-server
```
On SSO node 1, stop Ubilogin SSO process and Accounting Service, see Starting and stopping the services.
Test all functionality by using the updated SSO node 2.
On SSO node 1, return to the normal operation by starting Ubilogin SSO process and Accounting Service.
Reset the reverse proxy to the original configuration.