Skip to content

Commit b40a012

Browse files
authored
Merge pull request #83983 from openshift-cherrypick-robot/cherry-pick-79457-to-enterprise-4.12
[enterprise-4.12] : Updating CLI install link/removing warnings
2 parents ef53480 + f379386 commit b40a012

File tree

4 files changed

+22
-33
lines changed

4 files changed

+22
-33
lines changed

modules/network-observability-netobserv-cli-install.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,24 @@ You can optionally use Krew to install the `netobserv` CLI plugin. For more info
1818
1919
.Procedure
2020

21-
. Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/netobserv/latest/[`oc netobserv` CLI tar file].
22-
. Unpack the archive:
21+
. Download the link:https://developers.redhat.com/content-gateway/rest/mirror2/pub/openshift-v4/clients/netobserv/latest[`oc netobserv` CLI tar file] that corresponds with your architecture.
22+
. Unpack the archive. For example, for the `amd64` archive, run the following command:
2323
+
2424
[source,terminal]
2525
----
26-
$ tar xvf netobserv-cli.tar.gz
26+
$ tar xvf netobserv-cli-linux-amd64.tar.gz
2727
----
2828
. Make the file executable:
2929
+
3030
[source,terminal]
3131
----
32-
$ chmod +x ./build/oc-netobserv
32+
$ chmod +x ./oc-netobserv
3333
----
3434
. Move the extracted `netobserv-cli` binary to a directory that is on your `PATH`, such as `/usr/local/bin/`:
3535
+
3636
[source,terminal]
3737
----
38-
$ sudo mv ./build/oc-netobserv /usr/local/bin/
38+
$ sudo mv ./oc-netobserv /usr/local/bin/
3939
----
4040

4141
.Verification

observability/network_observability/netobserv_cli/netobserv-cli-install.adoc

-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
include::snippets/network-observability-netobserv-cli-install-warning.adoc[]
10-
119
The Network Observability CLI (`oc netobserv`) is deployed separately from the Network Observability Operator. The CLI is available as an {oc-first} plugin. It provides a lightweight way to quickly debug and troubleshoot with network observability.
1210

1311
:FeatureName: Network Observability CLI (`oc netobserv`)

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

+17-11
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,13 @@ You can now export enriched network flows to a compatible OpenTelemetry endpoint
2929
==== Network Observability Developer perspective
3030
You can now use Network Observability in the *Developer* perspective. For more information, see xref:../../observability/network_observability/network-observability-overview.adoc#no-console-integration[{product-title} console integration].
3131

32-
[id="network-observability-operator-tcp-flags-filtering-1-7_{context}"]
3332
==== TCP flags filtering
34-
You can now use the `tcpFlags` filter to limit the volume of packets processed by the eBPF program. For more information, see xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-flowcollector-flowfilter-parameters_nw-observe-network-traffic[Flow filter configuration parameters] and xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-ebpf-flow-rule-filter_nw-observe-network-traffic[eBPF flow rule filter].
33+
You can now use the `tcpFlags` filter to limit the volume of packets processed by the eBPF program. For more information, see xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-flowcollector-flowfilter-parameters_nw-observe-network-traffic[Flow filter configuration parameters], xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-ebpf-flow-rule-filter_nw-observe-network-traffic[eBPF flow rule filter], and xref:../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-tcp-flag-syn-flood_metrics-dashboards-alerts[Detecting SYN flooding using the FlowMetric API and TCP flags].
3534

3635
[id="network-observability-virtualization_{context}"]
3736
==== Network Observability for OpenShift Virtualization
3837
You can observe networking patterns on an {VirtProductName} setup by identifying eBPF-enriched network flows coming from VMs that are connected to secondary networks, such as through Open Virtual Network (OVN)-Kubernetes. For more information, see xref:../../observability/network_observability/network-observability-secondary-networks.adoc#network-observability-virtualization-config_network-observability-secondary-networks[Configuring virtual machine (VM) secondary network interfaces for Network Observability].
3938

40-
4139
[id="network-observability-network-policy-1-7_{context}"]
4240
==== Network policy deploys in the FlowCollector custom resource (CR)
4341
With this release, you can configure the `FlowCollector` CR to deploy a network policy for Network Observability. Previously, if you wanted a network policy, you had to manually create one. The option to manually create a network policy is still available. For more information, see xref:../../observability/network_observability/network-observability-network-policy.adoc#network-observability-deploy-network-policy_network_observability[Configuring an ingress network policy by using the FlowCollector custom resource].
@@ -61,6 +59,14 @@ The following enhancements are available for the eBPF agent:
6159

