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.

Index

• Constants
• type ClusterCache
  • func (cc *ClusterCache) Add(clusters ...*v2.Cluster)
  • func (cc *ClusterCache) Remove(names ...string)
• type Cond
  • func (c *Cond) Notify()
  • func (c *Cond) Register(ch chan int, last int)
• type EndpointsTranslator
  • func (c *EndpointsTranslator) Add(assignments ...*v2.ClusterLoadAssignment)
  • func (e *EndpointsTranslator) OnAdd(obj interface{})
  • func (e *EndpointsTranslator) OnDelete(obj interface{})
  • func (e *EndpointsTranslator) OnUpdate(oldObj, newObj interface{})
  • func (c *EndpointsTranslator) Remove(names ...string)
• type ListenerCache
  • func (lc *ListenerCache) Add(listeners ...*v2.Listener)
  • func (lc *ListenerCache) Remove(names ...string)
• type Translator
  • func (t *Translator) OnAdd(obj interface{})
  • func (t *Translator) OnDelete(obj interface{})
  • func (t *Translator) OnUpdate(oldObj, newObj interface{})
• type VirtualHostCache

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
)

const DEFAULT_INGRESS_CLASS = "contour"

Types

type ClusterCache

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

ClusterCache manage the contents of the gRPC SDS cache.

func (*ClusterCache) Add

func (cc *ClusterCache) Add(clusters ...*v2.Cluster)

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

func (*ClusterCache) Remove

func (cc *ClusterCache) Remove(names ...string)

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

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 occurence 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 occured.

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(assignments ...*v2.ClusterLoadAssignment)

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

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) Remove

func (c *EndpointsTranslator) Remove(names ...string)

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

type ListenerCache

type ListenerCache 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 configurs all listeners to expect a PROXY protocol
	// V1 header on new connections.
	// If not set, defaults to false.
	UseProxyProto bool

	Cond
	// contains filtered or unexported fields
}

ListenerCache manages the contents of the gRPC LDS cache.

func (*ListenerCache) Add

func (lc *ListenerCache) Add(listeners ...*v2.Listener)

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

func (*ListenerCache) Remove

func (lc *ListenerCache) Remove(names ...string)

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

type Translator

type Translator struct {
	// The logger for this Translator. There is no valid default, this value
	// must be supplied by the caller.
	logrus.FieldLogger

	ClusterCache
	ListenerCache
	VirtualHostCache

	// Contour's IngressClass.
	// If not set, defaults to DEFAULT_INGRESS_CLASS.
	IngressClass string
	// contains filtered or unexported fields
}

Translator receives notifications from the Kubernetes API and translates those objects into additions and removals entries of Envoy gRPC objects from a cache.

func (*Translator) OnAdd

func (t *Translator) OnAdd(obj interface{})

func (*Translator) OnDelete

func (t *Translator) OnDelete(obj interface{})

func (*Translator) OnUpdate

func (t *Translator) OnUpdate(oldObj, newObj interface{})

type VirtualHostCache

type VirtualHostCache struct {
	HTTP  virtualHostCache
	HTTPS virtualHostCache
	Cond
}

VirtualHostCache manage the contents of the gRPC RDS cache.