Skip to content

Commit e9bf3ae

Browse files
committed
OSDOCS-17329 [NETOBSERV] xrefs in Release Note modules
1 parent d3b2426 commit e9bf3ae

12 files changed

+132
-62
lines changed

modules/network-observability-release-notes-1-4-0-advisory.adoc renamed to modules/network-observability-operator-release-notes-1-4-0-advisory.adoc

File renamed without changes.

modules/network-observability-release-notes-1-4-0-fixed-issues.adoc renamed to modules/network-observability-operator-release-notes-1-4-0-fixed-issues.adoc

File renamed without changes.

modules/network-observability-release-notes-1-4-0-known-issues.adoc renamed to modules/network-observability-operator-release-notes-1-4-0-known-issues.adoc

File renamed without changes.

modules/network-observability-release-notes-1-4-0-new-features-and-enhancements.adoc renamed to modules/network-observability-operator-release-notes-1-4-0-new-features-and-enhancements.adoc

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,63 +21,76 @@ The 1.4 release of the Network Observability Operator adds improvements and new
2121
** The *NetObserv / Health* dashboard shows flows overhead as well as top flow rates per nodes, namespaces, and workloads.
2222
** Infrastructure and Application metrics are shown in a split-view for namespaces and workloads.
2323

24-
////
25-
For more information, see xref:../../../observability/network_observability/network-observability-overview.adoc#network-observability-dashboards_network-observability-overview[Network observability metrics dashboards] and xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-quickfilter_nw-observe-network-traffic[Quick filters].
26-
////
24+
25+
For more information, see:
26+
27+
* xref:../../../observability/network_observability/network-observability-overview.adoc#network-observability-dashboards_network-observability-overview[Network observability metrics dashboards]
28+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-quickfilter_nw-observe-network-traffic[Quick filters]
29+
2730

2831
[id="configuration-enhancements-1.4_{context}"]
2932
== Configuration enhancements:
3033
* You now have the option to specify different namespaces for any configured ConfigMap or Secret reference, such as in certificates configuration.
3134
* The `spec.processor.clusterName` parameter is added so that the name of the cluster appears in the flows data. This is useful in a multi-cluster context. When using {product-title}, leave empty to make it automatically determined.
3235

33-
////
34-
For more information, see the following links:
36+
37+
For more information, see:
38+
3539
* xref:../../../observability/network_observability/configuring-operator.adoc#network-observability-flowcollector-view_network_observability[Flow Collector sample resource]
36-
* xref:../../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference].
37-
////
40+
* xref:../../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference]
41+
3842

3943
[id="network-observability-without-loki-1.4_{context}"]
4044
== Network observability without Loki
4145
The Network Observability Operator is now functional and usable without Loki. If Loki is not installed, it can only export flows to KAFKA or IPFIX format and provide metrics in the network observability metrics dashboards.
4246

43-
////
44-
For more information, see the following link:
45-
* xref:../../../observability/network_observability/installing-operators.adoc#network-observability-without-loki_network_observability[Network observability without Loki].
46-
////
47+
48+
For more information, see:
49+
50+
* xref:../../../observability/network_observability/installing-operators.adoc#network-observability-without-loki_network_observability[Network observability without Loki]
51+
4752

4853
[id="network-observability-dns-tracking-1.4_{context}"]
4954
== DNS tracking
5055
In 1.4, the Network Observability Operator makes use of eBPF tracepoint hooks to enable DNS tracking. You can monitor your network, conduct security analysis, and troubleshoot DNS issues in the *Network Traffic* and *Overview* pages in the web console.
5156

52-
////
53-
For more information, see the following links:
57+
58+
For more information, see:
59+
5460
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-dns-overview_nw-observe-network-traffic[Configuring DNS tracking]
5561
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-dns-tracking_nw-observe-network-traffic[Working with DNS tracking]
56-
////
62+
5763

5864
[id="SR-IOV-configuration-1.4_{context}"]
5965
== SR-IOV support
6066
You can now collect traffic from a cluster with Single Root I/O Virtualization (SR-IOV) device.
6167

