| Table of Contents |
|---|
Pre Version 7 of uControl
There is no upgrade path from version 6.x to version 7.x of uControl. Please speak to TekWurx support for assistance migrating from 6.x to 7.x or see details for uMap application migration.
Pre GA version 7 of uControl
For customers upgrading from the Pre GA release of uControl 7.0 please update the following prior to starting up uControl after the upgrade has been completed:
| Code Block | ||
|---|---|---|
| ||
<bean id="patchAssetRecordUpdate" class="java.lang.Boolean" scope="singleton">
<constructor-arg value="true" />
</bean>
<bean id="reloadDefaultTeams" class="java.lang.Boolean" scope="singleton">
<constructor-arg value="true" />
</bean>
<bean id="reloadAuditIndexes" class="java.lang.Boolean" scope="singleton">
<constructor-arg value=“true”/>
</bean> |
| Warning |
|---|
Initial startup time will be increased while the patch is applied |
Once the system is up and running ensure you change these values back to default of "false".
Version 7.0.x Upgrade
Backup
Ensure that a full backup has been completed before starting the upgrade a it will provide a full rollback ability of the uControl application.
Either create a backup through the UI as details here. Alternatively, run a data export from MySQL Workbench.
Latest WAR Deployment File
Login to the tekwurx Download site https://e-download.tekwurx.com and download the latest upgrade WAR file.
SSO Users
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
web.xml
Location : <uControl_homeDir>/tomcat8/webapps/uControl/WEB-INF/web.xml
For SSO, update the following line in the web.xml:
From:
| Code Block |
|---|
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>default</param-value>
</context-param> |
To:
| Code Block |
|---|
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>SSO</param-value>
</context-param> |
LDAP Users
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
web.xml
Location : <uControl_homeDir>/tomcat8/webapps/uControl/WEB-INF/web.xml
For LDAP, update the following line in the web.xml:
From:
| Code Block |
|---|
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>default</param-value>
</context-param> |
To:
| Code Block |
|---|
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>LDAP</param-value>
</context-param> |
Email Notification Templates
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
When restoring ensure that the files are replaced rather than the directory. As future releases will include additional / new email notification templates.
Upgrading
Ensure the following steps are completed by the dedicated uControl user account
Stop the uControl application processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh |
Remove the previous uControl deployment
| Code Block |
|---|
rm -rf <uControl_homeDir>/tomcat8/webapps/uControl |
Recreate the uControl deployment directory
| Code Block |
|---|
mkdir <uControl_homeDir>/tomcat8/webapps/uControl |
Unzip the new uControl application package
| Code Block |
|---|
cd <uControl_homeDir>/tomcat8/webapps/uControl
unzip (path_to_uControl_war_file> |
Post Upgrade steps
Once the above steps are completed if using SSO or LDAP for user authentication the files will need to be copied over the top of the base files from the new deployment.
Also if customised database names / username or passwords are being used for the database connections update these settings in the <uControl_homeDir>/tomcat8/webapps/uControl/config/configurationPatameters.xml file.
Start the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/startup.sh |
Version 7.1 Upgrade
Backup
Ensure that a full backup has been completed before starting the upgrade a it will provide a full rollback ability of the uControl application.
Either create a backup through the UI as details here. Alternatively, run a data export from MySQL Workbench.
Latest WAR Deployment File
Login to the tekwurx Download site https://e-download.tekwurx.com and download the latest upgrade WAR file.
7.1
SSO Users
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
web.xml
Location : <uControl_homeDir>/tomcat8/webapps/uControl/WEB-INF/web.xml
For SSO, update the following line in the web.xml:
From:
| Code Block |
|---|
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>default</param-value>
</context-param> |
To:
| Code Block |
|---|
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>SSO</param-value>
</context-param> |
LDAP Users
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
web.xml
Location : <uControl_homeDir>/tomcat8/webapps/uControl/WEB-INF/web.xml
For LDAP, update the following line in the web.xml:
From:
| Code Block |
|---|
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>default</param-value>
</context-param> |
To:
| Code Block |
|---|
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>LDAP</param-value>
</context-param> |
Email Notification Templates
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.
Upgrading
Ensure the following steps are completed by the dedicated uControl user account
Stop the uControl application processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh |
Remove the previous uControl deployment
| Code Block |
|---|
rm -rf <uControl_homeDir>/tomcat8/webapps/uControl |
Recreate the uControl deployment directory
| Code Block |
|---|
mkdir <uControl_homeDir>/tomcat8/webapps/uControl |
Unzip the new uControl application package
| Code Block |
|---|
cd <uControl_homeDir>/tomcat8/webapps/uControl
unzip (path_to_uControl_war_file> |
Post Upgrade steps
Once the above steps are completed if using SSO or LDAP for user authentication the files will need to be copied over the top of the base files from the new deployment.
Also if customised database names / username or passwords are being used for the database connections update these settings in the <uControl_homeDir>/tomcat8/webapps/uControl/config/configurationPatameters.xml file.
Start the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/startup.sh |
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.
7.1.1
SSO Users
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 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
| Note |
|---|
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
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh |
Remove the previous uControl deployment
| Code Block |
|---|
rm -rf <uControl_homeDir>/tomcat8/webapps/uControl |
Recreate the uControl deployment directory
| Code Block |
|---|
mkdir <uControl_homeDir>/tomcat8/webapps/uControl |
Unzip the new uControl application package
| Code Block |
|---|
cd <uControl_homeDir>/tomcat8/webapps/uControl
unzip (path_to_uControl_war_file> |
Post Upgrade steps
Post upgrade - Database configuration
Also if customised database names / username or passwords are being used for the database connections update these settings in the <uControl_homeDir>/tomcat8/webapps/uControl/config/configurationPatameters.xml file.
Post upgrade - Start uControl
Start the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/startup.sh |
SSO and LDAP configurations have been externalised to prevent future upgrade requiring the backup and restore of these files.
Post upgrade - SSO
Copy the backed up 3 files to the /apps/uControl/security/saml directory
Edit the /apps/uControl/security/springProfile.properties :
From:
| Code Block |
|---|
spring.profiles.active=default |
To:
| Code Block |
|---|
spring.profiles.active=SAML |
Restart the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh
<uControl_homeDir>/tomcat8/bin/startup.sh |
Post upgrade - LDAP
Copy the backed up file to the /apps/uControl/security/ldap directory
Edit the /apps/uControl/security/springProfile.properties :
From:
| Code Block |
|---|
spring.profiles.active=default |
To:
| Code Block |
|---|
spring.profiles.active=LDAP |
Restart the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh
<uControl_homeDir>/tomcat8/bin/startup.sh |
7.1.1.HF1
SSO Users
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 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
| Note |
|---|
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
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh |
Remove the previous uControl deployment
| Code Block |
|---|
rm -rf <uControl_homeDir>/tomcat8/webapps/uControl |
Recreate the uControl deployment directory
| Code Block |
|---|
mkdir <uControl_homeDir>/tomcat8/webapps/uControl |
Unzip the new uControl application package
| Code Block |
|---|
cd <uControl_homeDir>/tomcat8/webapps/uControl
unzip (path_to_uControl_war_file> |
Post Upgrade steps
Post upgrade - Database configuration
Also if customised database names / username or passwords are being used for the database connections update these settings in the <uControl_homeDir>/tomcat8/webapps/uControl/config/configurationPatameters.xml file.
Post upgrade - Drop menu tables
To ensure all menu items are reloaded at startup the following tables need to be dropped prior to start the uControl application:
TEK_U_MENUS
TEK_MENU_GROUP_MAP
Post upgrade - Start uControl
Start the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/startup.sh |
SSO and LDAP configurations have been externalised to prevent future upgrade requiring the backup and restore of these files.
Post upgrade - SSO
Copy the backed up 3 files to the /apps/uControl/security/saml directory
Edit the /apps/uControl/security/springProfile.properties :
From:
| Code Block |
|---|
spring.profiles.active=default |
To:
| Code Block |
|---|
spring.profiles.active=SAML |
Restart the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh
<uControl_homeDir>/tomcat8/bin/startup.sh |
Post upgrade - LDAP
Copy the backed up file to the /apps/uControl/security/ldap directory
Edit the /apps/uControl/security/springProfile.properties :
From:
| Code Block |
|---|
spring.profiles.active=default |
To:
| Code Block |
|---|
spring.profiles.active=LDAP |
Restart the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh
<uControl_homeDir>/tomcat8/bin/startup.sh |
7.1.2
SSO Users
| Note |
|---|
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
| Note |
|---|
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
| Note |
|---|
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
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh |
Remove the previous uControl deployment
| Code Block |
|---|
rm -rf <uControl_homeDir>/tomcat8/webapps/uControl |
Recreate the uControl deployment directory
| Code Block |
|---|
mkdir <uControl_homeDir>/tomcat8/webapps/uControl |
Unzip the new uControl application package
| Code Block |
|---|
cd <uControl_homeDir>/tomcat8/webapps/uControl
unzip (path_to_uControl_war_file> |
Post Upgrade steps
Post upgrade - Database configuration
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
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/startup.sh |
SSO and LDAP configurations have been externalised to prevent future upgrade requiring the backup and restore of these files.
Post upgrade - SSO
| Note |
|---|
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:
| Code Block |
|---|
spring.profiles.active=default |
To:
| Code Block |
|---|
spring.profiles.active=SAML |
Restart the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh
<uControl_homeDir>/tomcat8/bin/startup.sh |
Post upgrade - LDAP
| Note |
|---|
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:
| Code Block |
|---|
spring.profiles.active=default |
To:
| Code Block |
|---|
spring.profiles.active=LDAP |
Restart the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh
<uControl_homeDir>/tomcat8/bin/startup.sh |
7.1.2.HF1, 7.1.3, 7.1.4, 7.1.5, 7.1.6
SSO Users
| Note |
|---|
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
| Note |
|---|
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
| Note |
|---|
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.
| Info | ||
|---|---|---|
| ||
If you are upgrading from a TekWurx uControl version 7.1 appliance follow the documentation here. |
| Info | ||
|---|---|---|
| ||
If you are upgrading from a TekWurx uControl version 7.1.1 appliance follow the documentation here. |
Upgrading
Ensure the following steps are completed by the dedicated uControl user account
Stop the uControl application processes
Code Block <uControl_homeDir>/tomcat8/bin/shutdown.sh
Remove the previous uControl deployment
Code Block rm -rf <uControl_homeDir>/tomcat8/webapps/uControl
Recreate the uControl deployment directory
Code Block mkdir <uControl_homeDir>/tomcat8/webapps/uControl
Unzip the new uControl application package
Code Block cd <uControl_homeDir>/tomcat8/webapps/uControl unzip (path<path_to_uControl_war_file>
Post Upgrade steps
...
Post upgrade - Database configuration
| Note |
|---|
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
...
Post upgrade - Start uControl
Start the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/startup.sh |
SSO and LDAP configurations have been externalised to prevent future upgrade requiring the backup and restore of these files.
Post upgrade - SSO
| Note |
|---|
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:
| Code Block |
|---|
spring.profiles.active=default |
To:
| Code Block |
|---|
spring.profiles.active=SAML |
Restart the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh
<uControl_homeDir>/tomcat8/bin/startup.sh |
Post upgrade - LDAP
| Note |
|---|
Copy the backed up file to the /apps/uControl/security/ldap directory
Edit the /apps/uControl/security/springProfile.properties :
From:
| Code Block |
|---|
spring.profiles.active=default |
To:
| Code Block |
|---|
spring.profiles.active=LDAP |
Restart the uControl processes
| Code Block |
|---|
<uControl_homeDir>/tomcat8/bin/shutdown.sh
<uControl_homeDir>/tomcat8/bin/startup.sh |
...