compressor: expose generic compressor filter to users #10553
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains 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 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 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,9 @@ | ||
| # 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 = ["@com_github_cncf_udpa//udpa/annotations:pkg"], | ||
| ) |
This file contains 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,67 @@ | ||
| syntax = "proto3"; | ||
|
There was a problem hiding this comment. How does this relate to https://github.com/envoyproxy/envoy/blob/master/api/envoy/config/filter/http/gzip/v2/gzip.proto? Which one should service operators configure and when? Is the former deprecated? There was a problem hiding this comment. Yes, exactly, the former is deprecated. We need to make that clear as @htuch points out, have text in deprecated.rst, and also make sure the deprecated feature warning/stat is incremented so that operators know thy need to upgrade. |
||
|
|
||
| package envoy.config.filter.http.compressor.gzip.v2; | ||
|
|
||
| import "google/protobuf/wrappers.proto"; | ||
|
|
||
| import "udpa/annotations/migrate.proto"; | ||
| import "udpa/annotations/status.proto"; | ||
| import "validate/validate.proto"; | ||
|
|
||
| option java_package = "io.envoyproxy.envoy.config.filter.http.compressor.gzip.v2"; | ||
| option java_outer_classname = "GzipProto"; | ||
| option java_multiple_files = true; | ||
| option (udpa.annotations.file_migrate).move_to_package = | ||
| "envoy.extensions.filters.http.compressor.gzip.v3"; | ||
| option (udpa.annotations.file_status).package_version_status = ACTIVE; | ||
|
|
||
| // [#protodoc-title: Gzip] | ||
| // [#extension: envoy.filters.http.compressor.gzip] | ||
|
|
||
| // [#next-free-field: 10] | ||
| message Gzip { | ||
| enum CompressionStrategy { | ||
| // The DEFAULT value translates directly to zlib's Z_DEFAULT_STRATEGY. It doesn't | ||
| // equate to any other strategy. | ||
| DEFAULT = 0; | ||
|
There was a problem hiding this comment. Can you comment on what the DEFAULTs are here and below? These should be fixed in the API. |
||
|
|
||
| FILTERED = 1; | ||
|
|
||
| HUFFMAN = 2; | ||
|
|
||
| RLE = 3; | ||
| } | ||
|
|
||
| message CompressionLevel { | ||
| enum Enum { | ||
| DEFAULT = 0; | ||
| BEST = 1; | ||
| SPEED = 2; | ||
| } | ||
| } | ||
htuch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // Value from 1 to 9 that controls the amount of internal memory used by zlib. Higher values | ||
| // use more memory, but are faster and produce better compression results. The default value is 5. | ||
| google.protobuf.UInt32Value memory_level = 1 [(validate.rules).uint32 = {lte: 9 gte: 1}]; | ||
|
|
||
| // A value used for selecting the zlib compression level. This setting will affect speed and | ||
| // amount of compression applied to the content. "BEST" provides higher compression at the cost of | ||
| // higher latency, "SPEED" provides lower compression with minimum impact on response time. | ||
| // "DEFAULT" provides an optimal result between speed and compression. This field will be set to | ||
| // "DEFAULT" if not specified. | ||
| CompressionLevel.Enum compression_level = 3 [(validate.rules).enum = {defined_only: true}]; | ||
|
|
||
| // A value used for selecting the zlib compression strategy which is directly related to the | ||
| // characteristics of the content. Most of the time "DEFAULT" will be the best choice, though | ||
| // there are situations which changing this parameter might produce better results. For example, | ||
| // run-length encoding (RLE) is typically used when the content is known for having sequences | ||
| // which same data occurs many consecutive times. For more information about each strategy, please | ||
| // refer to zlib manual. | ||
| CompressionStrategy compression_strategy = 4 [(validate.rules).enum = {defined_only: true}]; | ||
|
|
||
| // Value from 9 to 15 that represents the base two logarithmic of the compressor's window size. | ||
| // Larger window results in better compression at the expense of memory usage. The default is 12 | ||
| // which will produce a 4096 bytes window. For more details about this parameter, please refer to | ||
| // zlib manual > deflateInit2. | ||
| google.protobuf.UInt32Value window_bits = 9 [(validate.rules).uint32 = {lte: 15 gte: 9}]; | ||
| } | ||
This file contains 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 |
|---|---|---|
|
|
@@ -4,10 +4,12 @@ package envoy.config.filter.http.compressor.v2; | |
|
|
||
| import "envoy/api/v2/core/base.proto"; | ||
|
|
||
| import "google/protobuf/any.proto"; | ||
| import "google/protobuf/wrappers.proto"; | ||
|
|
||
| import "udpa/annotations/migrate.proto"; | ||
| import "udpa/annotations/status.proto"; | ||
| import "validate/validate.proto"; | ||
|
|
||
| option java_package = "io.envoyproxy.envoy.config.filter.http.compressor.v2"; | ||
| option java_outer_classname = "CompressorProto"; | ||
|
|
@@ -17,8 +19,10 @@ option (udpa.annotations.file_migrate).move_to_package = | |
| option (udpa.annotations.file_status).package_version_status = ACTIVE; | ||
|
|
||
| // [#protodoc-title: Compressor] | ||
| // Compressor :ref:`configuration overview <config_http_filters_compressor>`. | ||
| // [#extension: envoy.filters.http.compressor] | ||
|
|
||
| // [#next-free-field: 7] | ||
| message Compressor { | ||
| // Minimum response length, in bytes, which will trigger compression. The default value is 30. | ||
| google.protobuf.UInt32Value content_length = 1; | ||
|
|
@@ -45,4 +49,21 @@ message Compressor { | |
| // Runtime flag that controls whether the filter is enabled or not. If set to false, the | ||
| // filter will operate as a pass-through filter. If not specified, defaults to enabled. | ||
| api.v2.core.RuntimeFeatureFlag runtime_enabled = 5; | ||
|
|
||
| // A compressor library to use for compression. Currently only | ||
| // :ref:`envoy.filters.http.compressor.gzip<envoy_api_msg_config.filter.http.compressor.gzip.v2.Gzip>` | ||
| // is included in Envoy. | ||
| // | ||
| // This field is ignored when used in the context of the deprecated "envoy.filters.http.gzip" | ||
| // filter. | ||
| CompressorLibrary compressor_library = 6; | ||
|
There was a problem hiding this comment. I'm not sure it makes sense to have a default here. Can we require this and then make the gzip config explicit for clarity? There was a problem hiding this comment. Sure, this field is required now. There was a problem hiding this comment. Can we make it required via annotation? There was a problem hiding this comment. Hm... This message is used also in the deprecated
|
||
| } | ||
|
|
||
| message CompressorLibrary { | ||
| // The name of the compressor library to instantiate for the filter. | ||
| string name = 1 [(validate.rules).string = {min_bytes: 1}]; | ||
|
There was a problem hiding this comment. We can remove this for new extensions as the extension will be looked up via the typed_config. |
||
|
|
||
| // Compressor library specific configuration. See the supported libraries for further | ||
| // documentation. | ||
| google.protobuf.Any typed_config = 2; | ||
| } | ||
This file contains 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,12 @@ | ||
| # 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/filter/http/compressor/gzip/v2:pkg", | ||
| "@com_github_cncf_udpa//udpa/annotations:pkg", | ||
| ], | ||
| ) |
This file contains 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,71 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package envoy.extensions.filters.http.compressor.gzip.v3; | ||
|
|
||
| import "google/protobuf/wrappers.proto"; | ||
|
|
||
| import "udpa/annotations/status.proto"; | ||
| import "udpa/annotations/versioning.proto"; | ||
| import "validate/validate.proto"; | ||
|
|
||
| option java_package = "io.envoyproxy.envoy.extensions.filters.http.compressor.gzip.v3"; | ||
| option java_outer_classname = "GzipProto"; | ||
| option java_multiple_files = true; | ||
| option (udpa.annotations.file_status).package_version_status = NEXT_MAJOR_VERSION_CANDIDATE; | ||
|
|
||
| // [#protodoc-title: Gzip] | ||
| // [#extension: envoy.filters.http.compressor.gzip] | ||
|
|
||
| // [#next-free-field: 10] | ||
| message Gzip { | ||
| option (udpa.annotations.versioning).previous_message_type = | ||
| "envoy.config.filter.http.compressor.gzip.v2.Gzip"; | ||
|
|
||
| enum CompressionStrategy { | ||
| // The DEFAULT value translates directly to zlib's Z_DEFAULT_STRATEGY. It doesn't | ||
| // equate to any other strategy. | ||
| DEFAULT = 0; | ||
|
|
||
| FILTERED = 1; | ||
|
|
||
| HUFFMAN = 2; | ||
|
|
||
| RLE = 3; | ||
| } | ||
|
|
||
| message CompressionLevel { | ||
| option (udpa.annotations.versioning).previous_message_type = | ||
| "envoy.config.filter.http.compressor.gzip.v2.Gzip.CompressionLevel"; | ||
|
|
||
| enum Enum { | ||
| DEFAULT = 0; | ||
| BEST = 1; | ||
| SPEED = 2; | ||
| } | ||
| } | ||
|
|
||
| // Value from 1 to 9 that controls the amount of internal memory used by zlib. Higher values | ||
| // use more memory, but are faster and produce better compression results. The default value is 5. | ||
| google.protobuf.UInt32Value memory_level = 1 [(validate.rules).uint32 = {lte: 9 gte: 1}]; | ||
|
|
||
| // A value used for selecting the zlib compression level. This setting will affect speed and | ||
| // amount of compression applied to the content. "BEST" provides higher compression at the cost of | ||
| // higher latency, "SPEED" provides lower compression with minimum impact on response time. | ||
| // "DEFAULT" provides an optimal result between speed and compression. This field will be set to | ||
| // "DEFAULT" if not specified. | ||
| CompressionLevel.Enum compression_level = 3 [(validate.rules).enum = {defined_only: true}]; | ||
|
|
||
| // A value used for selecting the zlib compression strategy which is directly related to the | ||
| // characteristics of the content. Most of the time "DEFAULT" will be the best choice, though | ||
| // there are situations which changing this parameter might produce better results. For example, | ||
| // run-length encoding (RLE) is typically used when the content is known for having sequences | ||
| // which same data occurs many consecutive times. For more information about each strategy, please | ||
| // refer to zlib manual. | ||
| CompressionStrategy compression_strategy = 4 [(validate.rules).enum = {defined_only: true}]; | ||
|
|
||
| // Value from 9 to 15 that represents the base two logarithmic of the compressor's window size. | ||
| // Larger window results in better compression at the expense of memory usage. The default is 12 | ||
| // which will produce a 4096 bytes window. For more details about this parameter, please refer to | ||
| // zlib manual > deflateInit2. | ||
| google.protobuf.UInt32Value window_bits = 9 [(validate.rules).uint32 = {lte: 15 gte: 9}]; | ||
| } |
This file contains 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 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 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 |
|---|---|---|
|
|
@@ -9,3 +9,4 @@ HTTP filters | |
| */v2/* | ||
| */v2alpha/* | ||
| */v2alpha1/* | ||
| compressor/*/v2/* | ||
This file contains 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 |
|---|---|---|
|
|
@@ -7,3 +7,4 @@ HTTP filters | |
|
|
||
| */empty/* | ||
| ../../../extensions/filters/http/*/v3/* | ||
| ../../../extensions/filters/http/compressor/*/v3/* | ||
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.
Can this and line 25 be removed?
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.
Removed the line 27, but 25 is still needed according to
check_format.py fix