You can find the user guide in the official Kubernetes documentation.
The detailed design of the project can be found in the following docs:
For the broader view of monitoring in Kubernetes take a look into Monitoring architecture
Compatibility matrix:
| Metrics Server | Metrics API group/version | Supported Kubernetes version |
|---|---|---|
| 0.2.x | metrics.k8s.io/v1beta1 |
1.8+ |
| 0.1.x | metrics/v1alpha1 |
1.7 |
In order to deploy metrics-server in your cluster run the following command from the top-level directory of this repository:
# Kubernetes 1.7
$ kubectl create -f deploy/1.7/
# Kubernetes > 1.8
$ kubectl create -f deploy/1.8+/