FlexDeploy Installation Guide

The FlexDeploy™ Installation Guide provides system specifications and instructions for installing FlexDeploy and its components. 

FlexDeploy Architecture

FlexDeploy is a Java-based web application which requires an application server and an Oracle database.

Database Tier

FlexDeploy requires one of the following Oracle databases, and any required license is not included with your FlexDeploy subscription.

  • Oracle XE, version 11.2 (although supported for production use, XE is generally used for trials and proof of concepts)
  • Oracle Standard, version 11.2
  • Oracle Enterprise, version 11.2
  • Oracle Standard, version 12.1
  • Oracle Enterprise, version 12.1

Application Tier

FlexDeploy requires one of the following application servers. You must install FlexDeploy on only one application server process.

  • WebLogic 12.1.3 (license is not included with your FlexDeploy subscription)
  • Tomcat 8.x

FlexDeploy has built-in artifact repository for build artifacts (JAR, WAR, EAR and other files), which requires local or shared file system on application server host.

Platform Support

FlexDeploy performs actions on target server(s) as part of Build / Deploy operations using SSH connection, which means that it does not require any Agent process on target endpoint. FlexDeploy supports Unix or Windows Endpoints with SSH connectivity based on User / Password credentials or using SSH Key. Cygwin SSH is required on Windows endpoints.

  • Microsoft Windows
  • Unix/Linux (and its variants, such as OEL, RedHat, Solaris, AIX etc.)

Downloading FlexDeploy

For customers with active subscriptions, FlexDeploy can be downloaded from the Flexagon Support Site.

For users wishing to install the FlexDeploy Community Edition, or to request a trial version of FlexDeploy Standard/Enterprise Edition, please contact us through our website.

FlexDeploy System Requirements

Database Tier Requirements

FlexDeploy requires one of the following databases to be installed and running.

  • Oracle XE, version 11.2
  • Oracle Standard, version 11.2
  • Oracle Enterprise, version 11.2
  • Oracle Standard, version 12.1
  • Oracle Enterprise, version 12.1

Application Tier Requirements

Working Directory

FlexDeploy uses a working directory for temporary files to be transferred between the server and its endpoints. This directory needs to have at least 4GB of space available on the FlexDeploy Server.

  • As this file system contains only temporary files, there is no reason to backup this directory.
  • Availability of space within the server working directory is critical to functioning of the FlexDeploy platform. Therefore, the filesystem should be monitored and space should be allocated as necessary. In addition, it is recommended that this be a separate mount point.
  • Files in this directory which are older than one day will be purged automatically to help effectively manage the size.

Artifact Repository

The FlexDeploy artifact repository is a directory available on the FlexDeploy server where all build artifacts are stored, and later retrieved for the deployments. This directory needs to have at least 10GB of space available on the FlexDeploy Server.

  • Due to the importance of the artifact repository, this file system should be backed up regularly.
  • Availability of space within the Artifact Repository is critical to the creation of new build versions. It is highly recommended to have a file system size monitor in place for this directory, and size should be adjusted based on the number of builds created, and the size of the artifacts produced. In addition, it is recommended that this be a separate mount point.

Application Server

FlexDeploy is Java web-based application, you can setup either WebLogic or Tomcat to install FlexDeploy.

WebLogic

Tomcat

Endpoint Requirements

An Endpoint is a target server where FlexDeploy can perform build or deploy activities. Endpoints are configured within the FlexDeploy UI. See following requirements for each Endpoint.

Requirements

  • JDK version 1.6 or higher
  • Disk space on each endpoint of 4GB. There is no need to monitor this file system as FlexDeploy will automatically perform cleanup.
  • Operating Systems

    • Microsoft Windows. For Windows endpoint, cygwin must be installed on target see FlexDeploy Cygwin Install Guide.
    • Unix/Linux (and its variants, such as OEL, RedHat, Solaris, AIX, etc.)
  • SSH connectivity either using User / Password or using SSH Keys.

Installation Instructions

On-Premise or IaaS Installation

  1. Installation Instructions - Database Tier
  2. Installation Instructions - Application Tier
  3. Endpoint Configuration
  4. Loading FlexDeploy Plugins

FlexDeploy Installation with included Tomcat

This allows for very quick installation as Tomcat is already included and you just have to update few minor configurations.

  1. Installation Instructions - Database Tier
  2. Installing FlexDeploy with included Tomcat

Oracle Java Cloud Service (PaaS) Installation

See Oracle Java Cloud Service Installation.

  1. Creating an Oracle Database Cloud Service Instance
  2. Creating an Oracle Java Cloud Service Instance
  3. Installation Instructions - Database Tier
  4. Installation Instructions - Application Tier
  5. Endpoint Configuration
  6. Loading FlexDeploy Plugins

Windows Quick Start Installation

See Windows Quick Start Installer.