CORENET-6714 Adding documentation

[OlivierCazade]

Summary

Adding documentation on the network observability installation field related to how some cases will be handled.

The first goal of this cases is to prevent altering something that was changed by a user.

[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 @OlivierCazade! 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

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

Review profile: CHILL

Plan: Enterprise

Run ID: f793cf40-ce90-4155-a2c2-69dfb1e619b5

📥 Commits

Reviewing files that changed from the base of the PR and between 39631f4 and 63d1eff.

⛔ Files ignored due to path filters (6)

• config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_networks-CustomNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_networks-DevPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_networks-TechPreviewNoUpgrade.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
• config/v1/zz_generated.featuregated-crd-manifests/networks.config.openshift.io/NetworkObservabilityInstall.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*

📒 Files selected for processing (4)

• config/v1/types_network.go
• payload-manifests/crds/0000_10_config-operator_01_networks-CustomNoUpgrade.crd.yaml
• payload-manifests/crds/0000_10_config-operator_01_networks-DevPreviewNoUpgrade.crd.yaml
• payload-manifests/crds/0000_10_config-operator_01_networks-TechPreviewNoUpgrade.crd.yaml

---

📝 Walkthrough

Walkthrough

Updated the installationPolicy documentation in NetworkObservabilitySpec and in the generated Network CRD manifests. The new text describes how the platform handles existing manual Network Observability installations, including OLMv0/OLMv1 detection, reuse of a successfully detected installation, and stopping installation when provenance is unknown or the existing installation is incomplete.

🚥 Pre-merge checks | ✅ 14 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is relevant but too generic to identify the main change.	Use a concise title that names the specific change, such as updating NetworkObservability installation documentation.

✅ Passed checks (14 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description is related to the documentation update in this pull request.
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 PR only edits network-observability docs/CRD descriptions; no Ginkgo test files or test titles are added or changed.
Test Structure And Quality	✅ Passed	The PR only updates docs/CRD schema and generated files; no Ginkgo test files or test logic were changed, so the test-quality review is not applicable.
Microshift Test Compatibility	✅ Passed	Doc-only changes in NetworkObservability type/CRDs; the edited files have no Ginkgo specs or MicroShift-unsupported API usage.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	Touched files are docs/CRDs only; no Ginkgo test files or It/Describe/Context/When constructs were added, so SNO compatibility isn’t impacted.
Topology-Aware Scheduling Compatibility	✅ Passed	PASS: The change only expands documentation for networkObservability.installationPolicy; no deployment manifests, replicas, affinity, nodeSelector, or other scheduling logic changed.
Ote Binary Stdout Contract	✅ Passed	PR only updates documentation/comments in schema and CRDs; no process-level stdout/logging code was added or modified.
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	Docs-only changes to NetworkObservability descriptions; no new Ginkgo e2e tests or network-dependent code were added.
No-Weak-Crypto	✅ Passed	Only CRD/Go doc comments changed; no weak-crypto primitives or secret/token comparisons were added.
Container-Privileges	✅ Passed	Only API docs/CRD descriptions changed; scans of touched files found no privileged, hostPID/Network/IPC, SYS_ADMIN, or allowPrivilegeEscalation settings.
No-Sensitive-Data-In-Logs	✅ Passed	The PR only updates NetworkObservability documentation/CRD descriptions; no logging code or sensitive-data-bearing log output was added.

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

[openshift-ci]

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

[openshift-ci]

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