Installing FlexDeploy with Tomcat

The FlexDeploy distribution for Tomcat includes the binaries for Tomcat, the FlexDeploy WAR, and the base configurations, leaving only a few simple steps to complete the install. The distribution contains the following components. 

  • A tomcat 9.0.34 server with required libraries, and base configurations
  • The FlexDeploy WAR
  • The FlexDeploy database installation scripts
  • The FlexDeploy database migration scripts (for upgrading an existing FlexDeploy Tomcat installation)
  • The FlexDeploy plugins

Requirements 

Installation Instructions

Adjust for Windows path if you are installing on Windows platform.

Step 1. Ensure Java 8 is installed on the server.

In this example, JAVA_HOME is /u01/java/jdk1.8.0_171 but it can be anything you want. If default java is not version 8, then we will need to adjust for it during Step 7 later. 


Step 2. Extract the zip file in the desired location (referred to as "FlexDeploy Home" in this document). See example below, where zip was extracted in /u01/flexdeploy folder.

We recommend use of folder structure without any space in name.

Here is how it will look like after unzip.


Step 3. Setup the database for FlexDeploy, if you not already done so.


Step 4. Modify Tomcat configuration file (context.xml) for database connectivity depending on your database type.

  • Replace the contents of context.xml with the contents the context-<type>.xml if using PostgreSQL. The default context.xml file included is for Oracle database
  • Replace URL and Password with the actual values.

File - <FlexDeploy Home>/apache-tomcat-flexdeploy/conf/context.xml

Example JDBC URL (CONNECT_STRING)

  • Oracle
    • The JDBC short format of host:sid:port should not be used. URL must be in the format listed below as we are recommending user of UCP based connection pooling.
      • Example - jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=tcp)(HOST=**HOSTNAME**)(PORT=**PORT**)))(CONNECT_DATA=(SERVICE_NAME=**SERVICE_NAME**)))
      • If RAC is used for the database, multiple nodes can be listed in the address list of the URL or it can point to the scan listener for the cluster. See below sample URL for a RAC implementation that has a primary and secondary scan listener connecting to to a service name GOLD-CLOUD. This includes connection timeout, retry, and retry delay settings.
      • Example - jdbc:oracle:thin:@(DESCRIPTION = CONNECT_TIMEOUT=120) (RETRY_COUNT=20) (RETRY_DELAY=3) (TRANSPORT_CONNECT_TIMEOUT=3) (ADDRESS_LIST =(LOAD_BALANCE=on) (ADDRESS = (PROTOCOL = TCP) (HOST=primary-scan) (PORT=1521))) (ADDRESS_LIST =(LOAD_BALANCE=on) (ADDRESS = (PROTOCOL = TCP) (HOST=secondary-scan) (PORT=1521))) (CONNECT_DATA=(SERVICE_NAME = gold-cloud)))
    • For more information about using UCP please check here.
  • PostgreSQL

Connecting to Oracle Autonomous Database

