Merge pull request #54085 from snarayan-redhat/NO_singlePR

OSDOCS-4632: Observing network traffic

Author: snarayan-redhat

_topic_maps/_topic_map.yml

@@ -1313,6 +1313,8 @@ Topics:
   Topics:
   - Name: Installing Network Observability operators
     File: installing-operators
+  - Name: Observing the network traffic
+    File: observing-network-traffic
 ---
 Name: Storage
 Dir: storage

modules/network-observability-configuring-options-overview.adoc

@@ -0,0 +1,16 @@
+// Module included in the following assemblies:
+//
+// network_observability/observing-network-traffic.adoc
+
+:_content-type: REFERENCE
+[id="network-observability-configuring-options-overview_{context}"]
+= Configuring advanced options for the Overview view
+You can customize the graphical view by using advanced options. To access the advanced options, click *Show advanced options*.You can configure the details in the graph by using the *Display options* drop-down menu. The options available are:
+
+* *Metric type*: The metrics to be shown in *Bytes* or *Packets*. The default value is *Bytes*.
+* *Scope*: To select the detail of components between which the network traffic flows. You can set the scope to *Node*, *Namespace*, *Owner*, or *Resource*. *Owner* is an aggregation of resources. *Resource* can be a pod, service, node, in case of host-network traffic, or an unknown IP address. The default value is *Namespace*.
+* *Truncate labels*: Select the required width of the label from the drop-down list. The default value is *M*.
+
+[id="network-observability-cao-managing-panels-overview_{context}"]
+== Managing panels
+You can select the required statistics to be displayed, and reorder them. To manage columns, click *Manage panels*.

modules/network-observability-configuring-options-topology.adoc

@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// network_observability/observing-network-traffic.adoc
+
+:_content-type: REFERENCE
+[id="network-observability-configuring-options-topology_{context}"]
+= Configuring the advanced options for the Topology view
+You can customize and export the view by using *Show advanced options*. The advanced options view has the following features:
+
+* *Find in view*: To search the required components in the view. 
+* *Display options*: To configure the following options: 
++
+** *Layout*: To select the layout of the graphical representation. The default value is *ColaNoForce*.
+** *Scope*: To select the scope of components between which the network traffic flows. The default value is *Namespace*.
+** *Groups*: To enchance the understanding of ownership by grouping the components. The default value is *None*.
+** *Collapse groups*: To expand or collapse the groups. The groups are expanded by default. This option is disabled if *Groups* has value *None*.
+** *Show*: To select the details that need to be displayed. All the options are checked by default. The options available are: *Edges*, *Edges label*, and *Badges*.
+** *Truncate labels*: To select the required width of the label from the drop-down list. The default value is *M*.
+
+[id="network-observability-cao-export-topology_{context}"]
+== Exporting the topology view
+To export the view, click *Export topology view*. The view is downloaded in PNG format.

modules/network-observability-configuring-options-trafficflow.adoc

@@ -0,0 +1,23 @@
+// Module included in the following assemblies:
+//
+// network_observability/observing-network-traffic.adoc
+
+:_content-type: PROCEDURE
+[id="network-observability-configuring-options-trafficflow_{context}"]
+= Configuring advanced options for the Traffic flows view
+You can customize and export the view by using *Show advanced options*.
+You can set the row size by using the *Display options* drop-down menu. The default value is *Normal*.
+
+[id="network-observability-cao-managing-columns-trafficflow{context}"]
+== Managing columns
+You can select the required columns to be displayed, and reorder them. To manage columns, click *Manage columns*.
+
+[id="network-observability-cao-export-trafficflow_{context}"]
+== Exporting the traffic flow data
+You can export data from the *Traffic flows* view.
+
+.Procedure
+
+. Click *Export data*. 
+. In the pop-up window, you can select the *Export all data* checkbox to export all the data, and clear the checkbox to select the required fields to be exported.
+. Click *Export*.

modules/network-observability-overview.adoc

@@ -0,0 +1,8 @@
+// Module included in the following assemblies:
+//
+// network_observability/observing-network-traffic.adoc
+
+:_content-type: CONCEPT
+[id="network-observability-overview_{context}"]
+= Observing the network traffic from the Overview view
+The *Overview* view displays the overall aggregated metrics of the network traffic flow on the cluster. As an administrator, you can monitor the statistics with the available display options.

