admission control: Filter implementation with no-op controller #11414
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # DO NOT EDIT. This file is generated by tools/proto_sync.py. | ||
|
|
||
| load("@envoy_api//bazel:api_build_system.bzl", "api_proto_package") | ||
|
|
||
| licenses(["notice"]) # Apache 2 | ||
|
|
||
| api_proto_package( | ||
| deps = [ | ||
| "//envoy/config/core/v3:pkg", | ||
| "//envoy/type/v3:pkg", | ||
| "@com_github_cncf_udpa//udpa/annotations:pkg", | ||
| ], | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package envoy.extensions.filters.http.admission_control.v3alpha; | ||
|
|
||
| import "envoy/config/core/v3/base.proto"; | ||
| import "envoy/type/v3/range.proto"; | ||
|
|
||
| import "google/api/annotations.proto"; | ||
| import "google/protobuf/duration.proto"; | ||
| import "google/protobuf/wrappers.proto"; | ||
| import "google/rpc/status.proto"; | ||
|
|
||
| import "udpa/annotations/migrate.proto"; | ||
| import "udpa/annotations/status.proto"; | ||
| import "validate/validate.proto"; | ||
|
|
||
| option java_package = "io.envoyproxy.envoy.extensions.filters.http.admission_control.v3alpha"; | ||
| option java_outer_classname = "AdmissionControlProto"; | ||
| option java_multiple_files = true; | ||
| option (udpa.annotations.file_status).work_in_progress = true; | ||
| option (udpa.annotations.file_status).package_version_status = ACTIVE; | ||
|
|
||
| // [#protodoc-title: Admission Control] | ||
| // [#extension: envoy.filters.http.admission_control] | ||
|
|
||
| message AdmissionControl { | ||
| // Default method of specifying what constitutes a successful request. All status codes that | ||
| // indicate a successful request must be explicitly specified if not relying on the default | ||
| // values. | ||
| message SuccessCriteria { | ||
| message HttpCriteria { | ||
| // Status code ranges that constitute a successful request. Configurable codes are in the | ||
| // range [100, 600). If empty, all HTTP requests will be considered unsuccessful. | ||
| repeated type.v3.Int32Range http_success_status = 1; | ||
| } | ||
|
|
||
| message GrpcCriteria { | ||
| // Status codes that constitute a successful request. If empty, all gRPC requests will be | ||
| // considered unsuccessful. | ||
|
Member
There was a problem hiding this comment. Is this a good default? Should we have 0 be successful if empty? |
||
| // Mappings can be found at: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md. | ||
| repeated uint32 grpc_success_status = 1; | ||
| } | ||
|
|
||
| // If HTTP criteria are unspecified, all HTTP status codes below 500 are treated as successful | ||
| // responses. | ||
|
Comment on lines
+44
to
+45
Member
There was a problem hiding this comment. Hmm I see how you structured this. I would do 200-299 by default, and if specified I would make http_success_status min length 1 in the message above.
Member
Author
There was a problem hiding this comment. See the grpc code comment below. I think it also applies here for things like redirects or 403/404/etc. |
||
| HttpCriteria http_criteria = 1; | ||
|
|
||
| // GRPC status codes to consider as request successes. If unspecified, defaults to: Ok, | ||
|
tonya11en marked this conversation as resolved.
Member
There was a problem hiding this comment. Similar comment above. I would make the min repeated above required if the message is specified, and I think the default should be just OK here?
Member
Author
There was a problem hiding this comment. My reasoning for picking these specific codes is that something like Does that change anything for you?
Member
There was a problem hiding this comment. I guess? I'm fine either way but I would flesh out the docs as to why the default is what it is. Same for the HTTP one. |
||
| // Cancelled, Unknown, InvalidArgument, NotFound, AlreadyExists, Unauthenticated, | ||
| // FailedPrecondition, OutOfRange, and Unimplemented. | ||
| GrpcCriteria grpc_criteria = 2; | ||
| } | ||
|
|
||
| // If set to false, the admission control filter will operate as a pass-through filter. If the | ||
| // message is unspecified, the filter will be enabled. | ||
| config.core.v3.RuntimeFeatureFlag enabled = 1; | ||
|
|
||
| // Defines how a request is considered a success/failure. | ||
| oneof evaluation_criteria { | ||
| option (validate.required) = true; | ||
|
|
||
| SuccessCriteria success_criteria = 2; | ||
| } | ||
|
|
||
| // The sliding time window over which the success rate is calculated. The window is rounded to the | ||
| // nearest second. Defaults to 120s. | ||
| google.protobuf.Duration sampling_window = 3; | ||
|
tonya11en marked this conversation as resolved.
|
||
|
|
||
| // Rejection probability is defined by the formula:: | ||
| // | ||
| // max(0, (rq_count - aggression_coefficient * rq_success_count) / (rq_count + 1)) | ||
| // | ||
| // The coefficient dictates how aggressively the admission controller will throttle requests as | ||
| // the success rate drops. Lower values will cause throttling to kick in at higher success rates | ||
| // and result in more aggressive throttling. Any values less than 1.0, will be set to 1.0. If the | ||
| // message is unspecified, the coefficient is 2.0. | ||
| config.core.v3.RuntimeDouble aggression_coefficient = 4; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| load( | ||
| "//bazel:envoy_build_system.bzl", | ||
| "envoy_cc_extension", | ||
| "envoy_package", | ||
| ) | ||
|
|
||
| licenses(["notice"]) # Apache 2 | ||
|
|
||
| # HTTP L7 filter that probabilistically rejects requests based on upstream success-rate. | ||
| # Public docs: docs/root/configuration/http_filters/admission_control.rst | ||
|
|
||
| envoy_package() | ||
|
|
||
| envoy_cc_extension( | ||
| name = "admission_control_filter_lib", | ||
| srcs = [ | ||
| "admission_control.cc", | ||
| ], | ||
| hdrs = [ | ||
| "admission_control.h", | ||
| "thread_local_controller.h", | ||
| ], | ||
| security_posture = "unknown", | ||
| deps = [ | ||
| "//include/envoy/http:filter_interface", | ||
| "//include/envoy/runtime:runtime_interface", | ||
| "//source/common/common:cleanup_lib", | ||
| "//source/common/http:codes_lib", | ||
| "//source/common/runtime:runtime_lib", | ||
| "//source/extensions/filters/http:well_known_names", | ||
| "//source/extensions/filters/http/admission_control/evaluators:response_evaluator_lib", | ||
| "//source/extensions/filters/http/common:pass_through_filter_lib", | ||
| "@envoy_api//envoy/extensions/filters/http/admission_control/v3alpha:pkg_cc_proto", | ||
| ], | ||
| ) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a good default? Should we have 200-299 be successful by default?