Update whitespace in device plugin api.proto

This commit is contained in:
Kevin Klues 2020-07-02 15:15:41 +00:00
parent 4c853bb28f
commit 9c41989524

View File

@ -25,7 +25,7 @@ service Registration {
} }
message DevicePluginOptions { message DevicePluginOptions {
// Indicates if PreStartContainer call is required before each container start // Indicates if PreStartContainer call is required before each container start
bool pre_start_required = 1; bool pre_start_required = 1;
} }
@ -37,8 +37,8 @@ message RegisterRequest {
string endpoint = 2; string endpoint = 2;
// Schedulable resource name. As of now it's expected to be a DNS Label // Schedulable resource name. As of now it's expected to be a DNS Label
string resource_name = 3; string resource_name = 3;
// Options to be communicated with Device Manager // Options to be communicated with Device Manager
DevicePluginOptions options = 4; DevicePluginOptions options = 4;
} }
message Empty { message Empty {
@ -47,7 +47,7 @@ message Empty {
// DevicePlugin is the service advertised by Device Plugins // DevicePlugin is the service advertised by Device Plugins
service DevicePlugin { service DevicePlugin {
// GetDevicePluginOptions returns options to be communicated with Device // GetDevicePluginOptions returns options to be communicated with Device
// Manager // Manager
rpc GetDevicePluginOptions(Empty) returns (DevicePluginOptions) {} rpc GetDevicePluginOptions(Empty) returns (DevicePluginOptions) {}
// ListAndWatch returns a stream of List of Devices // ListAndWatch returns a stream of List of Devices
@ -60,9 +60,9 @@ service DevicePlugin {
// of the steps to make the Device available in the container // of the steps to make the Device available in the container
rpc Allocate(AllocateRequest) returns (AllocateResponse) {} rpc Allocate(AllocateRequest) returns (AllocateResponse) {}
// PreStartContainer is called, if indicated by Device Plugin during registeration phase, // PreStartContainer is called, if indicated by Device Plugin during registeration phase,
// before each container start. Device plugin can run device specific operations // before each container start. Device plugin can run device specific operations
// such as resetting the device before making devices available to the container // such as resetting the device before making devices available to the container
rpc PreStartContainer(PreStartContainerRequest) returns (PreStartContainerResponse) {} rpc PreStartContainer(PreStartContainerRequest) returns (PreStartContainerResponse) {}
} }
@ -78,7 +78,7 @@ message TopologyInfo {
} }
message NUMANode { message NUMANode {
int64 ID = 1; int64 ID = 1;
} }
/* E.g: /* E.g:
@ -87,7 +87,7 @@ message NUMANode {
* Health: "Healthy", * Health: "Healthy",
* Topology: * Topology:
* Node: * Node:
ID: 1 * ID: 1
*} */ *} */
message Device { message Device {
// A unique ID assigned by the device plugin used // A unique ID assigned by the device plugin used
@ -105,7 +105,7 @@ message Device {
// - PreStartContainer allows Device Plugin to run device specific operations on // - PreStartContainer allows Device Plugin to run device specific operations on
// the Devices requested // the Devices requested
message PreStartContainerRequest { message PreStartContainerRequest {
repeated string devicesIDs = 1; repeated string devicesIDs = 1;
} }
// PreStartContainerResponse will be send by plugin in response to PreStartContainerRequest // PreStartContainerResponse will be send by plugin in response to PreStartContainerRequest
@ -162,13 +162,13 @@ message Mount {
// DeviceSpec specifies a host device to mount into a container. // DeviceSpec specifies a host device to mount into a container.
message DeviceSpec { message DeviceSpec {
// Path of the device within the container. // Path of the device within the container.
string container_path = 1; string container_path = 1;
// Path of the device on the host. // Path of the device on the host.
string host_path = 2; string host_path = 2;
// Cgroups permissions of the device, candidates are one or more of // Cgroups permissions of the device, candidates are one or more of
// * r - allows container to read from the specified device. // * r - allows container to read from the specified device.
// * w - allows container to write to the specified device. // * w - allows container to write to the specified device.
// * m - allows container to create device files that do not yet exist. // * m - allows container to create device files that do not yet exist.
string permissions = 3; string permissions = 3;
} }