-
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.
Merge pull request #258 from rikatz/nginx-sticky-annotations
Nginx sticky annotations
- Loading branch information
Showing
10 changed files
with
406 additions
and
10 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
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,118 @@ | ||
| /* | ||
| 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 sessionaffinity | ||
|
|
||
| import ( | ||
| "regexp" | ||
|
|
||
| "github.com/golang/glog" | ||
|
|
||
| "k8s.io/kubernetes/pkg/apis/extensions" | ||
|
|
||
| "k8s.io/ingress/core/pkg/ingress/annotations/parser" | ||
| ) | ||
|
|
||
| const ( | ||
| annotationAffinityType = "ingress.kubernetes.io/affinity" | ||
| // If a cookie with this name exists, | ||
| // its value is used as an index into the list of available backends. | ||
| annotationAffinityCookieName = "ingress.kubernetes.io/session-cookie-name" | ||
| defaultAffinityCookieName = "INGRESSCOOKIE" | ||
| // This is the algorithm used by nginx to generate a value for the session cookie, if | ||
| // one isn't supplied and affintiy is set to "cookie". | ||
| annotationAffinityCookieHash = "ingress.kubernetes.io/session-cookie-hash" | ||
| defaultAffinityCookieHash = "md5" | ||
| ) | ||
|
|
||
| var ( | ||
| affinityCookieHashRegex = regexp.MustCompile(`^(index|md5|sha1)$`) | ||
| ) | ||
|
|
||
| // AffinityConfig describes the per ingress session affinity config | ||
| type AffinityConfig struct { | ||
| // The type of affinity that will be used | ||
| AffinityType string `json:"type"` | ||
| CookieConfig | ||
| } | ||
|
|
||
| // CookieConfig describes the Config of cookie type affinity | ||
| type CookieConfig struct { | ||
| // The name of the cookie that will be used in case of cookie affinity type. | ||
| Name string `json:"name"` | ||
| // The hash that will be used to encode the cookie in case of cookie affinity type | ||
| Hash string `json:"hash"` | ||
| } | ||
|
|
||
| // CookieAffinityParse gets the annotation values related to Cookie Affinity | ||
| // It also sets default values when no value or incorrect value is found | ||
| func CookieAffinityParse(ing *extensions.Ingress) *CookieConfig { | ||
|
|
||
| sn, err := parser.GetStringAnnotation(annotationAffinityCookieName, ing) | ||
|
|
||
| if err != nil || sn == "" { | ||
| glog.V(3).Infof("Ingress %v: No value found in annotation %v. Using the default %v", ing.Name, annotationAffinityCookieName, defaultAffinityCookieName) | ||
| sn = defaultAffinityCookieName | ||
| } | ||
|
|
||
| sh, err := parser.GetStringAnnotation(annotationAffinityCookieHash, ing) | ||
|
|
||
| if err != nil || !affinityCookieHashRegex.MatchString(sh) { | ||
| glog.V(3).Infof("Invalid or no annotation value found in Ingress %v: %v. Setting it to default %v", ing.Name, annotationAffinityCookieHash, defaultAffinityCookieHash) | ||
| sh = defaultAffinityCookieHash | ||
| } | ||
|
|
||
| return &CookieConfig{ | ||
| Name: sn, | ||
| Hash: sh, | ||
| } | ||
| } | ||
|
|
||
| // NewParser creates a new Affinity annotation parser | ||
| func NewParser() parser.IngressAnnotation { | ||
| return affinity{} | ||
| } | ||
|
|
||
| type affinity struct { | ||
| } | ||
|
|
||
| // ParseAnnotations parses the annotations contained in the ingress | ||
| // rule used to configure the affinity directives | ||
| func (a affinity) Parse(ing *extensions.Ingress) (interface{}, error) { | ||
|
|
||
| var cookieAffinityConfig *CookieConfig | ||
| cookieAffinityConfig = &CookieConfig{} | ||
|
|
||
| // Check the type of affinity that will be used | ||
| at, err := parser.GetStringAnnotation(annotationAffinityType, ing) | ||
| if err != nil { | ||
| at = "" | ||
| } | ||
|
|
||
| switch at { | ||
| case "cookie": | ||
| cookieAffinityConfig = CookieAffinityParse(ing) | ||
|
|
||
| default: | ||
| glog.V(3).Infof("No default affinity was found for Ingress %v", ing.Name) | ||
|
|
||
| } | ||
| return &AffinityConfig{ | ||
| AffinityType: at, | ||
| CookieConfig: *cookieAffinityConfig, | ||
| }, 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,88 @@ | ||
| /* | ||
| 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 sessionaffinity | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "k8s.io/kubernetes/pkg/api" | ||
| "k8s.io/kubernetes/pkg/apis/extensions" | ||
| "k8s.io/kubernetes/pkg/util/intstr" | ||
| ) | ||
|
|
||
| func buildIngress() *extensions.Ingress { | ||
| defaultBackend := extensions.IngressBackend{ | ||
| ServiceName: "default-backend", | ||
| ServicePort: intstr.FromInt(80), | ||
| } | ||
|
|
||
| return &extensions.Ingress{ | ||
| ObjectMeta: api.ObjectMeta{ | ||
| Name: "foo", | ||
| Namespace: api.NamespaceDefault, | ||
| }, | ||
| Spec: extensions.IngressSpec{ | ||
| Backend: &extensions.IngressBackend{ | ||
| ServiceName: "default-backend", | ||
| ServicePort: intstr.FromInt(80), | ||
| }, | ||
| Rules: []extensions.IngressRule{ | ||
| { | ||
| Host: "foo.bar.com", | ||
| IngressRuleValue: extensions.IngressRuleValue{ | ||
| HTTP: &extensions.HTTPIngressRuleValue{ | ||
| Paths: []extensions.HTTPIngressPath{ | ||
| { | ||
| Path: "/foo", | ||
| Backend: defaultBackend, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func TestIngressAffinityCookieConfig(t *testing.T) { | ||
| ing := buildIngress() | ||
|
|
||
| data := map[string]string{} | ||
| data[annotationAffinityType] = "cookie" | ||
| data[annotationAffinityCookieHash] = "sha123" | ||
| data[annotationAffinityCookieName] = "INGRESSCOOKIE" | ||
| ing.SetAnnotations(data) | ||
|
|
||
| affin, _ := NewParser().Parse(ing) | ||
| nginxAffinity, ok := affin.(*AffinityConfig) | ||
| if !ok { | ||
| t.Errorf("expected a Config type") | ||
| } | ||
|
|
||
| if nginxAffinity.AffinityType != "cookie" { | ||
| t.Errorf("expected cookie as sticky-type but returned %v", nginxAffinity.AffinityType) | ||
| } | ||
|
|
||
| if nginxAffinity.CookieConfig.Hash != "md5" { | ||
| t.Errorf("expected md5 as sticky-hash but returned %v", nginxAffinity.CookieConfig.Hash) | ||
| } | ||
|
|
||
| if nginxAffinity.CookieConfig.Name != "INGRESSCOOKIE" { | ||
| t.Errorf("expected route as sticky-name but returned %v", nginxAffinity.CookieConfig.Name) | ||
| } | ||
| } |
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
Oops, something went wrong.