context

Documentation

Index

• Constants
• type ControllerContext
  • func NewControllerContext(kubeConfig *rest.Config, kubeClient kubernetes.Interface, ...) *ControllerContext
  • func (ctx *ControllerContext) AddHealthCheck(id string, hc func() error)
  • func (ctx *ControllerContext) BackendConfigs() *typed.BackendConfigStore
  • func (ctx *ControllerContext) FrontendConfigs() *typed.FrontendConfigStore
  • func (ctx *ControllerContext) HasSynced() bool
  • func (ctx *ControllerContext) HealthCheck() HealthCheckResults
  • func (ctx *ControllerContext) Ingresses() *typed.IngressStore
  • func (ctx *ControllerContext) Init()
  • func (ctx *ControllerContext) Recorder(ns string) record.EventRecorder
  • func (ctx *ControllerContext) Services() *typed.ServiceStore
  • func (ctx *ControllerContext) Start(stopCh chan struct{})
• type ControllerContextConfig
• type HealthCheckResults

Constants

const (
	// Frequency to poll on local stores to sync.
	StoreSyncPollPeriod = 5 * time.Second

	ClusterTypeZonal    = "ZONAL"
	ClusterTypeRegional = "REGIONAL"
)

Types

type ControllerContext

type ControllerContext struct {
	KubeConfig            *rest.Config
	KubeClient            kubernetes.Interface
	SvcNegClient          svcnegclient.Interface
	DestinationRuleClient dynamic.NamespaceableResourceInterface
	SAClient              serviceattachmentclient.Interface

	Cloud *gce.Cloud

	ClusterNamer  *namer.Namer
	KubeSystemUID types.UID
	L4Namer       namer.L4ResourcesNamer

	ControllerContextConfig
	ASMConfigController *cmconfig.ConfigMapConfigController

	IngressInformer         cache.SharedIndexInformer
	ServiceInformer         cache.SharedIndexInformer
	BackendConfigInformer   cache.SharedIndexInformer
	FrontendConfigInformer  cache.SharedIndexInformer
	PodInformer             cache.SharedIndexInformer
	NodeInformer            cache.SharedIndexInformer
	EndpointInformer        cache.SharedIndexInformer
	EndpointSliceInformer   cache.SharedIndexInformer
	UseEndpointSlices       bool
	DestinationRuleInformer cache.SharedIndexInformer
	ConfigMapInformer       cache.SharedIndexInformer
	SvcNegInformer          cache.SharedIndexInformer
	IngClassInformer        cache.SharedIndexInformer
	IngParamsInformer       cache.SharedIndexInformer
	SAInformer              cache.SharedIndexInformer

	ControllerMetrics *metrics.ControllerMetrics

	// NOTE: If the flag GKEClusterType is empty, then cluster will default to zonal. This field should not be used for
	// controller logic and should only be used for providing additional information to the user.
	RegionalCluster bool
	// contains filtered or unexported fields
}

ControllerContext holds the state needed for the execution of the controller.

func NewControllerContext

func NewControllerContext(
	kubeConfig *rest.Config,
	kubeClient kubernetes.Interface,
	backendConfigClient backendconfigclient.Interface,
	frontendConfigClient frontendconfigclient.Interface,
	svcnegClient svcnegclient.Interface,
	ingParamsClient ingparamsclient.Interface,
	saClient serviceattachmentclient.Interface,
	cloud *gce.Cloud,
	clusterNamer *namer.Namer,
	kubeSystemUID types.UID,
	config ControllerContextConfig) *ControllerContext

NewControllerContext returns a new shared set of informers.

func (*ControllerContext) AddHealthCheck

func (ctx *ControllerContext) AddHealthCheck(id string, hc func() error)

AddHealthCheck registers function to be called for healthchecking.

func (*ControllerContext) BackendConfigs

func (ctx *ControllerContext) BackendConfigs() *typed.BackendConfigStore

BackendConfigs returns the store of BackendConfigs.

func (*ControllerContext) FrontendConfigs

func (ctx *ControllerContext) FrontendConfigs() *typed.FrontendConfigStore

FrontendConfigs returns the store of FrontendConfigs.

func (*ControllerContext) HasSynced

func (ctx *ControllerContext) HasSynced() bool

HasSynced returns true if all relevant informers has been synced.

func (*ControllerContext) HealthCheck

func (ctx *ControllerContext) HealthCheck() HealthCheckResults

HealthCheck runs all registered healthcheck functions.

func (*ControllerContext) Ingresses

func (ctx *ControllerContext) Ingresses() *typed.IngressStore

Ingresses returns the store of Ingresses.

func (*ControllerContext) Init

func (ctx *ControllerContext) Init()

Init inits the Context, so that we can defers some config until the main thread enter actually get the leader hcLock.

func (*ControllerContext) Recorder

func (ctx *ControllerContext) Recorder(ns string) record.EventRecorder

Recorder return the event recorder for the given namespace.

func (*ControllerContext) Services

func (ctx *ControllerContext) Services() *typed.ServiceStore

Services returns the store of Services.

func (*ControllerContext) Start

func (ctx *ControllerContext) Start(stopCh chan struct{})

Start all of the informers.

type ControllerContextConfig

type ControllerContextConfig struct {
	Namespace    string
	ResyncPeriod time.Duration
	NumL4Workers int
	// DefaultBackendSvcPortID is the ServicePort for the system default backend.
	DefaultBackendSvcPort utils.ServicePort
	HealthCheckPath       string
	FrontendConfigEnabled bool
	EnableASMConfigMap    bool
	ASMConfigMapNamespace string
	ASMConfigMapName      string
	EndpointSlicesEnabled bool
}

ControllerContextConfig encapsulates some settings that are tunable via command line flags.

type HealthCheckResults

type HealthCheckResults map[string]error

HealthCheckResults contains a mapping of component -> health check results.