source

package
v0.13.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 2, 2023 License: Apache-2.0 Imports: 63 Imported by: 3

Documentation

Index

Constants

View Source 
const (
	// ALBDualstackAnnotationKey is the annotation used for determining if an ALB ingress is dualstack
	ALBDualstackAnnotationKey = "alb.ingress.kubernetes.io/ip-address-type"
	// ALBDualstackAnnotationValue is the value of the ALB dualstack annotation that indicates it is dualstack
	ALBDualstackAnnotationValue = "dualstack"

	// Possible values for the ingress-hostname-source annotation
	IngressHostnameSourceAnnotationOnlyValue   = "annotation-only"
	IngressHostnameSourceDefinedHostsOnlyValue = "defined-hosts-only"
)
View Source 
const (
	EndpointsTypeNodeExternalIP = "NodeExternalIP"
	EndpointsTypeHostIP         = "HostIP"
)
View Source 
const (
	// The annotation used for determining if traffic will go through Cloudflare
	CloudflareProxiedKey = "external-dns.alpha.kubernetes.io/cloudflare-proxied"

	SetIdentifierKey = "external-dns.alpha.kubernetes.io/set-identifier"
)

Provider-specific annotations

View Source 
const (

	// DefaultRoutegroupVersion is the default version for route groups.
	DefaultRoutegroupVersion = "zalando.org/v1"
)
View Source 
const IstioMeshGateway = "mesh"

IstioMeshGateway is the built in gateway for all sidecars

Variables

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

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

Functions

func GetRestConfig added in v0.7.0 

func GetRestConfig(kubeConfig, apiServerURL string) (*rest.Config, error)

GetRestConfig returns the rest clients config to get automatically data if you run inside a cluster or by passing flags.

func NewCFClient added in v0.5.18 

func NewCFClient(cfAPIEndpoint string, cfUsername string, cfPassword string) (*cfclient.Client, error)

NewCFClient return a new CF client object.

func NewCRDClientForAPIVersionKind added in v0.5.6 

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

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

func NewDynamicKubernetesClient added in v0.7.2 

func NewDynamicKubernetesClient(kubeConfig, apiServerURL string, requestTimeout time.Duration) (dynamic.Interface, error)

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 NewIstioClient added in v0.5.6 

