Versions Compared

Key

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


Info

These are the upgrade instructions to the latest release: SSO 9.0. If you are upgrading to a SSO 8.x.x version, please check the upgrade instructions for that particular release.

...

Note

NOTE: If the solution contains additional components UbiloginCertAP and/or UbiloginWSIDP it is recommended to stop these services prior stopping the Ubiloginserver service whenever stated in the step list. UbiloginCertAP and UbiloginWSIDP services can be started after starting the Ubiloginserver service.

SSO Cluster

The diagram below describes an SSO cluster configuration to be updated.

High availability is achieved by using two SSO instances so that there is one active SSO node, and another, passive, as high availability option if another SSO node is not available. A reverse proxy is used to switch the traffic in case of failures. In case of high-performance setup, the traffic load can be distributed between both SSO nodes by the reverse proxy.

Note that LDAP content is replicated between the SSO instances, but both SSO nodes use their own LDAP (LDAPs can be installed also on their own nodes).

A reverse proxy is configured to use primarily SSO 1 node, and SSO 2 node only when SSO 1 node is not available. During the update operation, the reverse proxy is used to switch traffic away from an SSO node that is being updated while the other SSO node is still operational.   

Image Added

Image Removed

Clustered SSO Update

Update Procedure Overview

...

  1. Find out which SSO node is the schema master
    1. Use the Active Directory Schema snap-in to connect an AD LDS instance
    2. Identify the schema master
  2. Configure the reverse proxy server to route the production traffic only to the SSO 2 node
    1. Setup both SSO nodes for the activity test
    2. Optional: Test through the reverse proxy server which SSO node is active
    3. Disable traffic from the reverse proxy server to the SSO 1 node
    4. Test through the reverse proxy server which SSO node is active
  3. Disable the replication
    1. Stop the Ubiloginserver process from the SSO 1 node
    2. Disable outbound and inbound replication from the SSO 2 node
    3. Disable outbound and inbound replication from the SSO 1 node
  4. Configure the metadata clean up for the retired AD LDS instances in the SSO 1 node
    1. Clean up the metadata from the SSO 1 node using the dsmgmt tool
    2. Remove the SSO 2 node server object from the SSO 1 node using the ADSI Edit tool 
  5. Update the SSO 1 node
    1. Use document: Upgrade on Windows - SSO
    2. Test the functionality of the updated SSO 1 node
  6. Configure Proxy to route production traffic only to SSO 1 Server
    1. Route the traffic towards the SSO 1 node
    2. Optional: Export session information from the SSO 2 node's directory and import to SSO 1 node's directory
    3. Setup SSO 1 node for the activity test
    4. Test through the reverse proxy server which SSO node is active
  7. Remove the services and the AD LDS from the SSO 2 node
    1. For the version to be removed, check Check Java 8 environment variables
    2. Stop SSO and Accounting Service Windows services
    3. Remove SSO and Accounting Service Windows service configurations
    4. Remove the AD LDS from the SSO 2 node
  8. Enable the replication in the SSO 1 node
  9. Update the SSO 2 node
    1. Install Java 11 to the SSO 2 node
    2. Execute the steps in the document  AD LDS clustering setup (node 2) - SSO
    3. Install the new SSO version to the SSO 2 node
    4. Update Tomcat configuration by reinstalling it to the SSO 2 node
    5. See also Check Single node installation finalization
    6. Test the functionality of the updated SSO 2 node
  10. Enable traffic from the Reverse Proxy to route production traffic to SSO 2 node in addition to the SSO 1 node

...

Code Block
languagexml
themeDefault
regsvr32 schmmgmt.dll


Image Modified

Click the OK button


Code Block
languagexml
themeDefault
mmc


Image Modified

File - Add/Remove Snap-in...


Image Modified

Available snap-ins Active Directory Schema Add - OK


Image Modified

Active Directory Schema - Change Active Directory Domain Controller (Do not mind the possible connection error).


Image Modified

This Domain Controller or AD LDS instance - <SSO_Node _Name>:<LDAP Port>

Highlight the SSO Server name - OK


Image Modified

If you get this dialog - click the OK button

      

      b.   Identify the schema master

