disableCompression: Expose configuration to toggle Envoy GZIP compression on the responses

apis/projectcontour/v1alpha1/compression.go

@@ -0,0 +1,41 @@
+// Copyright Project Contour Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v1alpha1
+
+import "fmt"
+
+type EnvoyCompressionType string
+
+func (c EnvoyCompressionType) Validate() error {
+	switch c {
+	case BrotliCompression, DisabledCompression, GzipCompression, ZstdCompression:
+		return nil
+	default:
+		return fmt.Errorf("invalid compression type: %q", c)
+	}
+}
+
+const (
+	// BrotliCompression specifies brotli as the default HTTP filter chain compression mechanism
+	BrotliCompression EnvoyCompressionType = "brotli"
+
+	// DisabledCompression specifies that there will be no compression in the default HTTP filter chain
+	DisabledCompression EnvoyCompressionType = "disabled"
+
+	// GzipCompression specifies gzip as the default HTTP filter chain compression mechanism
+	GzipCompression EnvoyCompressionType = "gzip"
+
+	// ZstdCompression specifies zstd as the default HTTP filter chain compression mechanism
+	ZstdCompression EnvoyCompressionType = "zstd"
+)

apis/projectcontour/v1alpha1/compression_test.go

@@ -0,0 +1,32 @@
+// Copyright Project Contour Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v1alpha1_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	contour_v1alpha1 "github.com/projectcontour/contour/apis/projectcontour/v1alpha1"
+)
+
+func TestValidateEnvoyCompressionType(t *testing.T) {
+	require.Error(t, contour_v1alpha1.EnvoyCompressionType("").Validate())
+	require.Error(t, contour_v1alpha1.EnvoyCompressionType("foo").Validate())
+
+	require.NoError(t, contour_v1alpha1.BrotliCompression.Validate())
+	require.NoError(t, contour_v1alpha1.DisabledCompression.Validate())
+	require.NoError(t, contour_v1alpha1.GzipCompression.Validate())
+	require.NoError(t, contour_v1alpha1.ZstdCompression.Validate())
+}

apis/projectcontour/v1alpha1/contourconfig.go

@@ -348,6 +348,12 @@ type EnvoyListenerConfig struct {
 	// +optional
 	UseProxyProto *bool `json:"useProxyProtocol,omitempty"`
 
+	// Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+	// Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+	// Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+	// +optional
+	Compression EnvoyCompressionType `json:"compression,omitempty"`
+
 	// DisableAllowChunkedLength disables the RFC-compliant Envoy behavior to
 	// strip the "Content-Length" header if "Transfer-Encoding: chunked" is
 	// also set. This is an emergency off-switch to revert back to Envoy's

changelogs/unreleased/6546-chaosbox-small.md

@@ -0,0 +1 @@
+Add "compression" flag to set/disable the compression type applied in the default HTTP filter chain.

cmd/contour/serve.go

@@ -125,6 +125,7 @@
 	}
 	serve.Flag("accesslog-format", "Format for Envoy access logs.").PlaceHolder("<envoy|json>").StringVar((*string)(&ctx.Config.AccessLogFormat))
 
+	serve.Flag("compression", "Set or disable compression type in default Listener filters.").PlaceHolder("<gzip|brotli|zstd|disabled>").StringVar((*string)(&ctx.Config.Compression))
 	serve.Flag("config-path", "Path to base configuration.").Short('c').PlaceHolder("/path/to/file").Action(parseConfig).ExistingFileVar(&configFile)
 	serve.Flag("contour-cafile", "CA bundle file name for serving gRPC with TLS.").Envar("CONTOUR_CAFILE").StringVar(&ctx.caFile)
 	serve.Flag("contour-cert-file", "Contour certificate file name for serving gRPC over TLS.").PlaceHolder("/path/to/file").Envar("CONTOUR_CERT_FILE").StringVar(&ctx.contourCert)