func NewIstioClient(kubeConfig string, apiServerURL string) (*istioclient.Clientset, 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 API server endpoint, so the apiServerURL config attribute has no effect.

func NewKubeClient added in v0.4.0 

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

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 NewOpenShiftClient added in v0.7.2 

func NewOpenShiftClient(kubeConfig, apiServerURL string, requestTimeout time.Duration) (*openshift.Clientset, error)

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.

Types

type ClientGenerator added in v0.4.0 

type ClientGenerator interface {
	KubeClient() (kubernetes.Interface, error)
	GatewayClient() (gateway.Interface, error)
	IstioClient() (istioclient.Interface, error)
	CloudFoundryClient(cfAPPEndpoint string, cfUsername string, cfPassword string) (*cfclient.Client, error)
	DynamicKubernetesClient() (dynamic.Interface, error)
	OpenShiftClient() (openshift.Interface, error)
}

ClientGenerator provides clients

type Config added in v0.4.0 

type Config struct {
	Namespace                      string
	AnnotationFilter               string
	LabelFilter                    labels.Selector
	FQDNTemplate                   string
	CombineFQDNAndAnnotation       bool
	IgnoreHostnameAnnotation       bool
	IgnoreIngressTLSSpec           bool
	IgnoreIngressRulesSpec         bool
	GatewayNamespace               string
	GatewayLabelFilter             string
	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
	OCPRouterName                  string
}

Config holds shared configuration options for all Sources.

type SingletonClientGenerator added in v0.4.0 

type SingletonClientGenerator struct {
	KubeConfig     string
	APIServerURL   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) CloudFoundryClient added in v0.5.18 

func (p *SingletonClientGenerator) CloudFoundryClient(cfAPIEndpoint string, cfUsername string, cfPassword string) (*cfclient.Client, error)

CloudFoundryClient generates a cf client if it was not created before

func (*SingletonClientGenerator) DynamicKubernetesClient added in v0.7.2 

func (p *SingletonClientGenerator) DynamicKubernetesClient() (dynamic.Interface, error)

DynamicKubernetesClient generates a dynamic client if it was not created before

func (*SingletonClientGenerator) GatewayClient added in v0.12.0 

func (p *SingletonClientGenerator) GatewayClient() (gateway.Interface, error)

GatewayClient generates a gateway client if it was not created before

func (*SingletonClientGenerator) IstioClient added in v0.5.6 

func (p *SingletonClientGenerator) IstioClient() (istioclient.Interface, error)

IstioClient generates an istio go client if it was not created before

func (*SingletonClientGenerator) KubeClient added in v0.4.0 

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

KubeClient generates a kube client if it was not created before

func (*SingletonClientGenerator) OpenShiftClient added in v0.7.2 

func (p *SingletonClientGenerator) OpenShiftClient() (openshift.Interface, error)

OpenShiftClient generates an openshift client if it was not created before

type Source 

type Source interface {
	Endpoints(ctx context.Context) ([]*endpoint.Endpoint, error)
	// AddEventHandler adds an event handler that should be triggered if something in source changes
	AddEventHandler(context.Context, func())
}

Source defines the interface Endpoint sources should implement.

func BuildWithConfig added in v0.4.0 

func BuildWithConfig(ctx context.Context, source string, p ClientGenerator, cfg *Config) (Source, error)

BuildWithConfig allows to generate a Source implementation from the shared config

func ByNames added in v0.4.0 

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

ByNames returns multiple Sources given multiple names.

func NewAmbassadorHostSource added in v0.8.0 

func NewAmbassadorHostSource(
	ctx context.Context,
	dynamicKubeClient dynamic.Interface,
	kubeClient kubernetes.Interface,
	namespace string,
) (Source, error)

NewAmbassadorHostSource creates a new ambassadorHostSource with the given config.

func NewCRDSource added in v0.5.6 

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

NewCRDSource creates a new crdSource with the given config.

func NewCloudFoundrySource added in v0.5.18 

func NewCloudFoundrySource(cfClient *cfclient.Client) (Source, error)

NewCloudFoundrySource creates a new cloudfoundrySource with the given config

func NewConnectorSource added in v0.5.2 

func NewConnectorSource(remoteServer string) (Source, error)

NewConnectorSource creates a new connectorSource with the given config.

func NewContourHTTPProxySource added in v0.7.4 

func NewContourHTTPProxySource(
	ctx context.Context,
	dynamicKubeClient dynamic.Interface,
	namespace string,
	annotationFilter string,
	fqdnTemplate string,
	combineFqdnAnnotation bool,
	ignoreHostnameAnnotation bool,
) (Source, error)

NewContourHTTPProxySource creates a new contourHTTPProxySource with the given config.

func NewDedupSource added in v0.3.0 

func NewDedupSource(source Source) Source

NewDedupSource creates a new dedupSource wrapping the provided Source.

func NewEmptySource added in v0.5.18 

func NewEmptySource() Source

NewEmptySource creates a new emptySource.

func NewFakeSource added in v0.4.0 

func NewFakeSource(fqdnTemplate string) (Source, error)

NewFakeSource creates a new fakeSource with the given config.

func NewGatewayGRPCRouteSource added in v0.13.2 

func NewGatewayGRPCRouteSource(clients ClientGenerator, config *Config) (Source, error)

NewGatewayGRPCRouteSource creates a new Gateway GRPCRoute source with the given config.

func NewGatewayHTTPRouteSource added in v0.12.0 

func NewGatewayHTTPRouteSource(clients ClientGenerator, config *Config) (Source, error)

NewGatewayHTTPRouteSource creates a new Gateway HTTPRoute source with the given config.

func NewGatewayTCPRouteSource added in v0.12.0 

func NewGatewayTCPRouteSource(clients ClientGenerator, config *Config) (Source, error)

NewGatewayTCPRouteSource creates a new Gateway TCPRoute source with the given config.

func NewGatewayTLSRouteSource added in v0.12.0 

func NewGatewayTLSRouteSource(clients ClientGenerator, config *Config) (Source, error)

NewGatewayTLSRouteSource creates a new Gateway TLSRoute source with the given config.

func NewGatewayUDPRouteSource added in v0.12.0 

func NewGatewayUDPRouteSource(clients ClientGenerator, config *Config) (Source, error)

NewGatewayUDPRouteSource creates a new Gateway UDPRoute source with the given config.

func NewGlooSource added in v0.8.0 

func NewGlooSource(dynamicKubeClient dynamic.Interface, kubeClient kubernetes.Interface, glooNamespace string) (Source, error)

NewGlooSource creates a new glooSource with the given config

func NewIngressSource 

func NewIngressSource(ctx context.Context, kubeClient kubernetes.Interface, namespace, annotationFilter string, fqdnTemplate string, combineFqdnAnnotation bool, ignoreHostnameAnnotation bool, ignoreIngressTLSSpec bool, ignoreIngressRulesSpec bool, labelSelector labels.Selector) (Source, error)

NewIngressSource creates a new ingressSource with the given config.

func NewIstioGatewaySource added in v0.5.6 

func NewIstioGatewaySource(
	ctx context.Context,
	kubeClient kubernetes.Interface,
	istioClient istioclient.Interface,
	namespace string,
	annotationFilter string,
	fqdnTemplate string,
	combineFQDNAnnotation bool,
	ignoreHostnameAnnotation bool,
) (Source, error)

NewIstioGatewaySource creates a new gatewaySource with the given config.

func NewIstioVirtualServiceSource added in v0.7.3 

func NewIstioVirtualServiceSource(
	ctx context.Context,
	kubeClient kubernetes.Interface,
	istioClient istioclient.Interface,
	namespace string,
	annotationFilter string,
	fqdnTemplate string,
	combineFQDNAnnotation bool,
	ignoreHostnameAnnotation bool,
) (Source, error)

NewIstioVirtualServiceSource creates a new virtualServiceSource with the given config.

func NewKongTCPIngressSource added in v0.9.0 

func NewKongTCPIngressSource(ctx context.Context, dynamicKubeClient dynamic.Interface, kubeClient kubernetes.Interface, namespace string, annotationFilter string) (Source, error)

NewKongTCPIngressSource creates a new kongTCPIngressSource with the given config.

func NewMultiSource 

func NewMultiSource(children []Source, defaultTargets []string) Source

NewMultiSource creates a new multiSource.

func NewNodeSource added in v0.5.18 

func NewNodeSource(ctx context.Context, kubeClient kubernetes.Interface, annotationFilter, fqdnTemplate string) (Source, error)

NewNodeSource creates a new nodeSource with the given config.

func NewOcpRouteSource added in v0.7.2 

func NewOcpRouteSource(
	ctx context.Context,
	ocpClient versioned.Interface,
	namespace string,
	annotationFilter string,
	fqdnTemplate string,
	combineFQDNAnnotation bool,
	ignoreHostnameAnnotation bool,
	labelSelector labels.Selector,
	ocpRouterName string,
) (Source, error)

NewOcpRouteSource creates a new ocpRouteSource with the given config.

func NewPodSource added in v0.8.0 

func NewPodSource(ctx context.Context, kubeClient kubernetes.Interface, namespace string, compatibility string) (Source, error)

NewPodSource creates a new podSource with the given config.

func NewRouteGroupSource added in v0.7.0 

func NewRouteGroupSource(timeout time.Duration, token, tokenPath, apiServerURL, namespace, annotationFilter, fqdnTemplate, routegroupVersion string, combineFqdnAnnotation, ignoreHostnameAnnotation bool) (Source, error)

NewRouteGroupSource creates a new routeGroupSource with the given config.

func NewServiceSource 

func NewServiceSource(ctx context.Context, kubeClient kubernetes.Interface, namespace, annotationFilter string, fqdnTemplate string, combineFqdnAnnotation bool, compatibility string, publishInternal bool, publishHostIP bool, alwaysPublishNotReadyAddresses bool, serviceTypeFilter []string, ignoreHostnameAnnotation bool, labelSelector labels.Selector) (Source, error)

NewServiceSource creates a new serviceSource with the given config.

func NewTargetFilterSource added in v0.13.0 

func NewTargetFilterSource(source Source, targetFilter endpoint.TargetFilterInterface) Source

NewTargetFilterSource creates a new targetFilterSource wrapping the provided Source.

type TCPIngress added in v0.9.0 

type TCPIngress struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   tcpIngressSpec   `json:"spec,omitempty"`
	Status tcpIngressStatus `json:"status,omitempty"`
}

