Skip to content

Commit 7cd858c

Browse files
committed
docs: add decription and diagram
This patch adds some description and diagrams for the overview of mangoboost bridge and solution. Signed-off-by: Dongju Chae <dongju.chae@mangoboost.io>
1 parent 7895d10 commit 7cd858c

File tree

4 files changed

+20
-10
lines changed

4 files changed

+20
-10
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ RUN go mod download
1212

1313
# build an app
1414
COPY cmd/ cmd/
15-
#COPY pkg/ pkg/
15+
COPY pkg/ pkg/
1616
RUN go build -v -o /opi-mangoboost-bridge /app/cmd/...
1717

1818
# second stage to reduce image size

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,30 @@
1414
[![GitHub stars](https://img.shields.io/github/stars/opiproject/opi-mangoboost-bridge.svg?style=flat-square&label=github%20stars)](https://github.com/opiproject/opi-mangoboost-bridge)
1515
[![GitHub Contributors](https://img.shields.io/github/contributors/opiproject/opi-mangoboost-bridge.svg?style=flat-square)](https://github.com/opiproject/opi-mangoboost-bridge/graphs/contributors)
1616

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.
1819

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)
2022

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.
2226

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+
![opi-mangoboost-bridge system overview](doc/images/opi-mangoboost-bridge_system-overview.png "opi-mangoboost-bridge system overview")
2428

2529
## Getting started
2630

2731
:exclamation: `docker-compose` is deprecated. For details, see [Migrate to Compose V2](https://docs.docker.com/compose/migrate/).
2832

2933
Run `docker-compose up -d` or `docker compose up -d`
3034

31-
## Diagrams
35+
## Usage
3236

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.

cmd/main.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import (
1616
"time"
1717

1818
"github.com/opiproject/gospdk/spdk"
19-
// fe "github.com/opiproject/opi-mangoboost-bridge/pkg/frontend"
19+
fe "github.com/opiproject/opi-mangoboost-bridge/pkg/frontend"
2020
"github.com/opiproject/opi-smbios-bridge/pkg/inventory"
2121
"github.com/opiproject/opi-spdk-bridge/pkg/backend"
2222
"github.com/opiproject/opi-spdk-bridge/pkg/middleend"
@@ -120,13 +120,13 @@ func runGrpcServer(grpcPort int, spdkAddress string, tlsFiles string, store gokv
120120

121121
jsonRPC := spdk.NewClient(spdkAddress)
122122
// Mango StorageBoost - NTI
123-
// frontendOpiMangoboostServer := fe.NewServer(jsonRPC, store)
123+
frontendOpiMangoboostServer := fe.NewServer(jsonRPC, store)
124124
backendOpiSpdkServer := backend.NewServer(jsonRPC, store)
125125
middleendOpiMangoboostServer := middleend.NewCustomizedServer(
126126
jsonRPC, store, spdk.TweakModeJoinNegLbaWithLba,
127127
)
128128

129-
// pb.RegisterFrontendNvmeServiceServer(s, frontendOpiMangoboostServer)
129+
pb.RegisterFrontendNvmeServiceServer(s, frontendOpiMangoboostServer)
130130
pb.RegisterNvmeRemoteControllerServiceServer(s, backendOpiSpdkServer)
131131
pb.RegisterNullVolumeServiceServer(s, backendOpiSpdkServer)
132132
pb.RegisterMallocVolumeServiceServer(s, backendOpiSpdkServer)
100 KB
Loading

0 commit comments

Comments
 (0)