DOC: Update the cluster-configuration.md: FG names are case-insensitive - #4392
Conversation
kubevirt-prow
Bot
added
release-note-none
📝 WalkthroughWalkthroughFeature gate documentation now describes case-insensitive names and uniqueness requirements. Conversion fuzz generation adds a mixed-case unknown feature gate. Documentation generation now produces separate v1 and v1beta1 API references with refreshed schemas and examples. Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Warning Review ran into problems🔥 ProblemsLinked repositories: Your configuration references 13 linked repositories, but your current plan allows 10. Analyzed Linked repositories: Public OSS repositories can only analyze public repositories installed in this organization. Analyzed 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/cluster-configuration.md`:
- Around line 72-90: Expand the v1beta1 case-sensitivity note in the
feature-gates documentation with a concrete differently cased name example and
its resulting behavior. Explicitly state that differently cased duplicate names
are rejected in v1beta1, distinguishing this from the case-insensitive v1
behavior.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 529f5f00-b47c-46ab-9e9b-7da7d774ee1e
📒 Files selected for processing (2)
api/v1beta1/conversion_fuzz_test.godocs/cluster-configuration.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
kubevirt/hyperconverged-cluster-operator(manual)kubevirt/monitoring(manual)
Coverage Report for CI Build 29191098812Coverage remained the same at 81.536%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
|
hco-e2e-operator-sdk-gcp lane succeeded. |
|
@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-aws, ci/prow/hco-e2e-operator-sdk-aws, ci/prow/hco-e2e-operator-sdk-azure, ci/prow/hco-e2e-operator-sdk-sno-aws, ci/prow/hco-e2e-upgrade-prev-operator-sdk-aws, ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-aws 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 kubernetes-sigs/prow repository. |
|
hco-e2e-kv-smoke-azure lane succeeded. |
|
@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-kv-smoke-gcp 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 kubernetes-sigs/prow repository. |
|
hco-e2e-consecutive-operator-sdk-upgrades-azure lane succeeded. |
|
@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-aws, ci/prow/hco-e2e-upgrade-prev-operator-sdk-aws, ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-aws 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 kubernetes-sigs/prow repository. |
|
hco-e2e-kv-smoke-azure lane succeeded. |
|
@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-kv-smoke-gcp 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 kubernetes-sigs/prow repository. |
|
/override-bot |
|
hco-e2e-operator-sdk-sno-azure lane succeeded. |
|
@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-operator-sdk-aws, ci/prow/hco-e2e-operator-sdk-sno-aws 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 kubernetes-sigs/prow repository. |
|
hco-e2e-upgrade-operator-sdk-azure lane succeeded. |
|
@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-operator-sdk-aws 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 kubernetes-sigs/prow repository. |
|
hco-e2e-upgrade-prev-operator-sdk-sno-azure lane succeeded. |
|
@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-aws 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 kubernetes-sigs/prow repository. |
|
/retest |
2 similar comments
|
/retest |
|
/retest |
orenc1
left a comment
orenc1
left a comment
There was a problem hiding this comment.
nice.
please see couple of comments below
| state: Disabled | ||
| ``` | ||
|
|
||
| > **Note**: The feature gate names in the `v1beta1` API version are *case-sensitive*. |
There was a problem hiding this comment.
if this file is only about v1 api version, why do we have a note here about v1beta1?
it can confuse the readers.
|
|
||
| > **Note**: The feature gate names in the `v1beta1` API version are *case-sensitive*. | ||
| > | ||
| > **Note**: It is not allowed to create more than one feature gate with the same name (case-insensitive). This kind of |
There was a problem hiding this comment.
the word create here is a bit inaccurate, since the CEL validation applies for any action, such as patch or update, not just create.
maybe:
| > **Note**: It is not allowed to create more than one feature gate with the same name (case-insensitive). This kind of | |
| > **Note**: It is not allowed to have more than one feature gate with the same name (case-insensitive). This kind of |
or:
| > **Note**: It is not allowed to create more than one feature gate with the same name (case-insensitive). This kind of | |
| > **Note**: Feature gate names must be unique (case-insensitive). |
There was a problem hiding this comment.
Changed to the 2nd option.
Signed-off-by: Nahshon Unna Tsameret <nunnatsa@redhat.com>
In order to match to the cluster-configuration files, rename the `docs/api.md` file to `docs/api-v1beta1.md`, and `docs/api-v1.md`, to `docs/api.md`. Signed-off-by: Nahshon Unna Tsameret <nunnatsa@redhat.com>
Signed-off-by: Nahshon Unna Tsameret <nunnatsa@redhat.com>
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/api.md`:
- Line 181: Update the Go doc comment for FeatureGates to replace the generic
“here” link text with descriptive “HCO Feature Gates” text and adjust the
sentence to match the suggested wording. Do not edit the generated docs/api.md
directly; ensure regeneration produces the accessible link text.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 5b2e492b-4670-4b68-b975-5337c92e8ab8
📒 Files selected for processing (6)
Makefileapi/v1beta1/conversion_fuzz_test.godocs/api-v1.mddocs/api-v1beta1.mddocs/api.mddocs/cluster-configuration.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
kubevirt/hyperconverged-cluster-operator(manual)kubevirt/monitoring(manual)
💤 Files with no reviewable changes (1)
- docs/api-v1.md
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/cluster-configuration.md
- Makefile
- api/v1beta1/conversion_fuzz_test.go
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: orenc1 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 |
kubevirt-prow
Bot
added
the
approved
|
hco-e2e-consecutive-operator-sdk-upgrades-azure lane succeeded. |
|
@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-aws, ci/prow/hco-e2e-operator-sdk-aws, ci/prow/hco-e2e-operator-sdk-sno-aws, ci/prow/hco-e2e-upgrade-operator-sdk-sno-aws, ci/prow/hco-e2e-upgrade-prev-operator-sdk-aws 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 kubernetes-sigs/prow repository. |
|
/retest |
|
/test hco-e2e-upgrade-operator-sdk-aws hco-e2e-upgrade-operator-sdk-azure hco-e2e-upgrade-prev-operator-sdk-sno-aws hco-e2e-upgrade-prev-operator-sdk-sno-azure |
|
@nunnatsa: The specified target(s) for Use 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 kubernetes-sigs/prow repository. |
|
@nunnatsa: The following tests failed, say
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. |
|
hco-e2e-upgrade-operator-sdk-azure lane succeeded. |
|
@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-operator-sdk-aws, ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-aws 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 kubernetes-sigs/prow repository. |
4 participants
Follow-up #4384: update the user guide to include the fact that the feature gate names are now case-insensitive.
Also, in order to match to the cluster-configuration files, and to reflect that the default API version is now
v1, rename thedocs/api.mdfile todocs/api-v1beta1.md, anddocs/api-v1.md, todocs/api.md.Release note: