Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update existing documentation after removal of prometheus pod annotations #1770

Closed
3 tasks done
mflendrich opened this issue Aug 27, 2021 · 2 comments
Closed
3 tasks done
Assignees

Comments

@mflendrich
Copy link
Member

mflendrich commented Aug 27, 2021

Is there an existing issue for this?

  • I have searched the existing issues

Problem Statement

KIC 2.0 removes prometheus.io/* annotations from the KIC/proxy pod, in favor of a PodMonitor.
There are some bits of documentation (most notably the Grafana guide) impacted by this.

Also, ensure that the KIC metrics (not only the proxy metrics) are referenced.

Proposed Solution

Audit our monitoring documentation (docs.konghq.com, chart repo) for dependency on those annotations, and fix these to work with the changes introduced in 2.0.

Additional information

No response

Acceptance Criteria

  • Each bit of documentation (in particular, the Grafana guide) that requires Prometheus works with the changes to KIC pod annotations introduced in KIC 2.0
  • Monitoring documentation that predates KIC 2.0 and only showcased proxy metrics now exposes the ingress controller metrics as well.
@mflendrich mflendrich added this to the Blockers for KIC 2.0 GA milestone Aug 27, 2021
@rainest rainest self-assigned this Sep 29, 2021
@rainest
Copy link
Contributor

rainest commented Sep 30, 2021

Kong/docs.konghq.com#3288 (specifically Kong/docs.konghq.com@7e8628c) revises the docs guide to use the Prometheus Operator. That guide was already using a ServiceMonitor from the chart and just updates it slightly to match the new Prometheus' selection criteria.

On the chart end, we probably want to sub in the PodMonitor with a renamed values.yaml setting (deprecating the old key/using it as an alias for now).

@rainest
Copy link
Contributor

rainest commented Sep 30, 2021

Nevermind: the chart can just keep using a ServiceMonitor since the magic of the Prometheus Operator is such that it's just looking for the associated Deployment and doesn't care that the port isn't actually part of that Service (which makes sense--the actual metrics port doesn't have to be exposed via a Service). The changes we already made to the chart work; controller metrics do show up in Prometheus with the docs as-is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants