Skip to content

Commit 53581c8

Browse files
authored
Merge pull request #78138 from skrthomas/OCPBUGS-32397
OCPBUGS-32397: Add links to FlowCollector API Reference in the NetObserv Configuration guide
2 parents 6da7c01 + 4cb321f commit 53581c8

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

modules/network-observability-flows-format.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Automatically generated by 'hack/asciidoc-flows-gen.sh'. Do not edit, or make the NETOBSERV team aware of the editions.
22
:_mod-docs-content-type: REFERENCE
33
[id="network-observability-flows-format_{context}"]
4-
= Network Flows format reference
4+
= Network flows format reference
55

66
This is the specification of the network flows format. That format is used when a Kafka exporter is configured, for Prometheus metrics labels as well as internally for the Loki store.
77

observability/network_observability/configuring-operator.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,29 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
You can update the Flow Collector API resource to configure the Network Observability Operator and its managed components. The Flow Collector is explicitly created during installation. Since this resource operates cluster-wide, only a single `FlowCollector` is allowed, and it has to be named `cluster`.
9+
You can update the `FlowCollector` API resource to configure the Network Observability Operator and its managed components. The `FlowCollector` is explicitly created during installation. Since this resource operates cluster-wide, only a single `FlowCollector` is allowed, and it must be named `cluster`. For more information, see the xref:../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[FlowCollector API reference].
1010

1111

1212
include::modules/network-observability-flowcollector-view.adoc[leveloffset=+1]
1313

1414
[role="_additional-resources"]
1515
.Additional resources
16-
For more information about conversation tracking, see xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-working-with-conversations_nw-observe-network-traffic[Working with conversations].
16+
* xref:../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[FlowCollector API reference]
17+
* xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-working-with-conversations_nw-observe-network-traffic[Working with conversation tracking]
1718
1819
include::modules/network-observability-flowcollector-kafka-config.adoc[leveloffset=+1]
1920
include::modules/network-observability-enriched-flows.adoc[leveloffset=+1]
2021

2122
[role="_additional-resources"]
2223
.Additional resources
23-
For more information about specifying flow format, see xref:../../observability/network_observability/json-flows-format-reference.adoc#network-observability-flows-format_json_reference[Network flows format reference].
24+
* xref:../../observability/network_observability/json-flows-format-reference.adoc#network-observability-flows-format_json_reference[Network flows format reference].
2425
2526
include::modules/network-observability-configuring-FLP-sampling.adoc[leveloffset=+1]
2627
include::modules/network-observability-configuring-quickfilters-flowcollector.adoc[leveloffset=+1]
2728
include::modules/network-observability-SRIOV-configuration.adoc[leveloffset=+1]
2829
[role="_additional-resources"]
2930
.Additional resources
30-
For more information about creating the `SriovNetwork` custom resource, see xref:../../networking/hardware_networks/configuring-sriov-device.adoc#cnf-creating-an-additional-sriov-network-with-vrf-plug-in_configuring-sriov-device[Creating an additional SR-IOV network attachment with the CNI VRF plugin].
31+
* xref:../../networking/hardware_networks/configuring-sriov-device.adoc#cnf-creating-an-additional-sriov-network-with-vrf-plug-in_configuring-sriov-device[Creating an additional SR-IOV network attachment with the CNI VRF plugin]
3132
3233
include::modules/network-observability-resource-recommendations.adoc[leveloffset=+1]
3334
include::modules/network-observability-resources-table.adoc[leveloffset=+2]

observability/network_observability/flowcollector-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="flowcollector-api"]
3-
= FlowCollector configuration parameters
3+
= FlowCollector API reference
44
include::_attributes/common-attributes.adoc[]
55
:context: network_observability
66

0 commit comments

Comments
 (0)