Skip to content

OCPBUGS-100052: Created new job to update vSphere nodes to have vsphere label - #497

Open
vr4manta wants to merge 1 commit into
openshift:mainfrom
vr4manta:OCPBUGS-100052
Open

OCPBUGS-100052: Created new job to update vSphere nodes to have vsphere label#497
vr4manta wants to merge 1 commit into
openshift:mainfrom
vr4manta:OCPBUGS-100052

Conversation

@vr4manta

@vr4manta vr4manta commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

OCPBUGS-100052

Changes

  • Created new job that runs during install to update existing nodes to have new label node.openshift.io/platform-type=vsphere

Notes

Idea is to have this only be attempted to run once and only on first upgrade with this change. Following upgrades should not rerun this job.

Summary by CodeRabbit

  • New Features
    • Added a one-time Kubernetes Job to backfill missing vSphere node labels (node.openshift.io/platform-type=vsphere).
    • The labeling job runs only when the VSphereMixedNodeEnv feature gate is enabled and targets master nodes.
  • Tests
    • Added unit test coverage for vSphere vs. non-vSphere clusters, already-labeled vs. missing labels, missing ProviderID, and feature-gate disabled scenarios.

@openshift-ci-robot openshift-ci-robot added jira/severity-important Referenced Jira bug's severity is important for the branch this PR is targeting. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. labels Jul 29, 2026
@openshift-ci-robot

Copy link
Copy Markdown

@vr4manta: This pull request references Jira Issue OCPBUGS-100052, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target version (5.0.0) matches configured target version for branch (5.0.0)
  • bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, POST)

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

OCPBUGS-100052

Changes

  • Created new job that runs during install to update existing nodes to have new label node.openshift.io/platform-type=vsphere

Notes

Idea is to have this only be attempted to run once and only on first upgrade with this change. Following upgrades should not rerun this job.

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

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Enterprise

Run ID: 8c7cad96-d7bc-482b-97c6-58d0d4e7bc83

📥 Commits

Reviewing files that changed from the base of the PR and between 634d7eb and 68c2feb.

📒 Files selected for processing (7)
  • Dockerfile
  • Makefile
  • cmd/vsphere-node-label-sync-job/main.go
  • manifests/0000_26_cloud-controller-manager-operator_45_job-vsphere-node-label-sync.yaml
  • pkg/cloud/vsphere/vsphere.go
  • pkg/controllers/vsphere_node_label_sync.go
  • pkg/controllers/vsphere_node_label_sync_test.go
🚧 Files skipped from review as they are similar to previous changes (6)
  • pkg/cloud/vsphere/vsphere.go
  • Makefile
  • pkg/controllers/vsphere_node_label_sync_test.go
  • Dockerfile
  • pkg/controllers/vsphere_node_label_sync.go
  • cmd/vsphere-node-label-sync-job/main.go

Walkthrough

Changes

vSphere node label synchronization

Layer / File(s) Summary
Label reconciliation and validation
pkg/cloud/vsphere/vsphere.go, pkg/controllers/vsphere_node_label_sync.go, pkg/controllers/vsphere_node_label_sync_test.go
Adds vSphere label/provider ID constants, labels eligible nodes when platform and feature-gate conditions match, and tests the behavior.
Job entrypoint and binary packaging
cmd/vsphere-node-label-sync-job/main.go, Makefile, Dockerfile
Initializes the one-shot synchronization flow, builds the binary, and copies it into the runtime image.
One-time Job deployment
manifests/...job-vsphere-node-label-sync.yaml
Adds a feature-gated, create-only Kubernetes Job with scheduling, host configuration, security, resources, and lifecycle settings.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Job as vsphere-node-label-sync-job
  participant Config as OpenShift config informers
  participant Sync as SyncVSphereNodeLabels
  participant API as Kubernetes API

  Job->>Config: Wait for initial feature-gate state
  Job->>Sync: Start synchronization
  Sync->>API: Fetch Infrastructure and list Nodes
  Sync->>API: Patch eligible vSphere node labels
  Sync-->>Job: Return synchronization result
Loading

Suggested reviewers: nrb, damdo


Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (2 errors, 1 warning)

Check name Status Explanation Resolution
Container-Privileges ❌ Error The new Job manifest sets hostNetwork: true, which this check flags as disallowed. Remove hostNetwork: true from the Job, or justify and waive it if the deployment requires host networking.
No-Sensitive-Data-In-Logs ❌ Error syncVSphereNodeLabel logs node.Name, and returned errors include node %s, so internal hostnames can leak into job logs. Remove node-name logging; use generic counts or non-sensitive identifiers, and avoid embedding node.Name in returned errors.
Topology-Aware Scheduling Compatibility ⚠️ Warning The new Job hard-selects node-role.kubernetes.io/master, and the sync code only checks vSphere/feature-gate, not ControlPlaneTopology; on HyperShift it would have no matching nodes. Gate the Job or entrypoint on infrastructure.Status.ControlPlaneTopology, or avoid a master nodeSelector for external-control-plane clusters so the sync is skipped when no control-plane nodes exist.
✅ Passed checks (12 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: adding a new job to backfill the vSphere node label.
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 The only test titles are static t.Run names; no Ginkgo titles or dynamic values (node names, UUIDs, timestamps) appear in test names.
Test Structure And Quality ✅ Passed No Ginkgo-style tests were added; the new unit test is table-driven with a fake client, no waits or cleanup needs, and matches repo patterns.
Microshift Test Compatibility ✅ Passed The new test is a plain Go unit test, not a Ginkgo e2e spec, and it only uses fake clients plus core APIs.
Single Node Openshift (Sno) Test Compatibility ✅ Passed No new Ginkgo/e2e tests were added; the only test is a standard Go unit test (TestSyncVSphereNodeLabels) with no multi-node assumptions.
Ote Binary Stdout Contract ✅ Passed The new binary has no fmt.Print*/stdout writes in main/init; klog defaults to stderr, and controller-runtime Log is deferred until SetLogger.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed No new Ginkgo e2e tests were added; the new test uses testing.T and the changed files contain no IPv4 or external-connectivity assumptions.
No-Weak-Crypto ✅ Passed Changed files contain no MD5/SHA1/DES/RC4/3DES/Blowfish/ECB or custom crypto; only node label/providerID logic was added.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@openshift-ci
openshift-ci Bot requested a review from damdo July 29, 2026 15:50
@openshift-ci

openshift-ci Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign elmiko 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:

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

@openshift-ci
openshift-ci Bot requested a review from nrb July 29, 2026 15:50
@openshift-ci-robot

Copy link
Copy Markdown

@vr4manta: This pull request references Jira Issue OCPBUGS-100052, which is valid.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target version (5.0.0) matches configured target version for branch (5.0.0)
  • bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, POST)
