v1alpha1

package
v0.13.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 1, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the jamiethompson.me v1alpha1 API group +kubebuilder:object:generate=true +groupName=jamiethompson.me

Index

Constants

View Source 
const (
	// DecisionMaximum means use the highest predicted value from the models
	DecisionMaximum = "maximum"
	// DecisionMinimum means use the lowest predicted value from the models
	DecisionMinimum = "minimum"
	// DecisionMean means use the mean average of predicted values
	DecisionMean = "mean"
	// DecisionMedian means use the median average of predicted values
	DecisionMedian = "median"
)
View Source 
const (
	TypeHoltWinters = "HoltWinters"
	TypeLinear      = "Linear"
)
View Source 
const (
	HookTypeHTTP = "http"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "jamiethompson.me", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type HTTPHook 

type HTTPHook struct {
	// +kubebuilder:validation:Enum=GET;HEAD;POST;PUT;DELETE;CONNECT;OPTIONS;TRACE;PATCH
	Method       string            `json:"method"`
	URL          string            `json:"url"`
	Headers      map[string]string `json:"headers,omitempty"`
	SuccessCodes []int             `json:"successCodes"`
	// +kubebuilder:validation:Enum=query;body
	ParameterMode string `json:"parameterMode"`
}

HTTPHook describes configuration options for an HTTP request hook

func (*HTTPHook) DeepCopy 

func (in *HTTPHook) DeepCopy() *HTTPHook

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

func (*HTTPHook) DeepCopyInto 

func (in *HTTPHook) DeepCopyInto(out *HTTPHook)

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

type HoltWinters 

type HoltWinters struct {
	// +kubebuilder:validation:Minimum=0
	// +optional
	Alpha *float64 `json:"alpha"`

	// +kubebuilder:validation:Minimum=0
	// +optional
	Beta *float64 `json:"beta"`

	// +kubebuilder:validation:Minimum=0
	// +optional
	Gamma *float64 `json:"gamma"`

	// +kubebuilder:validation:Enum=add;additive;mul;multiplicative
	Trend string `json:"trend"`

	// +kubebuilder:validation:Enum=add;additive;mul;multiplicative
	Seasonal string `json:"seasonal"`

	// +kubebuilder:validation:Minimum=1
	SeasonalPeriods int `json:"seasonalPeriods"`

	// +kubebuilder:validation:Minimum=1
	StoredSeasons int `json:"storedSeasons"`

	// +optional
	DampedTrend *bool `json:"dampedTrend"`

	// +optional
	// +kubebuilder:validation:Enum=estimated;heuristic;known;legacy-heuristic
	InitializationMethod *string `json:"initializationMethod"`

	// +optional
	InitialLevel *float64 `json:"initialLevel"`

	// +optional
	InitialTrend *float64 `json:"initialTrend"`

	// +optional
	InitialSeasonal *float64 `json:"initialSeasonal"`

	// +optional
	RuntimeTuningFetchHook *HookDefinition `json:"runtimeTuningFetchHook"`
}

HoltWinters represents a holt-winters exponential smoothing prediction model configuration

func (*HoltWinters) DeepCopy 

func (in *HoltWinters) DeepCopy() *HoltWinters

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

func (*HoltWinters) DeepCopyInto 

func (in *HoltWinters) DeepCopyInto(out *HoltWinters)

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

type HookDefinition 

type HookDefinition struct {
	// +kubebuilder:validation:Enum=http
	Type string `json:"type"`
	// +kubebuilder:validation:Minimum=1
	Timeout int `json:"timeout"`
	// +optional
	HTTP *HTTPHook `json:"http"`
}

HookDefinition describes a hook for passing data/triggering logic, such as through a shell command

func (*HookDefinition) DeepCopy 

func (in *HookDefinition) DeepCopy() *HookDefinition

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

func (*HookDefinition) DeepCopyInto 

func (in *HookDefinition) DeepCopyInto(out *HookDefinition)

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

type Linear 

type Linear struct {
	// historySize is how many timestamped replica counts should be stored for this linear regression, with older
	// timestamped replica counts being removed from the data as new ones are added. For example a value of 6 means
	// there will only be a maxmimu of 6 stored timestamped replica counts for this model.
	// +kubebuilder:validation:Minimum=1
	HistorySize int `json:"historySize"`
	// lookAhead is how far in the future should the linear regression predict in seconds. For example a value of 10
	// will predict 10 seconds into the future
	// +kubebuilder:validation:Minimum=1
	LookAhead int `json:"lookAhead"`
}

Linear represents a linear regression prediction model configuration

func (*Linear) DeepCopy 

func (in *Linear) DeepCopy() *Linear

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

func (*Linear) DeepCopyInto 

func (in *Linear) DeepCopyInto(out *Linear)

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

type Model 

type Model struct {
	// type is the type of the model, for example 'Linear'. To see a full list of supported model types visit
	// https://predictive-horizontal-pod-autoscaler.readthedocs.io/en/latest/user-guide/models/.
	// +kubebuilder:validation:Enum=Linear;HoltWinters
	Type string `json:"type"`

	// name is the name of the model, this can be any arbitrary name and is just used to distinguish between models if
	// you have multiple and to keep track of model data if you modify your model parameters.
	Name string `json:"name"`

	// startInterval is the next interval to start applying this model at. This allows you to make sure a model starts
	// recording and being calculated only after a certain interval has passed, e.g. a Holt Winters model that only
	// runs at the top of every hour.
	// This value is a string duration, e.g. 2m30s is 2 minutes and 30 seconds.
	// +optional
	StartInterval *metav1.Duration `json:"startInterval"`

	// resetDuration is how long can pass without data for the model before the model should reset.
	// This is useful in case a model hasn't been calculated in a long time (e.g. a cluster being powered off) to
	// prevent it from operating on old data and to ensure that the start interval is recalculated.
	// This value is a string duration, e.g. 2m30s is 2 minutes and 30 seconds.
	// +optional
	ResetDuration *metav1.Duration `json:"resetDuration"`

	// calculationTimeout is how long the PHPA should allow for the model to calculate a value in milliseconds, if it
	// takes longer than this timeout it should skip processing the model.
	// Default varies based on model type:
	// Linear is 30000 milliseconds (30 seconds)
	// +kubebuilder:validation:Minimum=1
	// +optional
	CalculationTimeout *int `json:"calculationTimeout"`

	// perSyncPeriod is how frequently this model will run, with the syncPeriod as a base unit. This allows for you to
	// have multiple models which run at different time intervals, or only run the model every x number of sync periods
	// if the model is computation intensive.
	// For sync periods that the model is not run on, it will still add the calculated replica values to the model data
	// history and then prune that history if needs.
	// Default value is 1 (run every sync period)
	// +kubebuilder:validation:Minimum=1
	// +optional
	PerSyncPeriod *int `json:"perSyncPeriod"`

	// linear is the configuration to use for the linear regression model, it will only be used if the type is set to
	// 'Linear'.
	// +optional
	Linear *Linear `json:"linear"`

	// holtWinters is the configuration to use for the holt winters model, it will only be used if the type is set to
	// 'HoltWinters'
	// +optional
	HoltWinters *HoltWinters `json:"holtWinters"`
}

Model represents a prediction model to use, e.g. a linear regression

func (*Model) DeepCopy 

func (in *Model) DeepCopy() *Model

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

func (*Model) DeepCopyInto 

func (in *Model) DeepCopyInto(out *Model)

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

type ModelHistory 

type ModelHistory struct {
	// type is the type of the model the history is for, useful to check for model mismatches with the data.
	Type string `json:"type"`
	// syncPeriodsPassed is the number of sync periods that have passed since the last time this model was used, used
	// when determining if a model should run based on the perSyncPeriod
	SyncPeriodsPassed int `json:"syncPeriodsPassed"`
	// replicaHistory is a list of timestamped replicas, this data is fed into the model to calculate a predicted value.
	ReplicaHistory []TimestampedReplicas `json:"replicaHistory"`
	// startTime is the time after which the model should start applying and recording data. If it is before this time
	// no data will be recorded and the model will be skipped.
	// +optional
	StartTime *metav1.Time `json:"startTime"`
}

ModelHistory is the data stored for a single model's history, with all of the replica data the model is fed to calculate replicas.

func (*ModelHistory) DeepCopy 

func (in *ModelHistory) DeepCopy() *ModelHistory

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

func (*ModelHistory) DeepCopyInto 

func (in *ModelHistory) DeepCopyInto(out *ModelHistory)

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

type PredictiveHorizontalPodAutoscaler 

type PredictiveHorizontalPodAutoscaler struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PredictiveHorizontalPodAutoscalerSpec   `json:"spec,omitempty"`
	Status PredictiveHorizontalPodAutoscalerStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:shortName=phpa +kubebuilder:printcolumn:name="Reference",type="string",JSONPath=`.status.reference`,description="The identifier for the resource being scaled in the format <api-version>/<api-kind/<name>" +kubebuilder:printcolumn:name="Min Pods",type="integer",JSONPath=`.spec.minReplicas`,description="The minimum number of replicas of pods that the resource being managed by the autoscaler can have" +kubebuilder:printcolumn:name="Max Pods",type="integer",JSONPath=`.spec.maxReplicas`,description="The maximum number of replicas of pods that the resource being managed by the autoscaler can have" +kubebuilder:printcolumn:name="Replicas",type="integer",JSONPath=`.status.desiredReplicas`,description="The desired number of replicas of pods managed by this autoscaler as last calculated by the autoscaler" +kubebuilder:printcolumn:name="Last Scale Time",type="date",JSONPath=`.status.lastScaleTime`,description="The last time the PredictiveHorizontalPodAutoscaler scaled the number of pods" PredictiveHorizontalPodAutoscaler is the Schema for the predictivehorizontalpodautoscalers API

func (*PredictiveHorizontalPodAutoscaler) DeepCopy 

func (in *PredictiveHorizontalPodAutoscaler) DeepCopy() *PredictiveHorizontalPodAutoscaler

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

func (*PredictiveHorizontalPodAutoscaler) DeepCopyInto 

func (in *PredictiveHorizontalPodAutoscaler) DeepCopyInto(out *PredictiveHorizontalPodAutoscaler)

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

func (*PredictiveHorizontalPodAutoscaler) DeepCopyObject 

func (in *PredictiveHorizontalPodAutoscaler) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PredictiveHorizontalPodAutoscalerData 

type PredictiveHorizontalPodAutoscalerData struct {
	// modelHistories is a mapping of model names to model histories. This allows looking up a model's model history,
	// while allowing all of the model histories for a single PHPA to be stored in a single place.
	ModelHistories map[string]ModelHistory `json:"modelHistories"`
}

PredictiveHorizontalPodAutoscalerData is the data storage format for the PHPA, this is stored in a ConfigMap

func (*PredictiveHorizontalPodAutoscalerData) DeepCopy 

func (in *PredictiveHorizontalPodAutoscalerData) DeepCopy() *PredictiveHorizontalPodAutoscalerData

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

func (*PredictiveHorizontalPodAutoscalerData) DeepCopyInto 

func (in *PredictiveHorizontalPodAutoscalerData) DeepCopyInto(out *PredictiveHorizontalPodAutoscalerData)

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

type PredictiveHorizontalPodAutoscalerList 

type PredictiveHorizontalPodAutoscalerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PredictiveHorizontalPodAutoscaler `json:"items"`
}

