Add scheme to DNS service discovery docs #3450
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
pracucci
requested changes
Nov 15, 2022
There was a problem hiding this comment.
Thanks for opening this PR! The issue you raised is interesting. The doc page docs/sources/operators-guide/configure/about-dns-service-discovery.md is a generic one about the DNS-based service discovery. In the example you edited there (memcached one) it's correct to not have a schema (e.g. memcached protocol is not HTTP based). However, when you use the DNS-based service discovery with the alertmanager, you need to set the scheme there.
We can do few things to clarify it:
- In
docs/sources/operators-guide/configure/about-dns-service-discovery.md, mention the scheme is required when referencing the config option-ruler.alertmanager-url - We can improve the CLI flag description here to clarify it there as well
daquinoaldo
changed the title
|
Thank you, @pracucci. I've updated the PR. |
pracucci
approved these changes
Nov 16, 2022
There was a problem hiding this comment.
LGTM. Could you run make reference-help doc to update the auto-generated doc, please? @osg-grafana can you take a final look at the copy, please?
The missing schema leads to errors like `improperly formatted alertmanager URL "alertmanager.mimir.svc.cluster.local:8080/alertmanager" (maybe the scheme is missing?)`.
osg-grafana
reviewed
Nov 16, 2022
docs/sources/operators-guide/configure/about-dns-service-discovery.md
Outdated
Show resolved
Hide resolved
osg-grafana
approved these changes
Nov 16, 2022
jhesketh
approved these changes
Nov 17, 2022
…very.md Co-authored-by: Ursula Kallio <[email protected]>
manohar-koukuntla
added a commit
to manohar-koukuntla/mimir
that referenced
this pull request
Nov 17, 2022
Co-authored-by: Marco Pracucci <[email protected]> Add scheme to DNS service discovery docs (grafana#3450) * Add schema to DNS service discovery docs The missing schema leads to errors like `improperly formatted alertmanager URL "alertmanager.mimir.svc.cluster.local:8080/alertmanager" (maybe the scheme is missing?)`. * Update docs/sources/operators-guide/configure/about-dns-service-discovery.md Co-authored-by: Ursula Kallio <[email protected]> Co-authored-by: Marco Pracucci <[email protected]> Co-authored-by: Ursula Kallio <[email protected]> Alertmanager configuration validate-only mode grafana#3437 (grafana#3440) * Alertmanager configuration validate-only mode grafana#3437 * Documentation update for alertmanager config validation * Update changelog * Update docs/sources/operators-guide/architecture/components/alertmanager.md Co-authored-by: Ursula Kallio <[email protected]> * Swap a command line flag for a verify subcommand. * Update pkg/mimirtool/commands/alerts.go Co-authored-by: Marco Pracucci <[email protected]> * For loop to reduce repetition * Use review suggestion. * Make alertmanager verification docs more consistent. Bump from enhancement to feature. * fmt * Fix the golint issue. * Fix typo * Make doc result (as specified by lint process) Co-authored-by: Ursula Kallio <[email protected]> Co-authored-by: Marco Pracucci <[email protected]> lint fix
pracucci
pushed a commit
that referenced
this pull request
Nov 17, 2022
* add runbook urls for alerts Co-authored-by: Joshua Hesketh <[email protected]> Update CHANGELOG.md Co-authored-by: Joshua Hesketh <[email protected]> * Update CHANGELOG.md Co-authored-by: Marco Pracucci <[email protected]> Add scheme to DNS service discovery docs (#3450) * Add schema to DNS service discovery docs The missing schema leads to errors like `improperly formatted alertmanager URL "alertmanager.mimir.svc.cluster.local:8080/alertmanager" (maybe the scheme is missing?)`. * Update docs/sources/operators-guide/configure/about-dns-service-discovery.md Co-authored-by: Ursula Kallio <[email protected]> Co-authored-by: Marco Pracucci <[email protected]> Co-authored-by: Ursula Kallio <[email protected]> Alertmanager configuration validate-only mode #3437 (#3440) * Alertmanager configuration validate-only mode #3437 * Documentation update for alertmanager config validation * Update changelog * Update docs/sources/operators-guide/architecture/components/alertmanager.md Co-authored-by: Ursula Kallio <[email protected]> * Swap a command line flag for a verify subcommand. * Update pkg/mimirtool/commands/alerts.go Co-authored-by: Marco Pracucci <[email protected]> * For loop to reduce repetition * Use review suggestion. * Make alertmanager verification docs more consistent. Bump from enhancement to feature. * fmt * Fix the golint issue. * Fix typo * Make doc result (as specified by lint process) Co-authored-by: Ursula Kallio <[email protected]> Co-authored-by: Marco Pracucci <[email protected]> lint fix Co-authored-by: Joshua Hesketh <[email protected]>
masonmei
pushed a commit
to udmire/mimir
that referenced
this pull request
Dec 16, 2022
* Add schema to DNS service discovery docs The missing schema leads to errors like `improperly formatted alertmanager URL "alertmanager.mimir.svc.cluster.local:8080/alertmanager" (maybe the scheme is missing?)`. * Update docs/sources/operators-guide/configure/about-dns-service-discovery.md Co-authored-by: Ursula Kallio <[email protected]> Co-authored-by: Marco Pracucci <[email protected]> Co-authored-by: Ursula Kallio <[email protected]>
masonmei
pushed a commit
to udmire/mimir
that referenced
this pull request
Dec 16, 2022
* add runbook urls for alerts Co-authored-by: Joshua Hesketh <[email protected]> Update CHANGELOG.md Co-authored-by: Joshua Hesketh <[email protected]> * Update CHANGELOG.md Co-authored-by: Marco Pracucci <[email protected]> Add scheme to DNS service discovery docs (grafana#3450) * Add schema to DNS service discovery docs The missing schema leads to errors like `improperly formatted alertmanager URL "alertmanager.mimir.svc.cluster.local:8080/alertmanager" (maybe the scheme is missing?)`. * Update docs/sources/operators-guide/configure/about-dns-service-discovery.md Co-authored-by: Ursula Kallio <[email protected]> Co-authored-by: Marco Pracucci <[email protected]> Co-authored-by: Ursula Kallio <[email protected]> Alertmanager configuration validate-only mode grafana#3437 (grafana#3440) * Alertmanager configuration validate-only mode grafana#3437 * Documentation update for alertmanager config validation * Update changelog * Update docs/sources/operators-guide/architecture/components/alertmanager.md Co-authored-by: Ursula Kallio <[email protected]> * Swap a command line flag for a verify subcommand. * Update pkg/mimirtool/commands/alerts.go Co-authored-by: Marco Pracucci <[email protected]> * For loop to reduce repetition * Use review suggestion. * Make alertmanager verification docs more consistent. Bump from enhancement to feature. * fmt * Fix the golint issue. * Fix typo * Make doc result (as specified by lint process) Co-authored-by: Ursula Kallio <[email protected]> Co-authored-by: Marco Pracucci <[email protected]> lint fix Co-authored-by: Joshua Hesketh <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The missing schema leads to errors like
improperly formatted alertmanager URL "alertmanager.mimir.svc.cluster.local:8080/alertmanager" (maybe the scheme is missing?).CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]