Skip to content

docs: update mutual TLS reference in high availability documentation#5120

Merged
SoloJacobs merged 1 commit intoprometheus:mainfrom
TheMeier:issues/5109
Mar 28, 2026
Merged

docs: update mutual TLS reference in high availability documentation#5120
SoloJacobs merged 1 commit intoprometheus:mainfrom
TheMeier:issues/5109

Conversation

@TheMeier
Copy link
Copy Markdown
Contributor

@TheMeier TheMeier commented Mar 27, 2026

Fixes: #5109

Pull Request Checklist

Please check all the applicable boxes.

Which user-facing changes does this PR introduce?

NONE

Summary by CodeRabbit

  • Documentation
    • Updated the mutual TLS reference in the high-availability guide to point to the external Prometheus “Gossip Traffic” documentation.
    • Updated the “Further Reading” entry to link to the GitHub-hosted Secure Cluster Traffic design document for additional details.

@TheMeier TheMeier requested a review from a team as a code owner March 27, 2026 18:51
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 382d70ed-ff65-4899-823f-30ff70732ae8

📥 Commits

Reviewing files that changed from the base of the PR and between 4fc00c0 and d436e31.

📒 Files selected for processing (1)
  • docs/high_availability.md
✅ Files skipped from review due to trivial changes (1)
  • docs/high_availability.md

📝 Walkthrough

Walkthrough

A broken documentation link in the high availability guide was corrected. The internal reference to a non-existent secure cluster traffic design document was replaced with an external Prometheus documentation link pointing to the Gossip Traffic section for mutual TLS configuration.

Changes

Cohort / File(s) Summary
Documentation Link Fix
docs/high_availability.md
Replaced internal broken link (../doc/design/secure-cluster-traffic.md) with external Prometheus "Gossip Traffic" URL for mutual TLS in the "Security" section; updated "Further Reading" entry to the GitHub-hosted secure-cluster-traffic.md URL.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Hopped through docs with careful ears,

