controller

Documentation

Index

• Constants
• type Configuration
• type GenericController
  • func NewIngressController(backend ingress.Controller) *GenericController
  • func (ic *GenericController) CreateDefaultSSLCertificate() (path, hash string)
  • func (ic GenericController) GetAuthCertificate(name string) (*resolver.AuthSSLCert, error)
  • func (ic *GenericController) GetCertificate(name string) (*ingress.SSLCert, error)
  • func (ic *GenericController) GetConfig() *Configuration
  • func (ic *GenericController) GetDefaultBackend() defaults.Backend
  • func (ic GenericController) GetFullResourceName(name, currentNamespace string) string
  • func (ic GenericController) GetPublishService() *apiv1.Service
  • func (ic GenericController) GetRecorder() record.EventRecorder
  • func (ic GenericController) GetSecret(name string) (*apiv1.Secret, error)
  • func (ic GenericController) GetService(name string) (*apiv1.Service, error)
  • func (ic *GenericController) GetStopCh() chan struct{}
  • func (ic GenericController) Info() *ingress.BackendInfo
  • func (ic GenericController) IngressClass() string
  • func (ic *GenericController) SetForceReload(shouldReload bool)
  • func (ic *GenericController) Start()
  • func (ic *GenericController) StartControllers()
  • func (ic GenericController) Stop() error

Constants

const DeniedKeyName = "Denied"

DeniedKeyName name of the key that contains the reason to deny a location

Types

type Configuration

type Configuration struct {
	Client clientset.Interface

	RateLimitUpdate float32
	ResyncPeriod    time.Duration

	DefaultService string
	IngressClass   string
	Namespace      string
	ConfigMapName  string

	ForceNamespaceIsolation bool
	WaitBeforeShutdown      int
	AllowCrossNamespace     bool
	DisableNodeList         bool
	AnnPrefix               string

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

	// optional
	TCPConfigMapName string
	// optional
	UDPConfigMapName      string
	DefaultSSLCertificate string
	VerifyHostname        bool
	DefaultHealthzURL     string
	DefaultIngressClass   string
	// optional
	PublishService string
	// Backend is the particular implementation to be used.
	// (for instance NGINX)
	Backend ingress.Controller

	UpdateStatus           bool
	UseNodeInternalIP      bool
	ElectionID             string
	UpdateStatusOnShutdown bool

	SortBackends bool

	V07 bool
}

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 controlller.

func NewIngressController

func NewIngressController(backend ingress.Controller) *GenericController

NewIngressController returns a configured Ingress controller

func (*GenericController) CreateDefaultSSLCertificate

func (ic *GenericController) CreateDefaultSSLCertificate() (path, hash string)

CreateDefaultSSLCertificate ...

func (GenericController) GetAuthCertificate

func (ic GenericController) GetAuthCertificate(name string) (*resolver.AuthSSLCert, error)

GetAuthCertificate is used by the auth-tls annotations to get a cert from a secret

func (*GenericController) GetCertificate

func (ic *GenericController) GetCertificate(name 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) GetDefaultBackend

func (ic *GenericController) GetDefaultBackend() defaults.Backend

GetDefaultBackend returns the default backend

func (GenericController) GetFullResourceName

func (ic GenericController) GetFullResourceName(name, currentNamespace string) string

GetFullResourceName add the currentNamespace prefix if name doesn't provide one and AllowCrossNamespace is allowing this

func (GenericController) GetPublishService

func (ic GenericController) GetPublishService() *apiv1.Service

GetPublishService returns the configured service used to set ingress status

func (GenericController) GetRecorder

func (ic GenericController) GetRecorder() record.EventRecorder

GetRecorder returns the event recorder

func (GenericController) GetSecret

func (ic GenericController) GetSecret(name string) (*apiv1.Secret, error)

GetSecret searches for a secret in the local secrets Store

func (GenericController) GetService

func (ic GenericController) GetService(name string) (*apiv1.Service, error)

GetService searches for a service in the local secrets Store

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

func (ic GenericController) IngressClass() string

IngressClass returns information about the backend

func (*GenericController) SetForceReload

func (ic *GenericController) SetForceReload(shouldReload bool)

SetForceReload ...

func (*GenericController) Start

func (ic *GenericController) Start()

Start starts the Ingress controller.

func (*GenericController) StartControllers

func (ic *GenericController) StartControllers()

StartControllers ...

func (GenericController) Stop

func (ic GenericController) Stop() error

Stop stops the loadbalancer controller.