Skip to content

Commit

Permalink
docs: fixing typos in markdown files.
Browse files Browse the repository at this point in the history
Signed-off-by: Jeremy Pare <jeremy.pare@outlook.com>
  • Loading branch information
jayPare committed Aug 2, 2024
1 parent 3a7e0d2 commit fb58918
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CAPABILITIES.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Application API requirements center around the ability to provide service chaini

### Background

For network applications such as firewalls and load balancers to use DPUs there needs to be significant performanance benefits. Therefore this set of requriements focuses on the areas that require a significant amount of x86 CPU for these type of applications. Ideally the performance improvemenst should be in the range of at least one order of magnitude as there is both a CAPEX and OPEX costs for the end customers.
For network applications such as firewalls and load balancers to use DPUs there needs to be significant performanance benefits. Therefore this set of requirements focuses on the areas that require a significant amount of x86 CPU for these type of applications. Ideally the performance improvemenst should be in the range of at least one order of magnitude as there is both a CAPEX and OPEX costs for the end customers.

### SSL Acceleration

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## 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.
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 any number of people, and a maintainer may accept.

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.

Expand Down
2 changes: 1 addition & 1 deletion USECASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The API Abstraction Layer provides the interface set for the capabilities provid

![API Control Plane Stacking](doc/images/Control%20Path%20Stacking%20Diagram.png)

A detailed conceptial diagram below illustrates the deployment on the local xPU where the API gateway and load balancer which provides the gRPC/REST interface to the client (client can be an orchestration agent). As part of the abstraction layer, the Authentication and Authorization service is needed to verify the user/agent access and authorization for the service.
A detailed conceptual diagram below illustrates the deployment on the local xPU where the API gateway and load balancer which provides the gRPC/REST interface to the client (client can be an orchestration agent). As part of the abstraction layer, the Authentication and Authorization service is needed to verify the user/agent access and authorization for the service.

![API Abstraction Layer](doc/images/API-Detailed-Abstraction-Layer-Local.png)

Expand Down
2 changes: 1 addition & 1 deletion network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- OPI defines/recommends __protobuf__ definitions that each vendor can tie into the underlying SDKs.
- The __protobuf__ definitions will be aligned with the API and behavioral models available from OVS DB, OpenConfig, OpenFlow, P4, etc. to allow configuration of the service.
- OPI provides a __LAN service__ implementation for the network capabilities that is compatible with OVS, SONiC, VPP, P4, etc.
- OPI defines a __device interface__ for the data services that are delivered through the the PF/VF from the xPU.
- OPI defines a __device interface__ for the data services that are delivered through the PF/VF from the xPU.
- OPI provides a __prototype client__ for sending gRPC, REST protobufs to the xPU for configuation and management.

## Network APIs to be defined
Expand Down
2 changes: 1 addition & 1 deletion storage/v1alpha1/autogen.md
Original file line number Diff line number Diff line change
Expand Up @@ -1996,7 +1996,7 @@ Represnts emulated Virtio-blk device
<a name="opi_api-storage-v1-FrontendVirtioBlkService"></a>

### FrontendVirtioBlkService
Front End (host-facing) APIs. Mostly used for Virtio-blk emulation emulation and host presentation as alternative to Nvme.
Front End (host-facing) APIs. Mostly used for Virtio-blk emulation and host presentation as alternative to Nvme.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
Expand Down

0 comments on commit fb58918

Please sign in to comment.