[docs] Config Walkthroughs and FAQs #95

DirectXMan12 · 2018-08-07T19:50:58Z

This adds a more hands-on configuration example, plus a few FAQs.

The config docs had a find/replace error in the naming section, leading to an erroneus `as` clause. This fixes that.

DirectXMan12 · 2018-08-07T19:51:18Z

Thanks to @aabed and @atomaras for rightly pointing out that configuration
and labeling needed a bit more documentation!

atomaras · 2018-08-07T21:15:00Z

I like it!
One suggestion would be to give a more prominent position to the HPA in the walkthrough.
As a user this is my initial viewpoint and my ultimate goal.
What should my HPA yaml look like for it to actually work with custom metrics?
Then I would say that this HPA yaml will translate to hpa controller making this rest call to figure out the metric i.e $KUBERNETES/apis/custom.metrics.k8s.io/v1beta1/namespaces/production/pods/*/http_requests_per_second

Then I would jump into how custom metrics can be configured to expose this exact URL for HPA to be happy.
This HPA intro (goal first approach) will give readers all the context they need to be able to follow along and understand why we do all these complex configurations.

tanner-bruce · 2018-08-08T20:46:35Z

README.md

+and more information about configuring the adapter in the [docs](/docs/config.md).
+
+Next, check if the discovery information looks right.  You should see the metrics showing
+up as associated with the resources you expect at. `/apis/custom.metrics.k8s.io/v1beta1/`.


This could maybe be kubectl get --raw /apis/custom.metrics.k8s.io/v1beta1 | jq .

Agree, at least it should mention kubectl get --raw somewhere here.

tanner-bruce · 2018-08-08T20:50:12Z

docs/config-walkthrough.md

+- seriesQuery: 'http_requests_total{kubernetes_namespace!="",kubernetes_pod_name!=""}'
+  resources:
+    overrides:
+      kubernetes_namespace: {resource: "namespace"}


Is there somewhere that lists the available resource types? It might be good to include a link to that around this section.

There is a command, but it can change at any time due to CRDs, aggregated API servers, etc. I'll add a note about it.

tanner-bruce · 2018-08-08T20:50:32Z

docs/config-walkthrough.md

+      kubernetes_pod_name: {resource: "pod"}
+```
+
+This says that each label represents its corresponding reosurce. Since the


typo: reosurce

tanner-bruce · 2018-08-08T20:52:10Z

docs/config-walkthrough.md

+Since we're only working with a single metric anyway, we could replace
+`<<.Series>>` with `http_requests_total`.
+
+Now, if we put run an instance of the Prometheus adapter with this


if we put run

tanner-bruce · 2018-08-08T20:53:46Z

docs/walkthrough.md

-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


for configuring

tanner-bruce · 2018-08-08T20:54:22Z

docs/walkthrough.md

+### Quantity Values
+
+Notice that the API uses Kubernetes-style quantities to describe metric
+values.  These quantities use SI suffixes instead of decimal points.  The


There are two spaces after some periods here

discordianfish · 2018-08-20T16:53:24Z

README.md

+
+First, check your configuration.  Does it select your metric?  You can find the
+[default configuration](/deploy/custom-metrics-config-map.yaml) in the deploy directory,
+and more information about configuring the adapter in the [docs](/docs/config.md).


It would be helpful to have a command to return all metrics. Not only the registered metric names but the actual per pod/object metrics. That would help to validate this.

I agree. I'm currently struggling with the config and was hoping there's an easy way to list what it can "see".

Ah, never mind ... found what I was looking for in https://github.com/DirectXMan12/k8s-prometheus-adapter/pull/95/files#r208729936.

This only shows what metrics it knows about but you still might not have a metric with the right labels for a particular HPA. In that case it would be useful to have a expression that also returns the per-object/pod metrics.

Yeah, initially I came to the same conclusion eventually. 😅

can you file a separate issue for that?

discordianfish · 2018-08-20T16:57:29Z

Great, that will help a lot!

I'd also add some words around using object vs pod metrics. Another thing I haven't figured out (not needing it right now) is how to make the HPA scale down of a metric goes up.

tanner-bruce · 2018-08-20T20:07:30Z

README.md

+whichever metrics you want in the `metricsQuery`!  The series query can contain
+whichever metrics you want, as long as they have the right set of labels.
+
+For example, if you have two metrics `foo_total` and `foo_count`, you might write


It could be useful for clarity to say that foo_total has the label system_name which represents the actual node

DirectXMan12 · 2018-08-20T20:46:39Z

TODO: for me: make sure to add an FAQ entry about flickering metrics

itskingori · 2018-08-21T13:55:26Z

@DirectXMan12 This is really great, make the configuration clearer. Thank you! 🏆

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.

Quantities continue to confuse people, so adding concrete examples should help.

This adds some FAQs to the README containing information about certs, labelling, configuration, quantities, and multiple metrics.

This restructures the walkthrough to focus on the goal of scaling an application from the start. We start out with an application and an autoscaler, and then walk through how we can make the autoscaler actually able to function.

…ncy-openshift-4.15-ose-prometheus-adapter OCPBUGS-24155: Updating ose-prometheus-adapter-container image to be consistent with ART

Fix naming typo in the config docs

c912ebe

The config docs had a find/replace error in the naming section, leading to an erroneus `as` clause. This fixes that.

tanner-bruce reviewed Aug 8, 2018

View reviewed changes

DirectXMan12 force-pushed the docs/common-issues branch 2 times, most recently from 5485817 to 4579fc9 Compare August 8, 2018 21:14

DirectXMan12 mentioned this pull request Aug 9, 2018

rules do not seem to work #96

Closed

discordianfish reviewed Aug 20, 2018

View reviewed changes

tanner-bruce reviewed Aug 20, 2018

View reviewed changes

itskingori mentioned this pull request Aug 21, 2018

Add option for using prometheus labels instead running selector against API server #1

Closed

DirectXMan12 added 4 commits August 24, 2018 11:16

Add a config walkthrough and update the readme

9f08038

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.

Add a note on resource quanities to walkthrough

77614d1

Quantities continue to confuse people, so adding concrete examples should help.

Add some FAQs to the README

5118c9e

This adds some FAQs to the README containing information about certs, labelling, configuration, quantities, and multiple metrics.

Restructure walkthrough

a1f4aab

This restructures the walkthrough to focus on the goal of scaling an application from the start. We start out with an application and an autoscaler, and then walk through how we can make the autoscaler actually able to function.

DirectXMan12 force-pushed the docs/common-issues branch from 4579fc9 to a1f4aab Compare August 24, 2018 15:16

DirectXMan12 merged commit b755cf7 into master Aug 24, 2018

DirectXMan12 deleted the docs/common-issues branch August 24, 2018 15:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Config Walkthroughs and FAQs #95

[docs] Config Walkthroughs and FAQs #95

DirectXMan12 commented Aug 7, 2018

DirectXMan12 commented Aug 7, 2018 •

edited

Loading

atomaras commented Aug 7, 2018

tanner-bruce Aug 8, 2018

discordianfish Aug 20, 2018

tanner-bruce Aug 8, 2018

DirectXMan12 Aug 21, 2018

tanner-bruce Aug 8, 2018

tanner-bruce Aug 8, 2018

tanner-bruce Aug 8, 2018

tanner-bruce Aug 8, 2018

discordianfish Aug 20, 2018

itskingori Aug 21, 2018

itskingori Aug 21, 2018 •

edited

Loading

discordianfish Aug 21, 2018

itskingori Aug 21, 2018

DirectXMan12 Aug 24, 2018

discordianfish commented Aug 20, 2018

tanner-bruce Aug 20, 2018

DirectXMan12 commented Aug 20, 2018

itskingori commented Aug 21, 2018 •

edited

Loading

[docs] Config Walkthroughs and FAQs #95

[docs] Config Walkthroughs and FAQs #95

Conversation

DirectXMan12 commented Aug 7, 2018

DirectXMan12 commented Aug 7, 2018 • edited Loading

atomaras commented Aug 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itskingori Aug 21, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

discordianfish commented Aug 20, 2018

Choose a reason for hiding this comment

DirectXMan12 commented Aug 20, 2018

itskingori commented Aug 21, 2018 • edited Loading

DirectXMan12 commented Aug 7, 2018 •

edited

Loading

itskingori Aug 21, 2018 •

edited

Loading

itskingori commented Aug 21, 2018 •

edited

Loading