package
1.33.0-alpha.2
Repository: https://github.com/kubernetes/kubernetes.git
Documentation: pkg.go.dev

# Packages

Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.

# Functions

DeepCopyStringMap returns a copy of the input map.
DropRoundTripHorizontalPodAutoscalerAnnotations removes any annotations used to serialize round-tripped fields from later API versions, and returns false if no changes were made and the original input object was returned.
Kind takes an unqualified kind and returns a Group qualified GroupKind.
Resource takes an unqualified resource and returns a Group qualified GroupResource.

# Constants

AbleToScale indicates a lack of transient issues which prevent scaling from occurring, such as being in a backoff window, or being unable to access/update the target scale.
AverageValueMetricType is a possible value for MetricTarget.Type.
BehaviorSpecsAnnotation is the annotation which holds the HPA constraints specs when converting the `Behavior` field from autoscaling/v2beta2.
These are valid condition statuses.
These are valid condition statuses.
These are valid condition statuses.
ContainerResourceMetricSourceType is 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.
DefaultCPUUtilization is the default value for CPU utilization, provided no other metrics are present.
DisabledPolicySelect disables the scaling in this direction.
ExternalMetricSourceType is a global metric that is not associated with any Kubernetes object.
GroupName is the group name use in this package.
HorizontalPodAutoscalerConditionsAnnotation is the annotation which holds the conditions of an HPA when converting the `Conditions` field from autoscaling/v2beta1.
MaxPolicySelect selects the policy with the highest possible change.
MetricSpecsAnnotation is the annotation which holds non-CPU-utilization HPA metric specs when converting the `Metrics` field from autoscaling/v2beta1.
MetricStatusesAnnotation is the annotation which holds non-CPU-utilization HPA metric statuses when converting the `CurrentMetrics` field from autoscaling/v2beta1.
MinPolicySelect selects the policy with the lowest possible change.
ObjectMetricSourceType is a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
PercentScalingPolicy is a policy used to specify a relative amount of change with respect to the current number of pods.
PodsMetricSourceType is a metric describing each pod in the current scale target (for example, transactions-processed-per-second).
PodsScalingPolicy is a policy used to specify a change in absolute number of pods.
ResourceMetricSourceType is a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g.
ScalingActive indicates that the HPA controller is able to scale if necessary: it's correctly configured, can fetch the desired metrics, and isn't disabled.
ScalingLimited indicates that the calculated scale based on metrics would be above or below the range for the HPA, and has thus been capped.
UtilizationMetricType is a possible value for MetricTarget.Type.
ValueMetricType is a possible value for MetricTarget.Type.

# Variables

AddToScheme applies all the stored functions to the scheme.
SchemeBuilder points to a list of functions added to Scheme.
SchemeGroupVersion is group version used to register these objects.

# Structs

ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in the requests and limits, describing a single container in each of the pods of the current scale target(e.g.
ContainerResourceMetricStatus 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.
CrossVersionObjectReference contains enough information to let you identify the referred resource.
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).
ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.
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.
HorizontalPodAutoscalerBehavior configures a scaling behavior for Up and Down direction (scaleUp and scaleDown fields respectively).
HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.
HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.
HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.
HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.
HPAScalingPolicy is a single policy which must hold true for a specified past interval.
HPAScalingRules configures the scaling behavior for one direction.
MetricIdentifier defines the name and optionally selector for a metric.
MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).
MetricStatus describes the last-read state of a single metric.
MetricTarget defines the target value, average value, or average utilization of a specific metric.
MetricValueStatus indicates the current value of a metric.
ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second).
PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).
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.
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.
Scale represents a scaling request for a resource.
ScaleSpec describes the attributes of a scale subresource.
ScaleStatus represents the current status of a scale subresource.

# Type aliases

ConditionStatus indicates the status of a condition (true, false, or unknown).
HorizontalPodAutoscalerConditionType are the valid conditions of a HorizontalPodAutoscaler.
HPAScalingPolicyType is the type of the policy which could be used while making scaling decisions.
MetricSourceType indicates the type of metric.
MetricTargetType specifies the type of metric being targeted, and should be either "Value", "AverageValue", or "Utilization".
ScalingPolicySelect is used to specify which policy should be used while scaling in a certain direction.