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.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
metricName |
+metricName is the name of the metric in question |
+true |
+string |
++ |
targetAverageValue |
+targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity) |
+true |
+string |
++ |
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
@@ -427,6 +477,1135 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
observedGeneration |
+observedGeneration is the most recent generation observed by this autoscaler. |
+false |
+integer (int64) |
++ |
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. |
+false |
+string |
++ |
currentReplicas |
+currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. |
+true |
+integer (int32) |
++ |
desiredReplicas |
+desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. |
+true |
+integer (int32) |
++ |
currentMetrics |
+currentMetrics is the last read state of the metrics used by this autoscaler. |
+true |
+v2alpha1.MetricStatus array |
++ |
PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
metricName |
+metricName is the name of the metric in question |
+true |
+string |
++ |
currentAverageValue |
+currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity) |
+true |
+string |
++ |
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.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+name is the name of the resource in question. |
+true |
+string |
++ |
targetAverageUtilization |
+targetAverageUtilization 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. |
+false |
+integer (int32) |
++ |
targetAverageValue |
+targetAverageValue is the the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. |
+false |
+string |
++ |
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
++ |
resourceVersion |
+String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
++ |
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.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+metadata is the standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
+false |
++ | + |
spec |
+spec is the specification for the behaviour of the autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. |
+false |
++ | + |
status |
+status is the current information about the autoscaler. |
+false |
++ | + |
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
uid |
+Specifies the target UID. |
+false |
++ | + |
Status is a return value for calls that don’t return other objects.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
++ | + |
status |
+Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
+false |
+string |
++ |
message |
+A human-readable description of the status of this operation. |
+false |
+string |
++ |
reason |
+A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. |
+false |
+string |
++ |
details |
+Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. |
+false |
++ | + |
code |
+Suggested HTTP return code for this status, 0 if not set. |
+false |
+integer (int32) |
++ |
| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
type |
++ | true |
+string |
++ |
object |
++ | true |
+string |
++ |
HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
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. |
+true |
++ | + |
minReplicas |
+minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. |
+false |
+integer (int32) |
++ |
maxReplicas |
+maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. |
+true |
+integer (int32) |
++ |
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. |
+false |
+v2alpha1.MetricSpec array |
++ |
CrossVersionObjectReference contains enough information to let you identify the referred resource.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds" |
+true |
+string |
++ |
name |
+Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |
+true |
+string |
++ |
apiVersion |
+API version of the referent |
+false |
+string |
++ |
HorizontalPodAutoscaler is a list of horizontal pod autoscaler objects.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+metadata is the standard list metadata. |
+false |
++ | + |
items |
+items is the list of horizontal pod autoscaler objects. |
+true |
++ | + |
MetricStatus describes the last-read state of a single metric.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
type |
+type is the type of metric source. It will match one of the fields below. |
+true |
+string |
++ |
object |
+object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). |
+false |
++ | + |
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. |
+false |
++ | + |
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. |
+false |
++ | + |
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+DeleteOptions may be provided when deleting an API object.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
gracePeriodSeconds |
+The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
+false |
+integer (int64) |
++ |
preconditions |
+Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
+false |
++ | + |
orphanDependents |
+Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
+false |
+boolean |
+false |
+
propagationPolicy |
+Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
+false |
++ | + |
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
+false |
+string |
++ |
group |
+The group attribute of the resource associated with the status StatusReason. |
+false |
+string |
++ |
kind |
+The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
causes |
+The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
+false |
+v1.StatusCause array |
++ |
retryAfterSeconds |
+If specified, the time in seconds before the operation should be retried. |
+false |
+integer (int32) |
++ |
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.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+name is the name of the resource in question. |
+true |
+string |
++ |
currentAverageUtilization |
+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. It will only be present if |
+false |
+integer (int32) |
++ |
currentAverageValue |
+currentAverageValue is the the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification. |
+true |
+string |
++ |
ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
target |
+target is the described Kubernetes object. |
+true |
++ | + |
metricName |
+metricName is the name of the metric in question. |
+true |
+string |
++ |
targetValue |
+targetValue is the target value of the metric (as a quantity). |
+true |
+string |
++ |
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
apiVersion |
+API version of the referent. |
+true |
+string |
++ |
kind |
+Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+true |
+string |
++ |
name |
+Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
+true |
+string |
++ |
uid |
+UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
+true |
+string |
++ |
controller |
+If true, this reference points to the managing controller. |
+false |
+boolean |
+false |
+
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. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
+false |
+boolean |
+false |
+
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
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: http://kubernetes.io/docs/user-guide/identifiers#names |
+false |
+string |
++ |
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. |
+false |
+string |
++ |
namespace |
+Namespace defines the space within 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. |
+false |
+string |
++ |
selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
++ |
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. |
+false |
+string |
++ |
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. |
+false |
+string |
++ |
generation |
+A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
+false |
+integer (int64) |
++ |
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. |
+false |
+string |
++ |
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 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. |
+false |
+string |
++ |
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. |
+false |
+integer (int64) |
++ |
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: http://kubernetes.io/docs/user-guide/labels |
+false |
+object |
++ |
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: http://kubernetes.io/docs/user-guide/annotations |
+false |
+object |
++ |
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. |
+false |
+v1.OwnerReference array |
++ |
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. |
+false |
+string array |
++ |
clusterName |
+The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. |
+false |
+string |
++ |
MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).
| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
type |
+type is the type of metric source. It should match one of the fields below. |
+true |
+string |
++ |
object |
+object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). |
+false |
++ | + |
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. |
+false |
++ | + |
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. |
+false |
++ | + |
ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
target |
+target is the described Kubernetes object. |
+true |
++ | + |
metricName |
+metricName is the name of the metric in question. |
+true |
+string |
++ |
currentValue |
+currentValue is the current value of the metric (as a quantity). |
+true |
+string |
++ |
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
reason |
+A machine-readable description of the cause of the error. If this value is empty there is no information available. |
+false |
+string |
++ |
message |
+A human-readable description of the cause of the error. This field may be presented as-is to a reader. |
+false |
+string |
++ |
field |
+The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. |
+false |
+string |
++ |