Details

In response to this:

OCPBUGS-100052

Changes

  • Created new job that runs during install to update existing nodes to have new label node.openshift.io/platform-type=vsphere

Notes

Idea is to have this only be attempted to run once and only on first upgrade with this change. Following upgrades should not rerun this job.

Summary by CodeRabbit

  • New Features
  • Added automatic one-time synchronization of vSphere node labels.
  • vSphere nodes missing the node.openshift.io/platform-type=vsphere label are now identified and labeled when the VSphereMixedNodeEnv feature is enabled.
  • Added deployment support for running the synchronization job in the cluster.
  • Tests
  • Added coverage for vSphere, non-vSphere, already-labeled, and feature-disabled scenarios.

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 coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 7

🤖 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 `@cmd/vsphere-node-label-sync-job/main.go`:
- Line 75: Add an application-level timeout context derived from the context
returned by ctrl.SetupSignalHandler(), using a deadline safely below the
manifest’s 300-second limit, and ensure its cancel function is released. Pass
this context through the job’s initialization and synchronization calls so API
operations observe both termination cancellation and the application timeout;
use context.Context throughout the affected function signatures.

In
`@manifests/0000_26_cloud-controller-manager-operator_45_job-vsphere-node-label-sync.yaml`:
- Around line 46-47: Remove the hard-coded control-plane nodeSelector from the
Job manifest so scheduling is not restricted to the legacy
node-role.kubernetes.io/master label. Update the deployment scheduling
configuration to remain topology-aware and compatible with HyperShift-style
clusters, without requiring control-plane placement.
- Around line 71-97: Add a restrictive container securityContext to the
vsphere-node-label-sync container, requiring runAsNonRoot, disabling privilege
escalation, enabling a read-only root filesystem, and dropping ALL Linux
capabilities; preserve the existing host-etc-kube read-only mount and add any
other writable mounts or capabilities only if the job explicitly requires them.
- Around line 89-93: Update the container resources block in the Job manifest to
add bounded cpu and memory limits alongside the existing requests. Ensure every
container in this Kubernetes manifest defines both resource limit fields, using
values appropriate for this system-node-critical workload.
- Line 45: Remove the hostNetwork setting from the Job manifest so the
hostaccess workload uses ordinary Kubernetes Service connectivity. Ensure the
manifest retains no hostNetwork configuration while leaving its existing host
Kubernetes configuration mount unchanged.
- Line 26: Remove the ttlSecondsAfterFinished field from the Job manifest so the
completed create-only Job remains present and is not recreated on later CVO
syncs.

In `@pkg/controllers/vsphere_node_label_sync.go`:
- Line 89: Update the logging statement in the node label sync flow to avoid
emitting node.Name at info level. Replace the per-node hostname-containing
message with an aggregate/count message or a redacted identifier, while
preserving the label operation and its existing informational intent.
🪄 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: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: e2850ae9-15f2-41e7-bdec-611918f5192d

📥 Commits

Reviewing files that changed from the base of the PR and between 38f5e00 and 634d7eb.

📒 Files selected for processing (7)
  • Dockerfile
  • Makefile
  • cmd/vsphere-node-label-sync-job/main.go
  • manifests/0000_26_cloud-controller-manager-operator_45_job-vsphere-node-label-sync.yaml
  • pkg/cloud/vsphere/vsphere.go
  • pkg/controllers/vsphere_node_label_sync.go
  • pkg/controllers/vsphere_node_label_sync_test.go

Comment thread cmd/vsphere-node-label-sync-job/main.go Outdated
Comment thread pkg/controllers/vsphere_node_label_sync.go
@openshift-ci

openshift-ci Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

@vr4manta: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-aws-ovn-upgrade 68c2feb link true /test e2e-aws-ovn-upgrade
ci/prow/level0-clusterinfra-azure-ipi-proxy-tests 68c2feb link false /test level0-clusterinfra-azure-ipi-proxy-tests
ci/prow/e2e-azure-ovn-upgrade 68c2feb link true /test e2e-azure-ovn-upgrade
ci/prow/e2e-aws-ovn 68c2feb link true /test e2e-aws-ovn

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/severity-important Referenced Jira bug's severity is important for the branch this PR is targeting. jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants