About the automated Install/Migration tool

The flexdeployerinstaller.sh script is a new automated process that reduces customer efforts in installing or upgrading FlexDeploy, which will make staying up to date on FlexDeploy versions easier.  The installer will take care of installation or upgrade of FlexDeploy with no manual intervention required.  There is a configuration file which will need to be modified for your installation and then the installer can take over.  There are three basic modes to the installer: 1) prerequisite checking with no installation or upgrade, 2) first time installation of FlexDeploy and 3) upgrading a current installation of FlexDeploy.

The apache-tomcat-flexdeploy folder will be cleaned up with each upgrade, so it is important not to place any supporting files in the apache-tomcat-flexdeploy folder. Place them in the flexdeploy home folder or another subfolder instead.

Versions / Release Notes

Installer Version 1.0.1 was released on 12/6/2022. This version has fixes for a number of issues that customers faced and is recommended for all upgrades and installs moving forward.

This automated installer will handle

• executing prerequisite checks to ensure the installation/upgrade will be successful

• downloads of FlexDeploy software and influx database software if the VM has access to the Internet

• installation of FlexDeploy for the first time

• upgrading of FlexDeploy to a new version from version 5.2.0.5 or newer

• backing up the current FlexDeploy installation, plugins, and optionally artifacts before upgrading

• backing up the database before upgrading (optional)

• creating or migrating the FlexDeploy database schemas

• installation or configuration of the influx database which is used for reporting and dashboard data

This automated installer will not handle

• downloads of software if the VM has no access to the Internet. In this case, the files need to be placed on the FlexDeploy server in locations specified by the installer

• download of security wallets

• upgrading from FlexDeploy versions older than 5.2.0.5

• upgrading a Kubernetes installation

See FlexDeploy Architecture for architecture details.

Installer arguments

The Argument c must be the last argument specified.

The following arguments are available to be used:

• -p run the installer in the prerequisite checking mode with no installation/upgrade occurring.  The execution of this checking will not do anything with the current installation, so it can be run anytime.  If the installer detects any issue(s), the issue will be reported to the logs and displayed on the screen.  The prerequisites will also be run during the installation or upgrade process and may stop the process, which is why it is recommended to run this mode until there are no issues being reported.  Each issue that is reported will have a possible resolution to the issue to assist you in resolving it.  Some of the checks are: verify file system sizes to make sure all required directories have at least the minimum amount, flexdeployinstaller_config.txt file properties are set, java is at the right level, etc. Removing this argument will execute the install/upgrade.

• -c/<path to>/flexdeployinstaller_config.txt points the installer to the flexdeployinstaller_config.txt file that contains the user configurations.  The file should not be saved under the flexdeployinstaller folder.  It is always required.

• -s there are several passwords in the flexdeployinstaller_config.txt file and if a password field is left blank, in this scenario, a prompt for the password will happen (nothing will be stored) and the password is not shown on the screen, similar to other Linux password prompts.  The -s option will show the password on the screen as you type.

• -n don’t allow any Internet connections to download the necessary zip files. Use this if you downloaded them to the server already and wish for those to be used instead of downloading new ones.

• -i skip the database backup. This can be done if you have an existing database backup.

• -a skip the artifacts backup. This can be done if you have an existing backup of the artifacts folder or a snapshot of the VM.

• -d Install as a docker container.

• -w Specify that you are upgrading from a Weblogic install to a Tomcat install. Not compatible with the -d option.

Step by Step Guide to Using the installer

Step 0: System Requirements