Merge pull request #65770 from skrthomas/network-observability-topicmap-lift

OSDOCS-8022: Reorganizing Network Observability in the topicmap

Author: skrthomas

_topic_maps/_topic_map.yml

@@ -1500,31 +1500,6 @@ Topics:
     File: metallb-troubleshoot-support
 - Name: Associating secondary interfaces metrics to network attachments
   File: associating-secondary-interfaces-metrics-to-network-attachments
-- Name: Network Observability
-  Dir: network_observability
-  Topics:
-  - Name: Network Observability release notes
-    File: network-observability-operator-release-notes
-  - Name: Network Observability overview
-    File: network-observability-overview
-  - Name: Installing the Network Observability Operator
-    File: installing-operators
-  - Name: Understanding Network Observability Operator
-    File: understanding-network-observability-operator
-  - Name: Configuring the Network Observability Operator
-    File: configuring-operator
-  - Name: Network Policy
-    File: network-observability-network-policy
-  - Name: Observing the network traffic
-    File: observing-network-traffic
-  - Name: Monitoring the Network Observability Operator
-    File: network-observability-operator-monitoring
-  - Name: API reference
-    File: flowcollector-api
-  - Name: JSON flows format reference
-    File: json-flows-format-reference
-  - Name: Troubleshooting Network Observability
-    File: troubleshooting-network-observability
 ---
 Name: Storage
 Dir: storage
@@ -2624,6 +2599,33 @@ Topics:
 - Name: Config map reference for the Cluster Monitoring Operator
   File: config-map-reference-for-the-cluster-monitoring-operator
 ---
+Name: Network Observability
+Dir: network_observability
+Distros: openshift-enterprise,openshift-origin
+Topics:
+- Name: Network Observability release notes
+  File: network-observability-operator-release-notes
+- Name: Network Observability overview
+  File: network-observability-overview
+- Name: Installing the Network Observability Operator
+  File: installing-operators
+- Name: Understanding Network Observability Operator
+  File: understanding-network-observability-operator
+- Name: Configuring the Network Observability Operator
+  File: configuring-operator
+- Name: Network Policy
+  File: network-observability-network-policy
+- Name: Observing the network traffic
+  File: observing-network-traffic
+- Name: Monitoring the Network Observability Operator
+  File: network-observability-operator-monitoring
+- Name: API reference
+  File: flowcollector-api
+- Name: JSON flows format reference
+  File: json-flows-format-reference
+- Name: Troubleshooting Network Observability
+  File: troubleshooting-network-observability
+---
 Name: Scalability and performance
 Dir: scalability_and_performance
 Distros: openshift-origin,openshift-enterprise,openshift-webscale,openshift-dpu

networking/network_observability/_attributes renamed to network_observability/_attributes

@@ -13,21 +13,21 @@ include::modules/network-observability-flowcollector-view.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-For more information about conversation tracking, see xref:../../networking/network_observability/observing-network-traffic.adoc#network-observability-working-with-conversations_nw-observe-network-traffic[Working with conversations].
+For more information about conversation tracking, see xref:../network_observability/observing-network-traffic.adoc#network-observability-working-with-conversations_nw-observe-network-traffic[Working with conversations].
 
 include::modules/network-observability-flowcollector-kafka-config.adoc[leveloffset=+1]
 include::modules/network-observability-enriched-flows.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources 
-For more information about specifying flow format, see xref:../../networking/network_observability/json-flows-format-reference.adoc#network-observability-flows-format_json_reference[Network flows format reference].
+For more information about specifying flow format, see xref:../network_observability/json-flows-format-reference.adoc#network-observability-flows-format_json_reference[Network flows format reference].
 
 include::modules/network-observability-configuring-FLP-sampling.adoc[leveloffset=+1]
 include::modules/network-observability-configuring-quickfilters-flowcollector.adoc[leveloffset=+1]
 include::modules/network-observability-SRIOV-configuration.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
-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].
+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].
 
 include::modules/network-observability-resource-recommendations.adoc[leveloffset=+1]
 include::modules/network-observability-resources-table.adoc[leveloffset=+2]

networking/network_observability/configuring-operator.adoc renamed to network_observability/configuring-operator.adoc

@@ -0,0 +1,65 @@
+:_content-type: ASSEMBLY
+[id="installing-network-observability-operators"]
+= Installing the Network Observability Operator
+include::_attributes/common-attributes.adoc[]
+:context: network_observability
+
+toc::[]
+Installing Loki is a recommended prerequisite for using the Network Observability Operator. You can choose to use xref:../network_observability/installing-operators.adoc#network-observability-without-loki_network_observability[Network Observability without Loki], but there are some considerations for doing this, described in the previously linked section.
+
+The Loki Operator integrates a gateway that implements multi-tenancy and authentication with Loki for data flow storage. The `LokiStack` resource manages Loki, which is a scalable, highly-available, multi-tenant log aggregation system, and a web proxy with {product-title} authentication. The `LokiStack` proxy uses {product-title} authentication to enforce multi-tenancy and facilitate the saving and indexing of data in Loki log stores. 
+
+[NOTE]
+====
+The Loki Operator can also be used for xref:../logging/cluster-logging-loki.adoc#cluster-logging-loki[Logging with the LokiStack]. The Network Observability Operator requires a dedicated LokiStack separate from Logging.
+====
+
+include::modules/network-observability-without-loki.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../network_observability/configuring-operator.adoc#network-observability-enriched-flows_network_observability[Export enriched network flow data].
+
+include::modules/network-observability-loki-install.adoc[leveloffset=+1]
+include::modules/network-observability-loki-secret.adoc[leveloffset=+2]
+[role="_additional-resources"]
+.Additional resources
+* For more information about the option to use different namespaces for the separate components, see the `spec.loki.tls.caCert.namespace` specification in the xref:../network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference] and callout number 5 in the xref:../network_observability/configuring-operator.adoc#network-observability-flowcollector-view_network_observability[Flow Collector sample resource].
+
+include::modules/network-observability-lokistack-create.adoc[leveloffset=+2]
+include::modules/network-observability-lokistack-ingestion-query.adoc[leveloffset=+2]
+include::modules/network-observability-auth-multi-tenancy.adoc[leveloffset=+2]
+include::modules/network-observability-multitenancy.adoc[leveloffset=+2]
+include::modules/network-observability-operator-install.adoc[leveloffset=+1]
+
+
+[role="_additional-resources"]
+[id="additional-resources_configuring-flow-collector-considerations"]
+== Important Flow Collector configuration considerations
+Once you create the `FlowCollector` instance, you can reconfigure it, but the pods are terminated and recreated again, which can be disruptive. Therefore, you can consider configuring the following options when creating the `FlowCollector` for the first time:
+
+* xref:../network_observability/configuring-operator.adoc#network-observability-flowcollector-kafka-config_network_observability[Configuring the Flow Collector resource with Kafka]
+* xref:../network_observability/configuring-operator.adoc#network-observability-enriched-flows_network_observability[Export enriched network flow data to Kafka or IPFIX]
+* xref:../network_observability/configuring-operator.adoc#network-observability-SR-IOV-config_network_observability[Configuring monitoring for SR-IOV interface traffic]
+* xref:../network_observability/observing-network-traffic.adoc#network-observability-working-with-conversations_nw-observe-network-traffic[Working with conversation tracking]
+* xref:../network_observability/observing-network-traffic.adoc#network-observability-dns-tracking_nw-observe-network-traffic[Working with DNS tracking]
+* xref:../network_observability/observing-network-traffic.adoc#network-observability-packet-drops_nw-observe-network-traffic[Working with packet drops]
+
+[role="_additional-resources"]
+.Additional resources
+For more general information about Flow Collector specifications and the Network Observability Operator architecture and resource use, see the following resources: 
+
+* xref:../network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference]
+* xref:../network_observability/configuring-operator.adoc#network-observability-flowcollector-view_network_observability[Flow Collector sample resource]
+* xref:../network_observability/configuring-operator.adoc#network-observability-resources-table_network_observability[Resource considerations]
+* xref:../network_observability/troubleshooting-network-observability.adoc#controller-manager-pod-runs-out-of-memory_network-observability-troubleshooting[Troubleshooting Network Observability controller manager pod runs out of memory] 
+* xref:../network_observability/understanding-network-observability-operator.adoc#network-observability-architecture_nw-network-observability-operator[Network Observability architecture]
+
+
+include::modules/network-observability-kafka-option.adoc[leveloffset=+1]
+[role="_additional-resources"]
+.Additional resources
+xref:../network_observability/configuring-operator.adoc#network-observability-flowcollector-kafka-config_network_observability[Configuring the FlowCollector resource with Kafka].
+
+include::modules/network-observability-operator-uninstall.adoc[leveloffset=+1]
+

networking/network_observability/flowcollector-api.adoc renamed to network_observability/flowcollector-api.adoc

@@ -13,4 +13,4 @@ include::modules/network-observability-sample-network-policy-YAML.adoc[leveloffs
 
 [role="_additional-resources"]
 .Additional resources
-xref:../../networking/network_policy/creating-network-policy.adoc#nw-networkpolicy-object_creating-network-policy[Creating a network policy using the CLI]
+xref:../networking/network_policy/creating-network-policy.adoc#nw-networkpolicy-object_creating-network-policy[Creating a network policy using the CLI]

networking/network_observability/images renamed to network_observability/images

@@ -15,4 +15,4 @@ include::modules/network-observability-rate-limit-alert.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* For more information about creating alerts that you can see on the dashboard, see xref:../../monitoring/managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_managing-alerts[Creating alerting rules for user-defined projects].
+* For more information about creating alerts that you can see on the dashboard, see xref:../monitoring/managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_managing-alerts[Creating alerting rules for user-defined projects].