contour

Documentation

Overview

Package contour contains the translation business logic that listens to Kubernetes ResourceEventHandler events and translates those into additions/deletions in caches connected to the Envoy xDS gRPC API server.

Package contour contains the translation business logic that listens to Kubernetes ResourceEventHandler events and translates those into additions/deletions in caches connected to the Envoy xDS gRPC API server.

Package contour contains the translation business logic that listens to Kubernetes ResourceEventHandler events and translates those into additions/deletions in caches connected to the Envoy xDS gRPC API server.

Index

• Constants
• type CacheHandler
  • func (ch *CacheHandler) OnChange(dag *dag.DAG)
• type ClusterCache
  • func (c *ClusterCache) Contents() []proto.Message
  • func (c *ClusterCache) Query(names []string) []proto.Message
  • func (c *ClusterCache) Register(ch chan int, last int)
  • func (*ClusterCache) TypeURL() string
  • func (c *ClusterCache) Update(v map[string]*v2.Cluster)
• type Cond
  • func (c *Cond) Notify()
  • func (c *Cond) Register(ch chan int, last int)
• type EndpointsTranslator
  • func (c *EndpointsTranslator) Add(a *v2.ClusterLoadAssignment)
  • func (e *EndpointsTranslator) Contents() []proto.Message
  • func (e *EndpointsTranslator) OnAdd(obj interface{})
  • func (e *EndpointsTranslator) OnDelete(obj interface{})
  • func (e *EndpointsTranslator) OnUpdate(oldObj, newObj interface{})
  • func (e *EndpointsTranslator) Query(names []string) []proto.Message
  • func (c *EndpointsTranslator) Remove(name string)
  • func (*EndpointsTranslator) TypeURL() string
• type EventHandler
  • func (e *EventHandler) OnAdd(obj interface{})
  • func (e *EventHandler) OnDelete(obj interface{})
  • func (e *EventHandler) OnUpdate(oldObj, newObj interface{})
  • func (e *EventHandler) Start() func(<-chan struct{}) error
• type ListenerCache
  • func NewListenerCache(address string, port int) ListenerCache
  • func (c *ListenerCache) Contents() []proto.Message
  • func (c *ListenerCache) Query(names []string) []proto.Message
  • func (c *ListenerCache) Register(ch chan int, last int)
  • func (*ListenerCache) TypeURL() string
  • func (c *ListenerCache) Update(v map[string]*v2.Listener)
• type ListenerVisitorConfig
• type RouteCache
  • func (c *RouteCache) Contents() []proto.Message
  • func (c *RouteCache) Query(names []string) []proto.Message
  • func (c *RouteCache) Register(ch chan int, last int)
  • func (*RouteCache) TypeURL() string
  • func (c *RouteCache) Update(v map[string]*v2.RouteConfiguration)
• type SecretCache
  • func (c *SecretCache) Contents() []proto.Message
  • func (c *SecretCache) Query(names []string) []proto.Message
  • func (c *SecretCache) Register(ch chan int, last int)
  • func (*SecretCache) TypeURL() string
  • func (c *SecretCache) Update(v map[string]*auth.Secret)

Examples

• Cond

Constants

const (
	ENVOY_HTTP_LISTENER            = "ingress_http"
	ENVOY_HTTPS_LISTENER           = "ingress_https"
	DEFAULT_HTTP_ACCESS_LOG        = "/dev/stdout"
	DEFAULT_HTTP_LISTENER_ADDRESS  = "0.0.0.0"
	DEFAULT_HTTP_LISTENER_PORT     = 8080
	DEFAULT_HTTPS_ACCESS_LOG       = "/dev/stdout"
	DEFAULT_HTTPS_LISTENER_ADDRESS = DEFAULT_HTTP_LISTENER_ADDRESS
	DEFAULT_HTTPS_LISTENER_PORT    = 8443
)

Types

type CacheHandler

type CacheHandler struct {
	ListenerVisitorConfig
	ListenerCache
	RouteCache
	ClusterCache
	SecretCache

	IngressRouteStatus *k8s.IngressRouteStatus
	logrus.FieldLogger
	*metrics.Metrics
}

CacheHandler manages the state of xDS caches.

func (*CacheHandler) OnChange

func (ch *CacheHandler) OnChange(dag *dag.DAG)

type ClusterCache

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

ClusterCache manages the contents of the gRPC CDS cache.

func (*ClusterCache) Contents

func (c *ClusterCache) Contents() []proto.Message

Contents returns a copy of the cache's contents.

