Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.78 KB

install_overview.md

File metadata and controls

36 lines (23 loc) · 1.78 KB

XBOS Installation Overview

XBOS follows a "microservice" architecture; that is, an instance of XBOS is composed of a set of distributed services connected by a secure bus (BOSSWAVE). As such, there are several ways to arrange these services. In this guide, we will cover one common architectural configuration.

In this configuration, there is a local on-premesis server and a set of remote services.

Local Server

The local XBOS server has the following

  • BOSSWAVE Agent: a gateway to the global, secure pubsub communication plane
  • configuration: a git repo containing driver and service configurations. This repo is not necessarily pushed to a remote server
  • Spawnpoint: a local Spawnpoint daemon for running drivers requiring access to the local network
  • watchdogs: a set of monitors for local processes to help determine the health of the deployment

Installation instructions for the local server are located here

Core Services

There are several core services important for a full XBOS installation. These services can be run on a local node, but we recommend to run these on a more capable server or cluster.

These services are:

  • BTrDB: a fast, scalable timeseries database for storing all telemetry
  • Pundat: an archival/data ingester service for data published on BOSSWAVE
  • HodDB: a database and query processor for accessing Brick models describing deployment sites
  • MDAL: a data retrieval tool for fetching timeseries data using metadata stored in a Brick model

Schedulers

More formal definitions of schedulers are coming soon. In the meantime, we offer a sample scheduler example