logic

Documentation

Index

• func FilterControlledResources(estimation model.Resources, controlledResources []model.ResourceName) model.Resources
• func MapToListOfRecommendedContainerResources(resources RecommendedPodResources) *vpa_types.RecommendedPodResources
• type CPUEstimator
  • func NewConstCPUEstimator(cpu model.ResourceAmount) CPUEstimator
  • func NewPercentileCPUEstimator(percentile float64) CPUEstimator
  • func WithCPUConfidenceMultiplier(multiplier, exponent float64, baseEstimator CPUEstimator) CPUEstimator
  • func WithCPUMargin(marginFraction float64, baseEstimator CPUEstimator) CPUEstimator
  • func WithCPUMinResource(minResource model.ResourceAmount, baseEstimator CPUEstimator) CPUEstimator
• type MemoryEstimator
  • func NewConstMemoryEstimator(memory model.ResourceAmount) MemoryEstimator
  • func NewMemoryEstimator(percentile float64) MemoryEstimator
  • func NewPercentileMemoryEstimator(percentile float64) MemoryEstimator
  • func WithMemoryConfidenceMultiplier(multiplier, exponent float64, baseEstimator MemoryEstimator) MemoryEstimator
  • func WithMemoryMargin(marginFraction float64, baseEstimator MemoryEstimator) MemoryEstimator
  • func WithMemoryMinResource(minResource model.ResourceAmount, baseEstimator MemoryEstimator) MemoryEstimator
• type PodResourceRecommender
  • func CreatePodResourceRecommender() PodResourceRecommender
• type RecommendedContainerResources
• type RecommendedPodResources
• type ResourceEstimator
  • func NewCombinedEstimator(cpuEstimator CPUEstimator, memoryEstimator MemoryEstimator) ResourceEstimator

Functions

func FilterControlledResources

func FilterControlledResources(estimation model.Resources, controlledResources []model.ResourceName) model.Resources

FilterControlledResources returns estimations from 'estimation' only for resources present in 'controlledResources'.

func MapToListOfRecommendedContainerResources

func MapToListOfRecommendedContainerResources(resources RecommendedPodResources) *vpa_types.RecommendedPodResources

MapToListOfRecommendedContainerResources converts the map of RecommendedContainerResources into a stable sorted list This can be used to get a stable sequence while ranging on the data

Types

type CPUEstimator

type CPUEstimator interface {
	GetCPUEstimation(s *model.AggregateContainerState) model.ResourceAmount
}

CPUEstimator predicts CPU resources needed by a container

func NewConstCPUEstimator

func NewConstCPUEstimator(cpu model.ResourceAmount) CPUEstimator

NewConstCPUEstimator returns a CPU estimator that always returns the same value

func NewPercentileCPUEstimator

func NewPercentileCPUEstimator(percentile float64) CPUEstimator

NewPercentileCPUEstimator returns a new percentileCPUEstimator that uses provided percentile.

func WithCPUConfidenceMultiplier

func WithCPUConfidenceMultiplier(multiplier, exponent float64, baseEstimator CPUEstimator) CPUEstimator

WithCPUConfidenceMultiplier return a CPUEstimator estimator

func WithCPUMargin

func WithCPUMargin(marginFraction float64, baseEstimator CPUEstimator) CPUEstimator

WithCPUMargin returns a CPUEstimator that adds a margin to the base estimator.

func WithCPUMinResource

func WithCPUMinResource(minResource model.ResourceAmount, baseEstimator CPUEstimator) CPUEstimator

WithCPUMinResource returns a CPUEstimator that returns at least minResource

type MemoryEstimator

type MemoryEstimator interface {
	GetMemoryEstimation(s *model.AggregateContainerState) model.ResourceAmount
}

MemoryEstimator predicts memory resources needed by a container

func NewConstMemoryEstimator

func NewConstMemoryEstimator(memory model.ResourceAmount) MemoryEstimator

NewConstMemoryEstimator returns a Memory estimator that always returns the same value

func NewMemoryEstimator

func NewMemoryEstimator(percentile float64) MemoryEstimator

NewMemoryEstimator returns a new percentileMemoryEstimator that uses provided percentile.

func NewPercentileMemoryEstimator

func NewPercentileMemoryEstimator(percentile float64) MemoryEstimator

NewPercentileMemoryEstimator returns a new percentileMemoryEstimator that uses provided percentile.

func WithMemoryConfidenceMultiplier

func WithMemoryConfidenceMultiplier(multiplier, exponent float64, baseEstimator MemoryEstimator) MemoryEstimator

WithMemoryConfidenceMultiplier returns a MemoryEstimator that scales the

func WithMemoryMargin

func WithMemoryMargin(marginFraction float64, baseEstimator MemoryEstimator) MemoryEstimator

WithMemoryMargin returns a MemoryEstimator that adds a margin to the base estimator.

func WithMemoryMinResource

func WithMemoryMinResource(minResource model.ResourceAmount, baseEstimator MemoryEstimator) MemoryEstimator

WithMemoryMinResource returns a MemoryEstimator that returns at least minResource

type PodResourceRecommender

type PodResourceRecommender interface {
	GetRecommendedPodResources(containerNameToAggregateStateMap model.ContainerNameToAggregateStateMap) RecommendedPodResources
}

PodResourceRecommender computes resource recommendation for a Vpa object.

func CreatePodResourceRecommender

func CreatePodResourceRecommender() PodResourceRecommender

CreatePodResourceRecommender returns the primary recommender.

type RecommendedContainerResources

type RecommendedContainerResources struct {
	// Recommended optimal amount of resources.
	Target model.Resources
	// Recommended minimum amount of resources.
	LowerBound model.Resources
	// Recommended maximum amount of resources.
	UpperBound model.Resources
}

RecommendedContainerResources is the recommendation of resources for a container.

type RecommendedPodResources

type RecommendedPodResources map[string]RecommendedContainerResources

RecommendedPodResources is a Map from container name to recommended resources.

type ResourceEstimator

type ResourceEstimator interface {
	GetResourceEstimation(s *model.AggregateContainerState) model.Resources
}

ResourceEstimator is a function from AggregateContainerState to model.Resources, e.g. a prediction of resources needed by a group of containers.

func NewCombinedEstimator

func NewCombinedEstimator(cpuEstimator CPUEstimator, memoryEstimator MemoryEstimator) ResourceEstimator

NewCombinedEstimator returns a new combinedEstimator that uses provided estimators.