Skip to content

Commit 8449fe2

Browse files
committed
Doc review updates (Squash)
1 parent 9e2e418 commit 8449fe2

6 files changed

+17
-17
lines changed

modules/network-observability-operator-release-notes-1-10-fixed-issues.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ The Network Observability Operator 1.10 release contains several fixed issues th
1111
[id="metricname-and-remap-fields-are-validated-flowmetrics_{context}"]
1212
== MetricName and Remap fields are validated
1313

14-
Before this update, users could create a `FlowMetric` custom resource (`CR`) with an invalid metric name. Although the `FlowMetric` `CR` was successfully created, the underlying metric would fail silently without providing any error feedback to the user.
14+
Before this update, users could create a `FlowMetric` custom resource (CR) with an invalid metric name. Although the `FlowMetric` CR was successfully created, the underlying metric would fail silently without providing any error feedback to the user.
1515

16-
With this release, the `FlowMetric` `metricName` and `remap` fields are now validated before creation, so users are immediately notified if they enter an invalid name.
16+
With this release, the `FlowMetric`, `metricName`, and `remap` fields are now validated before creation, so users are immediately notified if they enter an invalid name.
1717

1818
link:https://issues.redhat.com/browse/NETOBSERV-2348[NETOBSERV-2348]
1919

2020
[id="export-overview-topology-freeze_{context}"]
2121
== Improved HTML-to-Image export performance
2222

23-
Before this update, performance issues in the underlying library caused the `HTML-to-image` export function to take a long time, leading to browser freezing.
23+
Before this update, performance issues in the underlying library caused the `html-to-image` export function to take a long time, leading to browser freezing.
2424

2525
With this release, the performance of the `html-to-image` library has been improved, reducing export wait times and eliminating browser freezing during image generation.
2626

@@ -29,7 +29,7 @@ link:https://issues.redhat.com/browse/NETOBSERV-2314[NETOBSERV-2314]
2929
[id="improved-warning-messages-on-missing-privileged-mode-for-ebpf-features_{context}"]
3030
== Improved warnings for eBPF privileged mode
3131

32-
Before this update, when users selected `eBPF` features that require `privileged mode`, the features would often fail without clearly informing the user that `privileged mode` was missing or needed to be enabled.
32+
Before this update, when users selected `eBPF` features that require `privileged` mode, the features would often fail without clearly informing the user that `privileged mode` was missing or needed to be enabled.
3333

3434
With this release, a validation hook immediately warns the user if the configuration is inconsistent. This improves user understanding and prevents misconfiguration.
3535

@@ -48,7 +48,7 @@ link:https://issues.redhat.com/browse/NETOBSERV-2405[NETOBSERV-2405]
4848
== Reduced default tolerations for network observability components
4949
Before this update, a default toleration was set on all network observability components to allow them to be scheduled on any node, including those tainted with `NoSchedule`. This could potentially block cluster upgrades.
5050

51-
With this release, the default toleration is now only maintained for the eBPF agents and the `Flowlogs-Pipeline` when configured in `Direct` mode. The toleration has been removed from the {product-title} web console plugin and the `Flowlogs-Pipeline` when configured in `Kafka` mode.
51+
With this release, the default toleration is now only maintained for the `eBPF` agents and the `Flowlogs-Pipeline` when configured in `Direct` mode. The toleration has been removed from the {product-title} web console plugin and the `Flowlogs-Pipeline` when configured in `Kafka` mode.
5252

5353
Additionally, while tolerations were always configurable in the `FlowCollector` custom resource (CR), it was previously impossible to replace the tolerations with an empty list. It is now possible to replace the tolerations with an empty list.
5454

