resources.autoscaling.v1.HorizontalPodAutoscaler

configuration of a horizontal pod autoscaler.

Type: attribute set of (submodule)

Default: { }

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.apiVersion

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

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.kind

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

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata

Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (submodule)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

Type: null or signed integer

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

Type: null or (list of (string))

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: null or signed integer

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.managedFields

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.apiVersion

APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.fieldsType

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.fieldsV1

FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.

Type: null or (submodule)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.manager

Manager is an identifier of the workflow managing these fields.

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.operation

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.subresource

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.time

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.namespace

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.apiVersion

API version of the referent.

Type: string

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.blockOwnerDeletion

If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: null or boolean

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.controller

If true, this reference points to the managing controller.

Type: null or boolean

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.kind

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.uid

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: null or (string)

Declared by:

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.metadata.uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.spec

spec defines the behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.

Type: null or (submodule)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.spec.maxReplicas

maxReplicas is the upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.

Type: signed integer

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.spec.minReplicas

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.

Type: null or signed integer

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.spec.scaleTargetRef

reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.

Type: submodule

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.spec.scaleTargetRef.apiVersion

apiVersion is the API version of the referent

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.spec.scaleTargetRef.kind

kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.spec.scaleTargetRef.name

name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: string

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.spec.targetCPUUtilizationPercentage

targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.

Type: null or signed integer

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.status

status is the current information about the autoscaler.

Type: null or (submodule)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.status.currentCPUUtilizationPercentage

currentCPUUtilizationPercentage is the current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.

Type: null or signed integer

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.status.currentReplicas

currentReplicas is the current number of replicas of pods managed by this autoscaler.

Type: signed integer

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.status.desiredReplicas

desiredReplicas is the desired number of replicas of pods managed by this autoscaler.

Type: signed integer

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.status.lastScaleTime

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.

Type: null or (string)

Declared by:

resources.autoscaling.v1.HorizontalPodAutoscaler.<name>.status.observedGeneration

observedGeneration is the most recent generation observed by this autoscaler.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.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.

Type: attribute set of (submodule)

Default: { }

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.apiVersion

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

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.kind

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

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

Type: null or (list of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.managedFields

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.apiVersion

APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.fieldsType

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.fieldsV1

FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.manager

Manager is an identifier of the workflow managing these fields.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.operation

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.subresource

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.managedFields.*.time

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.namespace

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.apiVersion

API version of the referent.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.blockOwnerDeletion

If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: null or boolean

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.controller

If true, this reference points to the managing controller.

Type: null or boolean

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.kind

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.ownerReferences.<name>.uid

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: null or (string)

Declared by:

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.metadata.uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleDown

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).

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleDown.policies

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

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleDown.policies.*.periodSeconds

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).

Type: signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleDown.policies.*.type

type is used to specify the scaling policy.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleDown.policies.*.value

value contains the amount of change which is permitted by the policy. It must be greater than zero

Type: signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleDown.selectPolicy

selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleDown.stabilizationWindowSeconds

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).

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleUp

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleUp.policies

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

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleUp.policies.*.periodSeconds

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).

Type: signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleUp.policies.*.type

type is used to specify the scaling policy.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleUp.policies.*.value

value contains the amount of change which is permitted by the policy. It must be greater than zero

Type: signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleUp.selectPolicy

selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.behavior.scaleUp.stabilizationWindowSeconds

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).

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.maxReplicas

maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.

Type: signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics

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.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.containerResource

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.containerResource.container

container is the name of the container in the pods of the scaling target

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.containerResource.name

name is the name of the resource in question.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.containerResource.target

target specifies the target value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.containerResource.target.averageUtilization

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

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.containerResource.target.averageValue

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.containerResource.target.type

type represents whether the metric type is Utilization, Value, or AverageValue

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.containerResource.target.value

value is the target value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external

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).

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.metric

metric identifies the target metric by name and selector

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.metric.name