62-
////
63-
For more information, see xref:../../../observability/network_observability/network-observability-secondary-networks.adoc#network-observability-SR-IOV-config_network-observability-secondary-networks[Configuring the monitoring of SR-IOV interface traffic].
64-
////
68+
69+
For more information, see:
70+
71+
* xref:../../../observability/network_observability/network-observability-secondary-networks.adoc#network-observability-SR-IOV-config_network-observability-secondary-networks[Configuring the monitoring of SR-IOV interface traffic]
72+
6573

6674
[id="IPFIX-support-1.4_{context}"]
6775
== IPFIX exporter support
6876
You can now export eBPF-enriched network flows to the IPFIX collector.
6977

70-
////
71-
For more information, see xref:../../../observability/network_observability/configuring-operator.adoc#network-observability-enriched-flows_network_observability[Export enriched network flow data].
72-
////
78+
79+
For more information, see:
80+
81+
* xref:../../../observability/network_observability/configuring-operator.adoc#network-observability-enriched-flows_network_observability[Export enriched network flow data]
82+
7383

7484
[id="network-observability-packet-drop-1.4_{context}"]
7585
== Packet drops
7686
In the 1.4 release of the Network Observability Operator, eBPF tracepoint hooks are used to enable packet drop tracking. You can now detect and analyze the cause for packet drops and make decisions to optimize network performance. In {product-title} 4.14 and later, both host drops and OVS drops are detected. In {product-title} 4.13, only host drops are detected.
7787

78-
////
79-
For more information, see xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-pktdrop-overview_nw-observe-network-traffic[Configuring packet drop tracking] and xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-packet-drops_nw-observe-network-traffic[Working with packet drops].
80-
////
88+
89+
For more information, see:
90+
91+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-pktdrop-overview_nw-observe-network-traffic[Configuring packet drop tracking]
92+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-packet-drops_nw-observe-network-traffic[Working with packet drops]
93+
8194

8295
[id="s390x-architecture-support_{context}"]
8396
== s390x architecture support

modules/network-observability-release-notes-1-4-0-removed-features.adoc renamed to modules/network-observability-operator-release-notes-1-4-0-removed-features.adoc

File renamed without changes.

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

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,41 +12,52 @@ You can view the following new features and enhancements for the Network Observa
1212
== DNS tracking enhancements
1313
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.
1414

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-
////
15+
For more information, see:
16+
17+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-dns-overview_nw-observe-network-traffic[Configuring DNS tracking]
18+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-dns-tracking_nw-observe-network-traffic[Working with DNS tracking]
19+
1820

1921
[id="network-observability-RTT-1.5_{context}"]
2022
== Round-trip time (RTT)
2123
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.
2224

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-
////
25+
26+
For more information, see:
27+
28+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-RTT-overview_nw-observe-network-traffic[RTT Overview]
29+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-RTT_nw-observe-network-traffic[Working with RTT]
30+
2631

2732
[id="network-observability-metrics-dashboard-enhancements_{context}"]
2833
== Metrics, dashboards, and alerts enhancements
2934
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.
3035

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-
////
36+
37+
For a complete list of these metrics, see:
38+
39+
* xref:../../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-metrics_metrics-dashboards-alerts[Network observability metrics]
40+
3441

3542
[id="network-observability-improved-lokistack-integration_{context}"]
3643
== Improvements for network observability without Loki
3744
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.
3845

39-
////
40-
For more information, see xref:../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-metrics_metrics-dashboards-alerts[Network observability metrics]
41-
////
46+
47+
For more information, see:
48+
49+
* xref:../../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-metrics_metrics-dashboards-alerts[Network observability metrics]
50+
4251

4352
[id="network-observability-zones_{context}"]
4453
== Availability zones
4554
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.
4655

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-
////
56+
57+
For more information, see:
58+
59+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-zones_nw-observe-network-traffic[Working with availability zones]
60+
5061