Image Modified

Active Directory Schema Operations Master


Image Modified

Verify the schema master and click the close button.


Step 2. Configure the Reverse Proxy to route the production traffic only to the SSO2 node

...

Code Block
languagexml
themeDefault
cd /d "C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\webapps\ROOT\

C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\webapps\ROOT\notepad index.html


Image Modified

Type: Node<SSO_node_number>

Update the ubilogin server.

...

      b.  Optional: Test which SSO node is active through the reverse proxy server (NOTE, in high-performance configuration where both SSO nodes are always active you can skip this step.)

Image Modified

Write the uas.url to the browser (found from the win32.config file).

Check which node responses.


Note

NOTE, the certification error in the browser window above is due to the self-assigned certificate used in the test environment.

...

      d.  Test which SSO node is active through the reverse proxy server

Image Modified

Write the uas.url to the browser (found from the win32.config file).

Verify that the correct node responses.

Step 3. Disable the Replication

...

Connect to the ADSI Edit tool.

Image Modified

Start - Windows Administrative Tools - ADSI Edit

Rick click ADSI Edit - Connect to...


Define the connection settings

Image Modified

Select a well known Naming Context - Configuration

Select or type a domain or server - localhost:389


Remove the NTDS settings object under the SSO 2 node if it exists.

Image Modified

ADSI Edit - <SSO_2_node> - NTDS Settings - Delete

Click the Yes button.


Remove the SSO 2 node object.

Image Modified

ADSI Edit - <SSO_2_node> - Delete

Click the Yes Button.

File - Exit


Step 5. Update the SSO1 node

...

Code Block
languagexml
themeDefault
cd /d "C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\webapps\ROOT\

C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\webapps\ROOT\notepad index.html


Image Modified

Type: Node<SSO_node_number>


Update the ubilogin server.

...

      d.   Test which SSO node is active through the reverse proxy server

Image Modified

Write the uas.url to the browser (found from the win32.config file).

Check which node responses.


Step 7. Remove the services and AD LDS from the SSO 2 node

...

      d.  Remove the AD LDS from the SSO 2 node

Image Modified

Start - Control Panel - Programs - Uninstall a program - AD LDS Instance UbiloginDirectory - Uninstall


Image Modified

Click the Yes button.


Image Modified

Click the Skip button if you get this message (the replication is not on at this

point in the SSO 2 node).


Image Modified

Click the OK button.


Step 8. Enable replication in the SSO 1 node

...

      c. Install the new SSO version to the SSO 2 node.

         Copy the Ubisecure SSO configurations from the SSO 1 node to the SSO 2 node.

    • In practice, this means that the SSO installation folder (C:\Program Files\ubisecure\ubilogin-sso) is copied as such
    • Check the win32.config file's parameter ldap.url to see if the LDAP has been installed in the localhost. If the directory (LDAP) connection is something else than "localhost" (LDAPs are installed on their own separate nodes) then modify the C:\Program Files\ubisecure\ubilogin-sso\ubilogin\config\settings.cmd file's LDAP URL parameters on the SSO node 2
      1. set LDAP_URL=ldap://<IP address of the LDAP server 2>:389
      2. set LDAP_URL_HOSTNAME=<IP address of the LDAP server 2>
      3. set LDAP_URL_PORT=389

      d. Update Tomcat configuration by reinstalling it (DON’T RUN setup.cmd on SSO node 2):

Code Block
languagexml
themeDefault
C:\Program Files\Ubisecure\ubilogin-sso\ubilogin>config\tomcat\install.cmd
Keystore already exist in c:\Program Files\Ubisecure\ubilogin-sso\ubilogin\custom\tomcat\keystore.pfx
5 File(s) copied
776 File(s) copied
[SC] ChangeServiceConfig SUCCESS
[SC] ChangeServiceConfig2 SUCCESS
[SC] ChangeServiceConfig SUCCESS
The UbiloginServer service is starting..
The UbiloginServer service was started successfully.


Ubilogin Server started at https://www.example.com/ubilogin/

      

      e. See also Check Single node installation finalization. For the new Java installation you must need to import SSO certificate to Java trust store.

...