[sradco]

Document the intentional zero scrape-success status when NVMe
subsystem sysfs data is missing or inaccessible. Explain that
DoNotCollect disables collection cluster-wide and does not
provide per-node configuration.

Regenerate the CRD, Swagger, OpenAPI, and payload descriptions.

Companion documentation PR: openshift/cluster-monitoring-operator#3161

Policy: prometheus/node_exporter#3864
Related: prometheus/procfs#881
Related: prometheus/node_exporter#3861

Validation:

• PROTO_OPTIONAL=1 GOFLAGS=-p=4 make update
• make lint EXTRA_ARGS=./config/v1alpha1/...
• go test ./config/v1alpha1
• schema and Swagger verification
• schema diffs checked for documentation-only changes

Protobuf generation skipped because protoc is unavailable.

Signed-off-by: Shirly Radco sradco@redhat.com
Co-authored-by: Codex noreply@openai.com

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

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

Details

In response to this:

Document the intentional zero scrape-success status when NVMe
subsystem sysfs data is missing or inaccessible. Explain that
DoNotCollect disables collection cluster-wide and does not
provide per-node configuration.

Regenerate the CRD, Swagger, OpenAPI, and payload descriptions.

Policy: prometheus/node_exporter#3864
Related: prometheus/procfs#881
Related: prometheus/node_exporter#3861

Validation:

• PROTO_OPTIONAL=1 GOFLAGS=-p=4 make update
• make lint EXTRA_ARGS=./config/v1alpha1/...
• go test ./config/v1alpha1
• schema and Swagger verification
• schema diffs checked for documentation-only changes

Protobuf generation skipped because protoc is unavailable.

Signed-off-by: Shirly Radco sradco@redhat.com
Co-authored-by: Codex noreply@openai.com

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]

Hello @sradco! 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.

