Deploy Liberator and Transformer

This page describes how to deploy Caplin Platform’s core components: Liberator and Transformer.

In the following steps you’ll be using the dfw command of the Deployment Framework. Before entering any dfw command as ./dfw <command-name>, make sure your current (working) directory is set to the Deployment Framework’s topmost directory.

For a list of dfw commands, click here.

Obtain kits and licenses

Deployment kits for Liberator and Transformer are available at the Caplin Downloads page.

Licenses are available at your Caplin account’s Licenses page.

Install the Deployment Framework

If you haven’t done so already, install the Deployment Framework on each of the server machines that host your system. See Installing the Deployment Framework.

Deploy Liberator and Transformer

Liberator and Transformer only need to be deployed to the servers on which they run, but in practice you may find it easier to deploy them to all servers in your infrastructure and use the dfw hosts command to specify on which servers they should run.

For full instructions on installing Liberator and Transformer, follow the links below:

Deploy modules

Both Liberator and Transformer use modules to implement or extend their functionality. Some modules are distributed with Liberator and Transformer, and some are available separately.

Liberator and Transformer module kits should be deployed to all servers in your deployment framework; they may contain configuration required by other Caplin Platform components.

To deploy a module kit, follow the steps below:

  1. Copy all the blade kits you require to the Deployment Framework’s <Framework-root>/kits directory on the relevant server machines.

  2. Run the deploy command on each of the server machines: ./dfw deploy

What does the 'deploy' command do?

The Deployment Framework’s deploy command performs the following tasks:

  1. It stops any Caplin Platform binaries that are running on the server.

  2. It unpacks (unzips) each kit and then moves the kits' zip files to the kits/archive directory.

  3. It activates each blade that it unpacks (but it doesn’t activate any built-in blades that are by default deactivated, only the blades that you’ve supplied in kit form).

The deploy command doesn’t start any Caplin Platform components (including any Adapter blades you’ve deployed).

Example deployment: Transformer 7.1.3
$ ./dfw deploy

  Deploying Transformer kit Transformer-7.1.3-311854-x86_64-pc-linux-EL6-gnu.tar.gz
  Kit will be saved in kits/archive.
  Kit successfully unpacked.
  Not copying license from Transformer kit. Ensure the current license
   is the same version as the kit just deployed.

  Transformer kit has deployed a new blade: PersistenceService
  Transformer kit has deployed a new blade: PersistenceServiceClient
  Transformer kit has deployed a new blade: TransformerDemoDataSource
  Transformer kit has deployed a new blade: TransformerJMX
  Transformer kit has deployed a new blade: TransformerToLiberatorConnection
  Transformer kit has deployed a new blade: TransformerToLiberatorSSLConnection

  Activating the peer connection blade.

  Activating TransformerToLiberatorConnection

  Blades ok

  The configuration has been updated. The new configuration will not be active
  until the Framework is restarted.

  1 kit(s) deployed

  Blades ok
To ensure that old kit files don’t take up too much space on your server, periodically check and clean out the kits/archive directory.

Check which blades are deployed

Enter the command: ./dfw versions

This command returns the Deployment Framework version, the versions of the deployed components and blades, and the status of the blades.

Example output:

$ ./dfw versions
Deployment Framework           6.0.4-268982

   Core components                Version
   -----------------------------------------------------------
   Liberator                      6.0.5-268662
   Transformer                    6.0.4-268662

   Deployed blades                Version            State
   -----------------------------------------------------------

   Built-in blades                                   State
   -----------------------------------------------------------
   BlotterExport                                     Inactive
   DemoDataSource                                    Inactive
   DirectConnection                                  Active
   HTTP                                              Active
   HTTPS                                             Inactive
   JavaOpenPermissioning                             Inactive
   LiberatorJMX                                      Inactive
   LiberatorWebsite                                  Active
   MinimalLiberatorWebsite                           Inactive
   OpenPermissioning                                 Active
   ServerIdentification                              Active
   TransformerJMX                                    Inactive

Check which blades are running

You can find out which core components and adapters are running, by entering the command: ./dfw status

At this stage, nothing is running, because we haven’t started the components and blades:

$ ./dfw status
Liberator                      Not running
Transformer                    Not running

Deployed Adapter blades        Status             Process ID
-------------------------------------------------------------

To start and stop components and adapters, see Start and stop components and blades.

See also: