aboutsummaryrefslogtreecommitdiff
path: root/src/zenserver/hub/README.md
blob: 322be3649888c755ac57fd6cfc7050c5b9331f9b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Zen Server Hub

The Zen Server can act in a "hub" mode. In this mode, the only services offered are the basic health
and diagnostic services alongside an API to provision and deprovision Storage server instances.

## Generic Server API

GET `/health` - returns an `OK!` payload when all enabled services are up and responding

## Hub API

GET `{moduleid}` - alphanumeric identifier to identify a dataset (typically associated with a content plug-in module)

GET `/hub/status` - obtain a summary of the currently live instances

GET `/hub/modules/{moduleid}` - retrieve information about a module

POST `/hub/modules/{moduleid}/provision` - provision service for module

POST `/hub/modules/{moduleid}/deprovision` - deprovision service for module

GET `/hub/stats` - retrieve stats for service

## Hub Configuration

The hub service can use Consul to provide status updates

The hub service can emit telemetry to an Open Telemetry collector