[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: 736ea4c
• Layers: Repository YAML (base), Central YAML (inherited)
• Review profile: CHILL
• Plan: Advanced
• Run ID: b1ec40b8-013d-4a16-913e-b29c661d4695

📥 Commits

Reviewing files that changed from the base of the PR and between 736ea4c and f91d8ce.

⛔ Files ignored due to path filters: 5

• config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_clustermonitorings.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• config/v1alpha1/zz_generated.featuregated-crd-manifests/clustermonitorings.config.openshift.io/ClusterMonitoringConfig.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
• config/v1alpha1/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: 2

• config/v1alpha1/types_cluster_monitoring.go
• payload-manifests/crds/0000_10_config-operator_01_clustermonitorings.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 API type and CRD now document that the NVMe subsystem collector reports a scrape-success value of 0 when its sysfs path is missing or inaccessible. They also state that DoNotCollect disables the collector cluster-wide and that per-node configuration is unsupported.

Suggested reviewers: simonpasquier

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to f91d8

The documentation-only changes are consistent and introduce no actionable merge risk.

Pre-merge checks: 15

Check name	Status	Explanation
Title check		The title clearly and concisely identifies the main change: clarifying NVMe subsystem collector documentation.
Description check		The description directly explains the documentation changes, regeneration work, validation steps, and related references.
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
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 NVMe documentation in Go comments and generated CRD/OpenAPI/Swagger descriptions. The authoritative diff adds no Ginkgo test declarations or test-title changes, so it int…
Test Structure And Quality		The pull request changes only NVMe collector documentation and generated schema/OpenAPI descriptions. It adds no Ginkgo tests or test setup, cleanup, waits, or assertions. Therefore, the listed test-q…
Microshift Test Compatibility		PASS: The pull request changes only collector documentation in the Go API type and generated CRD, Swagger, OpenAPI, and payload files. It adds no Ginkgo e2e tests or other test code, so the MicroShift…
Single Node Openshift (Sno) Test Compatibility		PASS: The pull request changes only NVMe collector documentation and generated schema/OpenAPI descriptions. The authoritative diff adds no Ginkgo e2e tests or other test code, so it introduces no SNO …
Topology-Aware Scheduling Compatibility		The pull request changes only NVMe collector documentation and generated schema/OpenAPI descriptions. The reviewed diff adds six descriptive lines and updates corresponding generated descriptions; it …
Ote Binary Stdout Contract		The pull request changes only API documentation and generated schema/OpenAPI descriptions. The diff adds six NVMe documentation lines and updates generated descriptions. It adds no main, suite setup, …
Ipv6 And Disconnected Network Test Compatibility		PASS. The pull request changes only API documentation and generated schema/OpenAPI descriptions. The diff adds no Ginkgo e2e tests and no IPv4 literals, URL construction, or external connectivity requ…
No-Weak-Crypto		The pull request adds only NVMe collector documentation and synchronized generated descriptions. The seven changed files contain no MD5, SHA1, DES, RC4, 3DES, Blowfish, ECB, custom cryptography, or se…
Container-Privileges		The pull request changes only NVMe collector documentation and generated schema/OpenAPI descriptions. The diff adds no container or Kubernetes workload settings and introduces none of privileged, host…
No-Sensitive-Data-In-Logs		The pull request changes only API documentation and generated schema descriptions. The added text contains NVMe paths, metric names, and configuration guidance. It adds no logging code or sensitive va…

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files. (1 skipped: 1 unsupported.)

Full details: Stable And Deterministic Test Names

Explanation

The pull request changes only NVMe documentation in Go comments and generated CRD/OpenAPI/Swagger descriptions. The authoritative diff adds no Ginkgo test declarations or test-title changes, so it introduces no unstable or overly specific test names.

Full details: Test Structure And Quality

Explanation

The pull request changes only NVMe collector documentation and generated schema/OpenAPI descriptions. It adds no Ginkgo tests or test setup, cleanup, waits, or assertions. Therefore, the listed test-quality requirements are not applicable.

Full details: Microshift Test Compatibility

Explanation

PASS: The pull request changes only collector documentation in the Go API type and generated CRD, Swagger, OpenAPI, and payload files. It adds no Ginkgo e2e tests or other test code, so the MicroShift test compatibility check is not applicable.

Full details: Single Node Openshift (Sno) Test Compatibility

Explanation

PASS: The pull request changes only NVMe collector documentation and generated schema/OpenAPI descriptions. The authoritative diff adds no Ginkgo e2e tests or other test code, so it introduces no SNO multi-node assumption.

Full details: Topology-Aware Scheduling Compatibility

Explanation

The pull request changes only NVMe collector documentation and generated schema/OpenAPI descriptions. The reviewed diff adds six descriptive lines and updates corresponding generated descriptions; it does not add or modify deployments, controllers, replicas, affinity, topology spread constraints, node selectors, tolerations, or PDBs. Therefore, it introduces no topology-dependent scheduling constraint.

Full details: Ote Binary Stdout Contract

Explanation

The pull request changes only API documentation and generated schema/OpenAPI descriptions. The diff adds six NVMe documentation lines and updates generated descriptions. It adds no main, suite setup, logging, Ginkgo, or stdout-writing code. Therefore, it does not introduce an OTE binary stdout contract violation.

Full details: Ipv6 And Disconnected Network Test Compatibility

Explanation

PASS. The pull request changes only API documentation and generated schema/OpenAPI descriptions. The diff adds no Ginkgo e2e tests and no IPv4 literals, URL construction, or external connectivity requirements.

Full details: No-Weak-Crypto

Explanation

The pull request adds only NVMe collector documentation and synchronized generated descriptions. The seven changed files contain no MD5, SHA1, DES, RC4, 3DES, Blowfish, ECB, custom cryptography, or secret/token comparison logic. No weak-crypto usage is introduced.

Full details: Container-Privileges

Explanation

The pull request changes only NVMe collector documentation and generated schema/OpenAPI descriptions. The diff adds no container or Kubernetes workload settings and introduces none of privileged, hostPID, hostNetwork, hostIPC, SYS_ADMIN, root, or allowPrivilegeEscalation settings.

Full details: No-Sensitive-Data-In-Logs

Explanation

The pull request changes only API documentation and generated schema descriptions. The added text contains NVMe paths, metric names, and configuration guidance. It adds no logging code or sensitive values such as passwords, tokens, API keys, PII, session IDs, hostnames, or customer data.

✨ 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.

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

[sradco]

@simonpasquier Hi, please review this PR

[sradco]

/test integration

[openshift-ci]

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

[simonpasquier]

/cc @simonpasquier

[simonpasquier]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

[redhat-chai-bot]

Chai test selection for f91d8ce552c428b56c8d1b34264cc510c4d87b4f → master

None.

Reason: Every changed line across all 7 files is documentation text only — Go doc comments on the existing NVMExpressSubsystem struct field and their regenerated propagation into CRD description strings, swagger docs, and OpenAPI descriptions. No types, validation rules, defaults, schema structure, or code logic changed. CRD description strings are informational metadata (displayed by kubectl explain) that do not affect validation, controller behavior, operator logic, or cluster state. No e2e test asserts on CRD description content. The 14 passing first-stage checks (build, images, unit, integration, lint, verify, verify-crd-schema, verify-crdify, verify-deps, verify-client-go, verify-feature-promotion, verify-hypershift-integration) comprehensively validate consistency and correctness for a documentation-only change.

[redhat-chai-bot]

/pipeline mark-pipeline-gate f91d8ce