Upgrading From 7.1
SSO Users
If upgrading from a release prior that 7.1.1 you will need to follow the below. If you are upgrading from 7.1.1 or greater there is no need to do this.
If you have configured uControl to use SSO for user authentication you will need to backup some files before continuing with the upgrade. These files are :
<uControl_homeDir>/tomcat8/webapps/uControl/config/samlSSO.properties
<uControl_homeDir>/tomcat8/webapps/uControl/WEB-INF/classes/metadata/Metadata.xml
<uControl_homeDir>/tomcat8/webapps/uControl/WEB-INF/classes/metadata/FederationMetadata.xml
LDAP Users
If upgrading from a release prior that 7.1.1 you will need to follow the below. If you are upgrading from 7.1.1 or greater there is no need to do this.
If you have configured uControl to use LDAP for user authentication you will need to backup some files before continuing with the upgrade. These files are :
<uControl_homeDir>/tomcat8/webapps/uControl/config/ldap/ldap.properties
Email Notification Templates
If upgrading from a release prior that 7.1 you will need to follow the below for email notification templates. If you are upgrading from 7.1 or greater there is no need to do this.
If changes to the email notifications has been done within the UI these will need to be backed up and restored after the uControl upgrade is completed.
The Template directory is located in the <uControl_homeDir>/tomcat8/webapps/uControl/config/templates
Version 7.1 includes a change to the location of these template files. Once the backup has been completed and the upgrade has also completed then location of the email templates are in the /apps/uControl/templates directory.
Post Upgrade - If changes to the email notifications need to be restored then once the system has started you will find the new location for the email templates at /apps/uControl/templates. Restore the backup of the email notification templates to this directory and restart the uControl application services.
Upgrading
Ensure the following steps are completed by the dedicated uControl user account
Stop the uControl application processes
<uControl_homeDir>/tomcat8/bin/shutdown.shRemove the previous uControl deployment
rm -rf <uControl_homeDir>/tomcat8/webapps/uControlRecreate the uControl deployment directory
mkdir <uControl_homeDir>/tomcat8/webapps/uControlUnzip the new uControl application package
cd <uControl_homeDir>/tomcat8/webapps/uControlunzip (path_to_uControl_war_file>
Post Upgrade steps
Post upgrade - Database configuration
If upgrading from a release prior that 7.1.2 you will need to follow the below. If you are upgrading from 7.1.2 or greater there is no need to do this.
The database configuration has been externalised from the uControl package - meaning the settings will not be overwritten in future upgrades.
Copy the following file and place in the /apps/uControl/security directory:
Edit the file and replace the required values DATABASE USER, DATABASE NAME and DATABASE PASSWORD
Ensure it's owned by the user used to start / stop uControl and has permissions set to 640
Post upgrade - Start uControl
Start the uControl processes
|
SSO and LDAP configurations have been externalised to prevent future upgrade requiring the backup and restore of these files.
Post upgrade - SSO
If upgrading from a release prior that 7.1.1 you will need to follow the below. If you are upgrading from 7.1.1 or greater there is no need to do this.
Copy the backed up 3 files to the /apps/uControl/security/saml directory
Edit the /apps/uControl/security/springProfile.properties :
From:
|
To:
|
Restart the uControl processes
|
Post upgrade - LDAP
If upgrading from a release prior that 7.1.1 you will need to follow the below. If you are upgrading from 7.1.1 or greater there is no need to do this.
Copy the backed up file to the /apps/uControl/security/ldap directory
Edit the /apps/uControl/security/springProfile.properties :
From:
|
To:
|
Restart the uControl processes
|