NO-ISSUE: Update InfraEnv CR description

[pastequo]

Update kube ocumentation for InfraEnv CR

List all the issues related to this PR

• New Feature
• Enhancement
• Bug fix
• Tests
• Documentation
• CI/CD

What environments does this code impact?

• Automation (CI, tools, etc)
• Cloud
• Operator Managed Deployments
• None

How was this code tested?

• assisted-test-infra environment
• dev-scripts environment
• Reviewer's test appreciated
• Waiting for CI to do a full test run
• Manual (Elaborate on how it was tested)
• No tests needed

Checklist

• Title and description added to both, commit and PR.
• Relevant issues have been associated (see CONTRIBUTING guide)
• This change does not require a documentation update (docstring, docs, README, etc)
• Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

• Are the title and description (in both PR and commit) meaningful and clear?
• Is there a bug required (and linked) for this change?
• Should this PR be backported?

Summary by CodeRabbit

• Documentation
  • Clarified that OSImageVersion cannot be specified together with ClusterRef when creating an InfraEnv.
• Chores
  • Added a new public message constant for InfraEnv availability and cleaned up related formatting and comment wording for clarity.

[openshift-ci-robot]

@pastequo: This pull request explicitly references no jira issue.

Details

In response to this:

Update kube ocumentation for InfraEnv CR

List all the issues related to this PR

• New Feature
• Enhancement
• Bug fix
• Tests
• Documentation
• CI/CD

What environments does this code impact?

• Automation (CI, tools, etc)
• Cloud
• Operator Managed Deployments
• None

How was this code tested?

• assisted-test-infra environment
• dev-scripts environment
• Reviewer's test appreciated
• Waiting for CI to do a full test run
• Manual (Elaborate on how it was tested)
• No tests needed

Checklist

• Title and description added to both, commit and PR.
• Relevant issues have been associated (see CONTRIBUTING guide)
• This change does not require a documentation update (docstring, docs, README, etc)
• Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

• Are the title and description (in both PR and commit) meaningful and clear?
• Is there a bug required (and linked) for this change?
• Should this PR be backported?

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]

Caution

Review failed

The head commit changed during the review from 8c9eca8 to 268fe6d.

Walkthrough

Added a new exported constant InfraEnvAvailableMessage to the InfraEnv Go types. Updated the OSImageVersion field description in CRD manifests to clarify the constraint applies when creating an InfraEnv. No runtime behavior or validation logic changes.

Changes

Cohort / File(s)	Summary
Go Type Definitions api/v1beta1/infraenv_types.go	Added exported constant InfraEnvAvailableMessage = "InfraEnv is available". Minor spacing/reformatting inside the const block; updated OSImageVersion comment to reference creation-time constraint.
CRD Schema Definitions config/crd/bases/agent-install.openshift.io_infraenvs.yaml, config/crd/resources.yaml, deploy/olm-catalog/manifests/agent-install.openshift.io_infraenvs.yaml	Refined OSImageVersion description to state it cannot be specified with ClusterRef when creating an InfraEnv; changes are documentation-only text updates.

Sequence Diagram(s)

(omitted — changes are documentation and a single-constant addition; no new multi-component control flow)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: updating InfraEnv CR description, which aligns with the changeset focusing on documentation updates to CRD descriptions.
Description check	✅ Passed	The PR description follows the template structure with documentation type selected and testing marked as 'No tests needed', though the narrative summary is minimal and contains a typo ('kube ocumentation').
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Stable And Deterministic Test Names	✅ Passed	PR does not modify any test files; changes are limited to Go source file and YAML documentation files.
Test Structure And Quality	✅ Passed	The PR is documentation-focused with no test file modifications, making the test quality check inapplicable as explicitly stated in the PR description.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[ddmitrie]

I suppose, it should be "while creating an InfraEnv"

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (3)

config/crd/resources.yaml (1)

3230-3230: Same grammar issue as in api/v1beta1/infraenv_types.go line 124.

This manifest is auto-generated from the Go source. Fix the comment in infraenv_types.go and regenerate.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@config/crd/resources.yaml` at line 3230, Update the grammar in the Go source
comment in infraenv_types.go (the InfraEnv type comment around the
OSImageVersion and ClusterRef fields) so it reads correctly (e.g., "Note:
OSImageVersion can't be specified together with ClusterRef when creating an
InfraEnv."). After fixing the comment in infraenv_types.go, regenerate the CRD
manifest so config/crd/resources.yaml contains the corrected sentence.

config/crd/bases/agent-install.openshift.io_infraenvs.yaml (1)

221-221: Same grammar issue as in api/v1beta1/infraenv_types.go line 124.

Auto-generated from Go source — regenerate after fixing the source comment.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@config/crd/bases/agent-install.openshift.io_infraenvs.yaml` at line 221, The
generated CRD contains a grammar issue in the source comment for the InfraEnv
type: change the phrasing that reads "OSImageVersion can't be specified along
with ClusterRef while creating a InfraEnv." in api/v1beta1/infraenv_types.go
(the comment associated with InfraEnv / the OSImageVersion and ClusterRef
fields) to a grammatically correct form such as "OSImageVersion cannot be
specified together with ClusterRef when creating an InfraEnv."; update that
comment on the InfraEnv/OSImageVersion/ClusterRef declaration and then
regenerate the CRD so config/crd/bases/agent-install.openshift.io_infraenvs.yaml
is updated.

