openshift-docs
openshift-docs copied to clipboard
OSDOCS-14941 [NETOBSERV] Update API references
OSDOCS-14941 [NETOBSERV] Update API/CLI references
Version(s):
Merge to only the no-1.9 branch - no cherrypicks are required.
I will open one PR against main to incorporate all of the NetObserv content just before its GA.
Issue: https://issues.redhat.com/browse/OSDOCS-14941
Link to docs preview:
- FlowCollector API reference: https://94756--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/flowcollector-api.html
- FlowMetrics: https://94756--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/flowmetric-api.html
- FlowsFormat: https://94756--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/json-flows-format-reference.html
QE review:
- [x] QE has approved this change.
Additional information:
06/302/2025:
modules/network-observability-con_filter-network-flows-at-ingestion.adoc has been reviewed/merged as part of https://github.com/openshift/openshift-docs/pull/95159 but for some reason, it continues to appear in existing open PRs against no-1.9 even after rebasing.
06/24/2025:
See https://github.com/openshift/openshift-docs/pull/95159. For some reason, all content from previously merged PRs vanished from the no-1.9 branch, and are appearing in any open PR against no-1.9. Hopefully merging 95159 and a rebase will resolve things.
Automatically generated by 'openshift-apidocs-gen'. Do not edit.
See engineering PR: https://github.com/netobserv/network-observability-operator/pull/1586
🤖 Mon Jun 30 13:32:05 - Prow CI generated the docs preview:
https://94756--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/configuring-operator.html https://94756--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/flowcollector-api.html https://94756--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/flowmetric-api.html https://94756--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/json-flows-format-reference.html
/label qe-approved
@gwynnemonahan: all tests passed!
Full PR test history. Your PR dashboard.
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.
/label peer-review-needed
Removed suggested changes after realizing that they were API docs. Whoops.
Formatting LGTM.