docs: Add Operations Guide (Prometheus Metrics & Troubleshooting) #2048
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.
This PR introduces the Markdown files for a new "Operations Guide" under the
docs/operations/
directory. This guide is intended to help users and operators effectively monitor, troubleshoot, and maintain OpenKruise installations.Key Documentation Files Added:
docs/operations/README.md
: An introductory page for the operations guide.docs/operations/prometheus-metrics.md
:ServiceMonitor
and example alerting rules.docs/operations/troubleshooting.md
:Purpose:
These files provide the core content for an operational guide. The navigation for these documents on the
openkruise.io
website will be added via a separate Pull Request to theopenkruise/openkruise.io
repository.Related Issue (Clarification):
This PR provides operational documentation. It does not directly address or fix feature request #1672 ("Support for configmaps grayscale publishing"), which is a feature implementation task. A pr from openkruise.io will be linked to this pr which would be a feature implementing pr.
How to Review:
docs/operations/
for clarity, accuracy, and completeness.Looking forward to feedback!