name is the name of the given metric

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.metric.selector

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.metric.selector.matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.metric.selector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.metric.selector.matchExpressions.*.operator

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.metric.selector.matchExpressions.*.values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Type: null or (list of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.metric.selector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.target

target specifies the target value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.target.averageUtilization

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

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.target.averageValue

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.target.type

type represents whether the metric type is Utilization, Value, or AverageValue

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.external.target.value

value is the target value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object

object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.describedObject

describedObject specifies the descriptions of a object,such as kind,name apiVersion

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.describedObject.apiVersion

apiVersion is the API version of the referent

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.describedObject.kind

kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.describedObject.name

name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.metric

metric identifies the target metric by name and selector

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.metric.name

name is the name of the given metric

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.metric.selector

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.metric.selector.matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.metric.selector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.metric.selector.matchExpressions.*.operator

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.metric.selector.matchExpressions.*.values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Type: null or (list of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.metric.selector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.target

target specifies the target value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.target.averageUtilization

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

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.target.averageValue

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.target.type

type represents whether the metric type is Utilization, Value, or AverageValue

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.object.target.value

value is the target value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.metric

metric identifies the target metric by name and selector

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.metric.name

name is the name of the given metric

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.metric.selector

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.metric.selector.matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.metric.selector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.metric.selector.matchExpressions.*.operator

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.metric.selector.matchExpressions.*.values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Type: null or (list of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.metric.selector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.target

target specifies the target value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.target.averageUtilization

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

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.target.averageValue

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.target.type

type represents whether the metric type is Utilization, Value, or AverageValue

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.pods.target.value

value is the target value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.resource

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.resource.name

name is the name of the resource in question.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.resource.target

target specifies the target value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.resource.target.averageUtilization

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

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.resource.target.averageValue

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.resource.target.type

type represents whether the metric type is Utilization, Value, or AverageValue

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.resource.target.value

value is the target value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.metrics.*.type

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

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.minReplicas

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.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.scaleTargetRef

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.

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.scaleTargetRef.apiVersion

apiVersion is the API version of the referent

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.scaleTargetRef.kind

kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.spec.scaleTargetRef.name

name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status

status is the current information about the autoscaler.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.conditions

conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.conditions.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.conditions.<name>.lastTransitionTime

lastTransitionTime is the last time the condition transitioned from one status to another

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.conditions.<name>.message

message is a human-readable explanation containing details about the transition

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.conditions.<name>.reason

reason is the reason for the condition’s last transition.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.conditions.<name>.status

status is the status of the condition (True, False, Unknown)

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.conditions.<name>.type

type describes the current condition

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics

currentMetrics is the last read state of the metrics used by this autoscaler.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.containerResource

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.containerResource.container

container is the name of the container in the pods of the scaling target

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.containerResource.current

current contains the current value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.containerResource.current.averageUtilization

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.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.containerResource.current.averageValue

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.containerResource.current.value

value is the current value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.containerResource.name

name is the name of the resource in question.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external

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).

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.current

current contains the current value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.current.averageUtilization

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.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.current.averageValue

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.current.value

value is the current value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.metric

metric identifies the target metric by name and selector

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.metric.name

name is the name of the given metric

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.metric.selector

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.metric.selector.matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.metric.selector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.metric.selector.matchExpressions.*.operator

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.metric.selector.matchExpressions.*.values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Type: null or (list of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.external.metric.selector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object

object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.current

current contains the current value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.current.averageUtilization

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.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.current.averageValue

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.current.value

value is the current value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.describedObject

DescribedObject specifies the descriptions of a object,such as kind,name apiVersion

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.describedObject.apiVersion

apiVersion is the API version of the referent

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.describedObject.kind

kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.describedObject.name

name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.metric

metric identifies the target metric by name and selector

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.metric.name

name is the name of the given metric

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.metric.selector

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.metric.selector.matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.metric.selector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.metric.selector.matchExpressions.*.operator

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.metric.selector.matchExpressions.*.values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Type: null or (list of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.object.metric.selector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.current

current contains the current value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.current.averageUtilization

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.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.current.averageValue

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.current.value

value is the current value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.metric

metric identifies the target metric by name and selector

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.metric.name

name is the name of the given metric

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.metric.selector

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.metric.selector.matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type: null or (list of (submodule))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.metric.selector.matchExpressions.*.key

key is the label key that the selector applies to.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.metric.selector.matchExpressions.*.operator

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.metric.selector.matchExpressions.*.values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Type: null or (list of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.pods.metric.selector.matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

Type: null or (attribute set of (string))

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.resource

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.

Type: null or (submodule)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.resource.current

current contains the current value for the given metric

Type: submodule

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.resource.current.averageUtilization

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.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.resource.current.averageValue

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.resource.current.value

value is the current value of the metric (as a quantity).

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.resource.name

name is the name of the resource in question.

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentMetrics.*.type

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

Type: string

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.currentReplicas

currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.

Type: null or signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.desiredReplicas

desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.

Type: signed integer

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.lastScaleTime

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.

Type: null or (string)

Declared by:

resources.autoscaling.v2.HorizontalPodAutoscaler.<name>.status.observedGeneration

observedGeneration is the most recent generation observed by this autoscaler.

Type: null or signed integer

Declared by: