[orc8r][service registry] Add proto for service registry service #2333
Conversation
Signed-off-by: mgermano <mgermano@fb.com>
| // The ServiceRegistry interface implements a set of functionalities that can | ||
| // be used for service discovery. | ||
| // -------------------------------------------------------------------------- | ||
| service ServiceRegistry { |
There was a problem hiding this comment.
Preference for the Uber style [0] where every request/response message is named directly after the RPC -- e.g. rpc ListAllServices (ListAllServicesRequest) returns (ListAllServicesResponse) {}
[0] https://github.com/uber/prototool/blob/dev/style/README.md#servicesrpcs
orc8r/protos/service_registry.proto
Outdated
| } | ||
|
|
||
| message AnnotationList { | ||
| repeated string annotations = 1; |
There was a problem hiding this comment.
This should just return the flat annotation (i.e. not repeated), and the client side can handle optionally parsing into separate values
Also may be useful to name it annotation_value to disambiguate annotation (name of annotation) vs annotation_value (value of annotation)
orc8r/protos/service_registry.proto
Outdated
|
|
||
| message AnnotationList { | ||
| repeated string annotations = 1; | ||
| } |
There was a problem hiding this comment.
Nit: editor config to always add eof newline
| option go_package = "magma/orc8r/lib/go/protos"; | ||
|
|
||
|
|
||
| // -------------------------------------------------------------------------- |
There was a problem hiding this comment.
Preference for following Go conventions when providing doc comments -- e.g.
// ServiceRegistry supports dynamic service discovery.
Signed-off-by: mgermano <mgermano@fb.com>
| service ServiceRegistry { | ||
|
|
||
| // ListAllServices returns the service name of all services in the registry. | ||
| rpc ListAllServices (Void) returns (ListAllServicesResponse) {} |
There was a problem hiding this comment.
In general I still prefer e.g. an empty ListAllServicesRequest defn over Void, though for this and other orc8r-internal grpc servicers it's not super relevant
Signed-off-by: mgermano mgermano@fb.com
Summary
The new service registry service will be used to provide registry
functionality for differing deployment environments (docker in dev,
k8s in prod). This PR adds the proto for the service.
Test Plan
n/a