func (*ClusterCache) Query

func (c *ClusterCache) Query(names []string) []proto.Message

func (*ClusterCache) Register

func (c *ClusterCache) Register(ch chan int, last int)

Register registers ch to receive a value when Notify is called. The value of last is the count of the times Notify has been called on this Cache. It functions of a sequence counter, if the value of last supplied to Register is less than the Cache's internal counter, then the caller has missed at least one notification and will fire immediately.

Sends by the broadcaster to ch must not block, therefor ch must have a capacity of at least 1.

func (*ClusterCache) TypeURL

func (*ClusterCache) TypeURL() string

func (*ClusterCache) Update

func (c *ClusterCache) Update(v map[string]*v2.Cluster)

Update replaces the contents of the cache with the supplied map.

type Cond

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

Cond implements a condition variable, a rendezvous point for goroutines waiting for or announcing the ocurence of an event.

Unlike sync.Cond, Cond communciates with waiters via channels registered by the waiters. This permits goroutines to wait on Cond events using select.

Example

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/heptio/contour/internal/contour"
)

func main() {
	ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
	defer cancel()
	ch := make(chan int, 1)
	last := 0
	var c contour.Cond
	go func() {
		for {
			time.Sleep(100 * time.Millisecond)
			c.Notify()
		}
	}()

	for {
		c.Register(ch, last)
		select {
		case last = <-ch:
			fmt.Println("notification received:", last)
		case <-ctx.Done():
			fmt.Println("timeout")
			return
		}
	}
}

func (*Cond) Notify

func (c *Cond) Notify()

Notify notifies all registered waiters that an event has ocured.

func (*Cond) Register

func (c *Cond) Register(ch chan int, last int)

Register registers ch to receive a value when Notify is called. The value of last is the count of the times Notify has been called on this Cond. It functions of a sequence counter, if the value of last supplied to Register is less than the Conds internal counter, then the caller has missed at least one notification and will fire immediately.

Sends by the broadcaster to ch must not block, therefor ch must have a capacity of at least 1.

type EndpointsTranslator

type EndpointsTranslator struct {
	logrus.FieldLogger

	Cond
	// contains filtered or unexported fields
}

A EndpointsTranslator translates Kubernetes Endpoints objects into Envoy ClusterLoadAssignment objects.

func (*EndpointsTranslator) Add

func (c *EndpointsTranslator) Add(a *v2.ClusterLoadAssignment)

Add adds an entry to the cache. If a ClusterLoadAssignment with the same name exists, it is replaced.

func (*EndpointsTranslator) Contents

func (e *EndpointsTranslator) Contents() []proto.Message

func (*EndpointsTranslator) OnAdd

func (e *EndpointsTranslator) OnAdd(obj interface{})

func (*EndpointsTranslator) OnDelete

func (e *EndpointsTranslator) OnDelete(obj interface{})

func (*EndpointsTranslator) OnUpdate

func (e *EndpointsTranslator) OnUpdate(oldObj, newObj interface{})

func (*EndpointsTranslator) Query

func (e *EndpointsTranslator) Query(names []string) []proto.Message

func (*EndpointsTranslator) Remove

func (c *EndpointsTranslator) Remove(name string)

Remove removes the named entry from the cache. If the entry is not present in the cache, the operation is a no-op.

func (*EndpointsTranslator) TypeURL

func (*EndpointsTranslator) TypeURL() string

type EventHandler

type EventHandler struct {
	dag.Builder

	*CacheHandler

	HoldoffDelay, HoldoffMaxDelay time.Duration

	*metrics.Metrics

	logrus.FieldLogger

	// Sequence is a channel that receives a incrementing sequence number
	// for each update processed. The updates may be processed immediately, or
	// delayed by a holdoff timer. In each case a non blocking send to Sequence
	// will be made once CacheHandler.OnUpdate has been called.
	Sequence chan int
	// contains filtered or unexported fields
}

EventHandler implements cache.ResourceEventHandler, filters k8s events towards a dag.Builder and calls through to the CacheHandler to notify it that a new DAG is available.

func (*EventHandler) OnAdd

func (e *EventHandler) OnAdd(obj interface{})

func (*EventHandler) OnDelete

func (e *EventHandler) OnDelete(obj interface{})

func (*EventHandler) OnUpdate

func (e *EventHandler) OnUpdate(oldObj, newObj interface{})

func (*EventHandler) Start

func (e *EventHandler) Start() func(<-chan struct{}) error

Start initializes the EventHandler and returns a function suitable for registration with a workgroup.Group.

type ListenerCache

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

ListenerCache manages the contents of the gRPC LDS cache.

func NewListenerCache

func NewListenerCache(address string, port int) ListenerCache

NewListenerCache returns an instance of a ListenerCache

func (*ListenerCache) Contents

func (c *ListenerCache) Contents() []proto.Message

Contents returns a copy of the cache's contents.

func (*ListenerCache) Query

func (c *ListenerCache) Query(names []string) []proto.Message

func (*ListenerCache) Register

func (c *ListenerCache) Register(ch chan int, last int)

Register registers ch to receive a value when Notify is called. The value of last is the count of the times Notify has been called on this Cache. It functions of a sequence counter, if the value of last supplied to Register is less than the Cache's internal counter, then the caller has missed at least one notification and will fire immediately.

Sends by the broadcaster to ch must not block, therefor ch must have a capacity of at least 1.

func (*ListenerCache) TypeURL

func (*ListenerCache) TypeURL() string

func (*ListenerCache) Update

func (c *ListenerCache) Update(v map[string]*v2.Listener)

Update replaces the contents of the cache with the supplied map.

type ListenerVisitorConfig

type ListenerVisitorConfig struct {
	// Envoy's HTTP (non TLS) listener address.
	// If not set, defaults to DEFAULT_HTTP_LISTENER_ADDRESS.
	HTTPAddress string

	// Envoy's HTTP (non TLS) listener port.
	// If not set, defaults to DEFAULT_HTTP_LISTENER_PORT.
	HTTPPort int

	// Envoy's HTTP (non TLS) access log path.
	// If not set, defaults to DEFAULT_HTTP_ACCESS_LOG.
	HTTPAccessLog string

	// Envoy's HTTPS (TLS) listener address.
	// If not set, defaults to DEFAULT_HTTPS_LISTENER_ADDRESS.
	HTTPSAddress string

	// Envoy's HTTPS (TLS) listener port.
	// If not set, defaults to DEFAULT_HTTPS_LISTENER_PORT.
	HTTPSPort int

	// Envoy's HTTPS (TLS) access log path.
	// If not set, defaults to DEFAULT_HTTPS_ACCESS_LOG.
	HTTPSAccessLog string

	// UseProxyProto configures all listeners to expect a PROXY
	// V1 or V2 preamble.
	// If not set, defaults to false.
	UseProxyProto bool

	// MinimumProtocolVersion defines the min tls protocol version to be used
	MinimumProtocolVersion auth.TlsParameters_TlsProtocol
}

ListenerVisitorConfig holds configuration parameters for visitListeners.

type RouteCache

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

RouteCache manages the contents of the gRPC RDS cache.

func (*RouteCache) Contents

func (c *RouteCache) Contents() []proto.Message

Contents returns a copy of the cache's contents.

func (*RouteCache) Query

func (c *RouteCache) Query(names []string) []proto.Message

func (*RouteCache) Register

func (c *RouteCache) Register(ch chan int, last int)

Register registers ch to receive a value when Notify is called. The value of last is the count of the times Notify has been called on this Cache. It functions of a sequence counter, if the value of last supplied to Register is less than the Cache's internal counter, then the caller has missed at least one notification and will fire immediately.

Sends by the broadcaster to ch must not block, therefor ch must have a capacity of at least 1.

func (*RouteCache) TypeURL

func (*RouteCache) TypeURL() string

func (*RouteCache) Update

func (c *RouteCache) Update(v map[string]*v2.RouteConfiguration)

Update replaces the contents of the cache with the supplied map.

type SecretCache

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

SecretCache manages the contents of the gRPC SDS cache.

func (*SecretCache) Contents

func (c *SecretCache) Contents() []proto.Message

Contents returns a copy of the cache's contents.

func (*SecretCache) Query

func (c *SecretCache) Query(names []string) []proto.Message

func (*SecretCache) Register

func (c *SecretCache) Register(ch chan int, last int)

Register registers ch to receive a value when Notify is called. The value of last is the count of the times Notify has been called on this Cache. It functions of a sequence counter, if the value of last supplied to Register is less than the Cache's internal counter, then the caller has missed at least one notification and will fire immediately.

Sends by the broadcaster to ch must not block, therefor ch must have a capacity of at least 1.

func (*SecretCache) TypeURL

func (*SecretCache) TypeURL() string

func (*SecretCache) Update

func (c *SecretCache) Update(v map[string]*auth.Secret)

Update replaces the contents of the cache with the supplied map.