brookeslab/cv3-backend-admin repository overview

⁠CV3 Backend Admin API

This repository contains a component of Cafe Variome V3 backend. It is a RESTful API server that provides an interface for managing the backend of Cafe Variome V3.

⁠When should I use it

This is an optional module. This module provides functionality essential to the management of CV3. If you need to use the admin interface, or need to operate CV3 from a different software or service, then this module is necessary. If you only wish to use the query functions, and all the configurations of the system has been set, then you do not need to deploy this module.

⁠Features and roadmap

The currently implemented features are:

• Management of operational data, including
  • users, registration requests and user permissions
  • record data and metadata
  • discovery networks and nodes
  • beacon endpoints
  • data ingestion and remapping pipelines
  • legacy support for CV2 (nexus mode)
• Statistics and monitoring

The planned features are:

• There are currently no planned features for this component

⁠Endpoints

This module is designed to be served under /api endpoint relative to system base URL. Note that this is a hard requirement, CV3 relies on pre-defined endpoint structure to function properly.

⁠Usage

The external dependencies are:

• KeyCloak
• Vault by Hashicorp
• MongoDB
• Redis

⁠Running with Docker

We provide docker images for this component. To use the image, you can pull it from our Docker Hub repository:

docker pull brookeslab/cv3-frontend-admin:latest

The versions of the image are in line with our regular release version, while the latest tag is the nightly build. You can run the image with:

docker run -d \
  --name cv3_backend_admin \
  --restart unless-stopped \
  -e VAULT_ROLE_ID=<Your role ID here> \
  -e VAULT_SECRET_ID=<Your secret ID here> \
  -p 5000:5000 \
  -v /path/to/instance_config.json:/app/instance_config.json \
  -v /path/to/access.log:/app/access.log \
  -v /path/to/error.log:/app/error.log \
  -v /path/to/hypercorn.log:/app/hypercorn.log \
  brookeslab/cv3-backend-admin:latest