Skip to content

Bloomberg Realtime Entitlements Accelerator Quickstart Guide

This page provides a quickstart guide for the Bloomberg Realtime Entitlements, 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
  • Credentials have been obtained and configured:
    • For Insights users:
      • GUI User
      • API Client
  • 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
  • Helm installed and logged in to nexus
  • VSCode plugins:
    • KX kdb
    • Jupyter

Quick start guide

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

# 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/1.2.0/fsi-lib-1.2.0.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/1.0.0/fsi-app-bbg-entl-1.0.0.kxi

Unpack

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

kxi package unpack fsi-app-bbg-entl-1.0.0.kxi

BPIPE 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 see the BPIPE customization documentation.
vi  fsi-app-bbg-entl/config/feed/bbg-bpipe-feed-values.yaml

EMRS feed 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 bases have been marked with a TODO comment.
  • For detailed information see the EMRS configuration documentation.

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

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

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

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 BPIPE feed handler from helm:

helm fetch kx/rt-bpipe-pub --version 1.0.1 --untar

Download the Bloomberg EMRS feed handler from helm:

helm fetch kx/rt-bpipeeid-pub --version 1.0.1 --untar

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

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>

Configure user access

Set up user mappings of Insights Enterprise to EMRS users via the user mapping pipeline

Deploy the accelerator

Push the packages to kdb Insights and Deploy the fsi-app-bbg-entl assembly:

# Install the packages
kxi pm push  fsi-lib/1.2.0
kxi pm push  fsi-app-bbg-entl/1.0.0

# Deploy the assembly
kxi pm deploy fsi-app-bbg-entl/1.2.0

Note

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

Deploy the feeds

Install the Bloomberg BPIPE Feed Handler Helm Chart using our config file:

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

Verify the Bloomberg BPIPE feed handler is running using kubectl:

kubectl describe pod rt-bpipe-pub-0

Expected output from the above command upon successful installation:

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:

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 BPIPE 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 getTicks.