[dipatil001]

Summary

• Correct the Node.spec.workerLatencyProfile description in config/v1, which is the source for the generated Config API reference.
• The published text is workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster.
• The intended text, from OSDOCS-24096, is workerLatencyProfile determines how frequently the kubelet updates the status and how quickly the cluster reacts accordingly.
• Generated CRD, swagger, and OpenAPI copies of that description are updated to match.

The OpenShift docs page is produced by openshift-apidocs-gen and is not edited by hand. After this merges, the API reference needs to be regenerated for the wording to show up on the 4.22 docs page. A backport to release-4.22 is needed for that version.

Test plan

• Confirm the godoc, CRD descriptions, swagger docs, and OpenAPI description all use the new sentence.
• verify-codegen still matches these generated files.
• After merge and docs regeneration, the Node config API page no longer contains determins.

[openshift-merge-bot]

Pipeline controller notification

This PR uses the pipeline controller for second-stage tests. Selection and triggering follow the repository configuration.

Use /test ? to list jobs and /pipeline help for commands.

[openshift-ci-robot]

@dipatil001: This pull request references OSDOCS-24096 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 bug to target the "5.1.0" version, but no target version was set.

Details

In response to this:

Summary

• Correct the Node.spec.workerLatencyProfile description in config/v1, which is the source for the generated Config API reference.
• The published text is workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster.
• The intended text, from OSDOCS-24096, is workerLatencyProfile determines how frequently the kubelet updates the status and how quickly the cluster reacts accordingly.
• Generated CRD, swagger, and OpenAPI copies of that description are updated to match.

The OpenShift docs page is produced by openshift-apidocs-gen and is not edited by hand. After this merges, the API reference needs to be regenerated for the wording to show up on the 4.22 docs page. A backport to release-4.22 is needed for that version.

Test plan

• Confirm the godoc, CRD descriptions, swagger docs, and OpenAPI description all use the new sentence.
• verify-codegen still matches these generated files.
• After merge and docs regeneration, the Node config API page no longer contains determins.

Made with Cursor

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]

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: openshift/api
• Branch: master
• File: .coderabbit.yaml
• Commit: c757da5
• Layers: Repository YAML (base), Central YAML (inherited)
• Review profile: CHILL
• Plan: Advanced
• Run ID: 8794894e-2d42-414e-b310-4cf13054f6e3

Commits

Reviewing files that changed from the base of the PR and between c757da5 and 2314bf7.

Files ignored due to path filters: 10