Once the Autonomous Database is created on Oracle cloud, download the client credentials zip file. You will need the admin userid and password. Unzip the client credentials zip file on endpoint where it will be used. You can mostly use localhost endpoint for this. For example, /home/flexdeploy/wallets/<wallet zip name>

  • Database URL Syntax : jdbc:oracle:thin:@service_high?TNS_ADMIN=/home/flexdeploy/wallets/<wallet zip name>
    • service_high is one of the entries in the tnsnames.ora file where client credentials zip file was unzipped
    • TNS_ADMIN value in URL points to the location of the unzipped client credentials zip file
  • Database URL Long Connection String Format Syntax : jdbc:oracle:thin:@(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=<hostname>))(connect_data=(service_name=<serice_name>))(security=(ssl_server_cert_dn="CN=<hostname>,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))
    • The " in the value for ssl_server_cert_dn field must be escaped using \
    • Examples for the same can be found here

Oracle
<Resource name="jdbc/flexdbDS" auth="Container"
    type="oracle.ucp.jdbc.PoolDataSource"
    factory="oracle.ucp.jdbc.PoolDataSourceImpl"
 
    connectionFactoryClassName="oracle.jdbc.pool.OracleDataSource"
    minPoolSize="0"
    maxPoolSize="100"
    initialPoolSize="0"
    autoCommit="false"
    inactiveConnectionTimeout="300"
 
    url="**CONNECT_STRING**"
    user="fd_admin"
    password="**FD_ADMIN_PASSWORD**"
 
    fastConnectionFailoverEnabled="true"
 
    validationQuery="select 1 from dual"
    testOnBorrow="true"
 
    useLocalSessionState="true"
    defaultAutoCommit="false"/>
Postgresql
<Resource name="jdbc/flexdbDS" auth="Container"
    type="javax.sql.DataSource"
    factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
    driverClassName="org.postgresql.Driver"
    
    url="**CONNECT_STRING**"
    username="fd_admin"
    password="**FD_ADMIN_PASSWORD**"
    
    maxTotal="100"
    maxIdle="20"
    
    validationQuery="select 1"
    testOnBorrow="true"
    
    defaultTransactionIsolation="READ_COMMITTED"
    useLocalSessionState="true"
    defaultAutoCommit="false"/>

Step 5. (Optional) Modify Tomcat server.xml for port if necessary. 

File - <FlexDeploy Home>/apache-tomcat-flexdeploy/conf/server.xml

  • By default, the Tomcat server is configured to run on port 8000. If this port is in use, change to some other unused port. Search for <Connector port="8000" protocol="HTTP/1.1" if you want to change it.
  • There are other ports referenced in the server.xml file as well. If the logs contain a port in use error, you can find the open ports on your machine and then search this file for ports that you find are in use and change them.

Step 6. (Optional) Modify Tomcat Environment script (setenvoverride.sh or setenvoverride.bat) for FlexDeploy server side directories.

If you are setting up FlexDeploy for Trial purposes, it is good idea to leave directories as default,  but if you are setting up FlexDeploy for production use, then we recommend to modify to use directory structure outside of FlexDeploy installation.

For previous FlexDeploy versions, these changes were directly done in setenv.sh or setenv.bat files.

File - <FlexDeploy Home>/apache-tomcat-flexdeploy/bin/setenvoverride.sh (setenvoverride.bat on windows)

Below are default artifact and working directories created under FlexDeploy Home when you extracted zip file. If you want to use different directories then modify setenvoverride.sh or setenvoverride.bat file, otherwise skip this step.

Default setenvoverride.sh is shown below.

Here is example of setenvoverride.sh which is modified to use non-default folders.


Step 7. (Optional) Modify Tomcat Environment script (setenvoverride.sh or setenvoverride.bat) for JAVA_HOME.

File - <FlexDeploy Home>/apache-tomcat-flexdeploy/bin/setenvoverride.sh (setenvoverride.bat on windows)

If JAVA_HOME is already set in your environment, you can skip this step.

Unix Example - JAVA_HOME=/u01/java/jdk1.8.0_121

Windows Example - set JAVA_HOME=c:/installs/Java/jdk1.8.0_121

 If you were also setting JAVA_HOME, this file would look like this.


Step 8. (Only if using Oracle Database)

Be sure to download the JDBC driver matching your Oracle Database version and one which is compiled and compatible with JDK8.  If you download the driver which is compiled with a newer JDK you will get errors on server startup similar to the following:

Caused by: java.lang.UnsupportedClassVersionError: oracle/jdbc/OracleClob has been compiled by a more recent version of the Java Runtime (class file version 54.0), this version of the Java Runtime only recognizes class file versions up to 52.0
	at java.lang.ClassLoader.defineClass1(Native Method)
	at java.lang.ClassLoader.defineClass(ClassLoader.java:756)
	at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:142)
  • Remove ojdbc jar files like ojdbc*.jar or ojdbc*dms.jar from <FlexDeploy Home>/apache-tomcat-flexdeploy/lib.
  • Copy all jar files (for example, ojdbc8.jar, ons.jar, ucp.jar and other jars) from downloaded archive ojdbc8-full.tar.gz to <FlexDeploy Home>/apache-tomcat-flexdeploy/libext.

    This has changed with FlexDeploy 5.6.0.1. Please put any extra libraries required inside of <FlexDeploy Home>/apache-tomcat-flexdeploy/libext not <FlexDeploy Home>/apache-tomcat-flexdeploy/lib. You will need to create this directory.

  • UCP is now required for Oracle Database connections. See Implementing UCP connections with Tomcat and Oracle for more info.

Step 9. (Linux only) - set the shell scripts executable with this command.

chmod +x <FlexDeploy Home>/apache-tomcat-flexdeploy/bin/*.sh
chmod +x <FlexDeploy Home>/*.sh

Step 10. Skip this step if you did not modify setenv.sh or setenv.bat to use non-default server side directories in Step 6.

If you are using non-default server side directories, then move all the jar files from <FlexDeploy Home>/application/plugins to FLEXDEPLOY_WORKING_DIR/plugins. At startup, FlexDeploy will load all the plugins.


Step 11. Start tomcat by running the following script.

File - <FlexDeploy Home>/StartFlexDeploy.sh(you can also use startup.sh or startup.bat scripts). If you want to use Windows service, see Install Windows Service for FlexDeploy Tomcat Server.

Note for Oracle XE Database

After starting your server, check the <FlexDeploy Home>/apache-tomcat-flexdeploy/logs/flexdeploy.0.log file for the following error message:

  • ORA-12519, TNS:no appropriate service handler found

If present, increase the number of processes for the database

  • Using SQLPlus update processes setting.
    • alter system set processes=200 scope=spfile;
  • Stop Tomcat
  • Restart the XE Database
  • Start Tomcat

Step 12. Launch FlexDeploy in your browser.

  • http://hostname:8000/flexdeploy
    • Update hostname in URL to indicate host where FlexDeploy is installed.
    • Update port if you had modified server.xml for different port number.
  • You will need to complete Initial Registration process, where you will create admin user for login.

Step 13. Go to Administration - Plugins on FlexDeploy. Verify that Plugins are loaded. You should not see any files remaining in FLEXDEPLOY_WORKING_DIR/plugins folder after few minutes.


Step 14. Now that you have installed FlexDeploy, let's get start with configuration. You can do this in matter of minutes by using Blueprints concept, which is very simple configuration wizard for most common usecases.

Related Topics