Found a path that led to tears.
Swapped the broken for the true,
Now the cluster hops anew. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating mutual TLS references in high availability documentation.
Description check ✅ Passed The description includes the linked issue (#5109), completes relevant checklist items, and indicates no user-facing changes.
Linked Issues check ✅ Passed The PR updates broken links in docs/high_availability.md to point to correct documentation, directly addressing issue #5109's requirement to fix 404 errors.
Out of Scope Changes check ✅ Passed All changes are focused on fixing broken documentation links in high_availability.md, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@TheMeier TheMeier changed the title docs: update mutual TLS reference in high availability documenta… docs: update mutual TLS reference in high availability documentation Mar 27, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/high_availability.md (1)

482-484: ⚠️ Potential issue | 🟠 Major

Another broken secure-cluster-traffic reference remains in “Further Reading.”

Line 483 still points to ../doc/design/secure-cluster-traffic.md, which resolves to a 404. This leaves the linked issue only partially fixed in this file.

Suggested doc fix
-- [Secure Cluster Traffic Design](../doc/design/secure-cluster-traffic.md)
+- [Gossip Traffic (mutual TLS)](https://prometheus.io/docs/alerting/latest/https/#gossip-traffic)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/high_availability.md` around lines 482 - 484, Update the broken link
"../doc/design/secure-cluster-traffic.md" in the "Further Reading" list so it
points to the correct relative location of the secure-cluster-traffic doc
(replace the broken target string "../doc/design/secure-cluster-traffic.md" with
the correct path, e.g., "design/secure-cluster-traffic.md" or
"./design/secure-cluster-traffic.md") in docs/high_availability.md where the
list item currently appears.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/high_availability.md`:
- Line 364: The sentence "See [Gossip
Traffic](https://prometheus.io/docs/alerting/latest/https/#gossip-traffic)
section for configuration mutual TLS." is awkward; change it to a clearer
phrasing such as "See the Gossip Traffic section for configuring mutual TLS" or
"See the Gossip Traffic section for mutual TLS configuration" to improve
readability and grammar.

---

Outside diff comments:
In `@docs/high_availability.md`:
- Around line 482-484: Update the broken link
"../doc/design/secure-cluster-traffic.md" in the "Further Reading" list so it
points to the correct relative location of the secure-cluster-traffic doc
(replace the broken target string "../doc/design/secure-cluster-traffic.md" with
the correct path, e.g., "design/secure-cluster-traffic.md" or
"./design/secure-cluster-traffic.md") in docs/high_availability.md where the
list item currently appears.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8cd687b1-a189-4f24-a484-bcb6718892ef

📥 Commits

Reviewing files that changed from the base of the PR and between 4189528 and 4fc00c0.

📒 Files selected for processing (1)
  • docs/high_availability.md

…tion

Fixes: prometheus#5109
Signed-off-by: Christoph Maser <christoph.maser+github@gmail.com>
@SoloJacobs SoloJacobs merged commit 4aac704 into prometheus:main Mar 28, 2026
7 checks passed
SoloJacobs added a commit to SoloJacobs/alertmanager that referenced this pull request Apr 6, 2026
* [CHANGE] `go get github.com/prometheus/alertmanager/ui` will now fail as compiled UI assets are no longer checked into the repository. Downstream builds that rely on these assets being present in the source tree must now build the UI from source. prometheus#5113
* [CHANGE] The '--enable-feature=auto-gomaxprocs' option is deprecated and will be removed in v0.33. This flag currently has no effect and can be safely removed from any startup scripts. prometheus#5090
* [CHANGE] Update internal function signatures across multiple packages. This affects any project that integrates `Alertmanager` code.
* [ENHANCEMENT] Add static asset caching. prometheus#5113
* [ENHANCEMENT] Reduce memory allocations through pre-sizing collections and batch allocation. prometheus#5020
* [ENHANCEMENT] Replace help with documentation in navigation bar. prometheus#4943
* [ENHANCEMENT] docs(ha): Update high availability documentation. prometheus#5136
* [ENHANCEMENT] docs: Add `auth_secret_file` for smtp in document. prometheus#5036
* [ENHANCEMENT] docs: Add description for global `telegram_bot_token`. prometheus#5114
* [ENHANCEMENT] docs: Add note about notifier timeouts. prometheus#5077
* [ENHANCEMENT] docs: Fix `force_implicit_tls` config field name. prometheus#5030
* [ENHANCEMENT] docs: Link community supported integrations. prometheus#4978
* [ENHANCEMENT] docs: Remove duplicate header. prometheus#5034
* [ENHANCEMENT] docs: Update mutual tls reference in high availability documentation. prometheus#5120
* [ENHANCEMENT] tracing: Use noop spans when tracing disabled. prometheus#5118
* [FEATURE] Add silence annotations. prometheus#4965
* [FEATURE] Add silence logging option. prometheus#4163
* [FEATURE] Add support for multiple matcher set silences. prometheus#4957
* [FEATURE] Add the reason for notifying in dedup stage. prometheus#4971
* [FEATURE] mattermost: Flatten attachments into top-level config. prometheus#5009
* [FEATURE] mattermost: Support global webhook url. prometheus#4998
* [FEATURE] slack: Add default color from template. prometheus#5014
* [FEATURE] slack: Allow receiver to edit existing messages. prometheus#5007
* [FEATURE] template: Add dict, map and append functions. prometheus#5093
* [FEATURE] webhook: Add full payload templating support for notifier. prometheus#5011
* [BUGFIX] config: Check for empty cluster tls client config. prometheus#5126
* [BUGFIX] config: Don't crash upon reading empty config for notifier. prometheus#4979
* [BUGFIX] config: Fix ipv6 address handling in hostport.string(). prometheus#5040
* [BUGFIX] mattermost: Omit empty text field in notifications. prometheus#4985
* [BUGFIX] telegram: Send fallback message when notification exceeds character limit. prometheus#5074
* [BUGFIX] ui: Fix escaping for matcher values with quotes. prometheus#4862
* [BUGFIX] ui: Handle special chars in silence regex-matchers. prometheus#4942
* [BUGFIX] ui: Support utf-8 label names in matchers. prometheus#5089

Signed-off-by: Solomon Jacobs <solomonjacobs@protonmail.com>
@SoloJacobs SoloJacobs mentioned this pull request Apr 6, 2026
ultrotter pushed a commit that referenced this pull request Apr 7, 2026
* [CHANGE] `go get github.com/prometheus/alertmanager/ui` will now fail as compiled UI assets are no longer checked into the repository. Downstream builds that rely on these assets being present in the source tree must now build the UI from source. #5113
* [CHANGE] The '--enable-feature=auto-gomaxprocs' option is deprecated and will be removed in v0.33. This flag currently has no effect and can be safely removed from any startup scripts. #5090
* [CHANGE] Update internal function signatures across multiple packages. This affects any project that integrates `Alertmanager` code.
* [ENHANCEMENT] Add static asset caching. #5113
* [ENHANCEMENT] Reduce memory allocations through pre-sizing collections and batch allocation. #5020
* [ENHANCEMENT] Replace help with documentation in navigation bar. #4943
* [ENHANCEMENT] docs(ha): Update high availability documentation. #5136
* [ENHANCEMENT] docs: Add `auth_secret_file` for smtp in document. #5036
* [ENHANCEMENT] docs: Add description for global `telegram_bot_token`. #5114
* [ENHANCEMENT] docs: Add note about notifier timeouts. #5077
* [ENHANCEMENT] docs: Fix `force_implicit_tls` config field name. #5030
* [ENHANCEMENT] docs: Link community supported integrations. #4978
* [ENHANCEMENT] docs: Remove duplicate header. #5034
* [ENHANCEMENT] docs: Update mutual tls reference in high availability documentation. #5120
* [ENHANCEMENT] tracing: Use noop spans when tracing disabled. #5118
* [FEATURE] Add silence annotations. #4965
* [FEATURE] Add silence logging option. #4163
* [FEATURE] Add support for multiple matcher set silences. #4957
* [FEATURE] Add the reason for notifying in dedup stage. #4971
* [FEATURE] mattermost: Flatten attachments into top-level config. #5009
* [FEATURE] mattermost: Support global webhook url. #4998
* [FEATURE] slack: Add default color from template. #5014
* [FEATURE] slack: Allow receiver to edit existing messages. #5007
* [FEATURE] template: Add dict, map and append functions. #5093
* [FEATURE] webhook: Add full payload templating support for notifier. #5011
* [BUGFIX] config: Check for empty cluster tls client config. #5126
* [BUGFIX] config: Don't crash upon reading empty config for notifier. #4979
* [BUGFIX] config: Fix ipv6 address handling in hostport.string(). #5040
* [BUGFIX] mattermost: Omit empty text field in notifications. #4985
* [BUGFIX] telegram: Send fallback message when notification exceeds character limit. #5074
* [BUGFIX] ui: Fix escaping for matcher values with quotes. #4862
* [BUGFIX] ui: Handle special chars in silence regex-matchers. #4942
* [BUGFIX] ui: Support utf-8 label names in matchers. #5089

Signed-off-by: Solomon Jacobs <solomonjacobs@protonmail.com>
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.

broken links to "secure cluster traffic"

2 participants