Merge pull request #54372 from skrthomas/netobservreorgtopics

Reorgainzing topic map and post-merge issues

Author: skrthomas

_topic_maps/_topic_map.yml

@@ -1321,10 +1321,10 @@ Topics:
   Topics:
   - Name: Network Observability overview
     File: network-observability-overview
-  - Name: Understanding Network Observability Operator
-    File: understanding-network-observability-operator
   - Name: Installing Network Observability Operators
     File: installing-operators
+  - Name: Understanding Network Observability Operator
+    File: understanding-network-observability-operator
   - Name: Configuring the Network Observability Operator
     File: configuring-operator
   - Name: Observing the network traffic

modules/network-observability-flowcollector-api-specifications.adoc

@@ -1,13 +1,11 @@
 // Automatically generated by '{product-title}-apidocs-gen'. Do not edit.
+// Module included in the following assemblies:
+// networking/network_observability/flowcollector-api.adoc
+
 :_content-type: REFERENCE
 [id="network-observability-flowcollector-api-specifications_{context}"]
 
 = FlowCollector API specifications
-Description::
-+
---
-FlowCollector is the Schema for the flowcollectors API, which pilots and configures netflow collection.
---
 
 Type::
   `object`
@@ -40,7 +38,7 @@ Type::
 | FlowCollectorStatus defines the observed state of FlowCollector
 
 |===
-=== .spec
+== .spec
 Description::
 +
 --
@@ -97,7 +95,7 @@ Required::
 | processor defines the settings of the component that receives the flows from the agent, enriches them, and forwards them to the Loki persistence layer.
 
 |===
-=== .spec.agent
+== .spec.agent
 Description::
 +
 --
@@ -333,7 +331,7 @@ Type::
 | namespace where OVN-Kubernetes pods are deployed.
 
 |===
-=== .spec.consolePlugin
+== .spec.consolePlugin
 Description::
 +
 --
@@ -499,7 +497,7 @@ Type::
 | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 
 |===
-=== .spec.exporters
+== .spec.exporters
 Description::
 +
 --
@@ -675,7 +673,7 @@ Type::
 | type for the certificate reference: config map or secret
 
 |===
-=== .spec.kafka
+== .spec.kafka
 Description::
 +
 --
@@ -810,7 +808,7 @@ Type::
 | type for the certificate reference: config map or secret
 
 |===
-=== .spec.loki
+== .spec.loki
 Description::
 +
 --
@@ -987,7 +985,7 @@ Type::
 | type for the certificate reference: config map or secret
 
 |===
-=== .spec.processor
+== .spec.processor
 Description::
 +
 --
@@ -1229,7 +1227,7 @@ Type::
 | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 
 |===
-=== .status
+== .status
 Description::
 +
 --

modules/nw-network-observability-operator.adoc

@@ -3,13 +3,13 @@
 
 :_content-type: PROCEDURE
 [id="nw-network-observability-operator_{context}"]
-= Network Observability Operator
+= Viewing statuses
 
-When you deploy flow collector, the Operator provides dashboards, metrics, and keeps flows accessible in the Grafana Loki log store. When a flow collector is deployed, new dashboards are available in the {product-title} console.
+The Network Observability Operator provides the Flow Collector API. When a Flow Collector resource is created, it deploys pods and services to create and store network flows in the Loki log store, as well as to display dashboards, metrics, and flows in the {product-title} web console.
 
 .Procedure
 
-. Run the following command to view the state of `flowcollector`:
+. Run the following command to view the state of `FlowCollector`:
 +
 [source,terminal]
 ----

modules/nw-view-status-configuration-network-observability-operator.adoc

@@ -5,7 +5,7 @@
 [id="nw-status-configuration-network-observability-operator_{context}"]
 = Viewing Network Observability Operator status and configuration
 
-You can inspect the status and view the details of the `flowcollector` using the `oc describe` command.
+You can inspect the status and view the details of the `FlowCollector` using the `oc describe` command.
 
 .Procedure
 

networking/network_observability/network-observability-overview.adoc

@@ -24,7 +24,7 @@ The Network Observability Operator requires the following Operators:
 [id="network-observability-operator"]
 == Network Observability Operator
 
-The Network Observability Operator deploys a monitoring pipeline to collect and enrich the network flows. The eBPF agent, which is deployed as a `daemonset` object, creates the network flows. The network flows are then collected and enriched with the Kubernetes metadata, before storing in Loki.
+The Network Observability Operator provides the Flow Collector API custom resource definition. A Flow Collector instance is created during installation and enables configuration of network flow collection. The Flow Collector instance deploys pods and services that form a monitoring pipeline where network flows are then collected and enriched with the Kubernetes metadata before storing in Loki. The eBPF agent, which is deployed as a `daemonset` object, creates the network flows. 
 
 [id="no-console-integration"]
 == {product-title} console integration

networking/network_observability/observing-network-traffic.adoc

@@ -28,3 +28,6 @@ include::modules/network-observability-quickfilter.adoc[leveloffset=+1]
 
 Alternatively, you can access the traffic flow data in the *Network Traffic* tab of the *Namespaces*, *Services*, *Routes*, *Nodes*, and *Workloads* pages which provide the filtered data of the corresponding aggregations.
 
+[role="_additional-resources"]
+.Additional resources
+For more information about configuring quick filters in the `FlowCollector`, see xref:../network_observability/configuring-operator.adoc#network-observability-config-quick-filters_network_observability[Configuring Quick Filters] and the xref:../network_observability/configuring-operator.adoc#network-observability-flowcollector-view_network_observability[Flow Collector sample resource].