Versions Compared

Version Old Version 19 New Version 20
Changes made by

Chandresh Patel

Chandresh Patel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The FlexDeploy™ Linux Installer Guide provides system requirements, required downloads and instructions for installing or upgrading FlexDeploy and its components.

...

Excerpt
nameAbout

About the automated Install/Migration tool

The flexdeployerinstaller.sh script is a new an automated process that reduces customer efforts in for 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 . There is a configuration file which will need to be modified 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.

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 FLEXDEPLOY_HOME folder or another subfolder instead. Example of such files may include SSO configuration file, other Keystore and/or Wallet files.

Versions / Release Notes

The current version is 1.0.5. 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 or upgrading to FlexDeploy 5.7.0.12 or higher.

  • upgrading from version 5.1.0.0 or higher.

  • 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 from FlexDeploy versions older than 5.1.0.0

  • upgrading to FlexDeploy versions older than 5.7.0.12

  • upgrading a Kubernetes installation

See FlexDeploy Architecture for architecture details.

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. Previously this was mentioned in the config file. It was moved here so that it is easier to ensure what version will be installed. (Added in version 1.0.5 of the installer.) You can specify versions as 4 numbers separated by periods, or the word latest. (Required argument)

    • 6.5.0.0

    • 6.0.0.4

    • 5.7.0.12

    • latest

  • -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. (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 WebLogic install to a Tomcat install. Not compatible with the -d option.

Step by Step Guide to Using the installer

Step 0: System Requirements

Info

See FlexDeploy System Requirements for details on software and hardware requirements

Step 1: Database Preparation (Installation Only)

PostgreSQL

Install the Postgres PostgreSQL binaries, and create a flexdeploy database. The automated installer will do the rest.

Either from the commandlinecommand line

Code Block
languagebash
createdb flexdeploy

or if you have sql access to the postgres PostgreSQL database, you can connect to the postgres database and use sql.

Code Block
languagesql
create database flexdeploy;

...

Excerpt
namestep2

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.

Code Block
wget -O flexdeployinstaller.zip https://flexagon.# 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/flexdeployinstaller

If you don’t have wget, and must use curl, use the -L argument like:

Code Block
curl -L --max-redirs 5 https://flexagon.com/downloads/flexdeployinstaller --output flexdeployinstaller.zip

Once downloaded, select a directory (ex. /u01 or /u02) to unzip the flexdeployinstaller.zip.Change directory to your selected directory and unzip the flexdeployinstaller.zip download in FLEXDEPLOY_INSTALLER_HOME.

Code Block
languagebash
cd <FLEXDEPLOY$FLEXDEPLOY_INSTALLER_HOME>HOME
unzip <path to flexdeployinstaller download>/flexdeployinstaller.zip

Step 3: Setup the Configuration File

...

Panel
panelIconId270b-1f3fc
panelIcon:raised_hand::skin-tone-3:
panelIconText✋🏼
bgColor#E6FCFF

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 processthis 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 to avoid being overlaid with any new flexdeployinstaller downloads as this would remove all of your entered configurations.  There for current and any future executions. There is a template file located in FLEXDEPLOYinstaller download, (for example $FLEXDEPLOY_INSTALLER_HOME/flexdeployinstaller_1.0.5).  This template file must be copied to any other location, it could be placed in the FLEXDEPLOY_HOME and it would be safe from overlay and easier to find for the next upgrademust be copied and modified.

Code Block
languagebash
cd <FLEXDEPLOY$FLEXDEPLOY_INSTALLER_HOME>HOME/flexdeployinstaller_X.X.X
cp flexdeployinstaller_config.txt ../  # this is one option to save but this can be saved to any other location.  Just must be out of FLEXDEPLOY_INSTALLER_HOME/fledeployinstaller directory due to installer upgrades.

Step 3.2: Updating flexdeployinstaller_config.txt

...

Info

FLEXDEPLOY_HOME is a key property as the flexdeployinstaller will determine based on this property if a current installation is running, make sure the directory location is correct (e.g. the FLEXDEPLOY_HOME would be the path up to, but not including, the apache-tomcat-flexdeploy directory. /u01/flexdeploy/apache-tomcat-flexdeploy would have a FLEXDEPLOY_HOME of /u01/flexdeploy.

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 Java JDK 8, it would be the path up to bin (not including bin)

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.

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 PostgresPostgreSQL.

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'

At the completion of updating and saving the flexdeployinstaller_config.txt file, run the following command at any time, to source in the properties from the flexdeployinstaller_config.txt file and make them available to be used for navigation.

...

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 you don’t your FlexDeploy server does not have Internet access, all software downloads noted below must reside on the FlexDeploy server be completed before you can install or upgrade. The prerequisite checks will validate if Internet access to the needed locations is available.If you have Internet access, but choose to place the files manually.

Step 4.1: FlexDeploy software (conditional)

...

conditional)

If your FlexDeploy server doesn't does not have internet access to the Internet, the then FlexDeploy software can 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).

...

languagebash

...

saved to $FLEXDEPLOY_INSTALLER_HOME

...

/downloads/software (don't unzip).

Step 4.2: Influx database (conditional)

...

If you are installing/upgrading FlexDeploy with to version 6.0+ and your FlexDeploy server has access to the Internet, the flexdeployinstaller.sh will pull the required version of the software and client from the influx data website.If you are installing/upgrading FlexDeploy with version 6.0+ and your FlexDeploy server doesn't have access to the Internetthen keep reading otherwise skip to next step. If your FlexDeploy server does not have Internet access, the software and the client must be downloaded from the influx data website using the embedded links.  The 2 downloaded gzip files must be saved to FLEXDEPLOY_INSTALLER_HOME/downloads/influxdb (don't extract them). This only needs to be downloaded once.

...

languagebash

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

Now that the downloads that are needed are completed and the flexdeployinstaller_config.txt file is updated, the prerequisite checks should be executed outside of the Next step is to run prerequisite checks before running install/upgrade process. 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 Tomcat process.

Code Block
languagebash
cd ${FLEXDEPLOY_INSTALLER_HOME}/flexdeployinstaller_X.X.X
./flexdeployinstaller.sh -p -v 6.5.0.0 -c <path to saved config file>/flexdeployinstaller_config.txt

...