v2

package
v1.25.0-kw3 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const GroupName = "autoscaling"

GroupName is the group name use in this package

Variables

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v2"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ContainerResourceMetricSource 

type ContainerResourceMetricSource struct {

	// container is the name of the container in the pods of the scaling target
	// Required: true
	Container *string `json:"container"`

	// name is the name of the resource in question.
	// Required: true
	Name *string `json:"name"`

	// target specifies the target value for the given metric
	// Required: true
	Target *MetricTarget `json:"target"`
}

ContainerResourceMetricSource ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

swagger:model ContainerResourceMetricSource

type ContainerResourceMetricStatus 

type ContainerResourceMetricStatus struct {

	// Container is the name of the container in the pods of the scaling target
	// Required: true
	Container *string `json:"container"`

	// current contains the current value for the given metric
	// Required: true
	Current *MetricValueStatus `json:"current"`

	// Name is the name of the resource in question.
	// Required: true
	Name *string `json:"name"`
}

ContainerResourceMetricStatus ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

swagger:model ContainerResourceMetricStatus

type CrossVersionObjectReference 

type CrossVersionObjectReference struct {

	// API version of the referent
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
	// Required: true
	Kind *string `json:"kind"`

	// Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
	// Required: true
	Name *string `json:"name"`
}

CrossVersionObjectReference CrossVersionObjectReference contains enough information to let you identify the referred resource.

swagger:model CrossVersionObjectReference

type ExternalMetricSource 

type ExternalMetricSource struct {

	// metric identifies the target metric by name and selector
	// Required: true
	Metric *MetricIdentifier `json:"metric"`

	// target specifies the target value for the given metric
	// Required: true
	Target *MetricTarget `json:"target"`
}

ExternalMetricSource ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

swagger:model ExternalMetricSource

type ExternalMetricStatus 

type ExternalMetricStatus struct {

	// current contains the current value for the given metric
	// Required: true
	Current *MetricValueStatus `json:"current"`

	// metric identifies the target metric by name and selector
	// Required: true
	Metric *MetricIdentifier `json:"metric"`
}

ExternalMetricStatus ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

swagger:model ExternalMetricStatus

type HPAScalingPolicy 

type HPAScalingPolicy struct {

	// PeriodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
	// Required: true
	PeriodSeconds *int32 `json:"periodSeconds"`

	// Type is used to specify the scaling policy.
	// Required: true
	Type *string `json:"type"`

	// Value contains the amount of change which is permitted by the policy. It must be greater than zero
	// Required: true
	Value *int32 `json:"value"`
}

HPAScalingPolicy HPAScalingPolicy is a single policy which must hold true for a specified past interval.

swagger:model HPAScalingPolicy

type HPAScalingRules 

type HPAScalingRules struct {

	// policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
	Policies []*HPAScalingPolicy `json:"policies,omitempty"`

	// selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
	SelectPolicy string `json:"selectPolicy,omitempty"`

	// StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
	StabilizationWindowSeconds int32 `json:"stabilizationWindowSeconds,omitempty"`
}

HPAScalingRules HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.

swagger:model HPAScalingRules

type HorizontalPodAutoscaler 

type HorizontalPodAutoscaler struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
	Spec *HorizontalPodAutoscalerSpec `json:"spec,omitempty"`

	// status is the current information about the autoscaler.
	Status *HorizontalPodAutoscalerStatus `json:"status,omitempty"`
}

HorizontalPodAutoscaler HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

swagger:model HorizontalPodAutoscaler

func (*HorizontalPodAutoscaler) GroupVersionKind 

func (v *HorizontalPodAutoscaler) GroupVersionKind() schema.GroupVersionKind

type HorizontalPodAutoscalerBehavior 

type HorizontalPodAutoscalerBehavior struct {

	// scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
	ScaleDown *HPAScalingRules `json:"scaleDown,omitempty"`

	// scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:
	//   * increase no more than 4 pods per 60 seconds
	//   * double the number of pods per 60 seconds
	// No stabilization is used.
	ScaleUp *HPAScalingRules `json:"scaleUp,omitempty"`
}

