kubernetes

Documentation

Overview

+kubebuilder:validation:Optional

Index

• Variables
• func InvokeServiceDiscovery(in FxInSvc) error
• func Module() fx.Option
• type AutoScaler
• type ControlPoint
  • func ControlPointFromSelector(k8sObjectSelector *policylangv1.KubernetesObjectSelector) (ControlPoint, error)
  • func (cp *ControlPoint) ToProto() *controlpointcachev1.KubernetesControlPoint
• type ControlPointCache
  • func ProvideControlPointCache(in FxInK8sScale) (ControlPointCache, error)
• type ControlPointStore
• type FxInK8sScale
• type FxInSvc
• type KubernetesDiscoveryConfig
  • func (in *KubernetesDiscoveryConfig) DeepCopy() *KubernetesDiscoveryConfig
  • func (in *KubernetesDiscoveryConfig) DeepCopyInto(out *KubernetesDiscoveryConfig)

Variables

var (
	// ConfigKey is the configuration key for Kubernetes Discovery.
	ConfigKey = common.DiscoveryConfigKey + ".kubernetes"
	// FxTagBase is the tag's base used to identify the Kubernetes Control Points Tracker.
	FxTagBase = "kubernetes_control_points"
	// FxTag is the tag used to identify the Kubernetes Control Points Tracker.
	FxTag = config.NameTag(FxTagBase)
)

Functions

func InvokeServiceDiscovery

func InvokeServiceDiscovery(in FxInSvc) error

InvokeServiceDiscovery creates a Kubernetes service discovery.

func Module

func Module() fx.Option

Module returns an fx.Option that provides the Kubernetes discovery module.

Types

type AutoScaler

type AutoScaler interface {
	Scale(ControlPoint, int32)
}

AutoScaler provides an interface to invoke auto-scale.

type ControlPoint

type ControlPoint struct {
	Group     string
	Version   string
	Kind      string
	Namespace string
	Name      string
}

A ControlPoint is identified by Group, Version, Kind, Namespace and Name.

func ControlPointFromSelector

func ControlPointFromSelector(k8sObjectSelector *policylangv1.KubernetesObjectSelector) (ControlPoint, error)

ControlPointFromSelector converts a policylangv1.KubernetesObjectSelector to a ControlPoint.

func (*ControlPoint) ToProto

func (cp *ControlPoint) ToProto() *controlpointcachev1.KubernetesControlPoint

ToProto converts a ControlPoint to a KubernetesControlPoint.

type ControlPointCache

type ControlPointCache interface {
	Keys() []ControlPoint
	AddKeyNotifier(notifiers.KeyNotifier) error
	RemoveKeyNotifier(notifiers.KeyNotifier) error
}

ControlPointCache is the interface for Reading or Watching Kubernetes Control Points.

func ProvideControlPointCache

func ProvideControlPointCache(in FxInK8sScale) (ControlPointCache, error)

ProvideControlPointCache provides Kubernetes AutoScaler and starts Kubernetes control point discovery if enabled.

type ControlPointStore

type ControlPointStore interface {
	Add(cp ControlPoint)
	Update(cp ControlPoint)
	Delete(cp ControlPoint)
}

ControlPointStore is the interface for Storing Kubernetes Control Points.

type FxInK8sScale

type FxInK8sScale struct {
	fx.In
	Unmarshaller     config.Unmarshaller
	Lifecycle        fx.Lifecycle
	StatusRegistry   status.Registry
	KubernetesClient k8s.K8sClient `optional:"true"`
	Election         *election.Election
	Trackers         notifiers.Trackers `name:"kubernetes_control_points"`
}

FxInK8sScale is the input for the ProvideKuberetesControlPointsCache function.

type FxInSvc

type FxInSvc struct {
	fx.In
	Unmarshaller     config.Unmarshaller
	Lifecycle        fx.Lifecycle
	StatusRegistry   status.Registry
	KubernetesClient k8s.K8sClient
	EntityTrackers   *entitycache.EntityTrackers
}

FxInSvc describes parameters passed to k8s discovery constructor.

type KubernetesDiscoveryConfig

type KubernetesDiscoveryConfig struct {
	// NodeName is the name of the k8s node the agent should be monitoring
	NodeName         string `json:"node_name"`
	PodName          string `json:"pod_name"`
	DiscoveryEnabled bool   `json:"discovery_enabled" default:"true"`
	AutoscaleEnabled bool   `json:"autoscale_enabled" default:"true"`
}

KubernetesDiscoveryConfig for Kubernetes service discovery. swagger:model +kubebuilder:object:generate=true

func (*KubernetesDiscoveryConfig) DeepCopy

func (in *KubernetesDiscoveryConfig) DeepCopy() *KubernetesDiscoveryConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubernetesDiscoveryConfig.

func (*KubernetesDiscoveryConfig) DeepCopyInto

func (in *KubernetesDiscoveryConfig) DeepCopyInto(out *KubernetesDiscoveryConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.