docs(storage): update front/back end Nvme service descriptions

Signed-off-by: Artsiom Koltun <artsiom.koltun@intel.com>
opiproject · Oct 5, 2023 · e7820ff · e7820ff
1 parent ca248b5
commit e7820ff
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/storage/v1alpha1/backend_nvme.proto b/storage/v1alpha1/backend_nvme.proto
@@ -21,7 +21,8 @@ import "google/protobuf/field_mask.proto";
 import "opicommon.proto";
 import "uuid.proto";
 
-// Back End (network-facing) APIs. NVMe/TCP and NVMe/RoCEv2 protocols are covered by this service.
+// Back End APIs. Reponsible for connection to external Nvme devices
+// e.g. connection to Nvme/TCP Nvme/RDMA and local Nvme/Pcie ssds
 service NvmeRemoteControllerService {
     // Create an Nvme Remote Controller
     rpc CreateNvmeRemoteController (CreateNvmeRemoteControllerRequest) returns (NvmeRemoteController) {

diff --git a/storage/v1alpha1/frontend_nvme.proto b/storage/v1alpha1/frontend_nvme.proto
@@ -21,7 +21,9 @@ import "google/api/annotations.proto";
 import "google/api/field_behavior.proto";
 import "google/protobuf/field_mask.proto";
 
-// Front End (host-facing) APIs. Mostly used for Nvme/PCIe emulation and host presentation.
+// Front End APIs. Used for creation of xPU managed Nvme devices
+// e.g. emulated host-facing Nvme/Pcie controllers as well as
+// Nvme-oF controllers
 service FrontendNvmeService {
     // Create an Nvme Subsystem
     rpc CreateNvmeSubsystem (CreateNvmeSubsystemRequest) returns (NvmeSubsystem) {