Skip to content

Commit

Permalink
grammatical changes to resource metrics pipeline
Browse files Browse the repository at this point in the history
Made some grammatical changes to the text.
  • Loading branch information
beccabau committed Aug 13, 2020
1 parent 7faf15a commit 2a19a35
Showing 1 changed file with 12 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,29 @@ content_type: concept
<!-- overview -->

Resource usage metrics, such as container CPU and memory usage,
are available in Kubernetes through the Metrics API. These metrics can be either accessed directly
by user, for example by using `kubectl top` command, or used by a controller in the cluster, e.g.
are available in Kubernetes through the Metrics API. These metrics can be accessed either directly
by the user, i.e. by using the `kubectl top` command, or by a controller in the cluster, e.g.
Horizontal Pod Autoscaler, to make decisions.

<!-- body -->

## The Metrics API

Through the Metrics API you can get the amount of resource currently used
Through the Metrics API, you can get the amount of resource currently used
by a given node or a given pod. This API doesn't store the metric values,
so it's not possible for example to get the amount of resources used by a
so it's not possible, for example, to get the amount of resources used by a
given node 10 minutes ago.

The API is no different from any other API:

- it is discoverable through the same endpoint as the other Kubernetes APIs under `/apis/metrics.k8s.io/` path
- it offers the same security, scalability and reliability guarantees
- it is discoverable through the same endpoint as the other Kubernetes APIs under the path: `/apis/metrics.k8s.io/`
- it offers the same security, scalability, and reliability guarantees

The API is defined in [k8s.io/metrics](https://github.com/kubernetes/metrics/blob/master/pkg/apis/metrics/v1beta1/types.go)
repository. You can find more information about the API there.

{{< note >}}
The API requires metrics server to be deployed in the cluster. Otherwise it will be not available.
The API requires the metrics server to be deployed in the cluster. Otherwise it will be not available.
{{< /note >}}

## Measuring Resource Usage
Expand All @@ -49,20 +49,18 @@ The kubelet chooses the window for the rate calculation.
Memory is reported as the working set, in bytes, at the instant the metric was collected.
In an ideal world, the "working set" is the amount of memory in-use that cannot be freed under memory pressure.
However, calculation of the working set varies by host OS, and generally makes heavy use of heuristics to produce an estimate.
It includes all anonymous (non-file-backed) memory since kubernetes does not support swap.
It includes all anonymous (non-file-backed) memory since Kubernetes does not support swap.
The metric typically also includes some cached (file-backed) memory, because the host OS cannot always reclaim such pages.

## Metrics Server

[Metrics Server](https://github.com/kubernetes-incubator/metrics-server) is a cluster-wide aggregator of resource usage data.
It is deployed by default in clusters created by `kube-up.sh` script
as a Deployment object. If you use a different Kubernetes setup mechanism you can deploy it using the provided
By default, it is deployed in clusters created by `kube-up.sh` script
as a Deployment object. If you use a different Kubernetes setup mechanism, you can deploy it using the provided
[deployment components.yaml](https://github.com/kubernetes-sigs/metrics-server/releases) file.

Metric server collects metrics from the Summary API, exposed by
[Kubelet](/docs/reference/command-line-tools-reference/kubelet/) on each node.

Metrics Server is registered with the main API server through
Metrics Server collects metrics from the Summary API, exposed by
[Kubelet](/docs/reference/command-line-tools-reference/kubelet/) on each node, and is registered with the main API server via
[Kubernetes aggregator](/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/).

Learn more about the metrics server in
Expand Down

0 comments on commit 2a19a35

Please sign in to comment.