-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add connection-proxy-header annotation (#1999)
This is the override the default connection header
- Loading branch information
Showing
7 changed files
with
158 additions
and
5 deletions.
There are no files selected for viewing
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,72 @@ | ||
| /* | ||
| Copyright 2016 The Kubernetes 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 connection | ||
|
|
||
| import ( | ||
| extensions "k8s.io/api/extensions/v1beta1" | ||
|
|
||
| "k8s.io/ingress-nginx/internal/ingress/annotations/parser" | ||
| "k8s.io/ingress-nginx/internal/ingress/resolver" | ||
| ) | ||
|
|
||
| // Config returns the connection header configuration for an Ingress rule | ||
| type Config struct { | ||
| Header string `json:"header"` | ||
| Enabled bool `json:"enabled"` | ||
| } | ||
|
|
||
| type connection struct { | ||
| r resolver.Resolver | ||
| } | ||
|
|
||
| // NewParser creates a new port in redirect annotation parser | ||
| func NewParser(r resolver.Resolver) parser.IngressAnnotation { | ||
| return connection{r} | ||
| } | ||
|
|
||
| // Parse parses the annotations contained in the ingress | ||
| // rule used to indicate if the connection header should be overridden. | ||
| func (a connection) Parse(ing *extensions.Ingress) (interface{}, error) { | ||
| cp, err := parser.GetStringAnnotation("connection-proxy-header", ing) | ||
| if err != nil { | ||
| return &Config{ | ||
| Enabled: false, | ||
| }, err | ||
| } | ||
| return &Config{ | ||
| Enabled: true, | ||
| Header: cp, | ||
| }, nil | ||
| } | ||
|
|
||
| // Equal tests for equality between two Connection types | ||
| func (r1 *Config) Equal(r2 *Config) bool { | ||
| if r1 == r2 { | ||
| return true | ||
| } | ||
| if r1 == nil || r2 == nil { | ||
| return false | ||
| } | ||
| if r1.Enabled != r2.Enabled { | ||
| return false | ||
| } | ||
| if r1.Header != r2.Header { | ||
| return false | ||
| } | ||
|
|
||
| return true | ||
| } |
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,64 @@ | ||
| /* | ||
| Copyright 2017 The Kubernetes 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 connection | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| api "k8s.io/api/core/v1" | ||
| extensions "k8s.io/api/extensions/v1beta1" | ||
| meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/ingress-nginx/internal/ingress/annotations/parser" | ||
| "k8s.io/ingress-nginx/internal/ingress/resolver" | ||
| ) | ||
|
|
||
| func TestParse(t *testing.T) { | ||
| annotation := parser.GetAnnotationWithPrefix("connection-proxy-header") | ||
|
|
||
| ap := NewParser(&resolver.Mock{}) | ||
| if ap == nil { | ||
| t.Fatalf("expected a parser.IngressAnnotation but returned nil") | ||
| } | ||
|
|
||
| testCases := []struct { | ||
| annotations map[string]string | ||
| expected *Config | ||
| }{ | ||
| {map[string]string{annotation: ""}, &Config{Enabled: true, Header: ""}}, | ||
| {map[string]string{annotation: "keep-alive"}, &Config{Enabled: true, Header: "keep-alive"}}, | ||
| {map[string]string{}, &Config{Enabled: false}}, | ||
| {nil, &Config{Enabled: false}}, | ||
| } | ||
|
|
||
| ing := &extensions.Ingress{ | ||
| ObjectMeta: meta_v1.ObjectMeta{ | ||
| Name: "foo", | ||
| Namespace: api.NamespaceDefault, | ||
| }, | ||
| Spec: extensions.IngressSpec{}, | ||
| } | ||
|
|
||
| for _, testCase := range testCases { | ||
| ing.SetAnnotations(testCase.annotations) | ||
| i, _ := ap.Parse(ing) | ||
| p, _ := i.(*Config) | ||
|
|
||
| if !p.Equal(testCase.expected) { | ||
| t.Errorf("expected %v but returned %v, annotations: %s", testCase.expected, p, testCase.annotations) | ||
| } | ||
| } | ||
| } |
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
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