Skip to content

Commit

Permalink
Move binding messages to a separate proto, refactor field names, add …
Browse files Browse the repository at this point in the history 
…comments
  • Loading branch information
@ajbalogh
ajbalogh committed Oct 28, 2024
1 parent ded4368 commit f628e4a
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 88 deletions.
116 changes: 116 additions & 0 deletions protos/bind.proto
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
// bind.proto
//
// A data model to describe binding infrastructure paths to third party
// information.

syntax = "proto3";

package bind;

import "google/protobuf/any.proto";

message CustomAttribute {
// Use this field to provide descriptive information about the message
// that is packed into the value field.
string name = 1;

// The value field can be used to store external information outside the
// scope of these protobuf messages.
//
// In addition to custom messages any wellknown type can be set into an
// Any message. See the following reference for details:
// https://protobuf.dev/reference/protobuf/google.protobuf/
//
// # The following is a python example of how to serialize a proto message
// into the value field of the CustomAttribute message.
// custom_msg = CustomMessage()
// any_message = Any()
// any_message.Pack(custom_msg)
// custom_attr = CustomAttribute(name="a custom message", value=custom_msg)
//
// # How to deserialize the contents of CustomAttribute.value into a message
// custom_msg = CustomMessage()
// if attr.value.Is(CustomMessage.DESCRIPTOR):
// attr.value.Unpack(custom_msg)
google.protobuf.Any value = 3;
}

enum LocationFormat {
// not to be used
LOCATION_UNSPECIFIED = 0;

// location is global
LOCATION_INFRASTRUCTURE = 1;

// location is a Infrastructure.inventory.devices.name
// example: dgx1
LOCATION_DEVICE = 2;

// location device index is an instance of
// Infrastructure.inventory.devices.name
// example: dgx1.1
LOCATION_DEVICE_INDEX = 3;

// location device index component is an instance of
// Infrastructure.inventory.devices.name and component.name
// example: dgx1.1.nic
LOCATION_DEVICE_INDEX_COMPONENT = 4;

// location device index component index is an instance of
// Infrastructure.inventory.devices.name and an instance of a component.name
// example: dgx1.1.nic.1
LOCATION_DEVICE_INDEX_COMPONENT_INDEX = 5;

// location device instance is an instance of
// Infrastructure.device_instances.name
LOCATION_DEVICE_INSTANCE = 6;

// location device instance is an instance of
// Infrastructure.device_instances.name
// and an index < Infrastructure.device_instances.count
LOCATION_DEVICE_INSTANCE_INDEX = 7;

// location device instance component is an instance of
// Infrastructure.device_instances.name
// and an index < Infrastructure.device_instances.count
// and an Infrastructure.inventory.device.component.name
LOCATION_DEVICE_INSTANCE_INDEX_COMPONENT = 8;

// location device instance component is an instance of
// Infrastructure.device_instances.name
// and an index < Infrastructure.device_instances.count
// and an Infrastructure.inventory.device.component.name
// and an index < Infrastructure.inventory.device.component.name.index
LOCATION_DEVICE_INSTANCE_INDEX_COMPONENT_INDEX = 9;
}

// The Binding message offers the option of binding different types of logical
// Infrastructure endpoints to custom attributes.
//
// The format allows for attributes to be applied at a macro level such as
// all devices or at a micro level such as an individual component in a
// specific device instance.
//
// The custom attributes allows for user defined information including but not
// limited to configuration, location, identification.
// Multiple custom attributes can be applied to a single binding value
// packed into an Any type.
message Binding {
// The format of the location value
LocationFormat format = 1;

// The location of infrastructure that matches the binding type format
string location = 2;

// custom information that can be as simple as a single attribute or as
// complex as a proto/json/yaml message
//
// attributes allow for complete flexibility to accomodate any combination
// of user defined information
repeated CustomAttribute attributes = 100;
}