modules/network-observability-quickfilter.adoc

@@ -0,0 +1,29 @@
+// Module included in the following assemblies:
+//
+// network_observability/observing-network-traffic.adoc
+
+:_content-type: REFERENCE
+[id="network-observability-quickfilter{context}"]
+= Filtering the network traffic
+By default, the Network Traffic page displays the traffic flow data in the cluster based on the default filters configured in the `FlowCollector` instance. You can use the filter options to observe the required data by changing the preset filter.
+
+
+Quick filters::
+The default values in *Quick filters* drop-down menu are defined in the `FlowCollector` configuration. You can modify the options from console. 
+
+Advanced filters::
+You can set the advanced filters by providing the parameter to be filtered and its corresponding text value. The section *Common* in the parameter drop-down list filters the results that match either *Source* or *Destination*. To enable or disable the applied filter, you can click on the applied filter listed below the filter options.
+
+[NOTE]
+====
+To understand the rules of specifying the text value, click *Learn More*.
+====
+
+Query Options::
+You can use *Query Options* to optimize the search results, as listed below:
+
+** *Reporter Node*: Every flow can be reported from both source and destination nodes. For cluster ingress, the flow is reported from the destination node and for cluster egress, the flow is reported from the source node. You can select either *Source* or *Destination*. The option *Both* is disabled for the *Overview* and *Topology* view. The default selected value is *Destination*.
+** *Match filters*: You can determine the relation between different filter parameters selected in the advanced filter. The available options are *Match all* and *Match any*. *Match all*  provides results that match all the values, and *Match any* provides results that match any of the values entered. The default value is *Match all*.
+** *Limit*: The data limit for internal backend queries. Depending upon the matching and the filter settings, the number of traffic flow data is displayed within the specified limit.
+
+You can click *Reset default filter* to remove the existing filters, and apply the filter defined in `FlowCollector` configuration.

modules/network-observability-topology.adoc

@@ -0,0 +1,8 @@
+// Module included in the following assemblies:
+//
+// network_observability/observing-network-traffic.adoc
+
+:_content-type: CONCEPT
+[id="network-observability-topology_{context}"]
+= Observing the network traffic from the Topology view
+The *Topology* view provides a graphical representation of the network flows and the amount of traffic. As an administrator, you can monitor the traffic data across the application by using the *Topology* view.

modules/network-observability-trafficflow.adoc

@@ -0,0 +1,8 @@
+// Module included in the following assemblies:
+//
+// network_observability/observing-network-traffic.adoc
+
+:_content-type: CONCEPT
+[id="network-observability-trafficflow_{context}"]
+= Observing the network traffic from the Traffic flows view
+The *Traffic flows* view displays the data of the network flows and the amount of traffic in a table. As an administrator, you can monitor the amount of traffic across the application by using the traffic flow table.

modules/network-observability-working-with-overview.adoc

@@ -0,0 +1,14 @@
+// Module included in the following assemblies:
+//
+// network_observability/observing-network-traffic.adoc
+
+:_content-type: PROCEDURE
+[id="network-observability-working-with-overview_{context}"]
+= Working with the Overview view
+As an administrator, you can navigate to the *Overview* view to see the graphical representation of the flow rate statistics.
+
+.Procedure
+. Navigate to *Observe* → *Network Traffic*.
+. In the *Network Traffic* page, click the *Overview* tab.
+
+You can configure the scope of each flow rate data by clicking the menu icon.

modules/network-observability-working-with-topology.adoc

@@ -0,0 +1,14 @@
+// Module included in the following assemblies:
+//
+// network_observability/observing-network-traffic.adoc
+
+:_content-type: PROCEDURE
+[id="network-observability-working-with-topology_{context}"]
+= Working with the Topology view
+As an administrator, you can navigate to the *Topology* view to see the details and metrics of the component.
+
+.Procedure
+. Navigate to *Observe* → *Network Traffic*.
+. In the *Network Traffic* page, click the *Topology* tab.
+
+You can click each component in the *Topology* to view the details and metrics of the component.