Example deployment to a single host

This section provides instructions for deploying a Discovery-enabled Caplin Platform stack to a single host.

Requirements

You require the following software:

  • Red Hat Enterprise Linux (RHEL) 9

  • unzip (RHEL package unzip)

  • OpenJDK 17 (RHEL package java-17-openjdk-devel), with the JAVA_HOME environment variable set to the root of the OpenJDK installation.

  • The latest 8.0 versions of the following installation kits, downloadable from Caplin Downloads:

    • Liberator-version-x86_64-pc-linux-EL7-gnu.tar.gz

    • Transformer-version-x86_64-pc-linux-EL7-gnu.tar.gz

    • Discovery-version.zip

    • DeploymentFramework-version.zip

Deploying the components

Follow the steps below:

  1. Download deployment kits to your home directory (/home/caplin/ is used in this example):

    homecaplinDiscovery-version.zipDeploymentFramework-version.zipLiberator-version-x86_64-pc-linux-EL7-gnu.tar.gzTransformer-version-x86_64-pc-linux-EL7-gnu.tar.gz
  2. Unzip the Discovery kit and the Deployment Framework kit.

    $ unzip -qoa Discovery-version.zip
    $ unzip -qoa DeploymentFramework-version.zip
    homecaplin Discovery-version DeploymentFramework-versionDiscovery-version.zipDeploymentFramework-version.zipLiberator-version-x86_64-pc-linux-EL7-gnu.tar.gzTransformer-version-x86_64-pc-linux-EL7-gnu.tar.gz
  3. Move the Liberator and Transformer kits to the Deployment Framework’s kits directory:

    $ mv Liberator-version-x86_64-pc-linux-EL7-gnu.tar.gz DeploymentFramework-version/kits
    $ mv Transformer-version-x86_64-pc-linux-EL7-gnu.tar.gz DeploymentFramework-version/kits
    homecaplinDiscovery-versionDeploymentFramework-versionkits Liberator-version-x86_64-pc-linux-EL7-gnu.tar.gz Transformer-version-x86_64-pc-linux-EL7-gnu.tar.gzDiscovery-version.zipDeploymentFramework-version.zip
  4. Change directory to DeploymentFramework-version:

    $ cd /home/caplin/DeploymentFramework-version
  5. Deploy the Liberator and Transformer kits:

    $ ./dfw deploy
  6. Deactivate the TransformerToLiberatorConnection blade:

    $ ./dfw deactivate TransformerToLiberatorConnection
  7. Activate the LiberatorSockmon and TransformerSockmon blades:

    $ ./dfw activate LiberatorSockmon TransformerSockmon
  8. Activate the LiberatorDiscovery and TransformerDiscovery blades:

    $ ./dfw activate LiberatorDiscovery TransformerDiscovery
  9. Activate the TransformerDemoDataSourceDiscovery blade:

    $ ./dfw activate TransformerDemoDataSourceDiscovery
  10. Set all activated blades to run on localhost:

    $ ./dfw hosts all localhost
  11. Remove any licences for Liberator and Transformer from the Deployment Framework’s global_config/licenses directory.

Starting the components

Follow the steps below:

  1. Run the command below to start the example HyperSQL database for Discovery:

    homecaplinDiscovery-versionsql hsqldb.sh
    $ ./hsqldb.sh start
    The packaged HyperSQL database is for evaluation purposes only. Caplin do not support the use of HyperSQL in production deployments.
  2. Run the command below to start the Discovery server:

    homecaplinDiscovery-version discovery.sh
    $ ./discovery.sh start
  3. Run the command below to start Liberator and Transformer:

    homecaplinDeploymentFramework-version dfw
    $ ./dfw start

Viewing the Discovery web interface

In a web browser, open the following URL:

http://hostname:4567/

Where hostname is the network hostname of the deployment. If the web browser is on the same machine as the deployment, use localhost.

discovery ui
Discovery UI

Installing a Discovery licence

Discovery is not packaged with a licence. If you don’t have a licence, please contact your Caplin account manager.

To install a Discovery license, see Discovery licensing.

Subscribing to test data

The diagnostic utility Liberator Explorer is available in this example deployment and provides you with a convenient interface to subscribe to test data published by the TransformerDemoDataSource blade.

The LiberatorWebsite blade, which includes Liberator Explorer, is not supported in production environments.

Follow the steps below:

  1. In a web browser, open the following URL:

    http://hostname:18080

    Where hostname is the network hostname of the deployment. If the web browser is on the same machine as the deployment, use localhost.

  2. Click Diagnostics, then click Liberator Explorer.

  3. Authenticate with the following credentials:

    • Username: admin

    • Password: admin

  4. In Liberator Explorer’s Subject field, type the following subject:

    /EXAMPLES/PRICING/TYPE1/AAPL
  5. Click Go

    discovery liberator explorer aapl
    Subscribing to test data in Liberator Explorer

For a full list of subjects published by the TransformerDemoDataSource blade, see the documentation for the LiberatorDemoDataSource blade, which publishes the same subjects as TransformerDemoDataSource.

Stopping the components

Follow the steps below:

  1. Run the command below to stop Liberator and Transformer:

    homecaplinDeploymentFramework-version dfw
    $ ./dfw stop
  2. Run the command below to stop Discovery:

    homecaplinDiscovery-version discovery.sh
    $ ./discovery.sh stop
  3. Run the command below to stop the example HyperSQL database for Discovery:

    homecaplinDiscovery-versionsql hsqldb.sh
    $ ./hsqldb.sh stop