CNTRLPLANE-3291: docs: add upstream documentation for configurable log levels - #9193
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@vsolanki12: This pull request references OCPSTRAT-3156 which is a valid jira issue. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
Bot
added
the
do-not-merge/work-in-progress
|
Pipeline controller notification For optional jobs, comment This repository is configured in: LGTM mode |
|
Skipping CI for Draft Pull Request. |
|
Warning Review limit reached
Next review available in: 25 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Repository YAML (base), Central YAML (inherited) Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis change adds documentation for configuring HostedCluster control plane component log levels through 🚥 Pre-merge checks | ✅ 11✅ Passed checks (11 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
openshift-ci
Bot
added
area/documentation
9834775 to
74adfb8
Compare
vsolanki12
changed the title
|
@vsolanki12: This pull request references CNTRLPLANE-3291 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/content/how-to/configure-ocp-components/configurable-log-levels.md`:
- Around line 45-46: Update the configurable log-level documentation around the
absent logLevel behavior and KAS annotation handling to clarify that the
component’s built-in default is restored only when neither the API field nor the
deprecated KAS annotation is present. Explicitly instruct users to remove the
annotation as well when resetting kube-apiserver to its default.
- Around line 64-68: Revise the documentation around the `logLevel`
rolling-restart statement to place all prerequisites before any zero-downtime
claim. Add the required rollout strategy, readiness/liveness probes, disruption
budget, scheduling spread or affinity, and supported management-cluster
topology; then qualify the HA guarantee as conditional on those prerequisites
rather than relying on replica counts alone.
- Around line 5-7: Update the Tech Preview warning in the configurable log
levels documentation to remove the unsupported
HCPUserFacingOperatorLogs/TechPreviewNoUpgrade prerequisite and state the actual
supported feature-set requirement. Do not reference feature gates that are not
defined in the repository.
- Around line 25-34: Update the configurable log levels documentation to remove
unsupported operatorConfiguration component examples and references, including
the listed control-plane and OAuth fields. Ensure the component table,
configuration examples, API reference, and reset instructions only use fields
defined under spec.operatorConfiguration, or remove the feature documentation if
no supported API field exists.
- Around line 38-44: Update the configurable log levels documentation to remove
or revise any claim that operatorConfiguration supports
spec.operatorConfiguration.<component>.logLevel for kube-apiserver, etcd, or
other components beyond ClusterVersionOperator, ClusterNetworkOperator, and
IngressOperator. Document only the supported component fields and identify the
kube-apiserver annotation path as deprecated where applicable.
🪄 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: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: e8bfcee9-1cbc-47ec-a53c-f10a38e0cc9e
📒 Files selected for processing (2)
docs/content/how-to/configure-ocp-components/configurable-log-levels.mddocs/mkdocs.yml
74adfb8 to
a182379
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/content/how-to/configure-ocp-components/configurable-log-levels.md (1)
17-19: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winResolve the reported MD046 warnings.
markdownlint-cli2reports these fenced blocks because the configured style expects indented code blocks. Convert these blocks to the configured style, or verify that fenced blocks are intentionally allowed and update the shared configuration.Static analysis reports MD046 for these ranges. Based on learnings, keep the required four-space indentation inside the
!!!admonitions.Also applies to: 54-56, 60-62, 72-74, 80-82, 97-121
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/content/how-to/configure-ocp-components/configurable-log-levels.md` around lines 17 - 19, Resolve MD046 in configurable-log-levels.md by converting the reported fenced code blocks to indented code blocks, including every listed range; preserve four-space indentation for code nested inside !!! admonitions.Sources: Learnings, Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/content/how-to/configure-ocp-components/configurable-log-levels.md`:
- Line 84: Update the reset guidance in the configurable log levels
documentation to replace “verbosity flag” with component-neutral wording such as
“component-specific log-level setting” or “flag or environment variable,” while
preserving the existing reconciliation and built-in-default behavior.
---
Nitpick comments:
In `@docs/content/how-to/configure-ocp-components/configurable-log-levels.md`:
- Around line 17-19: Resolve MD046 in configurable-log-levels.md by converting
the reported fenced code blocks to indented code blocks, including every listed
range; preserve four-space indentation for code nested inside !!! admonitions.
🪄 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: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 779e1671-31a7-42ba-ba93-d35318abaa32
📒 Files selected for processing (2)
docs/content/how-to/configure-ocp-components/configurable-log-levels.mddocs/mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/mkdocs.yml
a182379 to
d52fc83
Compare
…ANE-3291) Add documentation for the configurable log levels feature under how-to/configure-ocp-components/. Covers supported components, log level mappings, oc patch examples, reset procedure, KAS annotation deprecation, and API reference. Includes Tech Preview warning and feature gate prerequisite per existing gated feature documentation pattern. Signed-off-by: Vimal Solanki <vsolanki@redhat.com>
d52fc83 to
3c1126e
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/content/how-to/configure-ocp-components/configurable-log-levels.md (1)
17-19: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winResolve the reported MD046 warnings.
markdownlint-cli2reports MD046 for these fenced code blocks. Convert them to the configured indented style, or verify that fenced blocks are intended and update the lint configuration.Based on learnings, keep four-space indentation for MkDocs admonition bodies.
Also applies to: 54-56, 60-62, 74-76, 82-84, 99-123
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/content/how-to/configure-ocp-components/configurable-log-levels.md` around lines 17 - 19, Resolve the MD046 warnings in the affected code blocks by converting fenced blocks to the configured indented style, while preserving four-space indentation for code inside MkDocs admonition bodies. Apply this consistently to the referenced blocks and avoid changing the commands or surrounding documentation.Sources: Learnings, Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/content/how-to/configure-ocp-components/configurable-log-levels.md`:
- Around line 17-19: Resolve the MD046 warnings in the affected code blocks by
converting fenced blocks to the configured indented style, while preserving
four-space indentation for code inside MkDocs admonition bodies. Apply this
consistently to the referenced blocks and avoid changing the commands or
surrounding documentation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: c3bc7357-9cc0-48fe-a09c-cac9753d294b
📒 Files selected for processing (2)
docs/content/how-to/configure-ocp-components/configurable-log-levels.mddocs/mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/mkdocs.yml
openshift-ci
Bot
removed
the
do-not-merge/work-in-progress
celebdor
left a comment
celebdor
left a comment
There was a problem hiding this comment.
/lgtm
Thanks for the docs. Maybe the api reference at the end is not needed but I don't mind having it.
|
Pipeline controller notification No second-stage tests were triggered for this PR. This can happen when:
Use |
georgelipceanu
left a comment
georgelipceanu
left a comment
There was a problem hiding this comment.
/verified by @georgelipceanu
Manually verified the functionality of this PR by serving MKDocs locally and by confirming that:
- The Configurable Log Levels for Control Plane Components (Tech Preview) is listed under Configure OCP components in the sidebar nav group of the How-to guides page, and that this was the last option in this nav group and the page itself was accessible
- The
configurable-log-levels.mdpage loaded without critical errors and without any rendering mistakes - The
aggregated-docs.mdfile has a corresponding section that is identical to the content inconfirgurable-log-levels.md
openshift-ci-robot
added
the
verified
|
@georgelipceanu: This PR has been marked as verified by DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
celebdor
removed
the
verified
/verified by @georgelipceanu Also verified actual steps in docs, covered by #8878 (review) (verification comment here) |
openshift-ci-robot
added
the
verified
|
@georgelipceanu: This PR has been marked as verified by DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
csrwng
added
the
approved
|
[APPROVALNOTIFIER] This PR is APPROVED Approval requirements bypassed by manually added approval. This pull-request has been approved by: celebdor, vsolanki12 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
/test ci/prow/unit |
|
/test unit |
|
@vsolanki12: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
5 participants
What this PR does / why we need it:
Adds upstream documentation for the configurable log levels feature (CNTRLPLANE-3291) at hypershift.pages.dev under "Configure OCP components".
The doc covers:
oc patchexamples for setting, checking, and resetting log levelsHCPUserFacingOperatorLogsfeature gate prerequisiteFollows existing gated feature documentation pattern (same as Etcd Snapshot Backup Tech Preview docs).
Which issue(s) this PR fixes:
Fixes CNTRLPLANE-3291
Special notes for your reviewer:
Checklist:
Summary by CodeRabbit