FlexDeploy provides a file distribution for Tomcat which simplifies the installation process.  This distribution contains 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 8.5.11 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

 If you wish to use an existing Tomcat server, or to use a different version of Tomcat other than 8.5.11, please see Installing FlexDeploy on existing Tomcat.

Requirements 

• 8GB of RAM
• 1 CPU
• At least 20GB of available space, may need additional space based on purge criteria and usage.
• 64 bit Java 8 JDK which can be downloaded from http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html. (Open JDK 8 is also fine)
• If you have not created FlexDeploy Working Directory and Artifact Repository folders, we will create in steps below. (See Create Folders for FlexDeploy Server)
• See Installation Instructions - Database Tier for requirements on Database tier.
• Optional - consider Java Cryptography Extension (JCE) unlimited strength policy files to avoid SSH issues when using strong ciphers.

Installation Instructions

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

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 C:/installs/FlexDeploy folder.

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 URL and Password with the actual values.

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

<Resource name="jdbc/flexdbDS" auth="Container"
    type="oracle.jdbc.pool.OracleDataSource"
    factory="oracle.jdbc.pool.OracleDataSourceFactory"
    
    url="**CONNECT_STRING**"
    user="fd_admin"
    password="**FD_ADMIN_PASSWORD**"
    
    connectionCachingEnabled="true"
    connectionCacheProperties="{InitialLimit=0, MinLimit=0, MaxLimit=100, ConnectionWaitTimeout=60, InactivityTimeout=60, AbandonedConnectionTimeout=60, PropertyCheckInterval=30}"
    
    validationQuery="select 1 from dual"
    testOnBorrow="true"
    
    useLocalSessionState="true"
    defaultAutoCommit="false"/>

<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"/>

<Resource name="jdbc/flexdbDS" auth="Container"
    type="javax.sql.DataSource"
    factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
    driverClassName="com.mysql.jdbc.Driver"
    
    url="**CONNECT_STRING**"
    username="fd_admin"
    password="**FD_ADMIN_PASSWORD**"
    
    maxTotal="100"
    maxIdle="10"
    initialSize="10"
    
    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 (setenv.sh or setenv.bat) for FlexDeploy server side directories.

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

• Configure -Dflexagon.fd.install.root with directory to use as the FlexDeploy working directory (See Create Folders for FlexDeploy Server - FlexDeploy Working Directory)
• Configure -Dflexagon.fd.repository.root with the directory to host the FlexDeploy artifact repository (See Create Folders for FlexDeploy Server - FlexDeploy Artifact Repository)

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 setenv.sh or setenv.bat file, otherwise skip this step.

Default setenv.bat is shown below.

Here is example of setenv.bat which is modified to use non-default folders.

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

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

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

Step 8. ADF Essentials comes with the JDBC driver for Oracle 11g database (ojdbc6dms.jar). If you are using Oracle 12c database, you can download the driver (ojdbc7.jar) from the Oracle Technology Network site at Oracle 12c drivers. Delete ojdbc6dms.jar from <FlexDeploy Home>/apache-tomcat-flexdeploy/lib and place ojdbc7.jar in that same folder.

Step 9. (Optional) If using IBM ClearCase, you will need to copy some jar files from your ClearCase server or ClearTeam Explorer installation to the FlexDeploy installation

Copy all of the jar files found in the com.ibm.rational.teamapi_8.0.1.vxxx folder of your ClearCase server or ClearTeam Explorer installation to <FlexDeploy Home>/apache-tomcat-flexdeploy/lib. (commons-codec-1.3.jar, commons-lang-2.3.jar, icu4j-4_8.jar, remote_core.jar, stpclientws.jar, stpcq.jar, teamapiextensions.jar, unicodetypemgr.jar, commons-httpclient-3.0.jar, commons-logging-1.0.4.jar, icu4j-charset-4_8.jar, stpcc.jar, stpcmmn.jar, stpwvcm.jar, ucleardiffmerge.jar)

Step 10. Linux only - set the shell scripts executable with this command:chmod +x <FlexDeploy Home>/apache-tomcat-flexdeploy/bin/*.sh

Step 11. 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 12. Start tomcat by running the following script. Make sure to set JAVA_HOME to JDK 7 or JDK 8 if not already set in your environment.

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

Step 13. 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 14. 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.