Deploy Platform components to the Framework

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

Tip: 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.
Warning: before running any Deployment Framework (DFW) command that configures the framework, use the DFW stop command to stop all running core components and adapters. DFW commands that configure the framework include: deploy, activate, deactivate, redeploy, rollback, delete, erase, hosts, and java.

Contents:

  1. Obtain kits and licenses
  2. Install the Deployment Framework
  3. Deploy core components
  4. Deploy core-component modules
  5. Check which blades are deployed
  6. Check which blades are running

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.

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 core components

Core components (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. The Deployment Framework's hosts file determines on which servers each component runs. To specify on which servers Liberator and Transformer should run, use the Deployment Framework's hosts command.

To deploy core components, follow the links below:

Deploy core-component modules

Liberator and Transformer modules should be installed to all servers in your deployment framework.

To deploy a module blade, 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

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).

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
Tip: 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:

   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:

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: