Add support for AJP protocol #2871
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
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,62 @@ | ||
| /* | ||
| Copyright 2018 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 backendprotocol | ||
|
|
||
| import ( | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "github.com/golang/glog" | ||
| extensions "k8s.io/api/extensions/v1beta1" | ||
|
|
||
| "k8s.io/ingress-nginx/internal/ingress/annotations/parser" | ||
| "k8s.io/ingress-nginx/internal/ingress/resolver" | ||
| ) | ||
|
|
||
| var ( | ||
| validProtocols = regexp.MustCompile(`^(HTTP|HTTPS|AJP|GRPC|GRPCS)$`) | ||
| ) | ||
|
|
||
| type backendProtocol struct { | ||
| r resolver.Resolver | ||
| } | ||
|
|
||
| // NewParser creates a new backend protocol annotation parser | ||
| func NewParser(r resolver.Resolver) parser.IngressAnnotation { | ||
| return backendProtocol{r} | ||
| } | ||
|
|
||
| // ParseAnnotations parses the annotations contained in the ingress | ||
| // rule used to indicate the backend protocol. | ||
| func (a backendProtocol) Parse(ing *extensions.Ingress) (interface{}, error) { | ||
| if ing.GetAnnotations() == nil { | ||
| return "HTTP", nil | ||
| } | ||
|
|
||
| proto, err := parser.GetStringAnnotation("backend-protocol", ing) | ||
| if err != nil { | ||
| return "HTTP", nil | ||
| } | ||
|
|
||
| proto = strings.TrimSpace(strings.ToUpper(proto)) | ||
| if !validProtocols.MatchString(proto) { | ||
| glog.Warningf("Protocol %v is not a valid value for the backend-protocol annotation. Using HTTP as protocol", proto) | ||
| return "HTTP", nil | ||
| } | ||
|
|
||
| return proto, nil | ||
| } | ||
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,68 @@ | ||
| /* | ||
| Copyright 2018 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 backendprotocol | ||
|
|
||
| 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" | ||
|
|
||
| "k8s.io/apimachinery/pkg/util/intstr" | ||
| ) | ||
|
|
||
| func buildIngress() *extensions.Ingress { | ||
| return &extensions.Ingress{ | ||
| ObjectMeta: meta_v1.ObjectMeta{ | ||
| Name: "foo", | ||
| Namespace: api.NamespaceDefault, | ||
| }, | ||
| Spec: extensions.IngressSpec{ | ||
| Backend: &extensions.IngressBackend{ | ||
| ServiceName: "default-backend", | ||
| ServicePort: intstr.FromInt(80), | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func TestParseAnnotations(t *testing.T) { | ||
| ing := buildIngress() | ||
|
|
||
| _, err := NewParser(&resolver.Mock{}).Parse(ing) | ||
| if err != nil { | ||
| t.Errorf("unexpected error: %v", err) | ||
| } | ||
|
|
||
| data := map[string]string{} | ||
| data[parser.GetAnnotationWithPrefix("backend-protocol")] = "HTTPS" | ||
| ing.SetAnnotations(data) | ||
| i, err := NewParser(&resolver.Mock{}).Parse(ing) | ||
| if err != nil { | ||
| t.Errorf("unexpected error parsing ingress with backend-protocol") | ||
| } | ||
| val, ok := i.(string) | ||
| if !ok { | ||
| t.Errorf("expected a string type") | ||
| } | ||
| if val != "HTTPS" { | ||
| t.Errorf("expected HTTPS but %v returned", val) | ||
| } | ||
| } |
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
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.
should we log the error here?
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.
No? (we are not doing that in any other annotation that requires to return a default value)
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.
I did not mean return error, I meant log a warning just like we do at https://github.com/kubernetes/ingress-nginx/pull/2871/files#diff-42abcd9476cd9422cd55e93f503bd2e2R57
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.
That would log an error every time this annotation is unset. Expect a lot of verbosity :)
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.
oh strange that it returns error when the annotation is unset... kcco then
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.
I had the same question the first time I went through that code:
ingress-nginx/internal/ingress/annotations/parser/main.go
Lines 52 to 58 in cdbb9bd
I guess @aledbf has an explanation :)