-
Notifications
You must be signed in to change notification settings - Fork 299
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
575 additions
and
107 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,8 @@ | ||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: ingress-controller-asm-cm-config | ||
| namespace: kube-system | ||
| data: | ||
| enable-asm: "false" | ||
| asm-skip-namespaces: "kube-system,istio-system" |
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,54 @@ | ||
| package cmconfig | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
| "strings" | ||
|
|
||
| utilerrors "k8s.io/apimachinery/pkg/util/errors" | ||
| ) | ||
|
|
||
| // Config holds configmap based configurations. | ||
| type Config struct { | ||
| EnableASM bool | ||
| ASMServiceNEGSkipNamespaces []string | ||
| } | ||
|
|
||
| const ( | ||
| trueValue = "true" | ||
| falseValue = "false" | ||
|
|
||
| enableASM = "enable-asm" | ||
| asmSkipNamespaces = "asm-skip-namespaces" | ||
| ) | ||
|
|
||
| // NewConfig returns a Conifg instances with default values. | ||
| func NewConfig() Config { | ||
| return Config{ASMServiceNEGSkipNamespaces: []string{"kube-system"}} | ||
| } | ||
|
|
||
| // Equals returns true if c equals to other. | ||
| func (c *Config) Equals(other *Config) bool { | ||
| return reflect.DeepEqual(c, other) | ||
| } | ||
|
|
||
| // LoadValue loads configs from a map, it will ignore any unknow/unvalid field. | ||
| func (c *Config) LoadValue(m map[string]string) error { | ||
| var errList []error | ||
| for k, v := range m { | ||
| if k == enableASM { | ||
| if v == trueValue { | ||
| c.EnableASM = true | ||
| } else if v == falseValue { | ||
| c.EnableASM = false | ||
| } else { | ||
| errList = append(errList, fmt.Errorf("The map provided a unvalid value for field: %s, value: %s, valid values are: %s/%s", k, v, trueValue, falseValue)) | ||
| } | ||
| } else if k == asmSkipNamespaces { | ||
| c.ASMServiceNEGSkipNamespaces = strings.Split(v, ",") | ||
| } else { | ||
| errList = append(errList, fmt.Errorf("The map contains a unknown key-value pair: %s:%s", k, v)) | ||
| } | ||
| } | ||
| return utilerrors.NewAggregate(errList) | ||
| } |
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 @@ | ||
| package cmconfig | ||
|
|
||
| import ( | ||
| "reflect" | ||
| "strings" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestLoadValue(t *testing.T) { | ||
| testcases := []struct { | ||
| desc string | ||
| inputMap map[string]string | ||
| wantConfig Config | ||
| wantLog string | ||
| }{ | ||
| { | ||
| desc: "empty map should give default config", | ||
| inputMap: map[string]string{}, | ||
| wantConfig: NewConfig(), | ||
| wantLog: "", | ||
| }, | ||
| { | ||
| desc: "LoadValue should load values from a valid map", | ||
| inputMap: map[string]string{"enable-asm": "true", "asm-skip-namespaces": "name-space1,namespace2"}, | ||
| wantConfig: Config{EnableASM: true, ASMServiceNEGSkipNamespaces: []string{"name-space1", "namespace2"}}, | ||
| wantLog: "", | ||
| }, | ||
| { | ||
| desc: "LoadValue should return the default value if EnableASM has a unvalid value.", | ||
| inputMap: map[string]string{"enable-asm": "f"}, | ||
| wantConfig: Config{EnableASM: false, ASMServiceNEGSkipNamespaces: []string{"kube-system"}}, | ||
| wantLog: "The map provided a unvalid value for field: enable-asm, value: f, valid values are: true/false", | ||
| }, | ||
| { | ||
| desc: "LoadValue should be tolerant for unknow field.", | ||
| inputMap: map[string]string{"A": "B"}, | ||
| wantConfig: NewConfig(), | ||
| wantLog: "The map contains a unknown key-value pair: A:B", | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testcases { | ||
| t.Run(tc.desc, func(t *testing.T) { | ||
| config := NewConfig() | ||
| err := config.LoadValue(tc.inputMap) | ||
| if !config.Equals(&tc.wantConfig) { | ||
| t.Errorf("LoadValue loads wrong value, got: %v, want: %v", config, tc.wantConfig) | ||
| } | ||
| if tc.wantLog != "" { | ||
| if !strings.Contains(err.Error(), tc.wantLog) { | ||
| t.Errorf("LoadValue logs don't contain wanted log, got: %s, want: %s", err.Error(), tc.wantLog) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestConfigTag(t *testing.T) { | ||
| configType := reflect.TypeOf(Config{}) | ||
| for i := 0; i < configType.NumField(); i++ { | ||
| field := configType.Field(i) | ||
| fieldType := field.Type.Kind() | ||
| if fieldType != reflect.Bool && fieldType != reflect.String && fieldType != reflect.Slice { | ||
| t.Errorf("Struct config contains filed with unknown type: %s, only supports: %s/%s/[]string types", fieldType, reflect.Bool.String(), reflect.String.String()) | ||
| } | ||
| if fieldType == reflect.Slice { | ||
| if field.Type.Elem().Kind() != reflect.String { | ||
| t.Errorf("Struct config contains slice filed with unknown type: %s, only supports []string slice", field.Type.Elem().Kind()) | ||
| } | ||
| } | ||
| } | ||
| } |
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,117 @@ | ||
| package cmconfig | ||
|
|
||
| import ( | ||
| v1 "k8s.io/api/core/v1" | ||
| "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/client-go/kubernetes" | ||
| "k8s.io/client-go/tools/cache" | ||
| "k8s.io/client-go/tools/record" | ||
| "k8s.io/klog" | ||
| ) | ||
|
|
||
| // ConfigMapConfigController is the ConfigMap based config controller. | ||
| // If cmConfigModeEnabled set to true, it will load the config from configmap: configMapNamespace/configMapName and restart ingress controller if the config has any ligeal changes. | ||
| // If cmConfigModeEnabled set to false, it will return the default values for the configs. | ||
| type ConfigMapConfigController struct { | ||
| configMapNamespace string | ||
| configMapName string | ||
| currentConfig *Config | ||
| currentConfigMapObject *v1.ConfigMap | ||
| kubeClient kubernetes.Interface | ||
| recorder record.EventRecorder | ||
| } | ||
|
|
||
| // NewConfigMapConfigController creates a new ConfigMapConfigController, it will load the config from the target configmap | ||
| func NewConfigMapConfigController(kubeClient kubernetes.Interface, recorder record.EventRecorder, configMapNamespace, configMapName string) *ConfigMapConfigController { | ||
|
|
||
| currentConfig := NewConfig() | ||
| cm, err := kubeClient.CoreV1().ConfigMaps(configMapNamespace).Get(configMapName, metav1.GetOptions{}) | ||
| if err != nil { | ||
| if errors.IsNotFound(err) { | ||
| klog.Infof("ConfigMapConfigController: Not found the configmap based config, using default config: %v", currentConfig) | ||
| } else { | ||
| klog.Warningf("ConfigMapConfigController failed to load config from api server, using the defualt config. Error: %v", err) | ||
| } | ||
| } else { | ||
| if err := currentConfig.LoadValue(cm.Data); err != nil { | ||
| if recorder != nil { | ||
| recorder.Event(cm, "Warning", "LoadValueError", err.Error()) | ||
| } | ||
| klog.Warningf("LoadValue error: %s", err.Error()) | ||
| } | ||
| klog.Infof("ConfigMapConfigController: loaded config from configmap, config %v", currentConfig) | ||
| } | ||
|
|
||
| c := &ConfigMapConfigController{ | ||
| configMapNamespace: configMapNamespace, | ||
| configMapName: configMapName, | ||
| currentConfig: ¤tConfig, | ||
| kubeClient: kubeClient, | ||
| recorder: recorder, | ||
| } | ||
| return c | ||
| } | ||
|
|
||
| // GetConfig returns the internal Config | ||
| func (c *ConfigMapConfigController) GetConfig() Config { | ||
| return *c.currentConfig | ||
| } | ||
|
|
||
| // RecordEvent records a event to the ASMConfigmap | ||
| func (c *ConfigMapConfigController) RecordEvent(eventtype, reason, message string) bool { | ||
| if c.recorder == nil || c.currentConfigMapObject == nil { | ||
| return false | ||
| } | ||
| c.recorder.Event(c.currentConfigMapObject, eventtype, reason, message) | ||
| return true | ||
| } | ||
|
|
||
| // RegisterInformer regjister the configmap based config controller handler to the configapInformer which will watch the target | ||
| // configmap and send stop message to the stopCh if any valid change detected. | ||
| func (c *ConfigMapConfigController) RegisterInformer(configMapInformer cache.SharedIndexInformer, cancel func()) { | ||
| configMapInformer.AddEventHandler(cache.ResourceEventHandlerFuncs{ | ||
| AddFunc: func(obj interface{}) { | ||
| c.processItem(obj, cancel) | ||
| }, | ||
| DeleteFunc: func(obj interface{}) { | ||
| c.processItem(obj, cancel) | ||
| }, | ||
| UpdateFunc: func(_, cur interface{}) { | ||
| c.processItem(cur, cancel) | ||
| }, | ||
| }) | ||
|
|
||
| } | ||
|
|
||
| func (c *ConfigMapConfigController) processItem(obj interface{}, cancel func()) { | ||
| configMap, ok := obj.(*v1.ConfigMap) | ||
| if !ok { | ||
| klog.Errorf("ConfigMapConfigController: failed to convert informer object to ConfigMap.") | ||
| } | ||
| if configMap.Namespace != c.configMapNamespace || configMap.Name != c.configMapName { | ||
| return | ||
| } | ||
|
|
||
| config := NewConfig() | ||
| cm, err := c.kubeClient.CoreV1().ConfigMaps(c.configMapNamespace).Get(c.configMapName, metav1.GetOptions{}) | ||
| if err != nil { | ||
| if errors.IsNotFound(err) { | ||
| klog.Infof("ConfigMapConfigController: Not found the configmap based config, using default config: %v", config) | ||
| } else { | ||
| klog.Warningf("ConfigMapConfigController failed to load config from api server, using the defualt config. Error: %v", err) | ||
| } | ||
| } else { | ||
| c.currentConfigMapObject = cm | ||
| if err := config.LoadValue(cm.Data); err != nil { | ||
| c.RecordEvent("Warning", "LoadValueError", err.Error()) | ||
| klog.Warningf("LoadValue error: %s", err.Error()) | ||
| } | ||
| } | ||
|
|
||
| if !config.Equals(c.currentConfig) { | ||
| klog.Warningf("ConfigMapConfigController: Get a update on the ConfigMapConfig. Old config: %v, new config: %v. Restarting Ingress controller...", *c.currentConfig, config) | ||
| c.RecordEvent("Normal", "ASMConfigMapTiggerRestart", "ConfigMapConfigController: Get a update on the ConfigMapConfig, Restarting Ingress controller") | ||
| cancel() | ||
| } | ||
| } |
Oops, something went wrong.