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

docs: Add release label to prometheusRule example #3346

Merged

Conversation

alexandre-allard
Copy link
Contributor

Component: docs

Context:
In the documentation we were missing the release label for PrometheusRules, so rules were not taken into account by Prometheus.

Summary:
Add the label in the example and a note to explain the labels are mandatory.

Acceptance criteria: n/a


Closes: #3293

This label is mandatory as it is use by Prometheus
to find the rules.

Refs: #3293
@alexandre-allard alexandre-allard requested a review from a team as a code owner May 3, 2021 09:42
@bert-e
Copy link
Contributor

bert-e commented May 3, 2021

Hello alexandre-allard-scality,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Status report is not available.

@bert-e
Copy link
Contributor

bert-e commented May 3, 2021

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

@alexandre-allard
Copy link
Contributor Author

/approve

@bert-e
Copy link
Contributor

bert-e commented May 3, 2021

In the queue

The changeset has received all authorizations and has been added to the
relevant queue(s). The queue(s) will be merged in the target development
branch(es) as soon as builds have passed.

The changeset will be merged in:

  • ✔️ development/2.9

The following branches will NOT be impacted:

  • development/1.0
  • development/1.1
  • development/1.2
  • development/1.3
  • development/2.0
  • development/2.1
  • development/2.2
  • development/2.3
  • development/2.4
  • development/2.5
  • development/2.6
  • development/2.7
  • development/2.8

There is no action required on your side. You will be notified here once
the changeset has been merged. In the unlikely event that the changeset
fails permanently on the queue, a member of the admin team will
contact you to help resolve the matter.

IMPORTANT

Please do not attempt to modify this pull request.

  • Any commit you add on the source branch will trigger a new cycle after the
    current queue is merged.
  • Any commit you add on one of the integration branches will be lost.

If you need this pull request to be removed from the queue, please contact a
member of the admin team now.

The following options are set: approve

@bert-e
Copy link
Contributor

bert-e commented May 3, 2021

I have successfully merged the changeset of this pull request
into targetted development branches:

  • ✔️ development/2.9

The following branches have NOT changed:

  • development/1.0
  • development/1.1
  • development/1.2
  • development/1.3
  • development/2.0
  • development/2.1
  • development/2.2
  • development/2.3
  • development/2.4
  • development/2.5
  • development/2.6
  • development/2.7
  • development/2.8

Please check the status of the associated issue None.

Goodbye alexandre-allard-scality.

@bert-e bert-e merged commit 8429ac0 into development/2.9 May 3, 2021
@bert-e bert-e deleted the documentation/3293-prometheusrules-mandatory-labels branch May 3, 2021 10:47
Comment on lines +400 to +401
All the labels in the example above are mandatory for Prometheus
to take the new rules into account.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That seems like an issue, no? The app deploys the rule, so app.kubernetes.io/name and app must be related to the app creating the rule, totally unrelated to prometheus-operator. Similarly, release should not be part of any (required) set of labels, and should not be prometheus-release.

In essence, we need to change the set of labels our prometheus-operator uses to filter out rules (and other objects) it should take into account, e.g., turn the selector into metalk8s.scality.com/monitor: "true" or something along those lines.

Copy link
Contributor Author

@alexandre-allard alexandre-allard May 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can easily be overridden using prometheus.prometheusSpec.ruleSelector in the charts/kube-prometheus-stack.yaml file:

prometheus:
  prometheusSpec:
    ruleSelector:
      matchLabels:
        metalk8s.scality.com/monitor: "true"

And we should probably do the same for ServiceMonitor.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, that's what we recommend in #2199
This PR was more about making sure our docs are accurate about the current state of the product (although it's debatable whether it's a useful change 😜)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oneline fix, does not cost much, at least now it's accurate even if it's ugly (which was already the case).

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

Successfully merging this pull request may close these issues.

[doc] PrometheusRules require specific labels
4 participants