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

@ -146,7 +146,10 @@ You may also need to modify the ConfigMap containing the metrics discovery
configuration. If you're using the Prometheus configuration described
above, it should work out of the box in common cases. Otherwise, read the
[configuration documentation](/docs/config.md) to learn how to configure
the adapter for your particular metrics and labels.
the adapter for your particular metrics and labels. The [configuration
walkthrough](/docs/config-walkthrough.md) gives an end-to-end
configuration tutorial for configure the adapter for a scenario similar to
this one.
### The Registered API ###