LumisXP Upgrade Assistance Script

The LumisXP has a script to assist with your upgrade. It is a script compatible with both Windows and Linux, and it is designed to help with the update process of LumisXP.

However, it is worth noting that this script does not execute the complete process, which involves, among other things, backing up the environment. It only aims to assist with some steps that can be automated.

In order for the script to run, it is necessary to have a configuration file named lumisxpupgrade.config.yml in the same directory from which the script will be called. It is important to highlight that this directory should be some directory outside of the LumisXP installation directory.

The Configuration File

The update configuration file lumisxpupgrade.config.yml has the following options:
targetVersion: <target version to update to> lumisxp: directory: <path of the LumisXP installation that will be updated> appserver: type: <type of application server> http: port: <HTTP port number of the application server> bind: <bind address of the application server> stop: command: <command to stop the application server> webserver: type: <type of web server> version: <version of the web server> getVersionCommand: <command to get the version of the web server> bigdata: config: directory: <path of the Elasticsearch configuration directory> lumiswebsite: username: <username to download the new version of LumisXP>

Below is the description of each of these options:

Option Required Default Value Description

targetVersion

Yes

Version to which you want to update the LumisXP.
Accepts full versions (e.g., 16.1.0.240202-0) or partial versions (e.g., 16.1.0, 16.1.x, 16.x, 16).
If the version definition is partial and it satisfies more than one version, the most recent version will be chosen.
For example, if the available versions for download were 16.0.0.230707-0, 15.0.4.230411-0, 14.2.0.220506-0, and 14.1.1.220128-0, the following versions would be chosen:

`targetVersion`	Chosen Version
`16.1.x`	`16.1.0.240202-0`
`16.x`	`16.1.0.240202-0`
`16`	`16.1.0.240202-0`
`15`	`15.0.4.230411-0`
`14`	`14.2.0.220506-0`
`*`	`16.1.0.240202-0`

lumisxp.directory Yes Installation directory of the LumisXP. If LumisXP is installed using the Standalone version, this directory is the root directory of the Standalone version (the directory that contains the lumisportal directory).

appserver.type Yes Indicates the type of application server being used. It can be Tomcat or JBoss.

appserver.http.port No None, if the installation is not Standalone. HTTP port of the application server. Used along with appserver.http.bind to validate if the server is running or not. If not defined, this validation will not be performed.

9080, if the installation is Standalone

appserver.http.bind No "127.0.0.1" Bind address of the application server. Used along with appserver.http.port to validate if the server is running or not. Only used if appserver.http.port is defined.

appserver.stop.command No Optional command to be used to stop the application server before the upgrade is performed.

webserver.type Yes Indicates the type of web server being used. It can be None (none), Apache or Nginx.

webserver.version No Indicates the current version of the web server being used. Used to validate the compatibility of the web server with the new version of LumisXP.

webserver.getVersionCommand No Command to be executed to obtain the version of the web server. Only used if webserver.version is not defined.

bigdata.config.directory No Indicates the configuration directory of Elasticsearch. Used to validate that the necessary options for the proper functioning of LumisXP are present.

lumiswebsite.username No Username to download the new version of LumisXP from the Lumis website. If not defined, it will be requested during the update process.

Update on Linux

As an example, suppose that:

The LumisXP is installed in /lumis/lumisxp.
The update will be made to the latest available version.
The user who will download the new version from the Lumis website is my_user.
The application server used is Apache Tomcat and it will be stopped manually.
The web server used is Nginx.
The version of the web server is 1.25.3.
The update will be initialized from a directory ~/lumisxp-upgrade.
The Elasticsearch servers are on other machines, and therefore the configuration directories must be set manually.

In this case, the update configuration file lumisxpupgrade.config.yml would be in the ~/lumisxp-upgrade folder.
cat lumisxpupgrade.config.yml
# Let's update to the latest version targetVersion: "*" # LumisXP Directory lumisxp: directory: /lumis/lumisxp # Application Server appserver: type: Tomcat # Web Server webserver: type: Nginx version: 1.25.3 # Lumis Website lumiswebsite: username: my_user

To start the update process, one needs to:

Make a complete backup of the environment.
Change the current directory to ~/lumisxp-upgrade: cd ~/lumisxp-upgrade.
Run the update script: bash <(curl https://www.lumis.com.br/lumisxp/upgrade/upgrade.sh).
Follow the instructions of the script.

Update on Windows

As an example, suppose that:

The LumisXP is installed in C:\lumis\lumisxp.
The update will be made to version 16.1.0.
The user who will download the new version from the Lumis website is my_user.
The application server used is Apache Tomcat.
The command to be used to stop the application server is net stop tomcat
No web server is used.
The update will be initialized from a directory C:\lumis\lumisxp-upgrade.
The configuration directory of Elasticsearch is C:\lumis\elasticsearch\config.

In this case, the update configuration file lumisxpupgrade.config.yml would be in the C:\lumis\lumisxp-upgrade folder.
more lumisxpupgrade.config.yml
# Let's update to version 16.1.0 targetVersion: 16.1.0 # LumisXP Directory lumisxp: directory: C:\lumis\lumisxp # Application Server appserver: type: Tomcat http: port: 8080 bind: 127.0.0.1 stop: command: net stop tomcat # Web Server webserver: type: None # Lumis Website lumiswebsite: username: my_user # Elasticsearch Configuration bigdata: config: directory: C:\lumis\elasticsearch\config

To start the update process, one needs to:

Make a complete backup of the environment.
Open a terminal Powershell.
Change the current directory to C:\lumis\lumisxp-upgrade: cd C:\lumis\lumisxp-upgrade.
Run the update script: Invoke-Expression((New-Object System.Net.WebClient).DownloadString('https://www.lumis.com.br/lumisxp/upgrade/upgrade.ps1')).
Follow the instructions of the script.

Updating a Cluster Environment

If you want to update a cluster environment, the process described above must be repeated on each node of the LumisXP cluster.
However, the last step of the script (where it asks Would you like to execute LumisXP upgrade script (<script name>)? If it is a cluster install and the script has already been executed in another node, you should answer 'No'.) should only be executed on one of the cluster nodes. For the others, the answer to this question should be No.

Notes

This update method is only available from version 16.1.0 of LumisXP.
Before starting the LumisXP application server(s) for the first time after the update, you must:
- Review the entire installation for any corrections and adjustments for the new version of LumisXP.
- Review all configuration files for any corrections and adjustments for the new version of LumisXP.
- Review all solution files for any corrections and adjustments for the new version of LumisXP.
- Review the entire configuration of the servers (application, web, database, Elasticsearch, etc.) for any corrections and adjustments for the new version of LumisXP.
- Restart the servers (web, Elasticsearch, database, etc.) that need it (for example, due to changes in their configurations).