Kong types based on https://github.com/Kong/kubernetes-ingress-controller/blob/v1.2.0/pkg/apis/configuration/v1beta1/types.go to facilitate testing When trying to import them from the Kong repo as a dependency it required upgrading the k8s.io/client-go and k8s.io/apimachinery which seemed cause several changes in how the mock clients were working that resulted in a bunch of failures in other tests If that is dealt with at some point the below can be removed and replaced with an actual import

func (*TCPIngress) DeepCopy added in v0.9.0 

func (in *TCPIngress) DeepCopy() *TCPIngress

func (*TCPIngress) DeepCopyInto added in v0.9.0 

func (in *TCPIngress) DeepCopyInto(out *TCPIngress)

func (*TCPIngress) DeepCopyObject added in v0.9.0 

func (in *TCPIngress) DeepCopyObject() runtime.Object

type TCPIngressList added in v0.9.0 

type TCPIngressList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []TCPIngress `json:"items"`
}

func (*TCPIngressList) DeepCopy added in v0.9.0 

func (in *TCPIngressList) DeepCopy() *TCPIngressList

func (*TCPIngressList) DeepCopyInto added in v0.9.0 

func (in *TCPIngressList) DeepCopyInto(out *TCPIngressList)

func (*TCPIngressList) DeepCopyObject added in v0.9.0 

func (in *TCPIngressList) DeepCopyObject() runtime.Object

type UnstructuredConverter added in v0.7.2 

type UnstructuredConverter struct {
	// contains filtered or unexported fields
}

UnstructuredConverter handles conversions between unstructured.Unstructured and Contour types

func NewUnstructuredConverter added in v0.7.2 

func NewUnstructuredConverter() (*UnstructuredConverter, error)

NewUnstructuredConverter returns a new UnstructuredConverter initialized

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.