PredictiveHorizontalPodAutoscalerList contains a list of PredictiveHorizontalPodAutoscaler

func (*PredictiveHorizontalPodAutoscalerList) DeepCopy 

func (in *PredictiveHorizontalPodAutoscalerList) DeepCopy() *PredictiveHorizontalPodAutoscalerList

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

func (*PredictiveHorizontalPodAutoscalerList) DeepCopyInto 

func (in *PredictiveHorizontalPodAutoscalerList) DeepCopyInto(out *PredictiveHorizontalPodAutoscalerList)

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

func (*PredictiveHorizontalPodAutoscalerList) DeepCopyObject 

func (in *PredictiveHorizontalPodAutoscalerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PredictiveHorizontalPodAutoscalerSpec 

type PredictiveHorizontalPodAutoscalerSpec struct {
	// scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics
	// should be collected, as well as to actually change the replica count.
	ScaleTargetRef autoscalingv2.CrossVersionObjectReference `json:"scaleTargetRef"`

	// minReplicas is the lower limit for the number of replicas to which the autoscaler
	// can scale down.  It defaults to 1 pod.  minReplicas is allowed to be 0 if at least one Object or
	// External metric is configured.  Scaling is active as long as at least one metric value is
	// available.
	// +kubebuilder:validation:Minimum=0
	// +optional
	MinReplicas *int32 `json:"minReplicas"`

	// maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.
	// It cannot be less than minReplicas.
	// +kubebuilder:validation:Minimum=1
	MaxReplicas int32 `json:"maxReplicas"`

	// metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica
	// count across all metrics will be used).  The desired replica count is calculated multiplying the ratio between
	// the target value and the current value by the current number of pods.  Ergo, metrics used must decrease as the
	// pod count is increased, and vice-versa.  See the individual metric source types for more information about how
	// each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.
	// +listType=atomic
	// +optional
	Metrics []autoscalingv2.MetricSpec `json:"metrics"`

	// behavior configures the scaling behavior of the target
	// in both Up and Down directions (scaleUp and scaleDown fields respectively).
	// If not set, the default HPAScalingRules for scale up and scale down are used.
	// +optional
	Behavior *autoscalingv2.HorizontalPodAutoscalerBehavior `json:"behavior,omitempty"`

	// cpuInitializationPeriod is equivalent to --horizontal-pod-autoscaler-cpu-initialization-period; the period after
	// pod start when CPU samples might be skipped.
	// Default value 300 seconds (5 minutes).
	// +kubebuilder:validation:Minimum=0
	// +optional
	CPUInitializationPeriod *int `json:"cpuInitializationPeriod"`

	// initialReadinessDelay is equivalent to --horizontal-pod-autoscaler-initial-readiness-delay; the period after pod
	// start during which readiness changes will be treated as initial readiness.
	// Default value 30 seconds.
	// +kubebuilder:validation:Minimum=0
	// +optional
	InitialReadinessDelay *int `json:"initialReadinessDelay"`

	// tolerance is equivalent to --horizontal-pod-autoscaler-tolerance; the minimum change (from 1.0) in the
	// desired-to-actual metrics ratio for the predictive horizontal pod autoscaler to consider scaling.
	// Default value 0.1.
	// +kubebuilder:validation:Minimum=0
	// +optional
	Tolerance *float64 `json:"tolerance"`

	// syncPeriod is equivalent to --horizontal-pod-autoscaler-sync-period; the frequency with which the PHPA
	// calculates replica counts and scales in milliseconds.
	// Default value 15000 milliseconds (15 seconds).
	// +kubebuilder:validation:Minimum=1
	// +optional
	SyncPeriod *int `json:"syncPeriod"`

	// models is the list of models to apply to the calculated replica count to calculate predicted replica values.
	// +kubebuilder:validation:Required
	Models []Model `json:"models"`

	// decisionType is the strategy to use when picking which replica count to use if you have multiple models, or even
	// just choosing between the calculculated replicas and the predicted replicas of a single model. For details on
	// which decisionTypes are available visit
	// https://predictive-horizontal-pod-autoscaler.readthedocs.io/en/latest/reference/configuration/#decisiontype
	// Default strategy is 'maximum'
	// +kubebuilder:validation:Enum=maximum;minimum;mean;median
	// +optional
	DecisionType *string `json:"decisionType"`
}

PredictiveHorizontalPodAutoscalerSpec defines the desired state of PredictiveHorizontalPodAutoscaler

func (*PredictiveHorizontalPodAutoscalerSpec) DeepCopy 

func (in *PredictiveHorizontalPodAutoscalerSpec) DeepCopy() *PredictiveHorizontalPodAutoscalerSpec

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

func (*PredictiveHorizontalPodAutoscalerSpec) DeepCopyInto 

func (in *PredictiveHorizontalPodAutoscalerSpec) DeepCopyInto(out *PredictiveHorizontalPodAutoscalerSpec)

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

type PredictiveHorizontalPodAutoscalerStatus 

type PredictiveHorizontalPodAutoscalerStatus struct {
	// lastScaleTime is the last time the PredictiveHorizontalPodAutoscaler scaled the number of pods,
	// used by the autoscaler to control how often the number of pods is changed.
	// +optional
	LastScaleTime *metav1.Time `json:"lastScaleTime,omitempty"`

	// scaleUpReplicaHistory is a list of timestamped replicas within the scale up stabilization window.
	// Used for calculating upscale stabilization.
	// +optional
	ScaleUpReplicaHistory []TimestampedReplicas `json:"scaleUpReplicaHistory"`

	// scaleDownReplicaHistory is a list of timestamped replicas within the scale down stabilization window.
	// Used for calculating downscale stabilization.
	// +optional
	ScaleDownReplicaHistory []TimestampedReplicas `json:"scaleDownReplicaHistory"`

	// scaleUpEventHistory is a list of timestamped changes in replicas for every time a scale up event occurs for
	// this resource. A value of 5 means that at that scale event the resource was scaled up by 5 replicas.
	// Used for applying scale up policies.
	// +optional
	ScaleUpEventHistory []TimestampedReplicas `json:"scaleUpEventHistory"`

	// scaleDownEventHistory is a list of timestamped changes in replicas for every time a scale down event occurs for
	// this resource. A value of 5 means that at that scale event the resource was scaled down by 5 replicas.
	// Used for applying scale down policies.
	// +optional
	ScaleDownEventHistory []TimestampedReplicas `json:"scaleDownEventHistory"`

	// reference is the resource being referenced and targeted for scaling.
	Reference string `json:"reference"`

	// currentReplicas is current number of replicas of pods managed by this autoscaler,
	// as last seen by the autoscaler.
	// +optional
	CurrentReplicas int32 `json:"currentReplicas,omitempty"`

	// desiredReplicas is the desired number of replicas of pods managed by this autoscaler,
	// as last calculated by the autoscaler.
	DesiredReplicas int32 `json:"desiredReplicas"`

	// currentMetrics is the last read state of the metrics used by this autoscaler.
	// +listType=atomic
	// +optional
	CurrentMetrics []autoscalingv2.MetricStatus `json:"currentMetrics"`
}

PredictiveHorizontalPodAutoscalerStatus defines the observed state of PredictiveHorizontalPodAutoscaler

func (*PredictiveHorizontalPodAutoscalerStatus) DeepCopy 

func (in *PredictiveHorizontalPodAutoscalerStatus) DeepCopy() *PredictiveHorizontalPodAutoscalerStatus

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

func (*PredictiveHorizontalPodAutoscalerStatus) DeepCopyInto 

func (in *PredictiveHorizontalPodAutoscalerStatus) DeepCopyInto(out *PredictiveHorizontalPodAutoscalerStatus)

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

type TimestampedReplicas 

type TimestampedReplicas struct {
	// time is the time that the replica count was created at.
	Time *metav1.Time `json:"time"`
	// replicas is the replica count at the time.
	Replicas int32 `json:"replicas"`
}

TimestampedReplicas is a replica count paired with the time that the replica count was created at.

func (*TimestampedReplicas) DeepCopy 

func (in *TimestampedReplicas) DeepCopy() *TimestampedReplicas

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

func (*TimestampedReplicas) DeepCopyInto 

func (in *TimestampedReplicas) DeepCopyInto(out *TimestampedReplicas)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.