switchboard

Documentation

Index

• type HostCollection
  • func NewHostCollection() *HostCollection
  • func (a *HostCollection) Hosts() []string
  • func (a *HostCollection) Len() int
  • func (a *HostCollection) WithRouteHostsIfRequired(routes []traefik.Route) *HostCollection
  • func (a *HostCollection) WithTLSHostsIfAvailable(config *traefik.TLS) *HostCollection
• type Selector
  • func NewSelector(ingressClass *string) Selector
  • func (s Selector) Matches(annotations map[string]string) bool
• type Target
  • func NewTarget(name, namespace string) Target
  • func (t Target) IP(ctx context.Context, client client.Client) (string, error)
  • func (t Target) NamespacedName() types.NamespacedName

Types

type HostCollection

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

HostCollection allows to aggregate the hosts from ingress resources.

func NewHostCollection

func NewHostCollection() *HostCollection

NewHostCollection returns a new "empty" host collection.

func (*HostCollection) Hosts

func (a *HostCollection) Hosts() []string

Hosts returns all hosts managed by this aggregator.

func (*HostCollection) Len

func (a *HostCollection) Len() int

Len returns the number of hosts that the aggregator currently manages.

func (*HostCollection) WithRouteHostsIfRequired

func (a *HostCollection) WithRouteHostsIfRequired(routes []traefik.Route) *HostCollection

WithRouteHostsIfRequired aggregates all (unique) hosts found in the provided routes. If the aggregator already manages at least one host, this method is a noop, regardless of the routes passed as parameters.

func (*HostCollection) WithTLSHostsIfAvailable

func (a *HostCollection) WithTLSHostsIfAvailable(config *traefik.TLS) *HostCollection

WithTLSHostsIfAvailable aggregates all hosts found in the provided TLS configuration. If the TLS configuration is empty (i.e. `nil`), no hosts are extracted. This method should only be called on a freshly initialized aggregator.

type Selector

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

Selector allows to easily determine if a resource with a set of annotations should be processed.

func NewSelector

func NewSelector(ingressClass *string) Selector

NewSelector creates a new selector which selects resources with the `kubernetes.io/ingress.class` set to the specified value if it is not `nil`.

func (Selector) Matches

func (s Selector) Matches(annotations map[string]string) bool

Matches determines whether the provided set of annotation match the selector. If the method returns `true`, the resource from which the annotations were obtained should be processed.

type Target

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

Target represents a service whose external/internal IP should be used as target for DNS records.

func NewTarget

func NewTarget(name, namespace string) Target

NewTarget creates a new target from the service with the specified name in the given namespace.

func (Target) IP

func (t Target) IP(ctx context.Context, client client.Client) (string, error)

IP returns the IP that should be used as target or an error if querying the IP fails.

func (Target) NamespacedName

func (t Target) NamespacedName() types.NamespacedName

NamespacedName returns the namespaced name of the target service.