Merge pull request #55076 from skrthomas/GH#54809

GH#54809: Updates to Network Observability

Author: skrthomas

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

@@ -146,11 +146,12 @@ Type::
 
 | `cacheActiveTimeout`
 | `string`
-| cacheActiveTimeout is the max period during which the reporter will aggregate flows before sending
+| cacheActiveTimeout is the max period during which the reporter will aggregate flows before sending. Increasing `cacheMaxFlows` and `cacheActiveTimeout` can decrease the network traffic overhead and the CPU load, however you can expect higher memory consumption and an increased latency in the flow collection.
+
 
 | `cacheMaxFlows`
 | `integer`
-| cacheMaxFlows is the max number of flows in an aggregate; when reached, the reporter sends the flows
+| cacheMaxFlows is the max number of flows in an aggregate; when reached, the reporter sends the flows. Increasing `cacheMaxFlows` and `cacheActiveTimeout` can decrease the network traffic overhead and the CPU load, however you can expect higher memory consumption and an increased latency in the flow collection.
 
 | `debug`
 | `object`

modules/network-observability-loki-install.adoc

@@ -5,17 +5,17 @@
 :_content-type: PROCEDURE
 [id="network-observability-loki-installation_{context}"]
 = Installing the Loki Operator
+It is recommended to install Loki using the link:https://catalog.redhat.com/software/containers/openshift-logging/loki-rhel8-operator/622b46bcae289285d6fcda39[Loki Operator version 5.6], This version provides the ability to create a LokiStack instance using the `openshift-network` tennant configuration mode. It also provides fully automatic, in-cluster authentication and authorization support for Network Observability.
 
 .Prerequisites
 
-* Installed Loki, recommended to install Loki using the link:https://catalog.redhat.com/software/containers/openshift-logging/loki-rhel8-operator/622b46bcae289285d6fcda39[Loki Operator version 5.6], which allows the ability to specify a `network` tenant for Loki. The `network` tenant uses a specific tenant mode only implemented in version 5.6 of the Loki Operator. 
-* Object storage, such as AWS S3.
+* Supported Log Store (AWS S3, Google Cloud Storage, Azure, Swift, Minio, OpenShift Data Foundation)
 * {product-title} 4.10+.
 * Linux Kernel 4.18+.
 
 //* <Any Loki install prerequisites for using with Network Observability operator?>
 
-There are several ways you can install Loki. One way is by installing the Loki Operator using the {product-title} web console Operator Hub.
+There are several ways you can install Loki. One way you can install the Loki Operator is by using the {product-title} web console Operator Hub. 
 
 
 .Procedure
@@ -33,8 +33,8 @@ There are several ways you can install Loki. One way is by installing the Loki O
 .. Verify that *Loki Operator* is listed with *Status* as *Succeeded* in all the projects.
 +
 . Create a `Secret` YAML file. You can create this secret in the web console or CLI. 
-
-.. Using the web console, navigate to the Import icon ,*+*, in the top right corner. Drop your YAML file into the editor. It is important to create this YAML file in the `netobserv` namespace that uses the `access_key_id` and `access_key_secret` to specify your credentials. 
+.. Using the web console, navigate to the *Project* -> *All Projects* dropdown and select *Create Project*. Name the project `netobserv` and click *Create*.
+.. Navigate to the Import icon ,*+*, in the top right corner. Drop your YAML file into the editor. It is important to create this YAML file in the `netobserv` namespace that uses the `access_key_id` and `access_key_secret` to specify your credentials. 
 
 .. Once you create the secret, you should see it listed under *Workloads* -> *Secrets* in the web console.
 +

modules/network-observability-operator-install.adoc

@@ -5,7 +5,11 @@
 :_content-type: PROCEDURE
 [id="network-observability-operator-installation_{context}"]
 = Installing the Network Observability Operator
-You can install the Network Observability Operator using the {product-title} web console Operator Hub. When you install the Operator, you also create the `FlowCollector` resource. You can set specifications in the web console when you create the  `FlowCollector`.  
+You can install the Network Observability Operator using the {product-title} web console Operator Hub. When you install the Operator,  it provides the `FlowCollector` custom resource definition (CRD). You can set specifications in the web console when you create the  `FlowCollector`.  
+
+.Prerequisites
+
+* Installed Loki. It is recommended to install Loki using the link:https://catalog.redhat.com/software/containers/openshift-logging/loki-rhel8-operator/622b46bcae289285d6fcda39[Loki Operator version 5.6]. 
 
 .Procedure
 
@@ -17,7 +21,7 @@ You can install the Network Observability Operator using the {product-title} web
 +
 * *spec.agent.ebpf.Sampling* : Specify a sampling size for flows. Lower sampling sizes will have higher impact on resource utilization. For more information, see the `FlowCollector` API reference, under spec.agent.ebpf. 
 * *spec.deploymentModel*: If you are using Kafka, verify Kafka is selected.
-* *Loki.url*: Since authentication is specified separately, this URL needs to be updated to `https://loki-gateway.http-netobserv.svc:8080/api/logs/v1/network`
+* *loki.url*: Since authentication is specified separately, this URL needs to be updated to `https://loki-gateway-http.netobserv.svc:8080/api/logs/v1/network`. The first part of the URL, "loki", should match the name of your LokiStack.
 * *loki.tenantID*: Set this to `network`.
 * *loki.statusUrl*: Set this to `https://loki-query-frontend-http.netobserv.svc:3100/`.
 * *loki.authToken*: Select the `HOST` value.

networking/network_observability/network-observability-overview.adoc

@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-Red Hat offers cluster administrators the Network Observability Operator to observe the network traffic for {product-title} clusters. The Network Observability uses the eBPF technology to create network flows. The network flows are then enriched with {product-title} information and stored in Loki. You can view and analyze the stored netflow information in the {product-title} console for further insight and troubleshooting.
+Red Hat offers cluster administrators the Network Observability Operator to observe the network traffic for {product-title} clusters. The Network Observability uses the eBPF technology to create network flows. The network flows are then enriched with {product-title} information and stored in Loki. You can view and analyze the stored network flows information in the {product-title} console for further insight and troubleshooting.
 
 [id="dependency-network-observability"]
 == Dependency of Network Observability Operator
@@ -34,7 +34,8 @@ The Network Observability Operator provides the Flow Collector API custom resour
 [id="network-observability-dashboards"]
 === Network Observability metrics
 
-By using Network Observability metrics, you can refine the stats by using the filters and display options. The {product-title} console offers the *Overview* tab which displays the overall aggregated metrics of the network traffic flow on the cluster. You can access the information for node, namespace, owner, pod, and service.
+The {product-title} console offers the *Overview* tab which displays the overall aggregated metrics of the network traffic flow on the cluster. The information can be displayed by node, namespace, owner, pod, and service. Filters and display options can further refine the metrics.
+
 
 [id="network-observability-topology-views"]
 === Network Observability topology views