Skip to content

Commit

Permalink
metric-server README file is added (#27)
Browse files Browse the repository at this point in the history
README file is added
  • Loading branch information
nogodan committed Dec 22, 2020
1 parent 420cfaa commit 6973986
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 1 deletion.
2 changes: 1 addition & 1 deletion charts/metric-server/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
name: karbon-metric-server
home: https://github.com/nutanix/helm
description: A Metric Server Helm chart for Nutanix Karbon
version: 0.1.1
version: 0.1.2
appVersion: 0.3.7
kubeVersion: ">= 1.13.0"
maintainers:
Expand Down
60 changes: 60 additions & 0 deletions charts/metric-server/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Karbon metric server Helm chart

This is the helm chart tailored for Nutanix Karbon

# Kubernetes Metrics Server

Metrics Server is a scalable, efficient source of container resource metrics for Kubernetes
built-in autoscaling pipelines.

Metrics Server collects resource metrics from Kubelets and exposes them in Kubernetes apiserver through [Metrics API]
for use by [Horizontal Pod Autoscaler] and [Vertical Pod Autoscaler]. Metrics API can also be accessed by `kubectl top`,
making it easier to debug autoscaling pipelines.

Metrics Server is not meant for non-autoscaling purposes. For example, don't use it to forward metrics to monitoring solutions, or as a source of monitoring solution metrics.

Metrics Server offers:
- A single deployment that works on most clusters
- Scalable support up to 5,000 node clusters
- Resource efficiency: Metrics Server uses 1m core of CPU and 3 MB of memory per node

For the detail info, please visit below official git repo
https://github.com/kubernetes-sigs/metrics-server

## Prerequisites

- Kubernetes 1.13 or later
- Created base on metrics server 0.3.7 version
- Metrics API group/version(metrics.k8s.io/v1beta1)
- Karbon 2.1.x or later

## Installing the Chart

To install the chart with the name `metric-server`:

```console
helm repo add nutanix https://nutanix.github.io/helm/

helm install --name metric-server nutanix/metric-server
```

## Uninstalling the Chart

To uninstall/delete the `metric-server` deployment:

```console
$ helm delete metric-server
```

## Modified Configuration for Karbon deployment

```console
deployment.yaml
...
args:
- --cert-dir=/tmp
- --secure-port=4443
- --kubelet-insecure-tls
- --kubelet-preferred-address-types=InternalIP
...
``

0 comments on commit 6973986

Please sign in to comment.