deploy/olm-catalog/manifests/agent-install.openshift.io_infraenvs.yaml (1)

231-231: Same grammar issue as in api/v1beta1/infraenv_types.go line 124.

Regenerate after fixing the source comment.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@deploy/olm-catalog/manifests/agent-install.openshift.io_infraenvs.yaml` at
line 231, Update the source comment for the InfraEnv API (in
api/v1beta1/infraenv_types.go) that documents OSImageVersion to correct the
grammar and then regenerate the manifests; change the phrase "can't be specified
along with ClusterRef while creating a InfraEnv." to "cannot be specified along
with ClusterRef when creating an InfraEnv." and re-run the codegen that produces
deploy/olm-catalog/manifests/agent-install.openshift.io_infraenvs.yaml so the
fixed wording appears in the manifest.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@api/v1beta1/infraenv_types.go`:
- Line 124: Update the comment above the InfraEnv type to fix the article:
change "a InfraEnv" to "an InfraEnv" in the line that currently reads "Note:
OSImageVersion can't be specified along with ClusterRef while creating a
InfraEnv." so the comment correctly reads "... while creating an InfraEnv." This
will ensure the generated CRD YAML manifests receive the corrected wording for
the InfraEnv type.

---

Duplicate comments:
In `@config/crd/bases/agent-install.openshift.io_infraenvs.yaml`:
- Line 221: The generated CRD contains a grammar issue in the source comment for
the InfraEnv type: change the phrasing that reads "OSImageVersion can't be
specified along with ClusterRef while creating a InfraEnv." in
api/v1beta1/infraenv_types.go (the comment associated with InfraEnv / the
OSImageVersion and ClusterRef fields) to a grammatically correct form such as
"OSImageVersion cannot be specified together with ClusterRef when creating an
InfraEnv."; update that comment on the InfraEnv/OSImageVersion/ClusterRef
declaration and then regenerate the CRD so
config/crd/bases/agent-install.openshift.io_infraenvs.yaml is updated.

In `@config/crd/resources.yaml`:
- Line 3230: Update the grammar in the Go source comment in infraenv_types.go
(the InfraEnv type comment around the OSImageVersion and ClusterRef fields) so
it reads correctly (e.g., "Note: OSImageVersion can't be specified together with
ClusterRef when creating an InfraEnv."). After fixing the comment in
infraenv_types.go, regenerate the CRD manifest so config/crd/resources.yaml
contains the corrected sentence.

In `@deploy/olm-catalog/manifests/agent-install.openshift.io_infraenvs.yaml`:
- Line 231: Update the source comment for the InfraEnv API (in
api/v1beta1/infraenv_types.go) that documents OSImageVersion to correct the
grammar and then regenerate the manifests; change the phrase "can't be specified
along with ClusterRef while creating a InfraEnv." to "cannot be specified along
with ClusterRef when creating an InfraEnv." and re-run the codegen that produces
deploy/olm-catalog/manifests/agent-install.openshift.io_infraenvs.yaml so the
fixed wording appears in the manifest.

---

ℹ️ Review info

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 7ca2b35 and 8abf810.

⛔ Files ignored due to path filters (1)

• vendor/github.com/openshift/assisted-service/api/v1beta1/infraenv_types.go is excluded by !**/vendor/**, !vendor/**

📒 Files selected for processing (4)

• api/v1beta1/infraenv_types.go
• config/crd/bases/agent-install.openshift.io_infraenvs.yaml
• config/crd/resources.yaml
• deploy/olm-catalog/manifests/agent-install.openshift.io_infraenvs.yaml

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 43.10%. Comparing base (7ca2b35) to head (268fe6d).
⚠️ Report is 16 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #9938      +/-   ##
==========================================
- Coverage   44.07%   43.10%   -0.98%     
==========================================
  Files         414      414              
  Lines       72202    73830    +1628     
==========================================
  Hits        31824    31824              
- Misses      37502    39130    +1628     
  Partials     2876     2876              

see 3 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[pastequo]

/retest

[pastequo]

/override ci/prow/edge-e2e-ai-operator-disconnected-capi ci/prow/edge-subsystem-kubeapi-aws

[openshift-ci]

@pastequo: Overrode contexts on behalf of pastequo: ci/prow/edge-e2e-ai-operator-disconnected-capi, ci/prow/edge-subsystem-kubeapi-aws

Details

In response to this:

/override ci/prow/edge-e2e-ai-operator-disconnected-capi ci/prow/edge-subsystem-kubeapi-aws

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.

[CrystalChun]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CrystalChun, pastequo

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [CrystalChun,pastequo]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[pastequo]

/retest required

[pastequo]

/retest

[pastequo]

/retest

[openshift-ci]

@pastequo: all tests passed!

Full PR test history. Your PR dashboard.

Details

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. I understand the commands that are listed here.