HorizontalPodAutoscalerBehavior HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

swagger:model HorizontalPodAutoscalerBehavior

type HorizontalPodAutoscalerCondition 

type HorizontalPodAutoscalerCondition struct {

	// lastTransitionTime is the last time the condition transitioned from one status to another
	LastTransitionTime *apimachinery_pkg_apis_meta_v1.Time `json:"lastTransitionTime,omitempty"`

	// message is a human-readable explanation containing details about the transition
	Message string `json:"message,omitempty"`

	// reason is the reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`

	// status is the status of the condition (True, False, Unknown)
	// Required: true
	Status *string `json:"status"`

	// type describes the current condition
	// Required: true
	Type *string `json:"type"`
}

HorizontalPodAutoscalerCondition HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

swagger:model HorizontalPodAutoscalerCondition

type HorizontalPodAutoscalerList 

type HorizontalPodAutoscalerList struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// items is the list of horizontal pod autoscaler objects.
	// Required: true
	Items []*HorizontalPodAutoscaler `json:"items"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// metadata is the standard list metadata.
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

HorizontalPodAutoscalerList HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.

swagger:model HorizontalPodAutoscalerList

func (*HorizontalPodAutoscalerList) GroupVersionKind 

func (v *HorizontalPodAutoscalerList) GroupVersionKind() schema.GroupVersionKind

type HorizontalPodAutoscalerSpec 

type HorizontalPodAutoscalerSpec struct {

	// 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.
	Behavior *HorizontalPodAutoscalerBehavior `json:"behavior,omitempty"`

	// maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
	// Required: true
	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.
	Metrics []*MetricSpec `json:"metrics,omitempty"`

	// 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 the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured.  Scaling is active as long as at least one metric value is available.
	MinReplicas int32 `json:"minReplicas,omitempty"`

	// 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.
	// Required: true
	ScaleTargetRef *CrossVersionObjectReference `json:"scaleTargetRef"`
}

HorizontalPodAutoscalerSpec HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

swagger:model HorizontalPodAutoscalerSpec

type HorizontalPodAutoscalerStatus 

type HorizontalPodAutoscalerStatus struct {

	// conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
	Conditions []*HorizontalPodAutoscalerCondition `json:"conditions,omitempty"`

	// currentMetrics is the last read state of the metrics used by this autoscaler.
	CurrentMetrics []*MetricStatus `json:"currentMetrics,omitempty"`

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

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

	// lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
	LastScaleTime *apimachinery_pkg_apis_meta_v1.Time `json:"lastScaleTime,omitempty"`

	// observedGeneration is the most recent generation observed by this autoscaler.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

HorizontalPodAutoscalerStatus HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

swagger:model HorizontalPodAutoscalerStatus

type MetricIdentifier 

type MetricIdentifier struct {

	// name is the name of the given metric
	// Required: true
	Name *string `json:"name"`

	// selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
	Selector *apimachinery_pkg_apis_meta_v1.LabelSelector `json:"selector,omitempty"`
}

MetricIdentifier MetricIdentifier defines the name and optionally selector for a metric

swagger:model MetricIdentifier

type MetricSpec 

type MetricSpec struct {

	// containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
	ContainerResource *ContainerResourceMetricSource `json:"containerResource,omitempty"`

	// external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
	External *ExternalMetricSource `json:"external,omitempty"`

	// object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
	Object *ObjectMetricSource `json:"object,omitempty"`

	// pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second).  The values will be averaged together before being compared to the target value.
	Pods *PodsMetricSource `json:"pods,omitempty"`

	// resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
	Resource *ResourceMetricSource `json:"resource,omitempty"`

	// type is the type of metric source.  It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
	// Required: true
	Type *string `json:"type"`
}

MetricSpec MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).

swagger:model MetricSpec

type MetricStatus 

type MetricStatus struct {

	// container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
	ContainerResource *ContainerResourceMetricStatus `json:"containerResource,omitempty"`

	// external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
	External *ExternalMetricStatus `json:"external,omitempty"`

	// object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
	Object *ObjectMetricStatus `json:"object,omitempty"`

	// pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second).  The values will be averaged together before being compared to the target value.
	Pods *PodsMetricStatus `json:"pods,omitempty"`

	// resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
	Resource *ResourceMetricStatus `json:"resource,omitempty"`

	// type is the type of metric source.  It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
	// Required: true
	Type *string `json:"type"`
}

MetricStatus MetricStatus describes the last-read state of a single metric.

swagger:model MetricStatus

type MetricTarget 

type MetricTarget struct {

	// averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
	AverageUtilization int32 `json:"averageUtilization,omitempty"`

	// averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
	AverageValue *apimachinery_pkg_api_resource.Quantity `json:"averageValue,omitempty"`

	// type represents whether the metric type is Utilization, Value, or AverageValue
	// Required: true
	Type *string `json:"type"`

	// value is the target value of the metric (as a quantity).
	Value *apimachinery_pkg_api_resource.Quantity `json:"value,omitempty"`
}

MetricTarget MetricTarget defines the target value, average value, or average utilization of a specific metric

swagger:model MetricTarget

type MetricValueStatus 

type MetricValueStatus struct {

	// currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
	AverageUtilization int32 `json:"averageUtilization,omitempty"`

	// averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
	AverageValue *apimachinery_pkg_api_resource.Quantity `json:"averageValue,omitempty"`

	// value is the current value of the metric (as a quantity).
	Value *apimachinery_pkg_api_resource.Quantity `json:"value,omitempty"`
}

MetricValueStatus MetricValueStatus holds the current value for a metric

swagger:model MetricValueStatus

type ObjectMetricSource 

type ObjectMetricSource struct {

	// describedObject specifies the descriptions of a object,such as kind,name apiVersion
	// Required: true
	DescribedObject *CrossVersionObjectReference `json:"describedObject"`

	// metric identifies the target metric by name and selector
	// Required: true
	Metric *MetricIdentifier `json:"metric"`

	// target specifies the target value for the given metric
	// Required: true
	Target *MetricTarget `json:"target"`
}

ObjectMetricSource ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

swagger:model ObjectMetricSource

type ObjectMetricStatus 

type ObjectMetricStatus struct {

	// current contains the current value for the given metric
	// Required: true
	Current *MetricValueStatus `json:"current"`

	// DescribedObject specifies the descriptions of a object,such as kind,name apiVersion
	// Required: true
	DescribedObject *CrossVersionObjectReference `json:"describedObject"`

	// metric identifies the target metric by name and selector
	// Required: true
	Metric *MetricIdentifier `json:"metric"`
}

ObjectMetricStatus ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

swagger:model ObjectMetricStatus

type PodsMetricSource 

type PodsMetricSource struct {

	// metric identifies the target metric by name and selector
	// Required: true
	Metric *MetricIdentifier `json:"metric"`

	// target specifies the target value for the given metric
	// Required: true
	Target *MetricTarget `json:"target"`
}

PodsMetricSource PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

swagger:model PodsMetricSource

type PodsMetricStatus 

type PodsMetricStatus struct {

	// current contains the current value for the given metric
	// Required: true
	Current *MetricValueStatus `json:"current"`

	// metric identifies the target metric by name and selector
	// Required: true
	Metric *MetricIdentifier `json:"metric"`
}

PodsMetricStatus PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

swagger:model PodsMetricStatus

type ResourceMetricSource 

type ResourceMetricSource struct {

	// name is the name of the resource in question.
	// Required: true
	Name *string `json:"name"`

	// target specifies the target value for the given metric
	// Required: true
	Target *MetricTarget `json:"target"`
}

ResourceMetricSource ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

swagger:model ResourceMetricSource

type ResourceMetricStatus 

type ResourceMetricStatus struct {

	// current contains the current value for the given metric
	// Required: true
	Current *MetricValueStatus `json:"current"`

	// Name is the name of the resource in question.
	// Required: true
	Name *string `json:"name"`
}

ResourceMetricStatus ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

swagger:model ResourceMetricStatus

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.