You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The changes in this PR were primarily made by an AI agent on behalf of the PR author.
Do your changes match any of the following descriptions?
Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch
Summary by CodeRabbit
Documentation
Updated HAProxy examples with management-only binding, credential placeholders, and guidance for protecting access; the stats example no longer grants backend-control access.
Updated Prometheus and Grafana setup guidance with safer access and credential settings, including password setup for new and existing installations.
Clarified that firewalls should remain enabled and that required ports, especially management and monitoring ports, should be restricted to trusted sources.
Tests
Added checks for security guidance and settings across the HAProxy, Grafana, Prometheus, and firewall deployment guides.
It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.
The deployment guides update firewall, Prometheus, Grafana, and HAProxy configuration and access guidance. A Python script checks the guides for specified security guidance and prohibited configuration examples.
The guide requires an enabled firewall or equivalent access control. It limits required ports to trusted sources and management ports to management networks. It removes instructions to disable firewalld or use the permissive trusted zone.
Prometheus and Grafana configuration deploy-monitoring-services.md
Prometheus binds to loopback and no longer enables the admin API. The Grafana example uses credential placeholders. The guide updates password setup and login instructions for new and existing instances.
HAProxy Stats uses a management IP and credential placeholders. The guide adds network and authentication guidance and removes authenticated backend administration. The script checks required and prohibited guidance across the HAProxy, Grafana, Prometheus, and firewall guides.
The guides now push readers toward custom credentials and restricted access, but a few gaps remain. The Grafana password file has no permission advice, and the firewall examples still open ports to the whole public zone without a reload step. Prometheus proxy access needs an external URL note. These are low-impact documentation fixes that can be made before or shortly after merge.
Pre-merge checks: 5
Check name
Status
Explanation
Title check
The title "docs: harden monitoring admin access" matches the main change. The PR changes HAProxy Stats, Prometheus, Grafana, and firewall guidance to restrict admin access and remove default credentia…
Description check
The description fills in the required sections. It lists the changes, the validation commands, the affected versions, the related links, and the AI agent involvement. It also includes the first-time c…
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title "docs: harden monitoring admin access" matches the main change. The PR changes HAProxy Stats, Prometheus, Grafana, and firewall guidance to restrict admin access and remove default credentials. The title is concise and specific, and it follows the conventional commit style.
Full details: Description check
Explanation
The description fills in the required sections. It lists the changes, the validation commands, the affected versions, the related links, and the AI agent involvement. It also includes the first-time contributor checklist item and the change-type checkboxes from the template. The Contributor License Agreement box is not ticked, and the description does not state whether the validation commands passed. Neither gap blocks the check.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 1 files. (3 skipped: 3 unsupported.)
Finishing Touches
Generate unit tests (beta)
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Reviewing files that changed from the base of the PR and between b4c6071 and e0c0f72.
Files selected for processing: 3
best-practices/haproxy-best-practices.md
deploy-monitoring-services.md
scripts/test-admin-credential-guidance.py
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
This pull-request has been approved by: Once this PR has been reviewed and has the lgtm label, please ask for approval from lilin90. For more information see the Code Review Process. Please ensure that each of them provides their approval before proceeding.
The full list of commands accepted by this bot can be found here.
Details
Needs approval from an approver in each of these files:
Reviewing files that changed from the base of the PR and between e0c0f72 and ac93cf8.
Files selected for processing: 3
best-practices/haproxy-best-practices.md
deploy-monitoring-services.md
scripts/test-admin-credential-guidance.py
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
ti-chi-botBot
added
size/L
Denotes a PR that changes 100-499 lines, ignoring generated files.
and removed
size/M
Denotes a PR that changes 30-99 lines, ignoring generated files.
labels
Nov 5, 2026
lilin90
changed the title
docs: require custom admin credentials
docs: harden monitoring admin access
Nov 5, 2026
Reviewing files that changed from the base of the PR and between ac93cf8 and dcf1a22.
Files selected for processing: 4
best-practices/haproxy-best-practices.md
check-before-deployment.md
deploy-monitoring-services.md
scripts/test-admin-credential-guidance.py
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.
This file contains hidden or 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
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.
What is changed, added, or deleted? (Required)
Validation:
python3 scripts/test-admin-credential-guidance.py./scripts/markdownlint best-practices/haproxy-best-practices.md check-before-deployment.md deploy-monitoring-services.mdgit diff --checkWhich TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit