Welcome to ROVI documentation!

This repository contains the documentation for the ROVI project. The documentation is written in markdown and is rendered using MkDocs.

The following diagram provides a high-level overview of the ROVI Data Hub ingress architecture. Users or Devices connect to either the documentation or the Ingress API to interact with the system. The Ingress API has additional documentation in based on the OpenAPI Spec and can be located at the following links: - Swagger Ingress API - Redoc Ingress API

Currently, the NGINX Gateway proxies to five ingress/ingest services. These services are responsible for receiving data from the user or device and storing it encrypted in the redis cache. This encryption is done using FERNET symmetric encryption. The data is then stored in the cache for later retrieval by the redis2globus microservice. This microservice is responsible for transferring the data from the cache to the Globus endpoint. The redis2globus microservice is also responsible for managing the data transfer and ensuring that the data is transferred successfully.

ROVI Diagram

The redis2globus microservice will read from redis, decrypt the data, and transfer it to the Globus endpoint. Since encryption of data to Globus is enabled, the data is only decrypted when constructing the Globus payload

More information on the Ingress API can be found in the Ingress API Documentation

Ingress API

Read the Ingress API Documentation

Authentication Documentation

Read the Authentication Documentation

Data Transfer Documentation

Read the Data Transfer Documentation