⎈ k8s knowledge compiler

Kubernetes Metrics (v1beta1) [page]deterministic

reference

<p>Package v1beta1 is the v1beta1 version of the metrics API.</p>

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

<p>NodeMetrics sets resource usage metrics of a node.</p>

<table class="table"> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <tbody> <tr><td><code>apiVersion</code><br/>string</td><td><code>metrics.k8s.io/v1beta1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>NodeMetrics</code></td></tr> <tr><td><code>metadata</code><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a> </td> <td> <p>Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</p> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.</td> </tr> <tr><td><code>timestamp</code> <B>[Required]</B><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta"><code>meta/v1.Time</code></a> </td> <td> <p>The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp].</p> </td> </tr> <tr><td><code>window</code> <B>[Required]</B><br/> <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a> </td> <td> <span class="text-muted">No description provided.</span></td> </tr> <tr><td><code>usage</code> <B>[Required]</B><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcelist-v1-core"><code>core/v1.ResourceList</code></a> </td> <td> <p>The memory usage is the memory working set.</p> </td> </tr> </tbody> </table>

## `NodeMetricsList` {#metrics-k8s-io-v1beta1-NodeMetricsList}

<p>NodeMetricsList is a list of NodeMetrics.</p>

<table class="table"> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <tbody> <tr><td><code>apiVersion</code><br/>string</td><td><code>metrics.k8s.io/v1beta1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>NodeMetricsList</code></td></tr> <tr><td><code>metadata</code> <B>[Required]</B><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a> </td> <td> <p>Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</p> </td> </tr> <tr><td><code>items</code> <B>[Required]</B><br/> <a href="#metrics-k8s-io-v1beta1-NodeMetrics"><code>[]NodeMetrics</code></a> </td> <td> <p>List of node metrics.</p> </td> </tr> </tbody> </table>

## `PodMetrics` {#metrics-k8s-io-v1beta1-PodMetrics}

Appears in:

  • [PodMetricsList](#metrics-k8s-io-v1beta1-PodMetricsList)

<p>PodMetrics sets resource usage metrics of a pod.</p>

<table class="table"> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <tbody> <tr><td><code>apiVersion</code><br/>string</td><td><code>metrics.k8s.io/v1beta1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>PodMetrics</code></td></tr> <tr><td><code>metadata</code><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a> </td> <td> <p>Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</p> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.</td> </tr> <tr><td><code …(trimmed)

Sources

reference/external-api/metrics.v1beta1.md · docKubernetes Metrics (v1beta1)

Related (6)

part_of Resource typesdescribes conf=1

← all Docs