Deploy Platform components to the Framework

To create a Caplin Platform trading system, you must first deploy the Caplin Platform’s core components to the relevant server machines that host the system.

The core platform components are Liberator and Transformer.

You mightn’t need a Transformer in your Platform installation, but you’ll always need a Liberator.

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

First obtain the kits and licenses from Caplin Systems for the core components and Caplin Platform Blades. The Deployment Framework comes with some built-in Config blades, and Caplin can also supply other ready-made blades.

Make sure you’ve installed the Deployment Framework

Install it on each of the server machines that host your system. See Installing the Deployment Framework.

Deploy core component kits and blade kits

The minimum kits that you need to deploy are those for the core components – Caplin Liberator and (possibly) Caplin Transformer.

  • You only need to deploy a core component kit to the server machines on which the component is to run.

  • Each Caplin Platform blade kit that you require must be deployed to every server in your system.

To deploy Caplin Liberator:

Follow the instructions from Set up the Liberator licence onwards in Installing Liberator.

To deploy Caplin Transformer:

Follow the instructions from Set up the Transformer licence onwards in Installing Transformer.

To deploy the blade kits:

  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?

  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 of the Caplin Platform components (including any Adapter blades you’ve deployed).

Here’s an example of the terminal output from the deploy command:

Boot-strapping the Deployment Framework
Unpacking Liberator kit Liberator-6.0.5-268662-i686-pc-win32.zip
Liberator-6.0.5-268662-i686-pc-win32.zip successfully unpacked and stored in kits/archive
Deploying evaluation license from Liberator kit
Deploying example HTTPS keys from Liberator kit

Unpacking Transformer kit Transformer-6.0.4-268662-i686-pc-win32.zip
Transformer-6.0.4-268662-i686-pc-win32.zip successfully unpacked and stored in kits/archive
Deploying evaluation license from Transformer kit
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 what’s been deployed

Enter the command: ./dfw versions

This shows you the Deployment Framework version, the versions of the deployed components and blades, and the status of the blades.

For example:

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

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

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

Liberator                      Not running
Transformer                    Not running

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

Here’s how to start and stop the components and blades.

See also: