Installing the Deployment Framework

This page provides instructions on how to install the Caplin Deployment Framework, which you can then use to deploy Liberator, Transformer, and integration adapters.

Requirements

The Deployment Framework 7 is a Bash script with the following requirements:

  • Bash 4.1+

  • zip and unzip system commands (in Red Hat packages zip and unzip)

  • Oracle Java 8 64-bit (see Installing Java)

The Deployment Framework 7 is tested on the platforms below:

  • Red Hat Enterprise Linux (RHEL) 7

  • Red Hat Enterprise Linux (RHEL) 6

  • Cygwin, with the winsymlinks:lnk option enabled, on Windows 10 (see Installing Bash on Windows)

  • Git Bash, with the winsymlinks:lnk option enabled, on Windows 10 (see Installing Bash on Windows)

  • macOS 10.12.6 Sierra

Caplin Platform’s two core components, Liberator and Transformer, are available in builds for RHEL, Microsoft Windows, and macOS. Only the RHEL builds are supported in production.

Caplin Platform supported operating systems
RHEL Windows macOS

Production

Testing

Development

Additional requirements for Caplin Support

The following additional requirements increase the speed at which Caplin Support can diagnose issues in production and test environments:

  • System clock: UTC

  • Core dumps: set to unlimited size for all user accounts that run Caplin components

  • Java garbage collection logging: enabled for all JVMs on the Caplin Platform

  • Red Hat packages: gdb (the GNU Debugger)

For instructions on setting up the additional requirements, see Getting information about a failed Platform component: Prerequisites.

Installing the Deployment Framework

Follow the steps below to install the Deployment Framework:

  1. Ensure the Deployment Framework’s requirements are met. See Requirements above.

  2. Copy the Deployment Framework installation archive (DeploymentFramework-<version>.zip) to the directory you want to install to.

    On Microsoft Windows, to avoid exceeding the Win32 API’s maximum path length of 259 characters, install to a directory with a path of no more than 20 characters in length.

  3. In a Bash shell, run the command below to extract the Deployment Framework installation kit:

    $ unzip -qoa DeploymentFramework-<version>.zip
    Always extract the archive using the unzip command above from a Bash shell. The unzip command preserves symlinks and line-endings required for the correct operation of the Deployment Framework.

  4. Perform one of the tasks below to provide the Deployment Framework with the location of an Oracle Java 8 JVM:

    • Under the user account you will use to run dfw commands, set the JAVA_HOME environment variable to the installation directory for Oracle Java 8 64-bit.

    • In the root directory of the Deployment Framework, run the dfw java command, passing it the location of the Oracle Java 8 JVM’s dynamic library:

      Windows example (Oracle Java 8 64-bit update 181)
      $ ./dfw java "C:/Program Files/Java/jre1.8.0_181/bin/server/jvm.dll"
      Linux example
      $ ./dfw java "/usr/lib/jvm/java-8-oracle/jre/lib/amd64/server/libjvm.so"

  5. Enable Bash command-line completion for the dfw command. See Setting up dfw command completion.

    This step also sets an environment variable required by the logcat command

See also: