Only update Ingress status for the configured class
This commit is contained in:
parent
858e3ff235
commit
ad24784700
6 changed files with 139 additions and 106 deletions
55
core/pkg/ingress/annotations/class/main.go
Normal file
55
core/pkg/ingress/annotations/class/main.go
Normal file
|
@ -0,0 +1,55 @@
|
||||||
|
/*
|
||||||
|
Copyright 2015 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 class
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/golang/glog"
|
||||||
|
"k8s.io/kubernetes/pkg/apis/extensions"
|
||||||
|
|
||||||
|
"k8s.io/ingress/core/pkg/ingress/annotations/parser"
|
||||||
|
"k8s.io/ingress/core/pkg/ingress/errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// IngressKey picks a specific "class" for the Ingress.
|
||||||
|
// The controller only processes Ingresses with this annotation either
|
||||||
|
// unset, or set to either the configured value or the empty string.
|
||||||
|
IngressKey = "kubernetes.io/ingress.class"
|
||||||
|
)
|
||||||
|
|
||||||
|
// IsValid returns true if the given Ingress either doesn't specify
|
||||||
|
// the ingress.class annotation, or it's set to the configured in the
|
||||||
|
// ingress controller.
|
||||||
|
func IsValid(ing *extensions.Ingress, controller, defClass string) bool {
|
||||||
|
ingress, err := parser.GetStringAnnotation(IngressKey, ing)
|
||||||
|
if err != nil && !errors.IsMissingAnnotations(err) {
|
||||||
|
glog.Warningf("unexpected error reading ingress annotation: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// we have 2 valid combinations
|
||||||
|
// 1 - ingress with default class | blank annotation on ingress
|
||||||
|
// 2 - ingress with specific class | same annotation on ingress
|
||||||
|
//
|
||||||
|
// and 2 invalid combinations
|
||||||
|
// 3 - ingress with default class | fixed annotation on ingress
|
||||||
|
// 4 - ingress with specific class | different annotation on ingress
|
||||||
|
if ingress == "" && controller == defClass {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return ingress == controller
|
||||||
|
}
|
58
core/pkg/ingress/annotations/class/main_test.go
Normal file
58
core/pkg/ingress/annotations/class/main_test.go
Normal file
|
@ -0,0 +1,58 @@
|
||||||
|
/*
|
||||||
|
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 class
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"k8s.io/kubernetes/pkg/api"
|
||||||
|
"k8s.io/kubernetes/pkg/apis/extensions"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestIsValidClass(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
ingress string
|
||||||
|
controller string
|
||||||
|
defClass string
|
||||||
|
isValid bool
|
||||||
|
}{
|
||||||
|
{"", "", "nginx", true},
|
||||||
|
{"", "nginx", "nginx", true},
|
||||||
|
{"nginx", "nginx", "nginx", true},
|
||||||
|
{"custom", "custom", "nginx", true},
|
||||||
|
{"", "killer", "nginx", false},
|
||||||
|
{"", "", "nginx", true},
|
||||||
|
{"custom", "nginx", "nginx", false},
|
||||||
|
}
|
||||||
|
|
||||||
|
ing := &extensions.Ingress{
|
||||||
|
ObjectMeta: api.ObjectMeta{
|
||||||
|
Name: "foo",
|
||||||
|
Namespace: api.NamespaceDefault,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
data := map[string]string{}
|
||||||
|
ing.SetAnnotations(data)
|
||||||
|
for _, test := range tests {
|
||||||
|
ing.Annotations[IngressKey] = test.ingress
|
||||||
|
b := IsValid(ing, test.controller, test.defClass)
|
||||||
|
if b != test.isValid {
|
||||||
|
t.Errorf("test %v - expected %v but %v was returned", test, test.isValid, b)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -41,6 +41,7 @@ import (
|
||||||
|
|
||||||
cache_store "k8s.io/ingress/core/pkg/cache"
|
cache_store "k8s.io/ingress/core/pkg/cache"
|
||||||
"k8s.io/ingress/core/pkg/ingress"
|
"k8s.io/ingress/core/pkg/ingress"
|
||||||
|
"k8s.io/ingress/core/pkg/ingress/annotations/class"
|
||||||
"k8s.io/ingress/core/pkg/ingress/annotations/healthcheck"
|
"k8s.io/ingress/core/pkg/ingress/annotations/healthcheck"
|
||||||
"k8s.io/ingress/core/pkg/ingress/annotations/proxy"
|
"k8s.io/ingress/core/pkg/ingress/annotations/proxy"
|
||||||
"k8s.io/ingress/core/pkg/ingress/annotations/service"
|
"k8s.io/ingress/core/pkg/ingress/annotations/service"
|
||||||
|
@ -58,11 +59,6 @@ const (
|
||||||
defServerName = "_"
|
defServerName = "_"
|
||||||
podStoreSyncedPollPeriod = 1 * time.Second
|
podStoreSyncedPollPeriod = 1 * time.Second
|
||||||
rootLocation = "/"
|
rootLocation = "/"
|
||||||
|
|
||||||
// ingressClassKey picks a specific "class" for the Ingress. The controller
|
|
||||||
// only processes Ingresses with this annotation either unset, or set
|
|
||||||
// to either the configured value or the empty string.
|
|
||||||
ingressClassKey = "kubernetes.io/ingress.class"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
@ -168,8 +164,8 @@ func newIngressController(config *Configuration) *GenericController {
|
||||||
ingEventHandler := cache.ResourceEventHandlerFuncs{
|
ingEventHandler := cache.ResourceEventHandlerFuncs{
|
||||||
AddFunc: func(obj interface{}) {
|
AddFunc: func(obj interface{}) {
|
||||||
addIng := obj.(*extensions.Ingress)
|
addIng := obj.(*extensions.Ingress)
|
||||||
if !IsValidClass(addIng, config) {
|
if !class.IsValid(addIng, ic.cfg.IngressClass, ic.cfg.DefaultIngressClass) {
|
||||||
glog.Infof("ignoring add for ingress %v based on annotation %v", addIng.Name, ingressClassKey)
|
glog.Infof("ignoring add for ingress %v based on annotation %v", addIng.Name, class.IngressKey)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
ic.recorder.Eventf(addIng, api.EventTypeNormal, "CREATE", fmt.Sprintf("Ingress %s/%s", addIng.Namespace, addIng.Name))
|
ic.recorder.Eventf(addIng, api.EventTypeNormal, "CREATE", fmt.Sprintf("Ingress %s/%s", addIng.Namespace, addIng.Name))
|
||||||
|
@ -177,8 +173,8 @@ func newIngressController(config *Configuration) *GenericController {
|
||||||
},
|
},
|
||||||
DeleteFunc: func(obj interface{}) {
|
DeleteFunc: func(obj interface{}) {
|
||||||
delIng := obj.(*extensions.Ingress)
|
delIng := obj.(*extensions.Ingress)
|
||||||
if !IsValidClass(delIng, config) {
|
if !class.IsValid(delIng, ic.cfg.IngressClass, ic.cfg.DefaultIngressClass) {
|
||||||
glog.Infof("ignoring delete for ingress %v based on annotation %v", delIng.Name, ingressClassKey)
|
glog.Infof("ignoring delete for ingress %v based on annotation %v", delIng.Name, class.IngressKey)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
ic.recorder.Eventf(delIng, api.EventTypeNormal, "DELETE", fmt.Sprintf("Ingress %s/%s", delIng.Namespace, delIng.Name))
|
ic.recorder.Eventf(delIng, api.EventTypeNormal, "DELETE", fmt.Sprintf("Ingress %s/%s", delIng.Namespace, delIng.Name))
|
||||||
|
@ -187,7 +183,8 @@ func newIngressController(config *Configuration) *GenericController {
|
||||||
UpdateFunc: func(old, cur interface{}) {
|
UpdateFunc: func(old, cur interface{}) {
|
||||||
oldIng := old.(*extensions.Ingress)
|
oldIng := old.(*extensions.Ingress)
|
||||||
curIng := cur.(*extensions.Ingress)
|
curIng := cur.(*extensions.Ingress)
|
||||||
if !IsValidClass(curIng, config) && !IsValidClass(oldIng, config) {
|
if !class.IsValid(curIng, ic.cfg.IngressClass, ic.cfg.DefaultIngressClass) &&
|
||||||
|
!class.IsValid(oldIng, ic.cfg.IngressClass, ic.cfg.DefaultIngressClass) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -307,6 +304,8 @@ func newIngressController(config *Configuration) *GenericController {
|
||||||
PublishService: ic.cfg.PublishService,
|
PublishService: ic.cfg.PublishService,
|
||||||
IngressLister: ic.ingLister,
|
IngressLister: ic.ingLister,
|
||||||
ElectionID: config.ElectionID,
|
ElectionID: config.ElectionID,
|
||||||
|
IngressClass: config.IngressClass,
|
||||||
|
DefaultIngressClass: config.DefaultIngressClass,
|
||||||
})
|
})
|
||||||
} else {
|
} else {
|
||||||
glog.Warning("Update of ingress status is disabled (flag --update-status=false was specified)")
|
glog.Warning("Update of ingress status is disabled (flag --update-status=false was specified)")
|
||||||
|
@ -590,7 +589,7 @@ func (ic *GenericController) getBackendServers() ([]*ingress.Backend, []*ingress
|
||||||
for _, ingIf := range ings {
|
for _, ingIf := range ings {
|
||||||
ing := ingIf.(*extensions.Ingress)
|
ing := ingIf.(*extensions.Ingress)
|
||||||
|
|
||||||
if !IsValidClass(ing, ic.cfg) {
|
if !class.IsValid(ing, ic.cfg.IngressClass, ic.cfg.DefaultIngressClass) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -713,7 +712,7 @@ func (ic *GenericController) createUpstreams(data []interface{}) map[string]*ing
|
||||||
for _, ingIf := range data {
|
for _, ingIf := range data {
|
||||||
ing := ingIf.(*extensions.Ingress)
|
ing := ingIf.(*extensions.Ingress)
|
||||||
|
|
||||||
if !IsValidClass(ing, ic.cfg) {
|
if !class.IsValid(ing, ic.cfg.IngressClass, ic.cfg.DefaultIngressClass) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -885,7 +884,7 @@ func (ic *GenericController) createServers(data []interface{},
|
||||||
// initialize all the servers
|
// initialize all the servers
|
||||||
for _, ingIf := range data {
|
for _, ingIf := range data {
|
||||||
ing := ingIf.(*extensions.Ingress)
|
ing := ingIf.(*extensions.Ingress)
|
||||||
if !IsValidClass(ing, ic.cfg) {
|
if !class.IsValid(ing, ic.cfg.IngressClass, ic.cfg.DefaultIngressClass) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -925,7 +924,7 @@ func (ic *GenericController) createServers(data []interface{},
|
||||||
// configure default location and SSL
|
// configure default location and SSL
|
||||||
for _, ingIf := range data {
|
for _, ingIf := range data {
|
||||||
ing := ingIf.(*extensions.Ingress)
|
ing := ingIf.(*extensions.Ingress)
|
||||||
if !IsValidClass(ing, ic.cfg) {
|
if !class.IsValid(ing, ic.cfg.IngressClass, ic.cfg.DefaultIngressClass) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -22,11 +22,7 @@ import (
|
||||||
"github.com/golang/glog"
|
"github.com/golang/glog"
|
||||||
"github.com/imdario/mergo"
|
"github.com/imdario/mergo"
|
||||||
|
|
||||||
"k8s.io/kubernetes/pkg/apis/extensions"
|
|
||||||
|
|
||||||
"k8s.io/ingress/core/pkg/ingress"
|
"k8s.io/ingress/core/pkg/ingress"
|
||||||
"k8s.io/ingress/core/pkg/ingress/annotations/parser"
|
|
||||||
"k8s.io/ingress/core/pkg/ingress/errors"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// DeniedKeyName name of the key that contains the reason to deny a location
|
// DeniedKeyName name of the key that contains the reason to deny a location
|
||||||
|
@ -85,31 +81,6 @@ func matchHostnames(pattern, host string) bool {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsValidClass returns true if the given Ingress either doesn't specify
|
|
||||||
// the ingress.class annotation, or it's set to the configured in the
|
|
||||||
// ingress controller.
|
|
||||||
func IsValidClass(ing *extensions.Ingress, config *Configuration) bool {
|
|
||||||
currentIngClass := config.IngressClass
|
|
||||||
|
|
||||||
cc, err := parser.GetStringAnnotation(ingressClassKey, ing)
|
|
||||||
if err != nil && !errors.IsMissingAnnotations(err) {
|
|
||||||
glog.Warningf("unexpected error reading ingress annotation: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// we have 2 valid combinations
|
|
||||||
// 1 - ingress with default class | blank annotation on ingress
|
|
||||||
// 2 - ingress with specific class | same annotation on ingress
|
|
||||||
//
|
|
||||||
// and 2 invalid combinations
|
|
||||||
// 3 - ingress with default class | fixed annotation on ingress
|
|
||||||
// 4 - ingress with specific class | different annotation on ingress
|
|
||||||
if (cc == "" && currentIngClass == "") || (currentIngClass == config.DefaultIngressClass) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
return cc == currentIngClass
|
|
||||||
}
|
|
||||||
|
|
||||||
func mergeLocationAnnotations(loc *ingress.Location, anns map[string]interface{}) {
|
func mergeLocationAnnotations(loc *ingress.Location, anns map[string]interface{}) {
|
||||||
if _, ok := anns[DeniedKeyName]; ok {
|
if _, ok := anns[DeniedKeyName]; ok {
|
||||||
loc.Denied = anns[DeniedKeyName].(error)
|
loc.Denied = anns[DeniedKeyName].(error)
|
||||||
|
|
|
@ -29,8 +29,6 @@ import (
|
||||||
"k8s.io/ingress/core/pkg/ingress/annotations/proxy"
|
"k8s.io/ingress/core/pkg/ingress/annotations/proxy"
|
||||||
"k8s.io/ingress/core/pkg/ingress/annotations/ratelimit"
|
"k8s.io/ingress/core/pkg/ingress/annotations/ratelimit"
|
||||||
"k8s.io/ingress/core/pkg/ingress/annotations/rewrite"
|
"k8s.io/ingress/core/pkg/ingress/annotations/rewrite"
|
||||||
"k8s.io/kubernetes/pkg/api"
|
|
||||||
"k8s.io/kubernetes/pkg/apis/extensions"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type fakeError struct{}
|
type fakeError struct{}
|
||||||
|
@ -39,63 +37,6 @@ func (fe *fakeError) Error() string {
|
||||||
return "fakeError"
|
return "fakeError"
|
||||||
}
|
}
|
||||||
|
|
||||||
// just 2 combinations are valid
|
|
||||||
// 1 - ingress with default class (or no args) | blank annotation on ingress | valid
|
|
||||||
// 2 - ingress with specified class | same annotation on ingress | valid
|
|
||||||
//
|
|
||||||
// this combinations are invalid
|
|
||||||
// 3 - ingress with default class (or no args) | fixed annotation on ingress | invalid
|
|
||||||
// 4 - ingress with specified class | different annotation on ingress | invalid
|
|
||||||
func TestIsValidClass(t *testing.T) {
|
|
||||||
ing := &extensions.Ingress{
|
|
||||||
ObjectMeta: api.ObjectMeta{
|
|
||||||
Name: "foo",
|
|
||||||
Namespace: api.NamespaceDefault,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
config := &Configuration{DefaultIngressClass: "nginx", IngressClass: ""}
|
|
||||||
b := IsValidClass(ing, config)
|
|
||||||
if !b {
|
|
||||||
t.Error("Expected a valid class (missing annotation)")
|
|
||||||
}
|
|
||||||
|
|
||||||
config.IngressClass = "custom"
|
|
||||||
b = IsValidClass(ing, config)
|
|
||||||
if b {
|
|
||||||
t.Error("Expected a invalid class (missing annotation)")
|
|
||||||
}
|
|
||||||
|
|
||||||
data := map[string]string{}
|
|
||||||
data[ingressClassKey] = "custom"
|
|
||||||
ing.SetAnnotations(data)
|
|
||||||
b = IsValidClass(ing, config)
|
|
||||||
if !b {
|
|
||||||
t.Errorf("Expected valid class but %v returned", b)
|
|
||||||
}
|
|
||||||
|
|
||||||
config.IngressClass = "killer"
|
|
||||||
b = IsValidClass(ing, config)
|
|
||||||
if b {
|
|
||||||
t.Errorf("Expected invalid class but %v returned", b)
|
|
||||||
}
|
|
||||||
|
|
||||||
data[ingressClassKey] = ""
|
|
||||||
ing.SetAnnotations(data)
|
|
||||||
config.IngressClass = "killer"
|
|
||||||
b = IsValidClass(ing, config)
|
|
||||||
if b {
|
|
||||||
t.Errorf("Expected invalid class but %v returned", b)
|
|
||||||
}
|
|
||||||
|
|
||||||
config.IngressClass = ""
|
|
||||||
b = IsValidClass(ing, config)
|
|
||||||
if !b {
|
|
||||||
t.Errorf("Expected valid class but %v returned", b)
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIsHostValid(t *testing.T) {
|
func TestIsHostValid(t *testing.T) {
|
||||||
fkCert := &ingress.SSLCert{
|
fkCert := &ingress.SSLCert{
|
||||||
CAFileName: "foo",
|
CAFileName: "foo",
|
||||||
|
|
|
@ -32,6 +32,7 @@ import (
|
||||||
"k8s.io/kubernetes/pkg/util/wait"
|
"k8s.io/kubernetes/pkg/util/wait"
|
||||||
|
|
||||||
cache_store "k8s.io/ingress/core/pkg/cache"
|
cache_store "k8s.io/ingress/core/pkg/cache"
|
||||||
|
"k8s.io/ingress/core/pkg/ingress/annotations/class"
|
||||||
"k8s.io/ingress/core/pkg/k8s"
|
"k8s.io/ingress/core/pkg/k8s"
|
||||||
"k8s.io/ingress/core/pkg/strings"
|
"k8s.io/ingress/core/pkg/strings"
|
||||||
"k8s.io/ingress/core/pkg/task"
|
"k8s.io/ingress/core/pkg/task"
|
||||||
|
@ -53,6 +54,9 @@ type Config struct {
|
||||||
PublishService string
|
PublishService string
|
||||||
IngressLister cache_store.StoreToIngressLister
|
IngressLister cache_store.StoreToIngressLister
|
||||||
ElectionID string
|
ElectionID string
|
||||||
|
|
||||||
|
DefaultIngressClass string
|
||||||
|
IngressClass string
|
||||||
}
|
}
|
||||||
|
|
||||||
// statusSync keeps the status IP in each Ingress rule updated executing a periodic check
|
// statusSync keeps the status IP in each Ingress rule updated executing a periodic check
|
||||||
|
@ -243,6 +247,11 @@ func (s *statusSync) updateStatus(newIPs []api.LoadBalancerIngress) {
|
||||||
wg.Add(len(ings))
|
wg.Add(len(ings))
|
||||||
for _, cur := range ings {
|
for _, cur := range ings {
|
||||||
ing := cur.(*extensions.Ingress)
|
ing := cur.(*extensions.Ingress)
|
||||||
|
|
||||||
|
if !class.IsValid(ing, s.Config.IngressClass, s.Config.DefaultIngressClass) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
go func(wg *sync.WaitGroup) {
|
go func(wg *sync.WaitGroup) {
|
||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
ingClient := s.Client.Extensions().Ingresses(ing.Namespace)
|
ingClient := s.Client.Extensions().Ingresses(ing.Namespace)
|
||||||
|
|
Loading…
Reference in a new issue