controller

Documentation

Index

• type Configuration
• type GenericController
  • func NewIngressController(backend ingress.Controller) *GenericController
  • func (ic *GenericController) CreateDefaultSSLCertificate() (path, hash string, crt *x509.Certificate)
  • func (ic GenericController) DeleteSecret(key string)
  • func (ic *GenericController) GetCertificate(namespace, secretName string) (*ingress.SSLCert, error)
  • func (ic *GenericController) GetConfig() *Configuration
  • func (ic *GenericController) GetStopCh() chan struct{}
  • func (ic GenericController) Info() *ingress.BackendInfo
  • func (ic *GenericController) SetNewCtrl(newctrl NewCtrlIntf)
  • func (ic *GenericController) StartAsync()
  • func (ic GenericController) Stop() error
  • func (ic *GenericController) SyncSecret(key string)
  • func (ic GenericController) UpdateSecret(key string)
• type NewCtrlIntf
• type StatusSync
  • func NewStatusSyncer(ic *GenericController) StatusSync

Types

type Configuration

type Configuration struct {
	Client       types.Client
	MasterWorker bool
	MasterSocket string

	RateLimitUpdate  float32
	ReloadInterval   time.Duration
	ResyncPeriod     time.Duration
	WaitBeforeUpdate time.Duration

	DefaultService           string
	IngressClass             string
	IngressClassPrecedence   bool
	ControllerName           string
	WatchIngressWithoutClass bool
	WatchGateway             bool
	WatchNamespace           string
	ConfigMapName            string

	ReloadStrategy    string
	MaxOldConfigFiles int
	ValidateConfig    bool
	LocalFSPrefix     string

	ForceNamespaceIsolation bool
	WaitBeforeShutdown      int
	AllowCrossNamespace     bool
	DisablePodList          bool
	DisableExternalName     bool
	DisableConfigKeywords   string
	AnnPrefix               []string

	AcmeServer              bool
	AcmeCheckPeriod         time.Duration
	AcmeFailInitialDuration time.Duration
	AcmeFailMaxDuration     time.Duration
	AcmeElectionID          string
	AcmeSecretKeyName       string
	AcmeTokenConfigmapName  string
	AcmeTrackTLSAnn         bool

	BucketsResponseTime []float64

	TCPConfigMapName       string
	DefaultSSLCertificate  string
	VerifyHostname         bool
	DefaultHealthzURL      string
	StatsCollectProcPeriod time.Duration
	PublishService         string
	TrackOldInstances      bool
	Backend                ingress.Controller

	UpdateStatus           bool
	UseNodeInternalIP      bool
	ElectionID             string
	UpdateStatusOnShutdown bool

	BackendShards   int
	SortEndpointsBy string
}

Configuration contains all the settings required by an Ingress controller

type GenericController

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

GenericController holds the boilerplate code required to build an Ingress controller.

func NewIngressController

func NewIngressController(backend ingress.Controller) *GenericController

NewIngressController returns a configured Ingress controller

func (*GenericController) CreateDefaultSSLCertificate

func (ic *GenericController) CreateDefaultSSLCertificate() (path, hash string, crt *x509.Certificate)

CreateDefaultSSLCertificate ...

func (GenericController) DeleteSecret

func (ic GenericController) DeleteSecret(key string)

DeleteSecret ...

func (*GenericController) GetCertificate

func (ic *GenericController) GetCertificate(namespace, secretName string) (*ingress.SSLCert, error)

GetCertificate get a SSLCert object from a secret name

func (*GenericController) GetConfig

func (ic *GenericController) GetConfig() *Configuration

GetConfig expose the controller configuration

func (*GenericController) GetStopCh

func (ic *GenericController) GetStopCh() chan struct{}

GetStopCh ...

func (GenericController) Info

func (ic GenericController) Info() *ingress.BackendInfo

Info returns information about the backend

func (*GenericController) SetNewCtrl

func (ic *GenericController) SetNewCtrl(newctrl NewCtrlIntf)

SetNewCtrl ...

func (*GenericController) StartAsync

func (ic *GenericController) StartAsync()

StartAsync starts the Ingress controller.

func (GenericController) Stop

func (ic GenericController) Stop() error

Stop stops the loadbalancer controller.

func (*GenericController) SyncSecret

func (ic *GenericController) SyncSecret(key string)

SyncSecret keeps in sync Secrets used by Ingress rules with the files on disk to allow copy of the content of the secret to disk to be used by external processes.

func (GenericController) UpdateSecret

func (ic GenericController) UpdateSecret(key string)

UpdateSecret ...

type NewCtrlIntf

type NewCtrlIntf interface {
	GetIngressList() ([]*networking.Ingress, error)
	GetSecret(name string) (*apiv1.Secret, error)
	IsValidClass(ing *networking.Ingress) bool
}

NewCtrlIntf is a temporary interface used by this generic and now deprecated controller to call functionality moved to the new controller.

type StatusSync

type StatusSync interface {
	Run(stopCh <-chan struct{})
	Shutdown()
}

StatusSync ...

func NewStatusSyncer

func NewStatusSyncer(ic *GenericController) StatusSync

NewStatusSyncer returns a new Sync instance