source

Documentation

Index

• Constants
• Variables
• func NewCRDClientForAPIVersionKind(client kubernetes.Interface, kubeConfig, kubeMaster, apiVersion, kind string) (*rest.RESTClient, *runtime.Scheme, error)
• func NewIstioClient(kubeConfig string) (*istiocrd.Client, error)
• func NewKubeClient(kubeConfig, kubeMaster string, requestTimeout time.Duration) (*kubernetes.Clientset, error)
• type ClientGenerator
• type Config
• type SingletonClientGenerator
  • func (p *SingletonClientGenerator) IstioClient() (istiomodel.ConfigStore, error)
  • func (p *SingletonClientGenerator) KubeClient() (kubernetes.Interface, error)
• type Source
  • func BuildWithConfig(source string, p ClientGenerator, cfg *Config) (Source, error)
  • func ByNames(p ClientGenerator, names []string, cfg *Config) ([]Source, error)
  • func NewCRDSource(crdClient rest.Interface, namespace, kind string, scheme *runtime.Scheme) (Source, error)
  • func NewConnectorSource(remoteServer string) (Source, error)
  • func NewDedupSource(source Source) Source
  • func NewFakeSource(fqdnTemplate string) (Source, error)
  • func NewIngressSource(kubeClient kubernetes.Interface, namespace, annotationFilter string, ...) (Source, error)
  • func NewIstioGatewaySource(kubeClient kubernetes.Interface, istioClient istiomodel.ConfigStore, ...) (Source, error)
  • func NewMultiSource(children []Source) Source
  • func NewServiceSource(kubeClient kubernetes.Interface, namespace, annotationFilter string, ...) (Source, error)

Constants

const (
	// The annotation used for determining if traffic will go through Cloudflare
	CloudflareProxiedKey = "external-dns.alpha.kubernetes.io/cloudflare-proxied"
)

Provider-specific annotations

Variables

var ErrSourceNotFound = errors.New("source not found")

ErrSourceNotFound is returned when a requested source doesn't exist.

Functions

func NewCRDClientForAPIVersionKind

func NewCRDClientForAPIVersionKind(client kubernetes.Interface, kubeConfig, kubeMaster, apiVersion, kind string) (*rest.RESTClient, *runtime.Scheme, error)

NewCRDClientForAPIVersionKind return rest client for the given apiVersion and kind of the CRD

func NewIstioClient

func NewIstioClient(kubeConfig string) (*istiocrd.Client, error)

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 master, so the Master config attribute has no effect.

func NewKubeClient

func NewKubeClient(kubeConfig, kubeMaster string, requestTimeout time.Duration) (*kubernetes.Clientset, error)

NewKubeClient returns a new Kubernetes client object. It takes a Config and uses KubeMaster and KubeConfig attributes to connect to the cluster. If KubeConfig isn't provided it defaults to using the recommended default.

Types

type ClientGenerator

type ClientGenerator interface {
	KubeClient() (kubernetes.Interface, error)
	IstioClient() (istiomodel.ConfigStore, error)
}

ClientGenerator provides clients

type Config

type Config struct {
	Namespace                   string
	AnnotationFilter            string
	FQDNTemplate                string
	CombineFQDNAndAnnotation    bool
	IgnoreHostnameAnnotation    bool
	Compatibility               string
	PublishInternal             bool
	PublishHostIP               bool
	ConnectorServer             string
	CRDSourceAPIVersion         string
	CRDSourceKind               string
	KubeConfig                  string
	KubeMaster                  string
	ServiceTypeFilter           []string
	IstioIngressGatewayServices []string
}

Config holds shared configuration options for all Sources.

type SingletonClientGenerator

type SingletonClientGenerator struct {
	KubeConfig     string
	KubeMaster     string
	RequestTimeout time.Duration
	// contains filtered or unexported fields
}

SingletonClientGenerator stores provider clients and guarantees that only one instance of client will be generated

func (*SingletonClientGenerator) IstioClient

func (p *SingletonClientGenerator) IstioClient() (istiomodel.ConfigStore, error)

IstioClient generates an istio client if it was not created before

func (*SingletonClientGenerator) KubeClient

func (p *SingletonClientGenerator) KubeClient() (kubernetes.Interface, error)

KubeClient generates a kube client if it was not created before

type Source

type Source interface {
	Endpoints() ([]*endpoint.Endpoint, error)
}

Source defines the interface Endpoint sources should implement.

func BuildWithConfig

func BuildWithConfig(source string, p ClientGenerator, cfg *Config) (Source, error)

BuildWithConfig allows to generate a Source implementation from the shared config

func ByNames

func ByNames(p ClientGenerator, names []string, cfg *Config) ([]Source, error)

ByNames returns multiple Sources given multiple names.

func NewCRDSource

func NewCRDSource(crdClient rest.Interface, namespace, kind string, scheme *runtime.Scheme) (Source, error)

NewCRDSource creates a new crdSource with the given config.

func NewConnectorSource

func NewConnectorSource(remoteServer string) (Source, error)

NewConnectorSource creates a new connectorSource with the given config.

func NewDedupSource

func NewDedupSource(source Source) Source

NewDedupSource creates a new dedupSource wrapping the provided Source.

func NewFakeSource

func NewFakeSource(fqdnTemplate string) (Source, error)

NewFakeSource creates a new fakeSource with the given config.

func NewIngressSource

func NewIngressSource(kubeClient kubernetes.Interface, namespace, annotationFilter string, fqdnTemplate string, combineFqdnAnnotation bool, ignoreHostnameAnnotation bool) (Source, error)

NewIngressSource creates a new ingressSource with the given config.

func NewIstioGatewaySource

func NewIstioGatewaySource(
	kubeClient kubernetes.Interface,
	istioClient istiomodel.ConfigStore,
	istioIngressGatewayServices []string,
	namespace string,
	annotationFilter string,
	fqdnTemplate string,
	combineFqdnAnnotation bool,
	ignoreHostnameAnnotation bool,
) (Source, error)

NewIstioGatewaySource creates a new gatewaySource with the given config.

func NewMultiSource

func NewMultiSource(children []Source) Source

NewMultiSource creates a new multiSource.

func NewServiceSource

func NewServiceSource(kubeClient kubernetes.Interface, namespace, annotationFilter string, fqdnTemplate string, combineFqdnAnnotation bool, compatibility string, publishInternal bool, publishHostIP bool, serviceTypeFilter []string, ignoreHostnameAnnotation bool) (Source, error)

NewServiceSource creates a new serviceSource with the given config.