|
14 | 14 | [](https://github.com/opiproject/opi-mangoboost-bridge) |
15 | 15 | [](https://github.com/opiproject/opi-mangoboost-bridge/graphs/contributors) |
16 | 16 |
|
17 | | -This repo includes OPI Mangoboost bridge API for DPUs. |
| 17 | +This repo includes OPI Mangoboost bridge API for DPUs, particularly OPI storage APIs for NVMe/TCP initiator and target offloads. |
| 18 | +For additional information, please refer to the links below. |
18 | 19 |
|
19 | | -## I Want To Contribute |
| 20 | +- [Mango StorageBoost - NTI](https://www.mangoboost.io/products/hardware/mango-storageboost-tm-nti) |
| 21 | +- [Mango StorageBoost - NTT](https://www.mangoboost.io/products/hardware/mango-storageboost-tm-ntt) |
20 | 22 |
|
21 | | -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. |
| 23 | +The diagram below demonstrates an example of OPI-enabled workflows for xPU-based NVMe-oF initiator and target deployments. |
| 24 | +Running on an xPU, the bridge translates and forwards OPI API commands to the MangoBoost SDK for service management and configuration. |
| 25 | +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. |
22 | 26 |
|
23 | | -See [CONTRIBUTING](https://github.com/opiproject/opi/blob/main/CONTRIBUTING.md) and [GitHub Basic Process](https://github.com/opiproject/opi/blob/main/doc-github-rules.md) for more details. |
| 27 | + |
24 | 28 |
|
25 | 29 | ## Getting started |
26 | 30 |
|
27 | 31 | :exclamation: `docker-compose` is deprecated. For details, see [Migrate to Compose V2](https://docs.docker.com/compose/migrate/). |
28 | 32 |
|
29 | 33 | Run `docker-compose up -d` or `docker compose up -d` |
30 | 34 |
|
31 | | -## Diagrams |
| 35 | +## Usage |
32 | 36 |
|
33 | | -Tbd |
| 37 | +TBU |
| 38 | + |
| 39 | +## I Want To Contribute |
| 40 | + |
| 41 | +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. |
| 42 | + |
| 43 | +See [CONTRIBUTING](https://github.com/opiproject/opi/blob/main/CONTRIBUTING.md) and [GitHub Basic Process](https://github.com/opiproject/opi/blob/main/doc-github-rules.md) for more details. |
0 commit comments