KX Accelerator for Bloomberg B-PIPE Quickstart Guide

This page provides a quickstart guide for the KX Accelerator for Bloomberg B-PIPE, an FSI Accelerator package that comes with ready-made Pipelines, Views, and Schemas out of the box.

Prerequisites

This quickstart guide is not intended to be a comprehensive kdb Insights Install Guide. For more information regarding kdb Insights installation, refer to the kdb Insights Enterprise documentation. This guide assumes the following prerequisites:

  • kdb Insights Enterprise is installed, and:

    • The following credentials have been obtained and configured for Insights users: GUI User API Client

    • A KX Downloads Portal bearer token to download packages/charts (represented by BEARER in this guide).

  • Tools used:

    • Access to *nix command-line

    • KDB Insights CLI - kxi

    • Kubernetes tools:

      • kubectl

      • K9s

    • VSCode plugins: KX kdb Jupyter

Quickstart guide

Important

Before you begin, set your Accelerator and fsi-lib version, as shown below. This helps simplify the download and installation commands.

Shell

Copy 
export ACCELVER=1.3.0
export FSILIBVER=1.3.4 

To download the required FSI packages from the KX Downloads Portal, run the following:

Shell

Copy 
# Download fsi-lib - the Core FSI Library

curl -s --fail-with-body -D /dev/stderr --oauth2-bearer ${BEARER} -L -OJ https://portal.dl.kx.com/assets/raw/kxi-accelerators/fsi/fsi-lib/packages/${FSILIBVER}/fsi-lib-${FSILIBVER}.kxi

# Download fsi-app-bbg-entl - the Bloomberg Realtime Entitlements Accelerator
curl -s --fail-with-body -D /dev/stderr --oauth2-bearer ${BEARER} -L -OJ https://portal.dl.kx.com/assets/raw/kxi-accelerators/fsi/fsi-bbg-entl/packages/${ACCELVER}/fsi-app-bbg-entl-${ACCELVER}.kxi

Unpack

Run the command below to unpack fsi-app-bbg-entl:

Shell

Copy 
kxi package unpack fsi-app-bbg-entl-${ACCELVER}.kxi

B-PIPE feed handler configuration file

Update the example Bloomberg Feed Handler Config File to include your credentials and preferences.

Note

  • The config file contains a lot of commonly pre-populated default values.

  • Any values that are expected to require updating on a per-deployment basis have been marked with a TODO comment.

  • For detailed information on configuration, refer to theBloomberg B-Pipe Feed Handler Install and Setup documentation.

YAML

Copy 
vi  fsi-app-bbg-entl/config/feed/bbg-bpipe-feed-values.yaml

Configuration options

The bbg-bpipe-feed-values.yaml file included with the package provides only a subset of configuration options, focused specifically on:

  • Settings required for the Bloomberg B-PIPE Accelerator to function

  • Parameters that users are likely to modify to tailor the deployment to their specific environment

To explore the complete set of configuration options available for the B-PIPE feed deployment, refer to the full configuration files, once the helm charts have been fetched, available at rt-bpipe-pub/values.yaml. These files provide a comprehensive view of all parameters and default settings. Any of these parameters can be added to your bbg-bpipe-feed-values.yaml file to overwrite the default. This ensures you can independently upgrade your feed handler without losing configuration changes.

EMRS feed handler configuration file

Update the example Bloomberg EMRS Feed Config File to include your credentials and preferences.

Note

  • The config file contains a lot of commonly pre-populated default values.

  • Any values that are expected to require updating on a per-deployment basis have been marked with a TODO comment.

  • For detailed information on configuration, refer to the Bloomberg EMRS Feed Handler Install and Setup documentation.

The bpipe section of the emrs-feed-values.yaml file should be updated with the user/IP pairs and eid values of interest.

YAML

Copy 
vi  fsi-app-bbg-entl/config/feed/emrs-feed-values.yaml

Fetch the feed helm charts

Add the KX helm repository from the KX downloads portal, as follows:

Shell

Copy 
helm repo add kx https://portal.dl.kx.com/assets/helm --username <INSERT_EMAIL> --password <INSERT_BEARER_TOKEN>

Note

For info on how to set up your downloads bearer token, go to https://portal.dl.kx.com/auth/token

Download the Bloomberg B-PIPE feed handler from helm:

Shell

Copy 
helm fetch kx/rt-bpipe-pub --version 1.0.3 --untar        

Download the Bloomberg EMRS feed handler from helm:

Shell

Copy 
helm fetch kx/rt-bpipeeid-pub --version 1.0.3 --untar          

To create a secret for the Helm chart to pull the feed images, use the following command:

Shell

Copy 
kubectl create secret docker-registry "docker-pull" --docker-server=portal.dl.kx.com --docker-username=<INSERT_EMAIL> --docker-password=<INSERT_BEARER_TOKEN> --docker-email=<INSERT_EMAIL> -n <INSERT_YOUR_NAMESPACE>

Deploy the accelerator

Push the packages to kdb Insights and deploy the fsi-app-bbg-entl database and realtime pipeline:

Shell

Copy 
# Install the packages
kxi pm push fsi-lib-${FSILIBVER}.kxi
kxi pm push fsi-app-bbg-entl-${ACCELVER}.kxi

# Deploy the assembly and realtime pipelines
kxi pm deploy fsi-app-bbg-entl --db fsi-core-db
kxi pm deploy fsi-app-bbg-entl --pipeline bbg-realtime-l1

Note

At this point you should be able to see the assembly and pipeline booting up on the GUI or on k9s.

Configure user access

Set up user mappings of kdb Insights Enterprise to EMRS users through the user mapping pipeline.

Deploy the pipeline by running the following command:

Shell

Copy 
kxi pm deploy fsi-app-bbg-entl --pipeline bbgentpair --env bbgentpair:FSI_FILEPATH="s3://<YOUR FILEPATH>/<YOUR FILENAME>.csv" --env bbgentpair:FSI_REGION='us-east-2'

Once the user mapping is ingested, deploy the entitlements ingest pipeline by running the following command:

Shell

Copy 
kxi pm deploy fsi-app-bbg-entl --pipeline bbgentitlements

Deploy the feeds

Install the Bloomberg B-PIPE Feed Handler Helm Chart using our config file:

Shell

Copy 
helm install rt-bpipe-pub ./rt-bpipe-pub -f fsi-app-bbg-entl/config/feed/bbg-bpipe-feed-values.yaml

Verify the Bloomberg B-PIPE feed handler is running using kubectl:

Shell

Copy 
kubectl describe pod rt-bpipe-pub-0       

Expected output from the above command upon successful installation:

 

Copy 
Events:
  Type    Reason                  Age   From                     Message
  ----    ------                  ----  ----                     -------
  Normal  Created                 24s   kubelet                  Created container rt-bpipe-pub
  Normal  Started                 24s   kubelet                  Started container rt-bpipe-pub

Deploy EMRS by running the following command:

Shell

Copy 
helm install rt-bpipeeid-pub ./rt-bpipeeid-pub -f fsi-app-bbg-entl/config/feed/emrs-feed-values.yaml

Check dashboards

Now that you have the Bloomberg B-PIPE feed handler running, you should be able to see data flowing in real-time through the demo dashboard named Bloomberg-BPIPE, accessible in the GUI.

Access APIs

Once deployed, you can query the tables using getData or getBars.