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

Change 'metrics' to 'metrics.enabled' in helm chart documentation #981

Merged
merged 3 commits into from
Oct 17, 2022
Merged

Change 'metrics' to 'metrics.enabled' in helm chart documentation #981

merged 3 commits into from
Oct 17, 2022

Conversation

Kasape
Copy link
Contributor

@Kasape Kasape commented Oct 17, 2022

Description

According to the original documentation of values in README.md, one might think metrics are enabled just by defining the metrics key like this:

metrics:
    serviceMonitor:
        enabled: true
        interval: 30s
    prometheusRule:
        enabled: true

However, templates/service.yaml and other files don't check if the metrics key exists, but how the enabled value is set. The same value is defined in values.yaml. The documentation has been modified to make it clear that the value metrics.enabled must be explicitly defined.

metrics:
    enabled: true
    serviceMonitor:
        enabled: true
        interval: 30s
    prometheusRule:
        enabled: true

Checklist

  • I have reviewed the contributing guidelines.
  • I have included unit tests for my changes or additions.
  • I have successfully run make test-docker with my changes.
  • I have manually tested all relevant modes of the change in this PR.
  • I have updated the documentation.
  • I have updated the changelog.

Questions or Comments

Copy link
Owner

@jertel jertel left a comment

Choose a reason for hiding this comment

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

Thanks for clarifying this!

@jertel jertel merged commit a2a943b into jertel:master Oct 17, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants