NE-2217: Add haproxyVersion in IngressController API

[jcmoraisjr]

Add haproxyVersion field in IngressController API. This field adds the ability to revert HAProxy version to a previous one, as well as pin the current HAProxy version during OCP upgrades.

EP: openshift/enhancements#1965

Jira: https://redhat.atlassian.net/browse/NE-2217

[openshift-merge-bot]

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

[openshift-ci]

Hello @jcmoraisjr! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

[openshift-ci-robot]

@jcmoraisjr: This pull request references NE-2217 which is a valid jira issue.

Details

In response to this:

Add haproxyOCPVersion field in IngressController API. This field adds the ability to revert HAProxy version to a previous one, as well as pin the current HAProxy version during OCP upgrades.

EP: openshift/enhancements#1965

Jira: https://redhat.atlassian.net/browse/NE-2217

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]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: c416230e-adc5-4525-b1f6-e343229d14dd

📥 Commits

Reviewing files that changed from the base of the PR and between d41e8c5 and bdd334a.

⛔ Files ignored due to path filters (7)

• openapi/generated_openapi/zz_generated.openapi.go is excluded by !openapi/**, !**/zz_generated*
• operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers-CustomNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers-DevPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers-TechPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• operator/v1/zz_generated.featuregated-crd-manifests.yaml is excluded by !**/zz_generated*
• operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/IngressControllerMultipleHAProxyVersions.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
• operator/v1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*

📒 Files selected for processing (2)

• operator/v1/tests/ingresscontrollers.operator.openshift.io/IngressControllerMultipleHAProxyVersions.yaml
• operator/v1/types_ingresscontroller.go

🚧 Files skipped from review as they are similar to previous changes (2)

• operator/v1/tests/ingresscontrollers.operator.openshift.io/IngressControllerMultipleHAProxyVersions.yaml
• operator/v1/types_ingresscontroller.go

---

📝 Walkthrough

Walkthrough

IngressController now includes a feature-gated haproxyVersion field in spec and an effectiveHAProxyVersion field in status. A new HAProxyVersion type restricts values to 2.8 and 3.2. The test CRD adds create and update cases covering supported values, omitted values, invalid values, and version changes under the IngressControllerMultipleHAProxyVersions feature gate.

🚥 Pre-merge checks | ✅ 15

✅ Passed checks (15 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main API change by adding haproxyVersion to IngressController.
Description check	✅ Passed	The description is directly related to the PR and explains the new haproxyVersion field's purpose.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names	✅ Passed	Added test names are static strings; none include generated suffixes, dates, UUIDs, node/namespace names, or other runtime-only values.
Test Structure And Quality	✅ Passed	Declarative CRD validation tests are single-purpose and match existing ingresscontroller fixtures; Ginkgo-specific cleanup/timeouts don't apply here.
Microshift Test Compatibility	✅ Passed	No new Ginkgo e2e specs were added; this PR only updates API types and CRD/YAML validation fixtures, so MicroShift compatibility is not implicated.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	Added YAML only exercises IngressController schema validation for haproxyVersion; no node counts, scheduling, or HA failover assumptions, so SNO-safe.
Topology-Aware Scheduling Compatibility	✅ Passed	PR only adds API schema/tests for haproxyVersion; no deployment, affinity, nodeSelector, replica, or topology logic changed.
Ote Binary Stdout Contract	✅ Passed	Changed files are API/schema/test data only; modified Go files contain no main/init/TestMain/BeforeSuite/RunSpecs or stdout logging.
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	No new Ginkgo e2e tests were added; the only test artifact is an operator API YAML validation spec with no IP or external connectivity assumptions.
No-Weak-Crypto	✅ Passed	Touched files only add HAProxy version API fields/tests; no MD5/SHA1/DES/RC4/3DES/Blowfish/ECB, custom crypto, or secret comparisons found.
Container-Privileges	✅ Passed	The PR only adds IngressController API fields and test CRD YAML; no privileged, hostPID/Network/IPC, SYS_ADMIN, root, or allowPrivilegeEscalation settings appear.
No-Sensitive-Data-In-Logs	✅ Passed	Diff scan of the changed files found no runtime log calls or additions exposing passwords, tokens, secrets, PII, or hostnames.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.12.2)

Error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented
The command is terminated due to an error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🤖 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 `@operator/v1/types_ingresscontroller.go`:
- Around line 2258-2271: The EffectiveHAProxyOCPVersion field is marked as
optional but its comment does not document the expected behavior when the field
is omitted. Update the comment for the EffectiveHAProxyOCPVersion field to
explicitly specify what it means when this status field is absent, such as
whether omission indicates an unresolved value, feature-gate-disabled state, or
another condition. This clarification is required as per coding guidelines for
all optional fields.
- Around line 2341-2346: The OCPVersion type has kubebuilder validation markers
for MinLength=3 and MaxLength=8, but the comment only documents the format
requirement without mentioning the length constraints. Update the comment for
the OCPVersion type to include explicit documentation of the length constraints
(minimum 3 characters, maximum 8 characters) in human-readable terms alongside
the existing format documentation to match the validation markers and follow
coding guidelines.

🪄 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: Enterprise

Run ID: 302ef052-c626-4396-a8ab-1df4406a6900

📥 Commits

Reviewing files that changed from the base of the PR and between 5346161 and 2c6e76b.

⛔ Files ignored due to path filters (5)

• openapi/generated_openapi/zz_generated.openapi.go is excluded by !openapi/**, !**/zz_generated*
• operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers-CustomNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• operator/v1/zz_generated.featuregated-crd-manifests.yaml is excluded by !**/zz_generated*
• operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/IngressControllerMultipleHAProxyVersions.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
• operator/v1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*

📒 Files selected for processing (1)

• operator/v1/types_ingresscontroller.go

[jcmoraisjr]

@yuqi-zhang here is the API update for the openshift/enhancements#1965 you also reviewed.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

operator/v1/tests/ingresscontrollers.operator.openshift.io/IngressControllerMultipleHAProxyVersions.yaml (1)

86-185: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win

Missing onUpdate negative test for invalid haproxyVersion.

onCreate tests reject empty ("") and unsupported ("2.6") values, but onUpdate only covers valid transitions (unset↔2.8, 2.8→3.2). Add an update case setting an unsupported/empty value to confirm the enum validation is enforced symmetrically on update.

➕ Suggested additional test case

    - name: Should not be able to update to an unsupported version
      initial: |
        apiVersion: operator.openshift.io/v1
        kind: IngressController
        metadata:
          name: default
          namespace: openshift-ingress-operator
        spec:
          httpEmptyRequestsPolicy: Respond
          idleConnectionTerminationPolicy: Immediate
          closedClientConnectionPolicy: Continue
          haproxyVersion: "2.8"
      updated: |
        apiVersion: operator.openshift.io/v1
        kind: IngressController
        metadata:
          name: default
          namespace: openshift-ingress-operator
        spec:
          httpEmptyRequestsPolicy: Respond
          idleConnectionTerminationPolicy: Immediate
          closedClientConnectionPolicy: Continue
          haproxyVersion: "2.6"
      expectedError: 'Unsupported value: "2.6": supported values: "2.8", "3.2"'

🤖 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
`@operator/v1/tests/ingresscontrollers.operator.openshift.io/IngressControllerMultipleHAProxyVersions.yaml`
around lines 86 - 185, The onUpdate coverage in
IngressControllerMultipleHAProxyVersions is missing a negative validation case
for haproxyVersion, so add an update test that changes a valid existing value to
an unsupported or empty value and expects the enum rejection. Use the existing
onUpdate scenarios in IngressControllerMultipleHAProxyVersions and mirror the
validation style already used in onCreate so the update path is checked
symmetrically for haproxyVersion.

🤖 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 `@operator/v1/types_ingresscontroller.go`:
- Around line 389-413: The HAProxyVersion field comment repeats the same phrase
twice in the upgrade-preflight sentence, so tighten the wording to remove the
duplicate “block the cluster upgrade” phrasing. Update the comment near
HAProxyVersion in types_ingresscontroller.go to say the preflight check blocks
the upgrade until the field is updated, keeping the rest of the migration
guidance intact and concise.

---

Nitpick comments:
In
`@operator/v1/tests/ingresscontrollers.operator.openshift.io/IngressControllerMultipleHAProxyVersions.yaml`:
- Around line 86-185: The onUpdate coverage in
IngressControllerMultipleHAProxyVersions is missing a negative validation case
for haproxyVersion, so add an update test that changes a valid existing value to
an unsupported or empty value and expects the enum rejection. Use the existing
onUpdate scenarios in IngressControllerMultipleHAProxyVersions and mirror the
validation style already used in onCreate so the update path is checked
symmetrically for haproxyVersion.

🪄 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: Enterprise

Run ID: 23c20d00-d012-4aff-8d68-022b90037948

📥 Commits

Reviewing files that changed from the base of the PR and between d75078d and d41e8c5.

⛔ Files ignored due to path filters (7)

• openapi/generated_openapi/zz_generated.openapi.go is excluded by !openapi/**, !**/zz_generated*
• operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers-CustomNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers-DevPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers-TechPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• operator/v1/zz_generated.featuregated-crd-manifests.yaml is excluded by !**/zz_generated*
• operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/IngressControllerMultipleHAProxyVersions.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
• operator/v1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*

📒 Files selected for processing (2)

• operator/v1/tests/ingresscontrollers.operator.openshift.io/IngressControllerMultipleHAProxyVersions.yaml
• operator/v1/types_ingresscontroller.go

[openshift-ci]

@jcmoraisjr: 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.

[gcs278]

I've reviewed this as a part of the EP already and it looks good to me. The docs are quite specific and will go stale fast, but I guess that doesn't matter because the enum values will go stale in the next release anyways. So we are forced to update the API every release (maybe we can automate it later).

I think we are waiting on @yuqi-zhang to follow up on this one.

/lgtm

[openshift-merge-bot]

Pipeline controller notification

No second-stage tests were triggered for this PR.

This can happen when:

• The changed files don't match any pipeline_run_if_changed patterns
• All files match pipeline_skip_if_only_changed patterns
• No pipeline-controlled jobs are defined for the master branch

Use /test ? to see all available tests.

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: gcs278
Once this PR has been reviewed and has the lgtm label, please assign deads2k for approval. For more information see the Code Review Process.

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

Details

Needs approval from an approver in each of these files:

• OWNERS

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

[openshift-ci]

New changes are detected. LGTM label has been removed.