Skip to content

Commit

Permalink
Merge pull request #113 from DirectXMan12/release/v0.3.0-alpha.1
Browse files Browse the repository at this point in the history
Prep for v0.3.0 release
  • Loading branch information
DirectXMan12 authored Aug 29, 2018
2 parents 697f4e7 + 4a2c4f1 commit 668f948
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Compatibility matrix:

Metrics Server | Metrics API group/version | Supported Kubernetes version
---------------|---------------------------|-----------------------------
0.3.x | `metrics.k8s.io/v1beta1` | 1.8+
0.2.x | `metrics.k8s.io/v1beta1` | 1.8+
0.1.x | `metrics/v1alpha1` | 1.7

Expand All @@ -35,3 +36,43 @@ $ kubectl create -f deploy/1.7/
# Kubernetes > 1.8
$ kubectl create -f deploy/1.8+/
```

## Flags

Metrics Server supports all the standard Kubernetes API server flags, as
well as the standard Kubernetes `glog` logging flags. The most
commonly-used ones are:

- `--logtostderr`: log to standard error instead of files in the
container. You generally want this on.

- `--v=<X>`: set log verbosity. It's generally a good idea to run a log
level 1 or 2 unless you're encountering errors. At log level 10, large
amounts of diagnostic information will be reported, include API request
and response bodies, and raw metric results from Kubelet.

- `--secure-port=<port>`: set the secure port. If you're not running as
root, you'll want to set this to something other than the default (port
443).

- `--tls-cert-file`, `--tls-private-key-file`: the serving certificate and
key files. If not specified, self-signed certificates will be
generated, but it's recommended that you use non-self-signed
certificates in production.

Additionally, Metrics Server defines a number of flags for configuring its
behavior:

- `--metric-resolution=<duration>`: the interval at which metrics will be
scraped from Kubelets (defaults to 60s).

- `--kubelet-insecure-tls`: skip verifying Kubelet CA certificates. Not
recommended for production usage, but can be useful in test clusters
with self-signed Kubelet serving certificates.

- `--kubelet-port`: the port to use to connect to the Kubelet (defaults to
the default secure Kubelet port, 10250).

- `--kubelet-preferred-address-types`: the order in which to consider
different Kubelet node address types when connecting to Kubelet.
Functions similarly to the flag of the same name on the API server.

0 comments on commit 668f948

Please sign in to comment.