mirror of
https://github.com/status-im/consul.git
synced 2025-01-21 19:20:41 +00:00
085c0addc0
Protobuf Refactoring for Multi-Module Cleanliness This commit includes the following: Moves all packages that were within proto/ to proto/private Rewrites imports to account for the packages being moved Adds in buf.work.yaml to enable buf workspaces Names the proto-public buf module so that we can override the Go package imports within proto/buf.yaml Bumps the buf version dependency to 1.14.0 (I was trying out the version to see if it would get around an issue - it didn't but it also doesn't break things and it seemed best to keep up with the toolchain changes) Why: In the future we will need to consume other protobuf dependencies such as the Google HTTP annotations for openapi generation or grpc-gateway usage. There were some recent changes to have our own ratelimiting annotations. The two combined were not working when I was trying to use them together (attempting to rebase another branch) Buf workspaces should be the solution to the problem Buf workspaces means that each module will have generated Go code that embeds proto file names relative to the proto dir and not the top level repo root. This resulted in proto file name conflicts in the Go global protobuf type registry. The solution to that was to add in a private/ directory into the path within the proto/ directory. That then required rewriting all the imports. Is this safe? AFAICT yes The gRPC wire protocol doesn't seem to care about the proto file names (although the Go grpc code does tack on the proto file name as Metadata in the ServiceDesc) Other than imports, there were no changes to any generated code as a result of this.
99 lines
3.3 KiB
Protocol Buffer
99 lines
3.3 KiB
Protocol Buffer
// Package dataplane provides a service on Consul servers for the Consul Dataplane
|
|
|
|
syntax = "proto3";
|
|
|
|
package hashicorp.consul.dataplane;
|
|
|
|
import "annotations/ratelimit/ratelimit.proto";
|
|
import "google/protobuf/struct.proto";
|
|
|
|
message GetSupportedDataplaneFeaturesRequest {}
|
|
|
|
enum DataplaneFeatures {
|
|
DATAPLANE_FEATURES_UNSPECIFIED = 0;
|
|
DATAPLANE_FEATURES_WATCH_SERVERS = 1;
|
|
DATAPLANE_FEATURES_EDGE_CERTIFICATE_MANAGEMENT = 2;
|
|
DATAPLANE_FEATURES_ENVOY_BOOTSTRAP_CONFIGURATION = 3;
|
|
}
|
|
|
|
message DataplaneFeatureSupport {
|
|
DataplaneFeatures feature_name = 1;
|
|
bool supported = 2;
|
|
}
|
|
|
|
message GetSupportedDataplaneFeaturesResponse {
|
|
repeated DataplaneFeatureSupport supported_dataplane_features = 1;
|
|
}
|
|
|
|
message GetEnvoyBootstrapParamsRequest {
|
|
oneof node_spec {
|
|
string node_id = 1;
|
|
string node_name = 2;
|
|
}
|
|
// The proxy service ID
|
|
string service_id = 3;
|
|
string partition = 4;
|
|
string namespace = 5;
|
|
}
|
|
|
|
enum ServiceKind {
|
|
// ServiceKind UNSPECIFIED is a sentinel value for when a request
|
|
// did not specify a service kind. This will be treated the same
|
|
// as if TYPICAL was explicitly used.
|
|
SERVICE_KIND_UNSPECIFIED = 0;
|
|
|
|
// ServiceKind Typical is a typical, classic Consul service. This is
|
|
// represented by the absence of a value. This was chosen for ease of
|
|
// backwards compatibility: existing services in the catalog would
|
|
// default to the typical service.
|
|
SERVICE_KIND_TYPICAL = 1;
|
|
|
|
// ServiceKind Connect Proxy is a proxy for the Connect feature. This
|
|
// service proxies another service within Consul and speaks the connect
|
|
// protocol.
|
|
SERVICE_KIND_CONNECT_PROXY = 2;
|
|
|
|
// ServiceKind Mesh Gateway is a Mesh Gateway for the Connect feature. This
|
|
// service will proxy connections based off the SNI header set by other
|
|
// connect proxies.
|
|
SERVICE_KIND_MESH_GATEWAY = 3;
|
|
|
|
// ServiceKind Terminating Gateway is a Terminating Gateway for the Connect
|
|
// feature. This service will proxy connections to services outside the mesh.
|
|
SERVICE_KIND_TERMINATING_GATEWAY = 4;
|
|
|
|
// ServiceKind Ingress Gateway is an Ingress Gateway for the Connect feature.
|
|
// This service will ingress connections into the service mesh.
|
|
SERVICE_KIND_INGRESS_GATEWAY = 5;
|
|
|
|
// ServiceKind API Gateway is an API Gateway for the Connect feature.
|
|
// This service will ingress connections in to the service mesh.
|
|
SERVICE_KIND_API_GATEWAY = 6;
|
|
}
|
|
|
|
message GetEnvoyBootstrapParamsResponse {
|
|
ServiceKind service_kind = 1;
|
|
// service is be used to identify the service (as the local cluster name and
|
|
// in metric tags). If the service is a connect proxy it will be the name of
|
|
// the proxy's destination service, for gateways it will be the gateway
|
|
// service's name.
|
|
string service = 2;
|
|
string namespace = 3;
|
|
string partition = 4;
|
|
string datacenter = 5;
|
|
google.protobuf.Struct config = 6;
|
|
string node_id = 7;
|
|
string node_name = 8;
|
|
repeated string access_logs = 9;
|
|
}
|
|
|
|
service DataplaneService {
|
|
rpc GetSupportedDataplaneFeatures(GetSupportedDataplaneFeaturesRequest) returns (GetSupportedDataplaneFeaturesResponse) {
|
|
option (hashicorp.consul.internal.ratelimit.spec) = {operation_type: OPERATION_TYPE_READ};
|
|
}
|
|
|
|
rpc GetEnvoyBootstrapParams(GetEnvoyBootstrapParamsRequest) returns (GetEnvoyBootstrapParamsResponse) {
|
|
option (hashicorp.consul.internal.ratelimit.spec) = {operation_type: OPERATION_TYPE_READ};
|
|
}
|
|
}
|