Automated Linux Install / Upgrade
- Karl Henselin
- Jim Hardtke
- Ben Hoffman
The FlexDeploy™ Linux Installer Guide provides system requirements, required downloads and instructions for installing or upgrading FlexDeploy and its components on Linux and Docker.
About the automated Install/Migration tool
The flexdeployerinstaller.sh script is an automated process that reduces efforts for installing or upgrading FlexDeploy. There is a configuration file which will need to be configured 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. You choose prereqs mode with the -p argument. Upgrade or install is selected by the presence of the FlexDeploy war in the webapps folder. If you are upgrading Weblogic, use the -w argument.
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. Example of such files may include the SSO configuration file, Keystore and/or Wallet files.
Versions / Release Notes
The current version is 1.0.22. You should always download the latest version before running another install or upgrade. See the Installer Release Notes for more information.
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 server has access to the Internet
installation of FlexDeploy 5.7.0.12+
upgrading from version 5.1.0.0+
upgrading to FlexDeploy 5.7.0.12+
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 for FlexDeploy version 6.0 and higher.
This automated installer will not handle
downloads of software if the server 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 a Kubernetes installation
install or upgrade on Windows
Installer arguments
The following arguments are available to be used:
-p run the installer in the prerequisite checking mode. There will be no installation/upgrade performed when using this flag, so it can be run anytime. If the installer detects any issue(s), those 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.
-v version Tells the installer what version to install. You can specify versions as 4 numbers separated by periods, or the word latest. (Required argument)
See http://support.flexagon.com or http://wiki.flexagon.com to find details on latest or specific version. Few examples of specific versions are 8.0.0.1, 8.0.0.4 etc.
If you are planning to upgrade or install more than one FlexDeploy instances, then make sure to use specific version instead of word latest as meaning of latest will change over time.
-c <path to>/flexdeployinstaller_config.txt points the installer to the flexdeployinstaller_config.txt file that contains the user configurations. (Required argument)
-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.
-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
See FlexDeploy System Requirements for details on software and hardware requirements. See FlexDeploy Architecture for architecture details.
Step 1: Database Preparation (Installation Only)
Oracle
Install the Oracle Database binaries and find your jdbc connection string. The automated installer will create FD, FF, and FD_ADMIN schemas in the USERS tablespace.
PostgreSQL
Install the PostgreSQL binaries, and create a flexdeploy database. The automated installer will do the rest.
Either from the command line
createdb flexdeployor if you have sql access to the PostgreSQL database, you can connect to the database and use sql.
create database flexdeploy;Step 2: Get the Installer
Download flexdeployinstaller.zip and get it to the FlexDeploy server. You can wget it there directly if you have Internet access, or transfer the file from another machine. FLEXDEPLOY_INSTALLER_HOME is folder where installer will be used for installer binaries and configuration files.
# select folder location where installer will be downloaded and executed from
export FLEXDEPLOY_INSTALLER_HOME=/u01/fdinstaller
mkdir -p $FLEXDEPLOY_INSTALLER_HOME
cd $FLEXDEPLOY_INSTALLER_HOME
# delete older version of installer folders - for example, flexdeployinstaller_1.0.4 (rm -r flexdeployinstaller_1*)
wget -O flexdeployinstaller.zip https://flexagon.com/downloads/flexdeployinstallerIf you don’t have wget, and must use curl, use the -L argument like:
Once downloaded, unzip the flexdeployinstaller.zip download in FLEXDEPLOY_INSTALLER_HOME.
Step 3: Setup the Configuration File
Step 3.1: Save flexdeployinstaller_config.txt
This step is extremely important to preserve your configuration file from any potential installer upgrades. This step should only be done once: on a new installation or on a first time upgrade with this new process. Once you have this file, you can use it and modify as necessary.
There is a configuration file (flexdeployinstaller_config.txt) that controls the actions of the installer. It is the most important file for the installer and needs to be saved for current and any future executions. There is a template file located in installer download, (for example $FLEXDEPLOY_INSTALLER_HOME/flexdeployinstaller_1.0.5). This template file must be copied and modified.
Step 3.2: Updating flexdeployinstaller_config.txt
Spaces are not supported in any directory and/or password values.
This step should only need to be done once, on a new installation or on a first time upgrade with this new process. Unless there is a change to any of the configuration properties.
Once copied, the file needs to be adjusted for your installation requirements (there are many default values in the file and they can stay defaulted). There are comments in the template file for each property but this guide will cover the properties that need to be updated.
Configuration Property | Required | Description |
|---|---|---|
FLEXDEPLOY_HOME | Yes | This is the directory location where FlexDeploy will be installed or is already installed, the default is /u01/flexdeploy. |
FLEXDEPLOY_JAVA_HOME | Yes | This is the path to the appropriate Java JDK for FlexDeploy. It should be the path up to, but not including bin. Note that for FlexDeploy < 9.0 this is JDK 8, and for FlexDeploy 9.0+, this is Java 11 or 17. |
WORKING_DIRECTORY | No Defaults to ${FLEXDEPLOY_HOME}/application | This will be the directory location that FlexDeploy uses for temporary files to be transferred between the server and its endpoints. The default location is under FLEXDEPLOY_HOME and is named application. |
ARTIFACT_REPOSITORY_DIRECTORY | No Defaults to ${FLEXDEPLOY_HOME}/artifacts | this will be the directory location that FlexDeploy uses to store all build artifacts and retrieve deployment artifacts. The default location is under FLEXDEPLOY_HOME and is named artifacts. |
BACKUP_DATABASE_DIRECTORY | No | The directory where the database will be backed up to. This value is optional. If Oracle, this directory must already exist within the DBA_DIRECTORIES table and the DIRECTORY_PATH for the entry must exist on the file system on the Database Server. If Oracle, and BACKUP_DATABASE_DIRECTORY is blank, the DEFAULT data_pump directory is used if needed. If PostgreSQL, and BACKUP_DATABASE_DIRECTORY is provided, the database will be backed up to this local folder using the psql command, which must be available on this local host. If PostgreSQL, and BACKUP_DATABASE_DIRECTORY is blank, the database schemas will be backed up by cloning to another schema in the same database. |
INFLUXDB_PORT | No | InfluxDB port Defaults to 8086 if not specified. If running multiple influx servers on a single box, they must use different ports. |
FLEXDEPLOY_DB_PASSWORD | No | The password for fd_admin database user. The password will be prompted if not specified. |
SYSTEM_DB_USER | Yes | Usually set to system for Oracle and postgres for PostgreSQL. This user will create and update the schema definitions |
SYSTEM_DB_PASSWORD | No | The superuser / system password for the user SYSTEM_DB_USER This password is required to create and update schema definitions The password will be prompted if not specified. |
FLEXDEPLOY_PORT | No | Defaults to 8000 for standard installs, 8004 for Docker installs. If you are deploying SSL this port setting will likely not be helpful other than it sets the port that is shown in the message once FlexDeploy is running. |
MAINTAIN_EXISTING_CONTEXT_FILE | No Defaults to 1 | If 0, then the installation process will use the newly downloaded context.xml file and adjust the properties accordingly. If 1, then the installation process will save the existing context.xml and replace it after the upgrade so there are no changes to it.
Set to 1 if you have changes to the context.xml file that you wish to maintain such as using a password manager for your database password in context.xml. |
MAINTAIN_EXISTING_SERVER_FILE | No Defaults to 1 | If 0, then the installation process will use the newly downloaded server.xml file and adjust the properties accordingly. If 1, then the installation process will save the existing server.xml and replace it after the upgrade so there are no changes to it. If running SSL and upgrading, 1 is likely the easiest option. From very old versions, choosing 0 and then manually modifying the file may be the easiest option. |
DATABASE_URL | Yes | Adjust the appropriate connection string for the FlexDeploy database, Oracle or Postgres. Verify that your DATABASE_URL line isn’t commented out (# at the beginning of the line) and that all other DATABASE_URL lines are commented out. Several examples are listed in the config file. |
CONTAINER_NAME | No Only used for Docker Defaults to flexdeploy | If installing FlexDeploy through Docker you can set the name of the container that will be created by editing the variable below. Defaults to 'flexdeploy' |
Step 4: Download any Additional Software (conditional)
If your FlexDeploy server does not have Internet access, all software downloads noted below must be completed before you can install or upgrade. The prerequisite checks will validate if Internet access to the needed locations is available.
Step 4.1: FlexDeploy software (conditional)
If your FlexDeploy server does not have internet access then FlexDeploy software must be downloaded from the Flexagon Support Site and the downloaded zip file must be saved to $FLEXDEPLOY_INSTALLER_HOME/downloads/software (don't unzip).
Step 4.2: Influx database (conditional)
If you are installing/upgrading FlexDeploy to version 6.0+ then keep reading otherwise skip to next step. If your FlexDeploy server does not have Internet access, the software and the client must be downloaded and gzip files must be saved to $FLEXDEPLOY_INSTALLER_HOME/downloads/influxdb (don't extract them).
Step 5: Check the Prerequisites
Step 5.1: Execution
Next step is to run prerequisite checks before running install/upgrade. The prerequisite checking process is designed to be run multiple times until all reported issues are resolved. Any issue that is found will be displayed on the screen in the form of the issue and the potential resolution.
Run the installer as the user that you want to own and execute the FlexDeploy process.
Step 5.2: Resolution
With the list of issues on the screen, and in the logs (FLEXDEPLOY_HOME/upgrade/logs), each issue must be resolved before continuing. Each issue will provide some level of resolution that can assist in clearing up the given issue.
Step 6: Complete the Installation/Upgrade
Now that we have everything validated from a prerequisite check, we can start the installer process. As stated earlier, the same process will handle the installation and any upgrade. The installer will use the flexdeployinstaller_config.txt properties to detect if there is a current installation. Start the installer process by running the below command.
The process will take a few minutes.
Additional Information
Continuing an Upgrade after Database Migration Failure
When executing an upgrade with the installer you may run into a failure during the Database Migration scripts. In that case you will need to manually resolve the issue that was encountered and continue the specific migration script to completion. The execution logs for the upgrade will contain information on the last successfully run SQL statement as well as the error that occurred during execution. Once the issue is resolved we will find the location of the last successful SQL statement in the migration script and execute the remaining SQL statements one by one.
Below is an example of a log file where an exception occurred while upgrading from v5.7.0.2 to v6.0.0.0. As you can see we ran into an error when creating the FD.USER_FAVORITE table and the last successful statement was delete FROM FD.REL_SNAPSHOT_VERSION where REQUEST_ALL_FILES='Y' AND PACKAGE_NAME IS NOT NULL.
After fixing the issue we encountered while creating the FD.USER_FAVORITE table we will find the location of the last successfully executed statement in the migration script. For this specific example we can see that the last successful statement is on line 4. We will then execute the remaining SQL statements (Line 7 and beyond) one by one until all SQL statements have been executed for this migration script.
Finally, we can then attempt the upgrade again through the installer by following the instructions.
Restoring after an issue found during or after an upgrade
Sometimes it is necessary to restore if a support ticket resolution won’t be fast enough for you. In this case, you can restore using the directions here. The support team is always available for you for assistance with the restore as well.
- style