@@ -447,6 +448,7 @@
 	}
 
 	listenerConfig := xdscache_v3.ListenerConfig{
+		Compression:                   contourConfiguration.Envoy.Listener.Compression,
 		UseProxyProto:                 *contourConfiguration.Envoy.Listener.UseProxyProto,
 		HTTPAccessLog:                 contourConfiguration.Envoy.HTTPListener.AccessLog,
 		HTTPSAccessLog:                contourConfiguration.Envoy.HTTPSListener.AccessLog,
@@ -471,6 +473,8 @@
 		SocketOptions:                 contourConfiguration.Envoy.Listener.SocketOptions,
 	}
 
+	s.log.WithField("context", "listenerConfig").Infof("compression setting: %s", listenerConfig.Compression)
+
 	if listenerConfig.TracingConfig, err = s.setupTracingService(contourConfiguration.Tracing); err != nil {
 		return err
 	}

cmd/contour/servecontext.go

@@ -333,6 +333,18 @@
 		accessLogLevel = contour_v1alpha1.LogLevelDisabled
 	}
 
+	var compression contour_v1alpha1.EnvoyCompressionType
+	switch ctx.Config.Compression {
+	case config.CompressionBrotli:
+		compression = contour_v1alpha1.BrotliCompression
+	case config.CompressionDisabled:
+		compression = contour_v1alpha1.DisabledCompression
+	case config.CompressionGzip:
+		compression = contour_v1alpha1.GzipCompression
+	case config.CompressionZstd:
+		compression = contour_v1alpha1.ZstdCompression
+	}
+
 	var defaultHTTPVersions []contour_v1alpha1.HTTPVersionType
 	for _, version := range ctx.Config.DefaultHTTPVersions {
 		switch version {
@@ -519,6 +531,7 @@
 		Envoy: &contour_v1alpha1.EnvoyConfig{
 			Listener: &contour_v1alpha1.EnvoyListenerConfig{
 				UseProxyProto:                 &ctx.useProxyProto,
+				Compression:                   compression,
 				DisableAllowChunkedLength:     &ctx.Config.DisableAllowChunkedLength,
 				DisableMergeSlashes:           &ctx.Config.DisableMergeSlashes,
 				ServerHeaderTransformation:    serverHeaderTransformation,

cmd/contour/servecontext_test.go

@@ -408,6 +408,7 @@ func TestConvertServeContext(t *testing.T) {
 				},
 				Listener: &contour_v1alpha1.EnvoyListenerConfig{
 					UseProxyProto:              ptr.To(false),
+					Compression:                "gzip",
 					DisableAllowChunkedLength:  ptr.To(false),
 					DisableMergeSlashes:        ptr.To(false),
 					ServerHeaderTransformation: contour_v1alpha1.OverwriteServerHeader,
@@ -892,12 +893,14 @@ func TestConvertServeContext(t *testing.T) {
 				ctx.Config.Listener.MaxRequestsPerIOCycle = ptr.To(uint32(10))
 				ctx.Config.Listener.HTTP2MaxConcurrentStreams = ptr.To(uint32(30))
 				ctx.Config.Listener.MaxConnectionsPerListener = ptr.To(uint32(50))
+				ctx.Config.Compression = "gzip"
 				return ctx
 			},
 			getContourConfiguration: func(cfg contour_v1alpha1.ContourConfigurationSpec) contour_v1alpha1.ContourConfigurationSpec {
 				cfg.Envoy.Listener.MaxRequestsPerIOCycle = ptr.To(uint32(10))
 				cfg.Envoy.Listener.HTTP2MaxConcurrentStreams = ptr.To(uint32(30))
 				cfg.Envoy.Listener.MaxConnectionsPerListener = ptr.To(uint32(50))
+				cfg.Envoy.Listener.Compression = "gzip"
 				return cfg
 			},
 		},

examples/contour/01-crds.yaml

@@ -281,6 +281,12 @@ spec:
                     description: Listener hold various configurable Envoy listener
                       values.
                     properties:
+                      compression:
+                        description: |-
+                          Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                          Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                          Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                        type: string
                       connectionBalancer:
                         description: |-
                           ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer
@@ -4063,6 +4069,12 @@ spec:
                         description: Listener hold various configurable Envoy listener
                           values.
                         properties:
+                          compression:
+                            description: |-
+                              Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                              Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                              Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                            type: string
                           connectionBalancer:
                             description: |-
                               ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer

examples/render/contour-deployment.yaml

@@ -501,6 +501,12 @@ spec:
                     description: Listener hold various configurable Envoy listener
                       values.
                     properties:
+                      compression:
+                        description: |-
+                          Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                          Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                          Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                        type: string
                       connectionBalancer:
                         description: |-
                           ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer
@@ -4283,6 +4289,12 @@ spec:
                         description: Listener hold various configurable Envoy listener
                           values.
                         properties:
+                          compression:
+                            description: |-
+                              Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                              Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                              Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                            type: string
                           connectionBalancer:
                             description: |-
                               ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer

examples/render/contour-gateway-provisioner.yaml

@@ -292,6 +292,12 @@ spec:
                     description: Listener hold various configurable Envoy listener
                       values.
                     properties:
+                      compression:
+                        description: |-
+                          Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                          Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                          Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                        type: string
                       connectionBalancer:
                         description: |-
                           ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer
@@ -4074,6 +4080,12 @@ spec:
                         description: Listener hold various configurable Envoy listener
                           values.
                         properties:
+                          compression:
+                            description: |-
+                              Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                              Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                              Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                            type: string
                           connectionBalancer:
                             description: |-
                               ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer

examples/render/contour-gateway.yaml

@@ -317,6 +317,12 @@ spec:
                     description: Listener hold various configurable Envoy listener
                       values.
                     properties:
+                      compression:
+                        description: |-
+                          Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                          Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                          Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                        type: string
                       connectionBalancer:
                         description: |-
                           ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer
@@ -4099,6 +4105,12 @@ spec:
                         description: Listener hold various configurable Envoy listener
                           values.
                         properties:
+                          compression:
+                            description: |-
+                              Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                              Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                              Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                            type: string
                           connectionBalancer:
                             description: |-
                               ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer

examples/render/contour.yaml

@@ -501,6 +501,12 @@ spec:
                     description: Listener hold various configurable Envoy listener
                       values.
                     properties:
+                      compression:
+                        description: |-
+                          Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                          Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                          Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                        type: string
                       connectionBalancer:
                         description: |-
                           ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer
@@ -4283,6 +4289,12 @@ spec:
                         description: Listener hold various configurable Envoy listener
                           values.
                         properties:
+                          compression:
+                            description: |-
+                              Compression selects the compression type applied in the compression HTTP filter of the default Listener filters.
+                              Values: `gzip` (default), `brotli`, `zstd`, `disabled`.
+                              Setting this to `disabled` will make Envoy skip "Accept-Encoding: gzip,deflate" request header and always return uncompressed response
+                            type: string
                           connectionBalancer:
                             description: |-
                               ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer

internal/contourconfig/contourconfiguration.go

@@ -66,6 +66,7 @@ func Defaults() contour_v1alpha1.ContourConfigurationSpec {
 		Envoy: &contour_v1alpha1.EnvoyConfig{
 			Listener: &contour_v1alpha1.EnvoyListenerConfig{
 				UseProxyProto:              ptr.To(false),
+				Compression:                contour_v1alpha1.GzipCompression,
 				DisableAllowChunkedLength:  ptr.To(false),
 				DisableMergeSlashes:        ptr.To(false),
 				ServerHeaderTransformation: contour_v1alpha1.OverwriteServerHeader,

internal/contourconfig/contourconfiguration_test.go

@@ -55,10 +55,11 @@ func TestOverlayOnDefaults(t *testing.T) {
 		Envoy: &contour_v1alpha1.EnvoyConfig{
 			Listener: &contour_v1alpha1.EnvoyListenerConfig{
 				UseProxyProto:              ptr.To(true),
-				DisableAllowChunkedLength:  ptr.To(true),
-				DisableMergeSlashes:        ptr.To(true),
+				Compression:                "brotli",
 				MaxRequestsPerConnection:   ptr.To(uint32(1)),
 				HTTP2MaxConcurrentStreams:  ptr.To(uint32(10)),
+				DisableAllowChunkedLength:  ptr.To(true),
+				DisableMergeSlashes:        ptr.To(true),
 				ServerHeaderTransformation: contour_v1alpha1.PassThroughServerHeader,
 				ConnectionBalancer:         "yesplease",
 				TLS: &contour_v1alpha1.EnvoyTLS{