mirror of
				https://github.com/kubernetes-sigs/external-dns.git
				synced 2025-10-31 18:50:59 +01:00 
			
		
		
		
	Currently the `--label-filter` flag can only be used to filter CRDs which match the label selector passed through that flag. This change extends the functionality to the Ingress, Service and Openshift Route type objects. When the flag is not specified the default value is `labels.Everything()` which is an empty string, the same as before. Annotation based filter is inefficient because the filtering has to be done in the controller instead of the API server like with label filtering.
		
			
				
	
	
		
			456 lines
		
	
	
		
			15 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			456 lines
		
	
	
		
			15 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| /*
 | |
| 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 source
 | |
| 
 | |
| import (
 | |
| 	"net/http"
 | |
| 	"os"
 | |
| 	"strings"
 | |
| 	"sync"
 | |
| 	"time"
 | |
| 
 | |
| 	"github.com/cloudfoundry-community/go-cfclient"
 | |
| 	"github.com/linki/instrumented_http"
 | |
| 	openshift "github.com/openshift/client-go/route/clientset/versioned"
 | |
| 	"github.com/pkg/errors"
 | |
| 	log "github.com/sirupsen/logrus"
 | |
| 	istioclient "istio.io/client-go/pkg/clientset/versioned"
 | |
| 	"k8s.io/apimachinery/pkg/labels"
 | |
| 	"k8s.io/client-go/dynamic"
 | |
| 	"k8s.io/client-go/kubernetes"
 | |
| 	"k8s.io/client-go/rest"
 | |
| 	"k8s.io/client-go/tools/clientcmd"
 | |
| )
 | |
| 
 | |
| // ErrSourceNotFound is returned when a requested source doesn't exist.
 | |
| var ErrSourceNotFound = errors.New("source not found")
 | |
| 
 | |
| // Config holds shared configuration options for all Sources.
 | |
| type Config struct {
 | |
| 	Namespace                      string
 | |
| 	AnnotationFilter               string
 | |
| 	LabelFilter                    labels.Selector
 | |
| 	FQDNTemplate                   string
 | |
| 	CombineFQDNAndAnnotation       bool
 | |
| 	IgnoreHostnameAnnotation       bool
 | |
| 	IgnoreIngressTLSSpec           bool
 | |
| 	IgnoreIngressRulesSpec         bool
 | |
| 	Compatibility                  string
 | |
| 	PublishInternal                bool
 | |
| 	PublishHostIP                  bool
 | |
| 	AlwaysPublishNotReadyAddresses bool
 | |
| 	ConnectorServer                string
 | |
| 	CRDSourceAPIVersion            string
 | |
| 	CRDSourceKind                  string
 | |
| 	KubeConfig                     string
 | |
| 	APIServerURL                   string
 | |
| 	ServiceTypeFilter              []string
 | |
| 	CFAPIEndpoint                  string
 | |
| 	CFUsername                     string
 | |
| 	CFPassword                     string
 | |
| 	ContourLoadBalancerService     string
 | |
| 	GlooNamespace                  string
 | |
| 	SkipperRouteGroupVersion       string
 | |
| 	RequestTimeout                 time.Duration
 | |
| 	DefaultTargets                 []string
 | |
| }
 | |
| 
 | |
| // ClientGenerator provides clients
 | |
| type ClientGenerator interface {
 | |
| 	KubeClient() (kubernetes.Interface, error)
 | |
| 	IstioClient() (istioclient.Interface, error)
 | |
| 	CloudFoundryClient(cfAPPEndpoint string, cfUsername string, cfPassword string) (*cfclient.Client, error)
 | |
| 	DynamicKubernetesClient() (dynamic.Interface, error)
 | |
| 	OpenShiftClient() (openshift.Interface, error)
 | |
| }
 | |
| 
 | |
| // SingletonClientGenerator stores provider clients and guarantees that only one instance of client
 | |
| // will be generated
 | |
| type SingletonClientGenerator struct {
 | |
| 	KubeConfig      string
 | |
| 	APIServerURL    string
 | |
| 	RequestTimeout  time.Duration
 | |
| 	kubeClient      kubernetes.Interface
 | |
| 	istioClient     *istioclient.Clientset
 | |
| 	cfClient        *cfclient.Client
 | |
| 	dynKubeClient   dynamic.Interface
 | |
| 	openshiftClient openshift.Interface
 | |
| 	kubeOnce        sync.Once
 | |
| 	istioOnce       sync.Once
 | |
| 	cfOnce          sync.Once
 | |
| 	dynCliOnce      sync.Once
 | |
| 	openshiftOnce   sync.Once
 | |
| }
 | |
| 
 | |
| // KubeClient generates a kube client if it was not created before
 | |
| func (p *SingletonClientGenerator) KubeClient() (kubernetes.Interface, error) {
 | |
| 	var err error
 | |
| 	p.kubeOnce.Do(func() {
 | |
| 		p.kubeClient, err = NewKubeClient(p.KubeConfig, p.APIServerURL, p.RequestTimeout)
 | |
| 	})
 | |
| 	return p.kubeClient, err
 | |
| }
 | |
| 
 | |
| // IstioClient generates an istio go client if it was not created before
 | |
| func (p *SingletonClientGenerator) IstioClient() (istioclient.Interface, error) {
 | |
| 	var err error
 | |
| 	p.istioOnce.Do(func() {
 | |
| 		p.istioClient, err = NewIstioClient(p.KubeConfig, p.APIServerURL)
 | |
| 	})
 | |
| 	return p.istioClient, err
 | |
| }
 | |
| 
 | |
| // CloudFoundryClient generates a cf client if it was not created before
 | |
| func (p *SingletonClientGenerator) CloudFoundryClient(cfAPIEndpoint string, cfUsername string, cfPassword string) (*cfclient.Client, error) {
 | |
| 	var err error
 | |
| 	p.cfOnce.Do(func() {
 | |
| 		p.cfClient, err = NewCFClient(cfAPIEndpoint, cfUsername, cfPassword)
 | |
| 	})
 | |
| 	return p.cfClient, err
 | |
| }
 | |
| 
 | |
| // NewCFClient return a new CF client object.
 | |
| func NewCFClient(cfAPIEndpoint string, cfUsername string, cfPassword string) (*cfclient.Client, error) {
 | |
| 	c := &cfclient.Config{
 | |
| 		ApiAddress: "https://" + cfAPIEndpoint,
 | |
| 		Username:   cfUsername,
 | |
| 		Password:   cfPassword,
 | |
| 	}
 | |
| 	client, err := cfclient.NewClient(c)
 | |
| 	if err != nil {
 | |
| 		return nil, err
 | |
| 	}
 | |
| 
 | |
| 	return client, nil
 | |
| }
 | |
| 
 | |
| // DynamicKubernetesClient generates a dynamic client if it was not created before
 | |
| func (p *SingletonClientGenerator) DynamicKubernetesClient() (dynamic.Interface, error) {
 | |
| 	var err error
 | |
| 	p.dynCliOnce.Do(func() {
 | |
| 		p.dynKubeClient, err = NewDynamicKubernetesClient(p.KubeConfig, p.APIServerURL, p.RequestTimeout)
 | |
| 	})
 | |
| 	return p.dynKubeClient, err
 | |
| }
 | |
| 
 | |
| // OpenShiftClient generates an openshift client if it was not created before
 | |
| func (p *SingletonClientGenerator) OpenShiftClient() (openshift.Interface, error) {
 | |
| 	var err error
 | |
| 	p.openshiftOnce.Do(func() {
 | |
| 		p.openshiftClient, err = NewOpenShiftClient(p.KubeConfig, p.APIServerURL, p.RequestTimeout)
 | |
| 	})
 | |
| 	return p.openshiftClient, err
 | |
| }
 | |
| 
 | |
| // ByNames returns multiple Sources given multiple names.
 | |
| func ByNames(p ClientGenerator, names []string, cfg *Config) ([]Source, error) {
 | |
| 	sources := []Source{}
 | |
| 	for _, name := range names {
 | |
| 		source, err := BuildWithConfig(name, p, cfg)
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		sources = append(sources, source)
 | |
| 	}
 | |
| 
 | |
| 	return sources, nil
 | |
| }
 | |
| 
 | |
| // BuildWithConfig allows to generate a Source implementation from the shared config
 | |
| func BuildWithConfig(source string, p ClientGenerator, cfg *Config) (Source, error) {
 | |
| 	switch source {
 | |
| 	case "node":
 | |
| 		client, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewNodeSource(client, cfg.AnnotationFilter, cfg.FQDNTemplate)
 | |
| 	case "service":
 | |
| 		client, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewServiceSource(client, cfg.Namespace, cfg.AnnotationFilter, cfg.FQDNTemplate, cfg.CombineFQDNAndAnnotation, cfg.Compatibility, cfg.PublishInternal, cfg.PublishHostIP, cfg.AlwaysPublishNotReadyAddresses, cfg.ServiceTypeFilter, cfg.IgnoreHostnameAnnotation, cfg.LabelFilter)
 | |
| 	case "ingress":
 | |
| 		client, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewIngressSource(client, cfg.Namespace, cfg.AnnotationFilter, cfg.FQDNTemplate, cfg.CombineFQDNAndAnnotation, cfg.IgnoreHostnameAnnotation, cfg.IgnoreIngressTLSSpec, cfg.IgnoreIngressRulesSpec, cfg.LabelFilter)
 | |
| 	case "pod":
 | |
| 		client, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewPodSource(client, cfg.Namespace, cfg.Compatibility)
 | |
| 	case "istio-gateway":
 | |
| 		kubernetesClient, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		istioClient, err := p.IstioClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewIstioGatewaySource(kubernetesClient, istioClient, cfg.Namespace, cfg.AnnotationFilter, cfg.FQDNTemplate, cfg.CombineFQDNAndAnnotation, cfg.IgnoreHostnameAnnotation)
 | |
| 	case "istio-virtualservice":
 | |
| 		kubernetesClient, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		istioClient, err := p.IstioClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewIstioVirtualServiceSource(kubernetesClient, istioClient, cfg.Namespace, cfg.AnnotationFilter, cfg.FQDNTemplate, cfg.CombineFQDNAndAnnotation, cfg.IgnoreHostnameAnnotation)
 | |
| 	case "cloudfoundry":
 | |
| 		cfClient, err := p.CloudFoundryClient(cfg.CFAPIEndpoint, cfg.CFUsername, cfg.CFPassword)
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewCloudFoundrySource(cfClient)
 | |
| 	case "ambassador-host":
 | |
| 		kubernetesClient, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		dynamicClient, err := p.DynamicKubernetesClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewAmbassadorHostSource(dynamicClient, kubernetesClient, cfg.Namespace)
 | |
| 	case "contour-httpproxy":
 | |
| 		dynamicClient, err := p.DynamicKubernetesClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewContourHTTPProxySource(dynamicClient, cfg.Namespace, cfg.AnnotationFilter, cfg.FQDNTemplate, cfg.CombineFQDNAndAnnotation, cfg.IgnoreHostnameAnnotation)
 | |
| 	case "gloo-proxy":
 | |
| 		kubernetesClient, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		dynamicClient, err := p.DynamicKubernetesClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewGlooSource(dynamicClient, kubernetesClient, cfg.GlooNamespace)
 | |
| 	case "openshift-route":
 | |
| 		ocpClient, err := p.OpenShiftClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewOcpRouteSource(ocpClient, cfg.Namespace, cfg.AnnotationFilter, cfg.FQDNTemplate, cfg.CombineFQDNAndAnnotation, cfg.IgnoreHostnameAnnotation, cfg.LabelFilter)
 | |
| 	case "fake":
 | |
| 		return NewFakeSource(cfg.FQDNTemplate)
 | |
| 	case "connector":
 | |
| 		return NewConnectorSource(cfg.ConnectorServer)
 | |
| 	case "crd":
 | |
| 		client, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		crdClient, scheme, err := NewCRDClientForAPIVersionKind(client, cfg.KubeConfig, cfg.APIServerURL, cfg.CRDSourceAPIVersion, cfg.CRDSourceKind)
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewCRDSource(crdClient, cfg.Namespace, cfg.CRDSourceKind, cfg.AnnotationFilter, cfg.LabelFilter, scheme)
 | |
| 	case "skipper-routegroup":
 | |
| 		apiServerURL := cfg.APIServerURL
 | |
| 		tokenPath := ""
 | |
| 		token := ""
 | |
| 		restConfig, err := GetRestConfig(cfg.KubeConfig, cfg.APIServerURL)
 | |
| 		if err == nil {
 | |
| 			apiServerURL = restConfig.Host
 | |
| 			tokenPath = restConfig.BearerTokenFile
 | |
| 			token = restConfig.BearerToken
 | |
| 		}
 | |
| 		return NewRouteGroupSource(cfg.RequestTimeout, token, tokenPath, apiServerURL, cfg.Namespace, cfg.AnnotationFilter, cfg.FQDNTemplate, cfg.SkipperRouteGroupVersion, cfg.CombineFQDNAndAnnotation, cfg.IgnoreHostnameAnnotation)
 | |
| 	case "kong-tcpingress":
 | |
| 		kubernetesClient, err := p.KubeClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		dynamicClient, err := p.DynamicKubernetesClient()
 | |
| 		if err != nil {
 | |
| 			return nil, err
 | |
| 		}
 | |
| 		return NewKongTCPIngressSource(dynamicClient, kubernetesClient, cfg.Namespace, cfg.AnnotationFilter)
 | |
| 	}
 | |
| 	return nil, ErrSourceNotFound
 | |
| }
 | |
| 
 | |
| // GetRestConfig returns the rest clients config to get automatically
 | |
| // data if you run inside a cluster or by passing flags.
 | |
| func GetRestConfig(kubeConfig, apiServerURL string) (*rest.Config, error) {
 | |
| 	if kubeConfig == "" {
 | |
| 		if _, err := os.Stat(clientcmd.RecommendedHomeFile); err == nil {
 | |
| 			kubeConfig = clientcmd.RecommendedHomeFile
 | |
| 		}
 | |
| 	}
 | |
| 	log.Debugf("apiServerURL: %s", apiServerURL)
 | |
| 	log.Debugf("kubeConfig: %s", kubeConfig)
 | |
| 
 | |
| 	// evaluate whether to use kubeConfig-file or serviceaccount-token
 | |
| 	var (
 | |
| 		config *rest.Config
 | |
| 		err    error
 | |
| 	)
 | |
| 	if kubeConfig == "" {
 | |
| 		log.Infof("Using inCluster-config based on serviceaccount-token")
 | |
| 		config, err = rest.InClusterConfig()
 | |
| 	} else {
 | |
| 		log.Infof("Using kubeConfig")
 | |
| 		config, err = clientcmd.BuildConfigFromFlags(apiServerURL, kubeConfig)
 | |
| 	}
 | |
| 	if err != nil {
 | |
| 		return nil, err
 | |
| 	}
 | |
| 
 | |
| 	return config, nil
 | |
| }
 | |
| 
 | |
| // NewKubeClient returns a new Kubernetes client object. It takes a Config and
 | |
| // uses APIServerURL and KubeConfig attributes to connect to the cluster. If
 | |
| // KubeConfig isn't provided it defaults to using the recommended default.
 | |
| func NewKubeClient(kubeConfig, apiServerURL string, requestTimeout time.Duration) (*kubernetes.Clientset, error) {
 | |
| 	log.Infof("Instantiating new Kubernetes client")
 | |
| 	config, err := GetRestConfig(kubeConfig, apiServerURL)
 | |
| 	if err != nil {
 | |
| 		return nil, err
 | |
| 	}
 | |
| 
 | |
| 	config.Timeout = requestTimeout
 | |
| 	config.WrapTransport = func(rt http.RoundTripper) http.RoundTripper {
 | |
| 		return instrumented_http.NewTransport(rt, &instrumented_http.Callbacks{
 | |
| 			PathProcessor: func(path string) string {
 | |
| 				parts := strings.Split(path, "/")
 | |
| 				return parts[len(parts)-1]
 | |
| 			},
 | |
| 		})
 | |
| 	}
 | |
| 
 | |
| 	client, err := kubernetes.NewForConfig(config)
 | |
| 	if err != nil {
 | |
| 		return nil, err
 | |
| 	}
 | |
| 
 | |
| 	log.Infof("Created Kubernetes client %s", config.Host)
 | |
| 
 | |
| 	return client, nil
 | |
| }
 | |
| 
 | |
| // NewIstioClient returns a new Istio client object. It uses the configured
 | |
| // KubeConfig attribute to connect to the cluster. If KubeConfig isn't provided
 | |
| // it defaults to using the recommended default.
 | |
| // NB: Istio controls the creation of the underlying Kubernetes client, so we
 | |
| // have no ability to tack on transport wrappers (e.g., Prometheus request
 | |
| // wrappers) to the client's config at this level. Furthermore, the Istio client
 | |
| // constructor does not expose the ability to override the Kubernetes API server endpoint,
 | |
| // so the apiServerURL config attribute has no effect.
 | |
| func NewIstioClient(kubeConfig string, apiServerURL string) (*istioclient.Clientset, error) {
 | |
| 	if kubeConfig == "" {
 | |
| 		if _, err := os.Stat(clientcmd.RecommendedHomeFile); err == nil {
 | |
| 			kubeConfig = clientcmd.RecommendedHomeFile
 | |
| 		}
 | |
| 	}
 | |
| 
 | |
| 	restCfg, err := clientcmd.BuildConfigFromFlags(apiServerURL, kubeConfig)
 | |
| 	if err != nil {
 | |
| 		return nil, err
 | |
| 	}
 | |
| 
 | |
| 	ic, err := istioclient.NewForConfig(restCfg)
 | |
| 	if err != nil {
 | |
| 		return nil, errors.Wrap(err, "Failed to create istio client")
 | |
| 	}
 | |
| 
 | |
| 	return ic, nil
 | |
| }
 | |
| 
 | |
| // NewDynamicKubernetesClient returns a new Dynamic Kubernetes client object. It takes a Config and
 | |
| // uses APIServerURL and KubeConfig attributes to connect to the cluster. If
 | |
| // KubeConfig isn't provided it defaults to using the recommended default.
 | |
| func NewDynamicKubernetesClient(kubeConfig, apiServerURL string, requestTimeout time.Duration) (dynamic.Interface, error) {
 | |
| 	if kubeConfig == "" {
 | |
| 		if _, err := os.Stat(clientcmd.RecommendedHomeFile); err == nil {
 | |
| 			kubeConfig = clientcmd.RecommendedHomeFile
 | |
| 		}
 | |
| 	}
 | |
| 
 | |
| 	config, err := clientcmd.BuildConfigFromFlags(apiServerURL, kubeConfig)
 | |
| 	if err != nil {
 | |
| 		return nil, err
 | |
| 	}
 | |
| 
 | |
| 	config.WrapTransport = func(rt http.RoundTripper) http.RoundTripper {
 | |
| 		return instrumented_http.NewTransport(rt, &instrumented_http.Callbacks{
 | |
| 			PathProcessor: func(path string) string {
 | |
| 				parts := strings.Split(path, "/")
 | |
| 				return parts[len(parts)-1]
 | |
| 			},
 | |
| 		})
 | |
| 	}
 | |
| 
 | |
| 	config.Timeout = requestTimeout
 | |
| 
 | |
| 	client, err := dynamic.NewForConfig(config)
 | |
| 	if err != nil {
 | |
| 		return nil, err
 | |
| 	}
 | |
| 
 | |
| 	log.Infof("Created Dynamic Kubernetes client %s", config.Host)
 | |
| 
 | |
| 	return client, nil
 | |
| }
 | |
| 
 | |
| // NewOpenShiftClient returns a new Openshift client object. It takes a Config and
 | |
| // uses APIServerURL and KubeConfig attributes to connect to the cluster. If
 | |
| // KubeConfig isn't provided it defaults to using the recommended default.
 | |
| func NewOpenShiftClient(kubeConfig, apiServerURL string, requestTimeout time.Duration) (*openshift.Clientset, error) {
 | |
| 	if kubeConfig == "" {
 | |
| 		if _, err := os.Stat(clientcmd.RecommendedHomeFile); err == nil {
 | |
| 			kubeConfig = clientcmd.RecommendedHomeFile
 | |
| 		}
 | |
| 	}
 | |
| 
 | |
| 	config, err := clientcmd.BuildConfigFromFlags(apiServerURL, kubeConfig)
 | |
| 	if err != nil {
 | |
| 		return nil, err
 | |
| 	}
 | |
| 
 | |
| 	config.WrapTransport = func(rt http.RoundTripper) http.RoundTripper {
 | |
| 		return instrumented_http.NewTransport(rt, &instrumented_http.Callbacks{
 | |
| 			PathProcessor: func(path string) string {
 | |
| 				parts := strings.Split(path, "/")
 | |
| 				return parts[len(parts)-1]
 | |
| 			},
 | |
| 		})
 | |
| 	}
 | |
| 
 | |
| 	config.Timeout = requestTimeout
 | |
| 
 | |
| 	client, err := openshift.NewForConfig(config)
 | |
| 	if err != nil {
 | |
| 		return nil, err
 | |
| 	}
 | |
| 
 | |
| 	log.Infof("Created OpenShift client %s", config.Host)
 | |
| 
 | |
| 	return client, nil
 | |
| }
 |