horizontalpodautoscalerspec.json

{
  "description": "HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.",
  "required": [
    "scaleTargetRef",
    "maxReplicas"
  ],
  "properties": {
    "maxReplicas": {
      "description": "maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.",
      "type": "integer",
      "format": "int32"
    },
    "metrics": {
      "description": "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.",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "description": "MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).",
        "required": [
          "type"
        ],
        "properties": {
          "external": {
            "description": "ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). Exactly one \"target\" type should be set.",
            "required": [
              "metricName"
            ],
            "properties": {
              "metricName": {
                "description": "metricName is the name of the metric in question.",
                "type": "string"
              },
              "metricSelector": {
                "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
                "properties": {
                  "matchExpressions": {
                    "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
                    "type": [
                      "array",
                      "null"
                    ],
                    "items": {
                      "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
                      "required": [
                        "key",
                        "operator"
                      ],
                      "properties": {
                        "key": {
                          "description": "key is the label key that the selector applies to.",
                          "type": "string",
                          "x-kubernetes-patch-merge-key": "key",
                          "x-kubernetes-patch-strategy": "merge"
                        },
                        "operator": {
                          "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
                          "type": "string"
                        },
                        "values": {
                          "description": "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": [
                            "array",
                            "null"
                          ],
                          "items": {
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "matchLabels": {
                    "description": "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": "object",
                    "additionalProperties": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  }
                },
                "additionalProperties": false
              },
              "targetAverageValue": {
                "oneOf": [
                  {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  {
                    "type": "integer"
                  }
                ]
              },
              "targetValue": {
                "oneOf": [
                  {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  {
                    "type": "integer"
                  }
                ]
              }
            },
            "additionalProperties": false
          },
          "object": {
            "description": "ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).",
            "required": [
              "target",
              "metricName",
              "targetValue"
            ],
            "properties": {
              "metricName": {
                "description": "metricName is the name of the metric in question.",
                "type": "string"
              },
              "target": {
                "description": "CrossVersionObjectReference contains enough information to let you identify the referred resource.",
                "required": [
                  "kind",
                  "name"
                ],
                "properties": {
                  "apiVersion": {
                    "description": "API version of the referent",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "kind": {
                    "description": "Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds\"",
                    "type": "string"
                  },
                  "name": {
                    "description": "Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names",
                    "type": "string"
                  }
                },
                "additionalProperties": false
              },
              "targetValue": {
                "oneOf": [
                  {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  {
                    "type": "integer"
                  }
                ]
              }
            },
            "additionalProperties": false
          },
          "pods": {
            "description": "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.",
            "required": [
              "metricName",
              "targetAverageValue"
            ],
            "properties": {
              "metricName": {
                "description": "metricName is the name of the metric in question",
                "type": "string"
              },
              "targetAverageValue": {
                "oneOf": [
                  {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  {
                    "type": "integer"
                  }
                ]
              }
            },
            "additionalProperties": false
          },
          "resource": {
            "description": "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.",
            "required": [
              "name"
            ],
            "properties": {
              "name": {
                "description": "name is the name of the resource in question.",
                "type": "string"
              },
              "targetAverageUtilization": {
                "description": "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.",
                "type": "integer",
                "format": "int32"
              },
              "targetAverageValue": {
                "oneOf": [
                  {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  {
                    "type": "integer"
                  }
                ]
              }
            },
            "additionalProperties": false
          },
          "type": {
            "description": "type is the type of metric source.  It should be one of \"Object\", \"Pods\" or \"Resource\", each mapping to a matching field in the object.",
            "type": "string"
          }
        },
        "additionalProperties": false
      }
    },
    "minReplicas": {
      "description": "minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod.",
      "type": "integer",
      "format": "int32"
    },
    "scaleTargetRef": {
      "description": "CrossVersionObjectReference contains enough information to let you identify the referred resource.",
      "required": [
        "kind",
        "name"
      ],
      "properties": {
        "apiVersion": {
          "description": "API version of the referent",
          "type": [
            "string",
            "null"
          ]
        },
        "kind": {
          "description": "Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds\"",
          "type": "string"
        },
        "name": {
          "description": "Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names",
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/schema#",
  "type": "object"
}