config

Documentation

Overview

Reads the pod configuration from the Kubernetes apiserver.

Common logic used by both http and file channels.

Package config implements the pod configuration readers.

Reads the pod configuration from file or a directory of files.

Reads the pod configuration from an HTTP GET response.

Index

• Constants
• func NewSourceApiserver(c *client.Client, nodeName string, updates chan<- interface{})
• func NewSourceFile(path string, nodeName string, period time.Duration, updates chan<- interface{})
• func NewSourceURL(url string, header http.Header, nodeName string, period time.Duration, ...)
• type PodConfig
  • func NewPodConfig(mode PodConfigNotificationMode, recorder record.EventRecorder) *PodConfig
  • func (c *PodConfig) Channel(source string) chan<- interface{}
  • func (c *PodConfig) SeenAllSources(seenSources sets.String) bool
  • func (c *PodConfig) Sync()
  • func (c *PodConfig) Updates() <-chan kubetypes.PodUpdate
  • func (c *PodConfig) Wait(waitCh <-chan struct{})
• type PodConfigNotificationMode

Constants

const (
	// PodConfigNotificationUnknown is the default value for
	// PodConfigNotificationMode when uninitialized.
	PodConfigNotificationUnknown = iota
	// PodConfigNotificationSnapshot delivers the full configuration as a SET whenever
	// any change occurs.
	PodConfigNotificationSnapshot
	// PodConfigNotificationSnapshotAndUpdates delivers an UPDATE message whenever pods are
	// changed, and a SET message if there are any additions or removals.
	PodConfigNotificationSnapshotAndUpdates
	// PodConfigNotificationIncremental delivers ADD, UPDATE, and REMOVE to the update channel.
	PodConfigNotificationIncremental
)

Functions

func NewSourceApiserver

func NewSourceApiserver(c *client.Client, nodeName string, updates chan<- interface{})

NewSourceApiserver creates a config source that watches and pulls from the apiserver.

func NewSourceFile

func NewSourceFile(path string, nodeName string, period time.Duration, updates chan<- interface{})

func NewSourceURL

func NewSourceURL(url string, header http.Header, nodeName string, period time.Duration, updates chan<- interface{})

Types

type PodConfig

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

PodConfig is a configuration mux that merges many sources of pod configuration into a single consistent structure, and then delivers incremental change notifications to listeners in order.

func NewPodConfig

func NewPodConfig(mode PodConfigNotificationMode, recorder record.EventRecorder) *PodConfig

NewPodConfig creates an object that can merge many configuration sources into a stream of normalized updates to a pod configuration.

func (*PodConfig) Channel

func (c *PodConfig) Channel(source string) chan<- interface{}

Channel creates or returns a config source channel. The channel only accepts PodUpdates

func (*PodConfig) SeenAllSources

func (c *PodConfig) SeenAllSources(seenSources sets.String) bool

SeenAllSources returns true if seenSources contains all sources in the config, and also this config has received a SET message from each source.

func (*PodConfig) Sync

func (c *PodConfig) Sync()

Sync requests the full configuration be delivered to the update channel.

func (*PodConfig) Updates

func (c *PodConfig) Updates() <-chan kubetypes.PodUpdate

Updates returns a channel of updates to the configuration, properly denormalized.

func (*PodConfig) Wait

func (c *PodConfig) Wait(waitCh <-chan struct{})

type PodConfigNotificationMode

type PodConfigNotificationMode int

PodConfigNotificationMode describes how changes are sent to the update channel.