5162
[id="network-observability-enhanced-configuration-and-ui-1.5_{context}"]
5263
== Notable enhancements

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

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@ You can review the following new features and enhancements for the Network Obser
1212
== Enhanced use of Network Observability Operator without Loki
1313
You can now use Prometheus metrics and rely less on Loki for storage when using the Network Observability Operator.
1414

15-
// For more information, see xref:../../observability/network_observability/installing-operators.adoc#network-observability-without-loki_network_observability[Network observability without Loki].
15+
For more information, see:
16+
17+
* xref:../../../observability/network_observability/installing-operators.adoc#network-observability-without-loki_network_observability[Network observability without Loki]
1618

1719
[id="network-observability-custom-metrics-1.6_{context}"]
1820
== Custom metrics API
1921
You can create custom metrics out of flowlogs data by using the `FlowMetrics` API. Flowlogs data can be used with Prometheus labels to customize cluster information on your dashboards. You can add custom labels for any subnet that you want to identify in your flows and metrics. This enhancement can also be used to more easily identify external traffic by using the new labels `SrcSubnetLabel` and `DstSubnetLabel`, which exists both in flow logs and in metrics. Those fields are empty when there is external traffic, which gives a way to identify it.
2022

21-
//For more information, see xref:../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-custom-metrics_metrics-dashboards-alerts[Custom metrics] and xref:../../observability/network_observability/flowmetric-api.adoc#flowmetric-flows-netobserv-io-v1alpha1[FlowMetric API reference].
23+
For more information, see:
24+
25+
* xref:../../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-custom-metrics_metrics-dashboards-alerts[Custom metrics]
26+
* xref:../../../observability/network_observability/flowmetric-api.adoc#flowmetric-flows-netobserv-io-v1alpha1[FlowMetric API reference]
2227

2328
[id="network-observability-eBPF-performance-enhancements-1.6_{context}"]
2429
== eBPF performance enhancements
@@ -33,13 +38,18 @@ Experience improved performances of the eBPF agent, in terms of CPU and memory,
3338
=====
3439
With the duplicated flows update, the *Interface* and *Interface Direction* fields in the *Network Traffic* table are renamed to *Interfaces* and *Interface Directions*, so any bookmarked *Quick filter* queries using these fields need to be updated to `interfaces` and `ifdirections`.
3540
=====
36-
////
37-
For more information, see xref:../../observability/network_observability/network-observability-operator-monitoring.adoc#network-observability-netobserv-dashboard-ebpf-agent-alerts_network_observability[Using the eBPF agent alert]
38-
and For more information, see xref:../../observability/network_observability/network-observability-overview.adoc#network-observability-dashboards_network-observability-overview[Network observability metrics dashboards] and xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-quickfilter_nw-observe-network-traffic[Filtering the network traffic].
39-
////
41+
42+
For more information, see:
43+
44+
* xref:../../../observability/network_observability/network-observability-operator-monitoring.adoc#network-observability-netobserv-dashboard-ebpf-agent-alerts_network_observability[Using the eBPF agent alert]
45+
* xref:../../../observability/network_observability/network-observability-overview.adoc#network-observability-dashboards_network-observability-overview[Network observability metrics dashboards]
46+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-quickfilter_nw-observe-network-traffic[Filtering the network traffic]
47+
4048

4149
[id="network-observability-ebpf-collection-filtering-1.6_{context}"]
4250
== eBPF collection rule-based filtering
4351
You can use rule-based filtering to reduce the volume of created flows. When this option is enabled, the *Netobserv / Health* dashboard for eBPF agent statistics has the *Filtered flows rate* view.
4452

45-
//For more information, see xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-ebpf-flow-rule-filter_nw-observe-network-traffic[eBPF flow rule filter].
53+
For more information, see:
54+
55+
* xref:../../../observability/network_observability/observing-network-traffic.adoc#network-observability-ebpf-flow-rule-filter_nw-observe-network-traffic[eBPF flow rule filter]

0 commit comments

Comments
 (0)