Understanding Which ratelimit Package to Use

[Ronnie-personal]

Description: Currently, 'internal/xds/translator/ratelimit.go' utilizes 'github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3'. 'ratelimit.RateLimitConfig' does not have the ValidateAll() function, as a result, we cannot validate the resource. We need to understand why we don't use 'github.com/envoyproxy/go-control-plane/envoy/config/ratelimit/v3'.

[optional Relevant Links:] You may find more context at #1662 (comment)

[arkodg]

looks like the API lives here https://github.com/envoyproxy/ratelimit/blob/main/api/ratelimit/config/ratelimit/v3/rls_conf.proto and its generated go files live here
https://github.com/envoyproxy/go-control-plane/blob/main/ratelimit/config/ratelimit/v3/rls_conf.pb.go

so the proto API will need to be sprinkled with tags from https://github.com/bufbuild/protoc-gen-validate and then we'd need to run this https://github.com/bufbuild/protoc-gen-validate#go

what I can't find is, where is the buf / protoc-gen-validate cmd supposed to be run ?
any idea @phlax @mattklein123 @renuka-fernando ?

[Ronnie-personal]

looks like the API lives here https://github.com/envoyproxy/ratelimit/blob/main/api/ratelimit/config/ratelimit/v3/rls_conf.proto and its generated go files live here https://github.com/envoyproxy/go-control-plane/blob/main/ratelimit/config/ratelimit/v3/rls_conf.pb.go

so the proto API will need to be sprinkled with tags from https://github.com/bufbuild/protoc-gen-validate and then we'd need to run this https://github.com/bufbuild/protoc-gen-validate#go

what I can't find is, where is the buf / protoc-gen-validate cmd supposed to be run ? any idea @phlax @mattklein123 @renuka-fernando ?

@phlax @mattklein123 @renuka-fernando
I would like to follow up. Could you please help with the questions?

[renuka-fernando]

looks like the API lives here https://github.com/envoyproxy/ratelimit/blob/main/api/ratelimit/config/ratelimit/v3/rls_conf.proto and its generated go files live here https://github.com/envoyproxy/go-control-plane/blob/main/ratelimit/config/ratelimit/v3/rls_conf.pb.go

so the proto API will need to be sprinkled with tags from https://github.com/bufbuild/protoc-gen-validate and then we'd need to run this https://github.com/bufbuild/protoc-gen-validate#go

what I can't find is, where is the buf / protoc-gen-validate cmd supposed to be run ? any idea @phlax @mattklein123 @renuka-fernando ?

We have not automated generating pb files. I've created an issue [1] for that but couldn't get it done.

[1] envoyproxy/go-control-plane#646

[renuka-fernando]

Description: Currently, 'internal/xds/translator/ratelimit.go' utilizes 'github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3'. 'ratelimit.RateLimitConfig' does not have the ValidateAll() function, as a result, we cannot validate the resource. We need to understand why we don't use 'github.com/envoyproxy/go-control-plane/envoy/config/ratelimit/v3'.

[optional Relevant Links:] You may find more context at #1662 (comment)

We can't use 'github.com/envoyproxy/go-control-plane/envoy/config/ratelimit/v3'. This is the API for Envoy and RateLimit Service communication.

'github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3' is for RateLimit Service and RateLimit xDS service communication.

[Ronnie-personal]

looks like the API lives here https://github.com/envoyproxy/ratelimit/blob/main/api/ratelimit/config/ratelimit/v3/rls_conf.proto and its generated go files live here https://github.com/envoyproxy/go-control-plane/blob/main/ratelimit/config/ratelimit/v3/rls_conf.pb.go
so the proto API will need to be sprinkled with tags from https://github.com/bufbuild/protoc-gen-validate and then we'd need to run this https://github.com/bufbuild/protoc-gen-validate#go
what I can't find is, where is the buf / protoc-gen-validate cmd supposed to be run ? any idea @phlax @mattklein123 @renuka-fernando ?

We have not automated generating pb files. I've created an issue [1] for that but couldn't get it done.

[1] envoyproxy/go-control-plane#646

@renuka-fernando
Thanks for the information.
By any chance you could re-open envoyproxy/go-control-plane#646?

Thanks.

[renuka-fernando]

It looks like I don't have the necessary permissions to reopen the issue envoyproxy/go-control-plane#646.

cc: @phlax

[github-actions]

This issue has been automatically marked as stale because it has not had activity in the last 30 days.