Skip to content

Commit

Permalink
docs: add godpu example to readme
Browse files Browse the repository at this point in the history
Signed-off-by: Boris Glimcher <36732377+glimchb@users.noreply.github.com>
  • Loading branch information
glimchb authored Sep 7, 2023
1 parent 36f522a commit 3108cdf
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ See [CONTRIBUTING](https://github.com/opiproject/opi/blob/main/CONTRIBUTING.md)

## Getting started

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

## Manual gRPC example

using [grpcurl](https://github.com/fullstorydev/grpcurl)

```bash
# create
docker-compose exec opi-evpn-bridge grpcurl -plaintext -d '{"vrf" : {"spec" : {"vni" : 1234, "loopback_ip_prefix" : {"addr": {"af": "IP_AF_INET", "v4_addr": 167772162} }, "len": 24}, "vtep_ip_prefix": {"addr": {"af": "IP_AF_INET", "v4_addr": 167772162} }, "len": 24} }}, "vrf_id" : "testvrf" }' localhost:50151 opi_api.network.evpn-gw.v1alpha1.VrfService.CreateVrf"
Expand All @@ -47,6 +49,47 @@ docker-compose exec opi-evpn-bridge grpcurl -plaintext -d '{"name" : "//network.
docker-compose exec opi-evpn-bridge grpcurl -plaintext -d '{"name" : "//network.opiproject.org/vrfs/testvrf"}' localhost:50151 opi_api.network.evpn-gw.v1alpha1.VrfService.DeleteVrf
```
using [godpu](https://github.com/opiproject/godpu)
```bash
$ docker run --rm -it --network=host docker.io/opiproject/godpu:main evpn --help
Tests DPU evpn functionality
Usage:
godpu evpn [flags]
godpu evpn [command]
Aliases:
evpn, g
Available Commands:
create-bp Create a bridge port
create-lb Create a logical bridge
create-svi Create a SVI
create-vrf Create a VRF
delete-bp Delete a bridge port
delete-lb Delete a logical bridge
delete-svi Delete a SVI
delete-vrf Delete a VRF
get-bp Show details of a bridge port
get-lb Show details of a logical bridge
get-svi Show details of a SVI
get-vrf Show details of a VRF
list-bps Show details of all bridge ports
list-lbs Show details of all logical bridges
list-svis Show details of all SVIs
list-vrfs Show details of all Vrfs
update-bp Update the bridge port
update-lb update the logical bridge
update-svi update the SVI
update-vrf update the VRF
Flags:
-h, --help help for evpn
Use "godpu evpn [command] --help" for more information about a command.
```
## Architecture Diagram
![OPI EVPN Bridge Architcture Diagram](./docs/OPI-EVPN-GW-FRR-bridge.png)
Expand Down

0 comments on commit 3108cdf

Please sign in to comment.