README
¶
OPI gRPC to Mangoboost Bridge
This repo includes OPI Mangoboost bridge API for DPUs, particularly OPI storage APIs for NVMe/TCP initiator and target offloads. For additional information, please refer to the links below.
The diagram below demonstrates an example of OPI-enabled workflows for xPU-based NVMe-oF initiator and target deployments. Running on an xPU, the bridge translates and forwards OPI API commands to the MangoBoost SDK for service management and configuration. On both the initiator and target, the NVMe/TCP data path is fully offloaded to the xPU hardware without any involvement of host and SoC CPU cores.
Getting started
❗ docker-compose is deprecated. For details, see Migrate to Compose V2.
Run docker-compose up -d or docker compose up -d
Usage
TBU
I Want To Contribute
This project welcomes contributions and suggestions. We are happy to have the Community involved via submission of Issues and Pull Requests (with substantive content or even just fixes). We are hoping for the documents, test framework, etc. to become a community process with active engagement. PRs can be reviewed by by any number of people, and a maintainer may accept.
See CONTRIBUTING and GitHub Basic Process for more details.
Directories
¶
| Path | Synopsis |
|---|---|
|
main is the main package of the application
|
main is the main package of the application |
|
pkg
|
|
|
backend
Package backend implements the BackEnd APIs (network facing) of the storage Server
|
Package backend implements the BackEnd APIs (network facing) of the storage Server |
|
frontend
Package frontend implements the FrontEnd APIs (host facing) of the storage Server
|
Package frontend implements the FrontEnd APIs (host facing) of the storage Server |
|
models
Package models holds definitions for SPDK json RPC structs
|
Package models holds definitions for SPDK json RPC structs |