Deployment

Environment

Conda

Conda (the package manager used by Miniforge, Miniconda and Anaconda) is the environment we use to guarantee (a) C++ ABI compatibility and (b) a known set of dependencies.

You are not required to use Miniforge for your own C++ development (as long as your compiler is ABI compatible). However, using Miniforge may make it a lot easier for you to manage your package dependencies.

Docker

All binaries have been packaged as Docker images and available from Docker Hub.

Ansible

An Ansible playbook is being maintained on GitHub. It is meant as inspiration and an easy way to get started with provisioning a server.

Vagrant

Vagrant scripts are being maintained on GitHub. It is meant as inspiration and an easy way to get started with provisioning a virtual machine.

Observability

Because an operating system can be unpredictable in many ways, it is very important to be able to monitor internal gateway metrics in real time.

Prometheus

The gateways natively support Prometheus' exposition format. This allows you to capture statistics (distributions for all internal end-to-end latencies).

Grafana

Grafana is a popular application allowing you to easily set up a dashboard to monitor that everything is working correctly.

Database

The gateways are intentionally kept with a minimal external interface. In particular, there is no direct connectivity with database. Instead, all messages are being streamed to an event log.

An external application, e.g. roq-influxdb, can be used to tail the gateway event log and append all new updates to a third-party database.

InfluxDB

We currently support the InfluxDB time-series database.

ClickHouse

ClickHouse is on the roadmap as another time-series database.

Redis

Redis is on the roadmap for storing current snapshots.