modules/network-observability-operator-release-notes-1-10-known-issues.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Review the following known issues and their recommended workarounds (where avail
1010

1111
[id="eBPF-agent-compatibility-with-older-open-shift-versions_{context}"]
1212
== eBPF agent compatibility with older {product-title} versions
13-
The eBPF agent used in the Network Observability Command Line Interface (CLI) packet capture feature is incompatible with {product-title} (OCP) versions 4.16 and older.
13+
The eBPF agent used in the Network Observability Command Line Interface (CLI) packet capture feature is incompatible with {product-title} versions 4.16 and older.
1414

1515
This limitation prevents the eBPF-based Packet Capture Agent (PCA) from functioning correctly on those older clusters.
1616

modules/network-observability-operator-release-notes-1-10-new-features-enhancements.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
= Network Observability Operator 1.10 new features and enhancements
77

88
[role="_abstract"]
9-
The Network Observability Operator 1.10 release enhances security, improves performance, and introduces new CLI/UI tools for better network flow management.
9+
The Network Observability Operator 1.10 release enhances security, improves performance, and introduces new CLI UI tools for better network flow management.
1010

1111
[id="network-policy-updates_{context}"]
1212
== Network policy updates
@@ -21,22 +21,22 @@ This release brings the following new features and updates to the Network Observ
2121

2222
*Table view enhancements*
2323

24-
* Customizable columns: The `Manage Columns` button lets you select which columns to display and tailor the table to your needs.
24+
* Customizable columns: Click *Manage Columns* to select which columns to display, and tailor the table to your needs.
2525
* Smart filtering: Live filters now include auto-suggestions, making it easier to select the right keys and values.
2626
* Packet preview: When capturing packets, click a row to inspect the `pcap` content directly.
2727

2828
*Terminal-based line charts enhancements*
2929

3030
* Metrics visualization: Real-time graphs are rendered directly in the CLI.
31-
* Panel selection: Choose from predefined views or customize view using the `Manage Panels` popup to selectively view charts of specific metrics.
31+
* Panel selection: Choose from predefined views or customize views by using the *Manage Panels* pop-up menu to selectively view charts of specific metrics.
3232

3333
[id="network-observability-console-improvements_{context}"]
3434
== Network observability console improvements
35-
There is a new view in the network observability console plugin to configure the `FlowCollector` custom resource (CR). This new view:
35+
The network observability console plugin includes a new view to configure the `FlowCollector` custom resource (CR). From this view, you can complete the following tasks:
3636

37-
* Makes it easier to configure the `FlowCollector` CR.
38-
* Introduces a resource footprint calculator.
39-
* Increases the visibility of issues such as configuration warnings or high metrics cardinality.
37+
* Configure the `FlowCollector` CR.
38+
* Calculate your resource footprint.
39+
* Gain increased of issues such as configuration warnings or high metrics cardinality.
4040

4141
[id="network-observability-operator-performance-improvements_{context}"]
4242
== Performance improvements

modules/network-observability-operator-release-notes-1-10-removed-features.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Review the removed features that might affect your use of the Network Observabil
1010

1111
[id="flowcollector-api-v1beta1_{context}"]
1212
== FlowCollector API version v1beta1 has been removed
13-
The `FlowCollector` custom resource (`CR`) API version `v1beta1` has been removed and is no longer supported. Use the `v1beta2` version.
13+
The `FlowCollector` custom resource (CR) API version `v1beta1` has been removed and is no longer supported. Use the `v1beta2` version.

modules/network-observability-operator-release-notes-1-10-technology-preview-features.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
== Network Observability Operator custom alerts (Technology Preview)
1010
This release introduces new alert functionality, and custom alert configuration. These capabilities are Technology Preview features, and must be explicitly enabled.
1111

12-
The new alerts appear in *Observe* → *Alerting* → *Alerting rules* tab in the {product-title} web console.
12+
TTo view the new alerts, in the {product-title} web console, click *Observe* → *Alerting* → *Alerting rules*.
1313

1414
[id="network-observability-operator-network-health-dashboard-technology-preview_{context}"]
1515
== Network Observability Operator Network Health dashboard (Technology Preview)
16-
When you enable the Technology Preview alerts functionality in the Network Observability Operator, a new *Network Health* dashboard appears in {product-title} web console *Observe*.
16+
When you enable the Technology Preview alerts functionality in the Network Observability Operator, you can view a a new *Network Health* dashboard in the {product-title} web console by clicking *Observe*.
1717

1818
The *Network Health* dashboard provides a summary of triggered alerts, distinguishing between critical, warning, and minor issues, and also shows pending alerts.

observability/network_observability/network-observability-operator-release-notes-1-10.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include::_attributes/common-attributes.adoc[]
88

99
toc::[]
1010

11-
The Network Observability Operator enables administrators to observe and analyze network traffic flows for {product-title} clusters.
11+
With the Network Observability Operator, administrators can observe and analyze network traffic flows for {product-title} clusters.
1212

1313
These release notes track the development of the Network Observability Operator in the {product-title}.
1414

0 commit comments

Comments
 (0)