Skip to content

Commit 1ad869b

Browse files
gwynnemonahangwynnemonahan
committed
OSDOCS-15826 [NETOBSERV] Refactor release notes 1.5.0
1 parent 75e1650 commit 1ad869b

5 files changed

+134
-1
lines changed

‎modules/network-observability-operator-release-notes-1-5-0-fixed-issues.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Module included in the following assemblies:
2+
// * network_observability/release_notes_archive/network-observability-operator-release-notes-archive.adoc
3+
4+
:_mod-docs-content-type: REFERENCE
5+
[id="network-observability-operator-release-notes-1-5-0-fixed-issues_{context}"]
6+
= Network Observability Operator 1.5.0 fixed issues
7+
8+
[role="_abstract"]
9+
You can view the following fixed issues for the Network Observability Operator 1.5 release.
10+
11+
* Previously, it was not possible to register the console plugin manually in the web console interface if the automatic registration of the console plugin was disabled. If the `spec.console.register` value was set to `false` in the `FlowCollector` resource, the Operator would override and erase the plugin registration.
12+
With this fix, setting the `spec.console.register` value to `false` does not impact the console plugin registration or registration removal. As a result, the plugin can be safely registered manually. (link:https://issues.redhat.com/browse/NETOBSERV-1134[*NETOBSERV-1134*])
13+
* Previously, using the default metrics settings, the *NetObserv/Health* dashboard was showing an empty graph named *Flows Overhead*. This metric was only available by removing "namespaces-flows" and "namespaces" from the `ignoreTags` list. With this fix, this metric is visible when you use the default metrics setting. (link:https://issues.redhat.com/browse/NETOBSERV-1351[*NETOBSERV-1351*])
14+
* Previously, the node on which the eBPF Agent was running would not resolve with a specific cluster configuration. This resulted in cascading consequences that culminated in a failure to provide some of the traffic metrics. With this fix, the eBPF agent's node IP is safely provided by the Operator, inferred from the pod status. Now, the missing metrics are restored. (link:https://issues.redhat.com/browse/NETOBSERV-1430[*NETOBSERV-1430*])
15+
* Previously, the Loki error 'Input size too long' error for the Loki Operator did not include additional information to troubleshoot the problem.
16+
With this fix, help is directly displayed in the web console next to the error with a direct link for more guidance. (link:https://issues.redhat.com/browse/NETOBSERV-1464[*NETOBSERV-1464*])
17+
* Previously, the console plugin read timeout was forced to 30s.
18+
With the `FlowCollector` `v1beta2` API update, you can configure the `spec.loki.readTimeout` specification to update this value according to the Loki Operator `queryTimeout` limit. (link:https://issues.redhat.com/browse/NETOBSERV-1443[*NETOBSERV-1443*])
19+
* Previously, the Operator bundle did not display some of the supported features by CSV annotations as expected, such as `features.operators.openshift.io/...`
20+
With this fix, these annotations are set in the CSV as expected. (link:https://issues.redhat.com/browse/NETOBSERV-1305[*NETOBSERV-1305*])
21+
* Previously, the `FlowCollector` status sometimes oscillated between `DeploymentInProgress` and `Ready` states during reconciliation.
22+
With this fix, the status only becomes `Ready` when all of the underlying components are fully ready. (link:https://issues.redhat.com/browse/NETOBSERV-1293[*NETOBSERV-1293*])

‎modules/network-observability-operator-release-notes-1-5-0-known-issues.adoc‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Module included in the following assemblies:
2+
// * network_observability/release_notes_archive/network-observability-operator-release-notes-archive.adoc
3+
4+
:_mod-docs-content-type: REFERENCE
5+
[id="network-observability-operator-release-notes-1-5-0-known-issues_{context}"]
6+
= Network Observability Operator 1.5.0 known issues
7+
8+
[role="_abstract"]
9+
You can view the following known issues for the Network Observability Operator 1.5 release.
10+
11+
* When trying to access the web console, cache issues on OCP 4.14.10 prevent access to the *Observe* view. The web console shows the error message: `Failed to get a valid plugin manifest from /api/plugins/monitoring-plugin/`. The recommended workaround is to update the cluster to the latest minor version. If this does not work, you need to apply the workarounds described in this link:https://access.redhat.com/solutions/7052408[Red Hat Knowledgebase article].(link:https://issues.redhat.com/browse/NETOBSERV-1493[*NETOBSERV-1493*])
12+
13+
* Since the 1.3.0 release of the Network Observability Operator, installing the Operator causes a warning kernel taint to appear. The reason for this error is that the network observability eBPF agent has memory constraints that prevent preallocating the entire hashmap table. The Operator eBPF agent sets the `BPF_F_NO_PREALLOC` flag so that pre-allocation is disabled when the hashmap is too memory expansive.

‎modules/network-observability-operator-release-notes-1-5-0-new-features-and-enhancements.adoc‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
// Module included in the following assemblies:
2+
// * network_observability/release_notes_archive/network-observability-operator-release-notes-archive.adoc
3+
4+
:_mod-docs-content-type: REFERENCE
5+
[id="network-observability-operator-release-notes-1-5-0-new-features-and-enhancements_{context}"]
6+
= Network Observability Operator 1.5.0 new features and enhancements
7+
8+
[role="_abstract"]
9+
You can view the following new features and enhancements for the Network Observability Operator 1.5 release.
10+
11+
[id="network-observability-dns-enhancements-1.5_{context}"]
12+
== DNS tracking enhancements
13+
In 1.5, the TCP protocol is now supported in addition to UDP. New dashboards are also added to the *Overview* view of the Network Traffic page.
14+
15+
////
16+
For more information, see xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-dns-overview_nw-observe-network-traffic[Configuring DNS tracking] and xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-dns-tracking_nw-observe-network-traffic[Working with DNS tracking].
17+
////
18+
19+
[id="network-observability-RTT-1.5_{context}"]
20+
== Round-trip time (RTT)
21+
You can use TCP handshake Round-Trip Time (RTT) captured from the `fentry/tcp_rcv_established` Extended Berkeley Packet Filter (eBPF) hookpoint to read smoothed round-trip time (SRTT) and analyze network flows. In the *Overview*, *Network Traffic*, and *Topology* pages in web console, you can monitor network traffic and troubleshoot with RTT metrics, filtering, and edge labeling.
22+
23+
////
24+
For more information, see xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-RTT-overview_nw-observe-network-traffic[RTT Overview] and xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-RTT_nw-observe-network-traffic[Working with RTT].
25+
////
26+
27+
[id="network-observability-metrics-dashboard-enhancements_{context}"]
28+
== Metrics, dashboards, and alerts enhancements
29+
The network observability metrics dashboards in *Observe* → *Dashboards* → *NetObserv* have new metrics types you can use to create Prometheus alerts. You can now define available metrics in the `includeList` specification. In previous releases, these metrics were defined in the `ignoreTags` specification.
30+
31+
////
32+
For a complete list of these metrics, see xref:../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-metrics_metrics-dashboards-alerts[Network observability metrics].
33+
////
34+
35+
[id="network-observability-improved-lokistack-integration_{context}"]
36+
== Improvements for network observability without Loki
37+
You can create Prometheus alerts for the *Netobserv* dashboard using DNS, Packet drop, and RTT metrics, even if you don't use Loki. In the previous version of network observability, 1.4, these metrics were only available for querying and analysis in the *Network Traffic*, *Overview*, and *Topology* views, which are not available without Loki.
38+
39+
////
40+
For more information, see xref:../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-metrics_metrics-dashboards-alerts[Network observability metrics]
41+
////
42+
43+
[id="network-observability-zones_{context}"]
44+
== Availability zones
45+
You can configure the `FlowCollector` resource to collect information about the cluster availability zones. This configuration enriches the network flow data with the link:https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone[`topology.kubernetes.io/zone`] label value applied to the nodes.
46+
47+
////
48+
For more information, see xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-zones_nw-observe-network-traffic[Working with availability zones]
49+
////
50+
51+
[id="network-observability-enhanced-configuration-and-ui-1.5_{context}"]
52+
== Notable enhancements
53+
The 1.5 release of the Network Observability Operator adds improvements and new capabilities to the {product-title} web console plugin and the Operator configuration.
54+
55+
[id="performance-enhancements-1.5_{context}"]
56+
== Performance enhancements
57+
* The `spec.agent.ebpf.kafkaBatchSize` default is changed from `10MB` to `1MB` to enhance eBPF performance when using Kafka.
58+
+
59+
[IMPORTANT]
60+
=====
61+
When upgrading from an existing installation, this new value is not set automatically in the configuration. If you monitor a performance regression with the eBPF Agent memory consumption after upgrading, you might consider reducing the `kafkaBatchSize` to the new value.
62+
=====
63+
64+
[id="web-console-enhancements-1.5_{context}"]
65+
== Web console enhancements:
66+
67+
* There are new panels added to the *Overview* view for DNS and RTT: Min, Max, P90, P99.
68+
* There are new panel display options added:
69+
** Focus on one panel while keeping others viewable but with smaller focus.
70+
** Switch graph type.
71+
** Show *Top* and *Overall*.
72+
* A collection latency warning is shown in the *Custom time range* window.
73+
* There is enhanced visibility for the contents of the *Manage panels* and *Manage columns* pop-up windows.
74+
* The Differentiated Services Code Point (DSCP) field for egress QoS is available for filtering QoS DSCP in the web console *Network Traffic* page.
75+
76+
[id="configuration-enhancements-1.5_{context}"]
77+
== Configuration enhancements:
78+
79+
* The `LokiStack` mode in the `spec.loki.mode` specification simplifies installation by automatically setting URLs, TLS, cluster roles and a cluster role binding, as well as the `authToken` value. The `Manual` mode allows more control over configuration of these settings.
80+
* The API version changes from `flows.netobserv.io/v1beta1` to `flows.netobserv.io/v1beta2`.

‎modules/network-observability-operator-release-notes-1-5-0.adoc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Module included in the following assemblies:
2+
// * network_observability/release_notes_archive/network-observability-operator-release-notes-archive.adoc
3+
4+
:_mod-docs-content-type: REFERENCE
5+
[id="network-observability-operator-release-notes-1-5-0_{context}"]
6+
= Network Observability Operator 1.5.0 advisory
7+
8+
[role="_abstract"]
9+
You can view the following advisory for the Network Observability Operator 1.5 release.
10+
11+
link:https://access.redhat.com/errata/RHSA-2024:0853[Network Observability Operator 1.5.0]

‎observability/network_observability/release_notes_archive/network-observability-operator-release-notes-archive.adoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,14 @@ include::modules/network-observability-operator-release-notes-1-9-2-bug-fixes.ad
2828
//netobserv 1.6.2
2929
//netobserv 1.6.1
3030
//netobserv 1.6.0
31-
//netobserv 1.5.0
31+
32+
include::modules/network-observability-operator-release-notes-1-5-0.adoc[leveloffset=+1]
33+
34+
include::modules/network-observability-operator-release-notes-1-5-0-new-features-and-enhancements.adoc[leveloffset=+1]
35+
36+
include::modules/network-observability-operator-release-notes-1-5-0-fixed-issues.adoc[leveloffset=+1]
37+
38+
include::modules/network-observability-operator-release-notes-1-5-0-known-issues.adoc[leveloffset=+1]
3239

3340
include::modules/network-observability-operator-release-notes-1-4-2.adoc[leveloffset=+1]
3441

0 commit comments

Comments
 (0)