diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 0dab5c7feb..f5c9f852f2 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -102,6 +102,15 @@ operator to use or manage a cluster. * [v1beta3](/docs/reference/config-api/kubeadm-config.v1beta3/) * [v1beta4](/docs/reference/config-api/kubeadm-config.v1beta4/) +## External APIs + +These are the APIs defined by the Kubernetes project, but are not implemented +by the core project: + +* [Metrics API (v1beta1)](/docs/reference/external-api/metrics.v1beta1/) +* [Custom Metrics API (v1beta2)](/docs/reference/external-api/custom-metrics.v1beta2) +* [External Metrics API (v1beta1)](/docs/reference/external-api/external-metrics.v1beta1) + ## Design Docs An archive of the design docs for Kubernetes functionality. Good starting points are diff --git a/content/en/docs/reference/external-api/_index.md b/content/en/docs/reference/external-api/_index.md new file mode 100644 index 0000000000..c1e0eaea9e --- /dev/null +++ b/content/en/docs/reference/external-api/_index.md @@ -0,0 +1,4 @@ +--- +title: External APIs +weight: 135 +--- diff --git a/content/en/docs/reference/external-api/custom-metrics.v1beta2.md b/content/en/docs/reference/external-api/custom-metrics.v1beta2.md new file mode 100644 index 0000000000..cbbe894c10 --- /dev/null +++ b/content/en/docs/reference/external-api/custom-metrics.v1beta2.md @@ -0,0 +1,177 @@ +--- +title: Kubernetes Custom Metrics (v1beta2) +content_type: tool-reference +package: custom.metrics.k8s.io/v1beta2 +auto_generated: true +--- +
Package v1beta2 is the v1beta2 version of the custom_metrics API.
+ + +## Resource Types + + +- [MetricListOptions](#custom-metrics-k8s-io-v1beta2-MetricListOptions) +- [MetricValue](#custom-metrics-k8s-io-v1beta2-MetricValue) +- [MetricValueList](#custom-metrics-k8s-io-v1beta2-MetricValueList) + + + +## `MetricListOptions` {#custom-metrics-k8s-io-v1beta2-MetricListOptions} + + + +MetricListOptions is used to select metrics by their label selectors
+ + +Field | Description |
---|---|
apiVersion string | custom.metrics.k8s.io/v1beta2 |
kind string | MetricListOptions |
labelSelector + string
+ |
+
+ A selector to restrict the list of returned objects by their labels. +Defaults to everything. + |
+
metricLabelSelector + string
+ |
+
+ A selector to restrict the list of returned metrics by their labels + |
+
MetricValue is the metric value for some object
+ + +Field | Description |
---|---|
apiVersion string | custom.metrics.k8s.io/v1beta2 |
kind string | MetricValue |
describedObject [Required]+ core/v1.ObjectReference
+ |
+
+ a reference to the described object + |
+
metric [Required]+ MetricIdentifier
+ |
++ No description provided. | +
timestamp [Required]+ meta/v1.Time
+ |
+
+ indicates the time at which the metrics were produced + |
+
windowSeconds [Required]+ int64
+ |
+
+ indicates the window ([Timestamp-Window, Timestamp]) from +which these metrics were calculated, when returning rate +metrics calculated from cumulative metrics (or zero for +non-calculated instantaneous metrics). + |
+
value [Required]+ k8s.io/apimachinery/pkg/api/resource.Quantity
+ |
+
+ the value of the metric for this + |
+
MetricValueList is a list of values for a given metric for some set of objects
+ + +Field | Description |
---|---|
apiVersion string | custom.metrics.k8s.io/v1beta2 |
kind string | MetricValueList |
metadata [Required]+ meta/v1.ListMeta
+ |
++ No description provided. | +
items [Required]+ []MetricValue
+ |
+
+ the value of the metric across the described objects + |
+
MetricIdentifier identifies a metric by name and, optionally, selector
+ + +Field | Description |
---|---|
name [Required]+ string
+ |
+
+ name is the name of the given metric + |
+
selector + meta/v1.LabelSelector
+ |
+
+ selector represents the label selector that could be used to select +this metric, and will generally just be the selector passed in to +the query used to fetch this metric. +When left blank, only the metric's Name will be used to gather metrics. + |
+
Package v1beta1 is the v1beta1 version of the external metrics API.
+ + +## Resource Types + + +- [ExternalMetricValue](#external-metrics-k8s-io-v1beta1-ExternalMetricValue) +- [ExternalMetricValueList](#external-metrics-k8s-io-v1beta1-ExternalMetricValueList) + + + +## `ExternalMetricValue` {#external-metrics-k8s-io-v1beta1-ExternalMetricValue} + + +**Appears in:** + +- [ExternalMetricValueList](#external-metrics-k8s-io-v1beta1-ExternalMetricValueList) + + +ExternalMetricValue is a metric value for external metric +A single metric value is identified by metric name and a set of string labels. +For one metric there can be multiple values with different sets of labels.
+ + +Field | Description |
---|---|
apiVersion string | external.metrics.k8s.io/v1beta1 |
kind string | ExternalMetricValue |
metricName [Required]+ string
+ |
+
+ the name of the metric + |
+
metricLabels [Required]+ map[string]string
+ |
+
+ a set of labels that identify a single time series for the metric + |
+
timestamp [Required]+ meta/v1.Time
+ |
+
+ indicates the time at which the metrics were produced + |
+
window [Required]+ int64
+ |
+
+ indicates the window ([Timestamp-Window, Timestamp]) from +which these metrics were calculated, when returning rate +metrics calculated from cumulative metrics (or zero for +non-calculated instantaneous metrics). + |
+
value [Required]+ k8s.io/apimachinery/pkg/api/resource.Quantity
+ |
+
+ the value of the metric + |
+
ExternalMetricValueList is a list of values for a given metric for some set labels
+ + +Field | Description |
---|---|
apiVersion string | external.metrics.k8s.io/v1beta1 |
kind string | ExternalMetricValueList |
metadata [Required]+ meta/v1.ListMeta
+ |
++ No description provided. | +
items [Required]+ []ExternalMetricValue
+ |
+
+ value of the metric matching a given set of labels + |
+
Package v1beta1 is the v1beta1 version of the metrics API.
+ + +## Resource Types + + +- [NodeMetrics](#metrics-k8s-io-v1beta1-NodeMetrics) +- [NodeMetricsList](#metrics-k8s-io-v1beta1-NodeMetricsList) +- [PodMetrics](#metrics-k8s-io-v1beta1-PodMetrics) +- [PodMetricsList](#metrics-k8s-io-v1beta1-PodMetricsList) + + + +## `NodeMetrics` {#metrics-k8s-io-v1beta1-NodeMetrics} + + +**Appears in:** + +- [NodeMetricsList](#metrics-k8s-io-v1beta1-NodeMetricsList) + + +NodeMetrics sets resource usage metrics of a node.
+ + +Field | Description |
---|---|
apiVersion string | metrics.k8s.io/v1beta1 |
kind string | NodeMetrics |
metadata + meta/v1.ObjectMeta
+ |
+
+ Standard object's metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +Refer to the Kubernetes API documentation for the fields of themetadata field. |
+
timestamp [Required]+ meta/v1.Time
+ |
+
+ The following fields define time interval from which metrics were +collected from the interval [Timestamp-Window, Timestamp]. + |
+
window [Required]+ meta/v1.Duration
+ |
++ No description provided. | +
usage [Required]+ core/v1.ResourceList
+ |
+
+ The memory usage is the memory working set. + |
+
NodeMetricsList is a list of NodeMetrics.
+ + +Field | Description |
---|---|
apiVersion string | metrics.k8s.io/v1beta1 |
kind string | NodeMetricsList |
metadata [Required]+ meta/v1.ListMeta
+ |
+
+ Standard list metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+
items [Required]+ []NodeMetrics
+ |
+
+ List of node metrics. + |
+
PodMetrics sets resource usage metrics of a pod.
+ + +Field | Description |
---|---|
apiVersion string | metrics.k8s.io/v1beta1 |
kind string | PodMetrics |
metadata + meta/v1.ObjectMeta
+ |
+
+ Standard object's metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +Refer to the Kubernetes API documentation for the fields of themetadata field. |
+
timestamp [Required]+ meta/v1.Time
+ |
+
+ The following fields define time interval from which metrics were +collected from the interval [Timestamp-Window, Timestamp]. + |
+
window [Required]+ meta/v1.Duration
+ |
++ No description provided. | +
containers [Required]+ []ContainerMetrics
+ |
+
+ Metrics for all containers are collected within the same time window. + |
+
PodMetricsList is a list of PodMetrics.
+ + +Field | Description |
---|---|
apiVersion string | metrics.k8s.io/v1beta1 |
kind string | PodMetricsList |
metadata [Required]+ meta/v1.ListMeta
+ |
+
+ Standard list metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+
items [Required]+ []PodMetrics
+ |
+
+ List of pod metrics. + |
+
ContainerMetrics sets resource usage metrics of a container.
+ + +Field | Description |
---|---|
name [Required]+ string
+ |
+
+ Container name corresponding to the one from pod.spec.containers. + |
+
usage [Required]+ core/v1.ResourceList
+ |
+
+ The memory usage is the memory working set. + |
+