Add metrics authentication documentation #367
Open
Conversation
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
This commit adds detailed documentation covering Shifu's metrics authentication and authorization system, including: - Introduction to authentication and authorization features - Default HTTP configuration and rationale - Step-by-step guide for granting metrics access - Optional HTTPS setup with cert-manager - Troubleshooting common issues - Complete Prometheus integration example 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for Shifu's metrics authentication and authorization system introduced in Kubebuilder v4. The documentation provides detailed guidance on securing metrics access through RBAC and configuring monitoring tools like Prometheus.
Key changes include:
- Introduction of authentication/authorization concepts and default HTTP configuration
- Step-by-step RBAC setup instructions for granting metrics access to ServiceAccounts
- Optional HTTPS configuration with cert-manager for production environments
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This commit adds the Chinese (Simplified) translation of the metrics authentication documentation to support bilingual documentation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[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.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR adds comprehensive documentation for Shifu's metrics authentication and authorization system. The documentation covers:
This documentation helps users understand how to securely access metrics from Shifu's controller and configure their monitoring tools (like Prometheus) to scrape metrics with proper authentication.
Which issue(s) this PR fixes:
Fixes #
How is this PR tested:
Special notes for your reviewer:
The documentation follows the existing structure and style of Shifu docs. It includes practical examples and troubleshooting guidance based on common scenarios users encounter when setting up metrics collection.
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: