consul/proto-public at NET-2088-upgrade-test-ingress-gateway - consul - https://git.xinac.net

Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.

consul api-gateway kubernetes ecs service-discovery service-mesh vault

Branch: NET-2088-upgrade-test-ingress-gateway

History

Dan Upton d4c435856b grpc: `protoc` plugin for generating gRPC rate limit specifications (#15564 ) Adds automation for generating the map of `gRPC Method Name → Rate Limit Type` used by the middleware introduced in #15550, and will ensure we don't forget to add new endpoints. Engineers must annotate their RPCs in the proto file like so: ``` rpc Foo(FooRequest) returns (FooResponse) { option (consul.internal.ratelimit.spec) = { operation_type: READ, }; } ``` When they run `make proto` a protoc plugin `protoc-gen-consul-rate-limit` will be installed that writes rate-limit specs as a JSON array to a file called `.ratelimit.tmp` (one per protobuf package/directory). After running Buf, `make proto` will execute a post-process script that will ingest all of the `.ratelimit.tmp` files and generate a Go file containing the mappings in the `agent/grpc-middleware` package. In the enterprise repository, it will write an additional file with the enterprise-only endpoints. If an engineer forgets to add the annotation to a new RPC, the plugin will return an error like so: ``` RPC Foo is missing rate-limit specification, fix it with: import "proto-public/annotations/ratelimit/ratelimit.proto"; service Bar { rpc Foo(...) returns (...) { option (hashicorp.consul.internal.ratelimit.spec) = { operation_type: OPERATION_READ \| OPERATION_WRITE \| OPERATION_EXEMPT, }; } } ``` In the future, this annotation can be extended to support rate-limit category (e.g. KV vs Catalog) and to determine the retry policy.		2 years ago
..
annotations/ratelimit	grpc: `protoc` plugin for generating gRPC rate limit specifications (#15564 )	2 years ago
pbacl	grpc: `protoc` plugin for generating gRPC rate limit specifications (#15564 )	2 years ago
pbconnectca	grpc: `protoc` plugin for generating gRPC rate limit specifications (#15564 )	2 years ago
pbdataplane	grpc: `protoc` plugin for generating gRPC rate limit specifications (#15564 )	2 years ago
pbdns	grpc: `protoc` plugin for generating gRPC rate limit specifications (#15564 )	2 years ago
pbserverdiscovery	grpc: `protoc` plugin for generating gRPC rate limit specifications (#15564 )	2 years ago
buf.gen.yaml	grpc: `protoc` plugin for generating gRPC rate limit specifications (#15564 )	2 years ago
buf.yaml	Migrate from `protoc` to `buf` (#12841 )	3 years ago
go.mod	Make proto-public a Go module	2 years ago
go.sum	Make proto-public a Go module	2 years ago