6260
For more information, see xref:../../observability/network_observability/flowcollector-api.adoc#spec-agent-ebpf-advanced[FlowCollector API specifications].
6361

62+
[id="network-observability-cli-1-7_{context}"]
63+
==== Network Observability CLI
64+
The Network Observability CLI (`oc netobserv`), is now generally available. The following enhancements have been made since the 1.6 Technology Preview release:
65+
* There are now eBPF enrichment filters for packet capture similar to flow capture.
66+
* You can now use filter `tcp_flags` with both flow and packets capture.
67+
* The auto-teardown option is available when max-bytes or max-time is reached.
68+
For more information, see xref:../../observability/network_observability/netobserv_cli/netobserv-cli-install.adoc#network-observability-netoberv-cli-about_netobserv-cli-install[Network Observability CLI] and link:https://access.redhat.com/errata/RHEA-2024:8264[Network Observability CLI 1.7.0].
69+
6470
[id="network-observability-operator-1-7-bug-fixes_{context}"]
6571
=== Bug fixes
6672

@@ -153,9 +159,10 @@ The following advisory is available for the Network Observability Operator 1.6.0
153159
* link:https://access.redhat.com/errata/RHSA-2024:3868[Network Observability Operator 1.6.0]
154160

155161
[IMPORTANT]
156-
====
162+
=====
157163
Before upgrading to the latest version of the Network Observability Operator, you must xref:../../observability/network_observability/installing-operators.adoc#network-observability-updating-migrating_network_observability[Migrate removed stored versions of the FlowCollector CRD]. An automated solution to this workaround is planned with link:https://issues.redhat.com/browse/NETOBSERV-1747[*NETOBSERV-1747*].
158-
====
164+
=====
165+
159166
[id="network-observability-operator-1.6.0-features-enhancements_{context}"]
160167
=== New features and enhancements
161168

@@ -177,9 +184,9 @@ Experience improved performances of the eBPF agent, in terms of CPU and memory,
177184
* Loki storage demand decreases significantly now that duplicated flows are removed. Instead of having multiple, individual duplicated flows per network interface, there is one de-duplicated flow with a list of related network interfaces.
178185

179186
[IMPORTANT]
180-
====
187+
=====
181188
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`.
182-
====
189+
=====
183190

184191
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]
185192
and xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-quickfilternw-observe-network-traffic[Quick filters].
@@ -197,8 +204,7 @@ link:https://access.redhat.com/support/offerings/techpreview[Technology Preview
197204

198205
[id="network-observability-cli-1.6_{context}"]
199206
==== Network Observability CLI
200-
include::snippets/network-observability-netobserv-cli-install-warning.adoc[]
201-
You can debug and troubleshoot network traffic issues without needing to install the Network Observability Operator by using the Network Observability CLI. Capture and visualize flow and packet data in real-time with no persistent storage requirement during the capture. For more information, see xref:../../observability/network_observability/netobserv_cli/netobserv-cli-install.adoc#network-observability-netoberv-cli-about_netobserv-cli-install[Network Observability CLI] and link:https://access.redhat.com/errata/RHEA-2024:3869[Network Observability CLI 1.6.0]
207+
You can debug and troubleshoot network traffic issues without needing to install the Network Observability Operator by using the Network Observability CLI. Capture and visualize flow and packet data in real-time with no persistent storage requirement during the capture. For more information, see xref:../../observability/network_observability/netobserv_cli/netobserv-cli-install.adoc#network-observability-netoberv-cli-about_netobserv-cli-install[Network Observability CLI] and link:https://access.redhat.com/errata/RHEA-2024:3869[Network Observability CLI 1.6.0].
202208

203209
[id="network-observability-operator-1.6.0-bug-fixes_{context}"]
204210
=== Bug fixes
@@ -257,9 +263,9 @@ The 1.5 release of the Network Observability Operator adds improvements and new
257263
* The `spec.agent.ebpf.kafkaBatchSize` default is changed from `10MB` to `1MB` to enhance eBPF performance when using Kafka.
258264
+
259265
[IMPORTANT]
260-
====
266+
=====
261267
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.
262-
====
268+
=====
263269

264270
[discrete]
265271
[id="web-console-enhancements-1.5"]

snippets/network-observability-netobserv-cli-install-warning.adoc

-15
This file was deleted.

0 commit comments

Comments
 (0)