message Bindings {
// A list of user defined information for specific endpoints
repeated Binding bindings = 1;
}
90 changes: 2 additions & 88 deletions protos/infra.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,6 @@ syntax = "proto3";

package infra;

import "google/protobuf/any.proto";
import "google/protobuf/empty.proto";

message CustomAttribute {
string name = 1;
string doc_string = 2;

// # in addition to custom messages any wellknown type can be set into Any
// https://protobuf.dev/reference/protobuf/google.protobuf/
//
// # how to pack a proto message into CustomAttribute.any_val
// nic_config = NicConfig()
// any_message = Any()
// any_message.Pack(nic_config)
// attr = CustomAttribute(name="proto message", any_val=any_message)
//
// # how to unpack an CustomAttribute.any_val message into a message
// nic_config = NicConfig()
// if attr.any_val.Is(NicConfig.DESCRIPTOR):
// attr.any_val.Unpack(nic_config)
google.protobuf.Any value = 3;
}

enum MemoryType {
MEM_UNSPECIFIED = 0;

Expand Down Expand Up @@ -129,17 +106,6 @@ message Bandwidth {
}
}

message Latency {
oneof type {
// milliseond latency
uint64 ms = 1;
// microsecond latency
uint64 us = 2;
// nanonsecond latency
uint64 ns = 3;
}
}

// Link describes a link between Components
message Link {
// name of the link
Expand All @@ -148,11 +114,8 @@ message Link {
// type of link
LinkType type = 2;

// NOTE: the following fields are currently being discussed
// and are subject to change
// Describes the bandwidth of the link
Bandwidth bandwidth = 10;

Latency latency = 11;
}

message ComponentConnection {
Expand All @@ -172,7 +135,7 @@ message ComponentConnection {
//
// examples:
// nic.0.pcie.cpu.0
// npu.0.pcie.nwswitch.0
// npu.0.pcie.nvswitch.0
//
string connection = 1;
}
Expand Down Expand Up @@ -233,52 +196,6 @@ message DeviceInstances {
uint32 count = 3;
}

enum LocationFormat {
// not to be used
LOCATION_UNSPECIFIED = 0;

// location is global
LOCATION_INFRASTRUCTURE = 1;

// location is a Infrastructure.inventory.devices.name
// example: dgx1
LOCATION_DEVICE = 2;

LOCATION_DEVICE_INDEX = 3;
LOCATION_DEVICE_INDEX_COMPONENT = 4;
LOCATION_DEVICE_INDEX_COMPONENT_INDEX = 5;
LOCATION_DEVICE_INSTANCE = 6;
LOCATION_DEVICE_INSTANCE_INDEX = 7;
LOCATION_DEVICE_INSTANCE_INDEX_COMPONENT = 8;
LOCATION_DEVICE_INSTANCE_INDEX_COMPONENT_INDEX = 9;
}

// The Binding message offers the option of binding different types of logical
// Infrastructure endpoints to custom attributes.
//
// The format allows for attributes to be applied at a macro level such as
// all devices or at a micro level such as an individual component in a
// specific device instance.
//
// The custom attributes allows for user defined information including but not
// limited to configuration, location, identification.
// Multiple custom attributes can be applied to a single binding value
// packed into an Any type.
message Binding {
// The format of the binding value
LocationFormat location_format = 1;

// The location of infrastructure that matches the binding type format
string location_value = 2;

// custom information that can be as simple as a single attribute or as
// complex as a proto/json/yaml message
//
// attributes allow for complete flexibility to accomodate any combination
// of userinformation
repeated CustomAttribute attributes = 100;
}

// The Inventory message is a collection of unique devices and links present
// in the infrastructure.
// The devices and links in the inventory are meant to be reused in
Expand Down Expand Up @@ -314,7 +231,4 @@ message Infrastructure {

// A list that describes how device instances are connected
repeated DeviceConnection connections = 20;

// A list of user supplied custom information for specific endpoints
repeated Binding bindings = 30;
}

0 comments on commit f628e4a

Please sign in to comment.