diff --git a/api/flowcollector/v1beta2/flowcollector_types.go b/api/flowcollector/v1beta2/flowcollector_types.go index 47ac6f646..64d9e83db 100644 --- a/api/flowcollector/v1beta2/flowcollector_types.go +++ b/api/flowcollector/v1beta2/flowcollector_types.go @@ -378,25 +378,24 @@ type FlowCollectorEBPF struct { // `advanced` allows setting some aspects of the internal configuration of the eBPF agent. // This section is aimed mostly for debugging and fine-grained performance optimizations, - // such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. You can also + // such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. You can also // override the default Linux capabilities from there. // +optional Advanced *AdvancedAgentConfig `json:"advanced,omitempty"` // List of additional features to enable. They are all disabled by default. Enabling additional features might have performance impacts. Possible values are:
// - `PacketDrop`: Enable the packets drop flows logging feature. This feature requires mounting - // the kernel debug filesystem, so the eBPF agent pods must run as privileged. - // If the `spec.agent.ebpf.privileged` parameter is not set, an error is reported.
+ // the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`.
// - `DNSTracking`: Enable the DNS tracking feature.
// - `FlowRTT`: Enable flow latency (sRTT) extraction in the eBPF agent from TCP traffic.
// - `NetworkEvents`: Enable the network events monitoring feature, such as correlating flows and network policies. - // This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. + // This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. // It requires using the OVN-Kubernetes network plugin with the Observability feature. // IMPORTANT: This feature is available as a Technology Preview.
// - `PacketTranslation`: Enable enriching flows with packet translation information, such as Service NAT.
// - `EbpfManager`: [Unsupported (*)]. Use eBPF Manager to manage NetObserv eBPF programs. Pre-requisite: the eBPF Manager operator (or upstream bpfman operator) must be installed.
// - `UDNMapping`: Enable interfaces mapping to User Defined Networks (UDN).
- // This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. + // This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. // It requires using the OVN-Kubernetes network plugin with the Observability feature.
// - `IPSec`, to track flows between nodes with IPsec encryption.
// +optional @@ -694,7 +693,7 @@ type FlowCollectorFLP struct { // `advanced` allows setting some aspects of the internal configuration of the flow processor. // This section is aimed mostly for debugging and fine-grained performance optimizations, - // such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. + // such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. // +optional Advanced *AdvancedProcessorConfig `json:"advanced,omitempty"` } @@ -1064,7 +1063,7 @@ type FlowCollectorConsolePlugin struct { // `advanced` allows setting some aspects of the internal configuration of the console plugin. // This section is aimed mostly for debugging and fine-grained performance optimizations, - // such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. + // such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. // +optional Advanced *AdvancedPluginConfig `json:"advanced,omitempty"` } diff --git a/bundle/manifests/flows.netobserv.io_flowcollectors.yaml b/bundle/manifests/flows.netobserv.io_flowcollectors.yaml index 41c508edd..7f9c9d94c 100644 --- a/bundle/manifests/flows.netobserv.io_flowcollectors.yaml +++ b/bundle/manifests/flows.netobserv.io_flowcollectors.yaml @@ -2901,7 +2901,7 @@ spec: description: |- `advanced` allows setting some aspects of the internal configuration of the eBPF agent. This section is aimed mostly for debugging and fine-grained performance optimizations, - such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. You can also + such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. You can also override the default Linux capabilities from there. properties: capOverride: @@ -3958,18 +3958,17 @@ spec: description: |- List of additional features to enable. They are all disabled by default. Enabling additional features might have performance impacts. Possible values are:
- `PacketDrop`: Enable the packets drop flows logging feature. This feature requires mounting - the kernel debug filesystem, so the eBPF agent pods must run as privileged. - If the `spec.agent.ebpf.privileged` parameter is not set, an error is reported.
+ the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`.
- `DNSTracking`: Enable the DNS tracking feature.
- `FlowRTT`: Enable flow latency (sRTT) extraction in the eBPF agent from TCP traffic.
- `NetworkEvents`: Enable the network events monitoring feature, such as correlating flows and network policies. - This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. + This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. It requires using the OVN-Kubernetes network plugin with the Observability feature. IMPORTANT: This feature is available as a Technology Preview.
- `PacketTranslation`: Enable enriching flows with packet translation information, such as Service NAT.
- `EbpfManager`: [Unsupported (*)]. Use eBPF Manager to manage NetObserv eBPF programs. Pre-requisite: the eBPF Manager operator (or upstream bpfman operator) must be installed.
- `UDNMapping`: Enable interfaces mapping to User Defined Networks (UDN).
- This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. + This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. It requires using the OVN-Kubernetes network plugin with the Observability feature.
- `IPSec`, to track flows between nodes with IPsec encryption.
items: @@ -4557,7 +4556,7 @@ spec: description: |- `advanced` allows setting some aspects of the internal configuration of the console plugin. This section is aimed mostly for debugging and fine-grained performance optimizations, - such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. + such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. properties: args: description: |- @@ -7111,7 +7110,7 @@ spec: description: |- `advanced` allows setting some aspects of the internal configuration of the flow processor. This section is aimed mostly for debugging and fine-grained performance optimizations, - such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. + such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. properties: conversationEndTimeout: default: 10s diff --git a/bundle/manifests/netobserv-operator.clusterserviceversion.yaml b/bundle/manifests/netobserv-operator.clusterserviceversion.yaml index a2187772e..88fbd2c71 100644 --- a/bundle/manifests/netobserv-operator.clusterserviceversion.yaml +++ b/bundle/manifests/netobserv-operator.clusterserviceversion.yaml @@ -435,7 +435,7 @@ metadata: categories: Monitoring, Networking, Observability console.openshift.io/plugins: '["netobserv-plugin"]' containerImage: quay.io/netobserv/network-observability-operator:1.8.2-community - createdAt: "2025-06-16T15:06:19Z" + createdAt: "2025-06-23T09:16:32Z" description: Network flows collector and monitoring solution operatorframework.io/initialization-resource: '{"apiVersion":"flows.netobserv.io/v1beta2", "kind":"FlowCollector","metadata":{"name":"cluster"},"spec": {}}' diff --git a/config/crd/bases/flows.netobserv.io_flowcollectors.yaml b/config/crd/bases/flows.netobserv.io_flowcollectors.yaml index 4be6eb528..8f081da82 100644 --- a/config/crd/bases/flows.netobserv.io_flowcollectors.yaml +++ b/config/crd/bases/flows.netobserv.io_flowcollectors.yaml @@ -2650,7 +2650,7 @@ spec: description: |- `advanced` allows setting some aspects of the internal configuration of the eBPF agent. This section is aimed mostly for debugging and fine-grained performance optimizations, - such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. You can also + such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. You can also override the default Linux capabilities from there. properties: capOverride: @@ -3638,18 +3638,17 @@ spec: description: |- List of additional features to enable. They are all disabled by default. Enabling additional features might have performance impacts. Possible values are:
- `PacketDrop`: Enable the packets drop flows logging feature. This feature requires mounting - the kernel debug filesystem, so the eBPF agent pods must run as privileged. - If the `spec.agent.ebpf.privileged` parameter is not set, an error is reported.
+ the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`.
- `DNSTracking`: Enable the DNS tracking feature.
- `FlowRTT`: Enable flow latency (sRTT) extraction in the eBPF agent from TCP traffic.
- `NetworkEvents`: Enable the network events monitoring feature, such as correlating flows and network policies. - This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. + This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. It requires using the OVN-Kubernetes network plugin with the Observability feature. IMPORTANT: This feature is available as a Technology Preview.
- `PacketTranslation`: Enable enriching flows with packet translation information, such as Service NAT.
- `EbpfManager`: [Unsupported (*)]. Use eBPF Manager to manage NetObserv eBPF programs. Pre-requisite: the eBPF Manager operator (or upstream bpfman operator) must be installed.
- `UDNMapping`: Enable interfaces mapping to User Defined Networks (UDN).
- This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. + This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. It requires using the OVN-Kubernetes network plugin with the Observability feature.
- `IPSec`, to track flows between nodes with IPsec encryption.
items: @@ -4176,7 +4175,7 @@ spec: description: |- `advanced` allows setting some aspects of the internal configuration of the console plugin. This section is aimed mostly for debugging and fine-grained performance optimizations, - such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. + such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. properties: args: description: |- @@ -6515,7 +6514,7 @@ spec: description: |- `advanced` allows setting some aspects of the internal configuration of the flow processor. This section is aimed mostly for debugging and fine-grained performance optimizations, - such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. + such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. properties: conversationEndTimeout: default: 10s diff --git a/docs/FlowCollector.md b/docs/FlowCollector.md index 8b9753682..749518c04 100644 --- a/docs/FlowCollector.md +++ b/docs/FlowCollector.md @@ -6204,7 +6204,7 @@ is set to `eBPF`. `advanced` allows setting some aspects of the internal configuration of the eBPF agent. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. You can also +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. You can also override the default Linux capabilities from there.
false @@ -6249,18 +6249,17 @@ Otherwise it is matched as a case-sensitive string.
List of additional features to enable. They are all disabled by default. Enabling additional features might have performance impacts. Possible values are:
- `PacketDrop`: Enable the packets drop flows logging feature. This feature requires mounting -the kernel debug filesystem, so the eBPF agent pods must run as privileged. -If the `spec.agent.ebpf.privileged` parameter is not set, an error is reported.
+the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`.
- `DNSTracking`: Enable the DNS tracking feature.
- `FlowRTT`: Enable flow latency (sRTT) extraction in the eBPF agent from TCP traffic.
- `NetworkEvents`: Enable the network events monitoring feature, such as correlating flows and network policies. -This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. +This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. It requires using the OVN-Kubernetes network plugin with the Observability feature. IMPORTANT: This feature is available as a Technology Preview.
- `PacketTranslation`: Enable enriching flows with packet translation information, such as Service NAT.
- `EbpfManager`: [Unsupported (*)]. Use eBPF Manager to manage NetObserv eBPF programs. Pre-requisite: the eBPF Manager operator (or upstream bpfman operator) must be installed.
- `UDNMapping`: Enable interfaces mapping to User Defined Networks (UDN).
-This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. +This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. It requires using the OVN-Kubernetes network plugin with the Observability feature.
- `IPSec`, to track flows between nodes with IPsec encryption.

@@ -6361,7 +6360,7 @@ For more information, see https://kubernetes.io/docs/concepts/configuration/mana `advanced` allows setting some aspects of the internal configuration of the eBPF agent. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. You can also +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. You can also override the default Linux capabilities from there. @@ -8966,7 +8965,7 @@ refer to `forceSampleAll`. Alternatively, you can use the eBPF Agent instead of @@ -9055,7 +9054,7 @@ For more information, see https://kubernetes.io/docs/concepts/configuration/mana `advanced` allows setting some aspects of the internal configuration of the console plugin. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk.
`advanced` allows setting some aspects of the internal configuration of the console plugin. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk.
+such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk.
 false
@@ -14357,7 +14356,7 @@ This feature requires the "topology.kubernetes.io/zone" label to be set on nodes @@ -14502,7 +14501,7 @@ When a subnet matches the source or destination IP of a flow, a corresponding fi `advanced` allows setting some aspects of the internal configuration of the flow processor. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk.
`advanced` allows setting some aspects of the internal configuration of the flow processor. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk.
+such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk.
 false
diff --git a/docs/flowcollector-flows-netobserv-io-v1beta2.adoc b/docs/flowcollector-flows-netobserv-io-v1beta2.adoc index a9350afe4..40ca2d795 100644 --- a/docs/flowcollector-flows-netobserv-io-v1beta2.adoc +++ b/docs/flowcollector-flows-netobserv-io-v1beta2.adoc @@ -180,7 +180,7 @@ Type:: | `object` | `advanced` allows setting some aspects of the internal configuration of the eBPF agent. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. You can also +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. You can also override the default Linux capabilities from there. | `cacheActiveTimeout` @@ -281,7 +281,7 @@ Description:: -- `advanced` allows setting some aspects of the internal configuration of the eBPF agent. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. You can also +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. You can also override the default Linux capabilities from there. -- @@ -801,7 +801,7 @@ Type:: | `object` | `advanced` allows setting some aspects of the internal configuration of the console plugin. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. | `autoscaler` | `object` @@ -843,7 +843,7 @@ Description:: -- `advanced` allows setting some aspects of the internal configuration of the console plugin. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. -- Type:: @@ -2703,7 +2703,7 @@ This feature requires the "topology.kubernetes.io/zone" label to be set on nodes | `object` | `advanced` allows setting some aspects of the internal configuration of the flow processor. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. | `clusterName` | `string` @@ -2783,7 +2783,7 @@ Description:: -- `advanced` allows setting some aspects of the internal configuration of the flow processor. This section is aimed mostly for debugging and fine-grained performance optimizations, -such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. +such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. -- Type:: diff --git a/docs/flows-format.adoc b/docs/flows-format.adoc index a824d0035..2483aa004 100644 --- a/docs/flows-format.adoc +++ b/docs/flows-format.adoc @@ -157,7 +157,7 @@ The "Cardinality" column gives information about the implied metric cardinality | n/a | `Flags` | string[] -| List of TCP flags comprised in the flow, as per RFC-9293, with additional custom flags to represent the following per-packet combinations: + +| List of TCP flags comprised in the flow, according to RFC-9293, with additional custom flags to represent the following per-packet combinations: + - SYN_ACK + - FIN_ACK + - RST_ACK diff --git a/helm/templates/flows.netobserv.io_flowcollectors.yaml b/helm/templates/flows.netobserv.io_flowcollectors.yaml index b00de8f30..7de2bec74 100644 --- a/helm/templates/flows.netobserv.io_flowcollectors.yaml +++ b/helm/templates/flows.netobserv.io_flowcollectors.yaml @@ -2664,7 +2664,7 @@ spec: description: |- `advanced` allows setting some aspects of the internal configuration of the eBPF agent. This section is aimed mostly for debugging and fine-grained performance optimizations, - such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. You can also + such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. You can also override the default Linux capabilities from there. properties: capOverride: @@ -3652,18 +3652,17 @@ spec: description: |- List of additional features to enable. They are all disabled by default. Enabling additional features might have performance impacts. Possible values are:
- `PacketDrop`: Enable the packets drop flows logging feature. This feature requires mounting - the kernel debug filesystem, so the eBPF agent pods must run as privileged. - If the `spec.agent.ebpf.privileged` parameter is not set, an error is reported.
+ the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`.
- `DNSTracking`: Enable the DNS tracking feature.
- `FlowRTT`: Enable flow latency (sRTT) extraction in the eBPF agent from TCP traffic.
- `NetworkEvents`: Enable the network events monitoring feature, such as correlating flows and network policies. - This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. + This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. It requires using the OVN-Kubernetes network plugin with the Observability feature. IMPORTANT: This feature is available as a Technology Preview.
- `PacketTranslation`: Enable enriching flows with packet translation information, such as Service NAT.
- `EbpfManager`: [Unsupported (*)]. Use eBPF Manager to manage NetObserv eBPF programs. Pre-requisite: the eBPF Manager operator (or upstream bpfman operator) must be installed.
- `UDNMapping`: Enable interfaces mapping to User Defined Networks (UDN).
- This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged. + This feature requires mounting the kernel debug filesystem, so the eBPF agent pods must run as privileged via `spec.agent.ebpf.privileged`. It requires using the OVN-Kubernetes network plugin with the Observability feature.
- `IPSec`, to track flows between nodes with IPsec encryption.
items: @@ -4190,7 +4189,7 @@ spec: description: |- `advanced` allows setting some aspects of the internal configuration of the console plugin. This section is aimed mostly for debugging and fine-grained performance optimizations, - such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. + such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. properties: args: description: |- @@ -6529,7 +6528,7 @@ spec: description: |- `advanced` allows setting some aspects of the internal configuration of the flow processor. This section is aimed mostly for debugging and fine-grained performance optimizations, - such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk. + such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk. properties: conversationEndTimeout: default: 10s diff --git a/internal/controller/consoleplugin/config/static-frontend-config.yaml b/internal/controller/consoleplugin/config/static-frontend-config.yaml index aa4c611af..83de67d91 100644 --- a/internal/controller/consoleplugin/config/static-frontend-config.yaml +++ b/internal/controller/consoleplugin/config/static-frontend-config.yaml @@ -429,7 +429,7 @@ columns: width: 10 - id: TCPFlags name: TCP Flags - tooltip: Logical OR combination of unique TCP flags comprised in the flow, as per RFC-9293, with additional custom values. + tooltip: Logical OR combination of unique TCP flags comprised in the flow, according to RFC-9293, with additional custom values. field: Flags filter: tcp_flags default: false @@ -966,7 +966,7 @@ filters: component: autocomplete hint: Specify a TCP flags value. examples: |- - Logical OR combination of unique TCP flags comprised in the flow, as per RFC-9293, with additional custom flags (SYN_ACK, FIN_ACK and RST_ACK). + Logical OR combination of unique TCP flags comprised in the flow, according to RFC-9293, with additional custom flags (SYN_ACK, FIN_ACK and RST_ACK). - id: node_direction name: Node Direction component: autocomplete @@ -1354,7 +1354,7 @@ fields: - name: Flags type: string[] description: | - List of TCP flags comprised in the flow, as per RFC-9293, with additional custom flags to represent the following per-packet combinations: + + List of TCP flags comprised in the flow, according to RFC-9293, with additional custom flags to represent the following per-packet combinations: + - SYN_ACK + - FIN_ACK + - RST_ACK