• config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-Default.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-OKD.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/AAA_ungated.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
• config/v1/zz_generated.featuregated-crd-manifests/nodes.config.openshift.io/MinimumKubeletVersion.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
• config/v1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
• openapi/generated_openapi/zz_generated.openapi.go is excluded by !openapi/**, !**/zz_generated*
• openapi/openapi.json is excluded by !openapi/**

Files selected for processing: 6

• config/v1/types_node.go
• payload-manifests/crds/0000_10_config-operator_01_nodes-CustomNoUpgrade.crd.yaml
• payload-manifests/crds/0000_10_config-operator_01_nodes-Default.crd.yaml
• payload-manifests/crds/0000_10_config-operator_01_nodes-DevPreviewNoUpgrade.crd.yaml
• payload-manifests/crds/0000_10_config-operator_01_nodes-OKD.crd.yaml
• payload-manifests/crds/0000_10_config-operator_01_nodes-TechPreviewNoUpgrade.crd.yaml

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

Walkthrough

The WorkerLatencyProfile comment and its descriptions in five CRD manifests now describe kubelet status-update frequency and cluster reaction speed. No schema or runtime behavior changed.

Merge Risk: Minimal · up to 2314b

The documentation correction is consistent across all generated copies and does not change API behavior, so the PR is ready to merge.

Pre-merge checks: 15

Check name	Status	Explanation
Docstring Coverage		No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names		The pull request changes only API comments and generated schema/documentation descriptions. The diff adds no Ginkgo tests or test titles, so it introduces no unstable or overly specific test names.
Test Structure And Quality		PASS: The pull request changes only API documentation and generated schema files. The authoritative diff contains no *_test.go files and no added Ginkgo It, BeforeEach, AfterEach, Eventually, or Consi…
Microshift Test Compatibility		The pull request changes only API description text and generated CRD, Swagger, and OpenAPI files. The authoritative diff adds no Ginkgo e2e tests or test declarations, so MicroShift test compatibility…
Single Node Openshift (Sno) Test Compatibility		PASS: The pull request changes only the workerLatencyProfile documentation in config/v1 and generated CRD, Swagger, and OpenAPI artifacts. It adds no Ginkgo e2e tests or test wrappers, so no SNO m…
Topology-Aware Scheduling Compatibility		PASS. The pull request changes only the workerLatencyProfile documentation string in config/v1/types_node.go and generated CRD, Swagger, and OpenAPI files. The diff introduces no manifests, contro…
Ote Binary Stdout Contract		PASS: The PR changes only API descriptions and generated schema/OpenAPI strings. The Go diff contains no main, init, TestMain, suite setup, logging, or stdout writes. The OTE binary stdout contract is…
Ipv6 And Disconnected Network Test Compatibility		The pull request changes only API comments and generated schema/documentation descriptions. The authoritative diff adds no Ginkgo tests or test code, IPv4 assumptions, or external connectivity require…
No-Weak-Crypto		The pull request changes only the workerLatencyProfile documentation in config/v1/types_node.go and generated CRD, Swagger, and OpenAPI files. The added lines contain descriptive text only. No MD5…
Container-Privileges		The pull request changes only the workerLatencyProfile documentation in Go, CRD, Swagger, and OpenAPI files. No added line contains privileged: true, hostPID, hostNetwork, hostIPC, SYS_ADMIN, allowPri…
No-Sensitive-Data-In-Logs		PASS. The pull request changes only API description text and generated documentation copies. The diff adds no logging, credentials, tokens, personal data, hostnames, or customer data.
Title check		The title clearly identifies the correction to the workerLatencyProfile API description, which is the main change.
Description check		The description explains the wording correction and identifies the affected source and generated API documentation files.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 1 files. (5 skipped: 5 unsupported.)

Full details: Test Structure And Quality

Explanation

PASS: The pull request changes only API documentation and generated schema files. The authoritative diff contains no *_test.go files and no added Ginkgo It, BeforeEach, AfterEach, Eventually, or Consistently calls. Therefore, the stated Ginkgo test-quality checks do not apply.

Full details: Microshift Test Compatibility

Explanation

The pull request changes only API description text and generated CRD, Swagger, and OpenAPI files. The authoritative diff adds no Ginkgo e2e tests or test declarations, so MicroShift test compatibility is not applicable.

Full details: Single Node Openshift (Sno) Test Compatibility

Explanation

PASS: The pull request changes only the workerLatencyProfile documentation in config/v1 and generated CRD, Swagger, and OpenAPI artifacts. It adds no Ginkgo e2e tests or test wrappers, so no SNO multi-node compatibility assumption is introduced.

Full details: Topology-Aware Scheduling Compatibility

Explanation

PASS. The pull request changes only the workerLatencyProfile documentation string in config/v1/types_node.go and generated CRD, Swagger, and OpenAPI files. The diff introduces no manifests, controllers, replicas, affinity, topology spread, node selectors, tolerations, or PDBs. Therefore, it introduces no topology-dependent scheduling constraint.

Full details: Ote Binary Stdout Contract

Explanation

PASS: The PR changes only API descriptions and generated schema/OpenAPI strings. The Go diff contains no main, init, TestMain, suite setup, logging, or stdout writes. The OTE binary stdout contract is not affected.

Full details: Ipv6 And Disconnected Network Test Compatibility

Explanation

The pull request changes only API comments and generated schema/documentation descriptions. The authoritative diff adds no Ginkgo tests or test code, IPv4 assumptions, or external connectivity requirements. The compatibility check is therefore not applicable.

Full details: No-Weak-Crypto

Explanation

The pull request changes only the workerLatencyProfile documentation in config/v1/types_node.go and generated CRD, Swagger, and OpenAPI files. The added lines contain descriptive text only. No MD5, SHA1, DES, RC4, 3DES, Blowfish, ECB, custom cryptography, or non-constant-time secret/token comparison was introduced.

Full details: Container-Privileges

Explanation

The pull request changes only the workerLatencyProfile documentation in Go, CRD, Swagger, and OpenAPI files. No added line contains privileged: true, hostPID, hostNetwork, hostIPC, SYS_ADMIN, allowPrivilegeEscalation: true, or root container settings.

Finishing Touches

🧪 Generate unit tests (beta)

• Create a new PR

Warning

Some tools did not complete. Review the errors below.

golangci-lint (2.14.0)

golangci-lint (2.14.0) skipped for .golangci.yaml: configuration contains disallowed or uninspectable plugin or linter settings. Use supported built-in linters.

[openshift-ci]

Hello @dipatil001! 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]

Hi @dipatil001. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

[openshift-ci-robot]

@dipatil001: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.

Details

In response to this:

Summary

• Correct the Node.spec.workerLatencyProfile description in config/v1, which is the source for the generated Config API reference.
• The published text is workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster.
• The intended text, from OSDOCS-24096, is workerLatencyProfile determines how frequently the kubelet updates the status and how quickly the cluster reacts accordingly.
• Generated CRD, swagger, and OpenAPI copies of that description are updated to match.

The OpenShift docs page is produced by openshift-apidocs-gen and is not edited by hand. After this merges, the API reference needs to be regenerated for the wording to show up on the 4.22 docs page. A backport to release-4.22 is needed for that version.

Test plan

• Confirm the godoc, CRD descriptions, swagger docs, and OpenAPI description all use the new sentence.
• verify-codegen still matches these generated files.
• After merge and docs regeneration, the Node config API page no longer contains determins.

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-robot]

@dipatil001: This pull request references OSDOCS-24096 which is a valid jira issue.

Details

In response to this:

Summary

• Correct the Node.spec.workerLatencyProfile description in config/v1, which is the source for the generated Config API reference.
• The published text is workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster.
• The intended text, from OSDOCS-24096, is workerLatencyProfile determines how frequently the kubelet updates the status and how quickly the cluster reacts accordingly.
• Generated CRD, swagger, and OpenAPI copies of that description are updated to match.

The OpenShift docs page is produced by openshift-apidocs-gen and is not edited by hand. After this merges, the API reference needs to be regenerated for the wording to show up on the 4.22 docs page. A backport to release-4.22 is needed for that version.

Test plan

• Confirm the godoc, CRD descriptions, swagger docs, and OpenAPI description all use the new sentence.
• verify-codegen still matches these generated files.
• After merge and docs regeneration, the Node config API page no longer contains determins.

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.

[everettraven]

/approve
/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: everettraven

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 [everettraven]

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

[everettraven]

/ok-to-test

[openshift-merge-bot]

Scheduling tests matching the pipeline_run_if_changed or not excluded by pipeline_skip_if_only_changed parameters:
/test e2e-aws-ovn
/test e2e-aws-ovn-customnoupgrade
/test e2e-aws-ovn-hypershift
/test e2e-aws-ovn-hypershift-conformance
/test e2e-aws-ovn-techpreview
/test e2e-aws-serial-1of2
/test e2e-aws-serial-2of2
/test e2e-aws-serial-techpreview-1of2
/test e2e-aws-serial-techpreview-2of2
/test e2e-azure
/test e2e-gcp
/test e2e-upgrade
/test e2e-upgrade-out-of-change
/test minor-e2e-upgrade-minor

[openshift-ci]

@dipatil001: 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-hypershift-conformance	2314bf7	link	true	/test e2e-aws-ovn-hypershift-conformance
ci/prow/e2e-aws-serial-2of2	2314bf7	link	true	/test e2e-aws-serial-2of2
ci/prow/e2e-aws-ovn-hypershift	2314bf7	link	true	/test e2e-aws-ovn-hypershift

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.