Add a config walkthrough and update the readme

A helful community member rightly pointed out that configuring the
adapter was a bit confusing, and a step-by-step example would be useful.
This adds such an example, and links to it from relevant places.
This commit is contained in:
Solly Ross 2018-08-07 15:11:47 -04:00
parent c912ebed77
commit 9f08038f07
4 changed files with 248 additions and 1 deletions

View file

@ -1,6 +1,10 @@
Metrics Discovery and Presentation Configuration
================================================
*If you want a full walkthrough of configuring the adapter for a sample
metric, please read the [configuration
walkthrough](/docs/config-walkthrough.md)*
The adapter determines which metrics to expose, and how to expose them,
through a set of "discovery" rules. Each rule is executed independently
(so make sure that your rules are mutually exclusive), and specifies each
@ -123,6 +127,9 @@ resource:
These two can be combined, so you can specify both a template and some
individual overrides.
The resources mentioned can be any resource available in your kubernetes
cluster, as long as you've got a corresponding label.
Naming
------