Address feedback & regenerate

.github/pull_request_template.md

@@ -13,7 +13,7 @@ If you are not familiar with our processes or don't know what to answer in the l
 
 * [ ] Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix _(in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes)._
 * [ ] Does this PR require product documentation?
-  * [ ] If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
+  * [ ] If so, make sure the JIRA epic is labeled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
 * [ ] Does this PR require a product release notes entry?
   * [ ] If so, fill in "Release Note Text" in the JIRA.
 * [ ] Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.

apis/flowcollector/v1beta2/flowcollector_types.go

@@ -458,7 +458,7 @@ type FlowCollectorOpenTelemetry struct {
 
 	// Custom fields mapping to an OpenTelemetry conformant format.
 	// By default, NetObserv format proposal is used: https://github.com/rhobs/observability-data-model/blob/main/network-observability.md#format-proposal .
-	// As there is currently no accepted standard for L3/4 enriched network logs, you can freely override it with your own.
+	// As there is currently no accepted standard for L3 or L4 enriched network logs, you can freely override it with your own.
 	// +optional
 	FieldsMapping *[]GenericTransformRule `json:"fieldsMapping,omitempty"`
 
@@ -1212,7 +1212,7 @@ type AdvancedProcessorConfig struct {
 
 	// Define secondary networks to be checked for resources identification.
 	// In order to guarantee a correct identification, it is important that the indexed values form an unique identifier across the cluster.
-	// If there are collisions in the indexes (same index used by several resources), those resources might be wrongly labelled.
+	// If there are collisions in the indexes (same index used by several resources), those resources might be wrongly labeled.
 	// +optional
 	SecondaryNetworks []SecondaryNetwork `json:"secondaryNetworks,omitempty"`
 }

apis/flowmetrics/v1alpha1/flowmetric_types.go

@@ -93,7 +93,7 @@ type FlowMetricSpec struct {
 	// +optional
 	Labels []string `json:"labels"`
 
-	// `remap` allows to use different names for the generated metric labels than the flow fields. Use the origin flow fields as keys, and the desired label names as values.
+	// Set the `remap` property to use different names for the generated metric labels than the flow fields. Use the origin flow fields as keys, and the desired label names as values.
 	// +optional
 	Remap map[string]string `json:"remap"`
 

bundle/manifests/flows.netobserv.io_flowcollectors.yaml

@@ -3725,12 +3725,12 @@ spec:
                         description: |-
                           List of additional features to enable. They are all disabled by default. Enabling additional features might have performance impacts. Possible values are:<br>
                           - `PacketDrop`: enable the packets drop flows logging feature. This feature requires mounting
-                          the kernel debug filesystem, so the eBPF pod has to run as privileged.
+                          the kernel debug filesystem, so the eBPF agent pods have to run as privileged.
                           If the `spec.agent.ebpf.privileged` parameter is not set, an error is reported.<br>
                           - `DNSTracking`: enable the DNS tracking feature.<br>
                           - `FlowRTT`: enable flow latency (sRTT) extraction in the eBPF agent from TCP traffic.<br>
-                          - `NetworkEvents`: enable the Network events monitoring feature. This feature requires mounting
-                          the kernel debug filesystem, so the eBPF pod has to run as privileged.
+                          - `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 have to run as privileged.
                           It requires using the OVN-Kubernetes network plugin with the Observability feature.
                           IMPORTANT: this feature is available as a Developer Preview.<br>
                         items:
@@ -5873,14 +5873,14 @@ spec:
                       - topic
                       type: object
                     openTelemetry:
-                      description: Open telemetry configuration, such as the IP address
-                        and port to send enriched logs, metrics and or traces to.
+                      description: OpenTelemetry configuration, such as the IP address
+                        and port to send enriched logs or metrics to.
                       properties:
                         fieldsMapping:
                           description: |-
                             Custom fields mapping to an OpenTelemetry conformant format.
                             By default, NetObserv format proposal is used: https://github.com/rhobs/observability-data-model/blob/main/network-observability.md#format-proposal .
-                            As there is currently no accepted otlp standard for L3/4 network logs, you can freely override it with your own.
+                            As there is currently no accepted standard for L3 or L4 enriched network logs, you can freely override it with your own.
                           items:
                             properties:
                               input:
@@ -5897,40 +5897,40 @@ spec:
                           description: Headers to add to messages (optional)
                           type: object
                         logs:
-                          description: Open telemetry configuration for logs.
+                          description: OpenTelemetry configuration for logs.
                           properties:
                             enable:
                               default: true
                               description: Set `enable` to `true` to send logs to
-                                Open Telemetry receiver.
+                                an OpenTelemetry receiver.
                               type: boolean
                           type: object
                         metrics:
-                          description: Open telemetry configuration for metrics.
+                          description: OpenTelemetry configuration for metrics.
                           properties:
                             enable:
                               default: true
                               description: Set `enable` to `true` to send metrics
-                                to Open Telemetry receiver.
+                                to an OpenTelemetry receiver.
                               type: boolean
                             pushTimeInterval:
                               default: 20s
                               description: How often should metrics be sent to collector
                               type: string
                           type: object
                         protocol:
-                          description: Protocol of Open Telemetry connection. The
+                          description: Protocol of the OpenTelemetry connection. The
                             available options are `http` and `grpc`.
                           enum:
                           - http
                           - grpc
                           type: string
                         targetHost:
                           default: ""
-                          description: Address of the Open Telemetry receiver
+                          description: Address of the OpenTelemetry receiver
                           type: string
                         targetPort:
-                          description: Port for the Open Telemetry receiver
+                          description: Port for the OpenTelemetry receiver
                           type: integer
                         tls:
                           description: TLS client configuration.
@@ -7787,16 +7787,18 @@ spec:
                         description: |-
                           Define secondary networks to be checked for resources identification.
                           In order to guarantee a correct identification, it is important that the indexed values form an unique identifier across the cluster.
-                          If there are collisions in the indexes (same index used by several resources), those resources might be wrongly labelled.
+                          If there are collisions in the indexes (same index used by several resources), those resources might be wrongly labeled.
                         items:
                           properties:
                             index:
                               description: |-
                                 `index` is a list of fields to use for indexing the pods. They should form a unique Pod identifier across the cluster.
-                                Can be any of: MAC, IP, Interface
+                                Can be any of: `MAC`, `IP`, `Interface`.
+                                Fields absent from the 'k8s.v1.cni.cncf.io/network-status' annotation must not be added to the index.
                               items:
                                 description: 'Field to index for secondary network
-                                  pod identification, can be any of: MAC, IP, Interface'
+                                  pod identification, can be any of: `MAC`, `IP`,
+                                  `Interface`.'
                                 enum:
                                 - MAC
                                 - IP

bundle/manifests/flows.netobserv.io_flowmetrics.yaml

@@ -214,9 +214,9 @@ spec:
               remap:
                 additionalProperties:
                   type: string
-                description: '`remap` allows to use different names for the generated
-                  metric labels than the flow fields. Use the origin flow fields as
-                  keys, and the desired label names as values.'
+                description: Set the `remap` property to use different names for the
+                  generated metric labels than the flow fields. Use the origin flow
+                  fields as keys, and the desired label names as values.
                 type: object
               type:
                 description: |-

config/crd/bases/flows.netobserv.io_flowcollectors.yaml

@@ -3442,8 +3442,8 @@ spec:
                             If the `spec.agent.ebpf.privileged` parameter is not set, an error is reported.<br>
                             - `DNSTracking`: enable the DNS tracking feature.<br>
                             - `FlowRTT`: enable flow latency (sRTT) extraction in the eBPF agent from TCP traffic.<br>
-                            - `NetworkEvents`: enable the Network events monitoring feature. This feature requires mounting
-                            the kernel debug filesystem, so the eBPF pod has to run as privileged.
+                            - `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 have to run as privileged.
                             It requires using the OVN-Kubernetes network plugin with the Observability feature.
                             IMPORTANT: this feature is available as a Developer Preview.<br>
                           items:
@@ -5447,7 +5447,7 @@ spec:
                             description: |-
                               Custom fields mapping to an OpenTelemetry conformant format.
                               By default, NetObserv format proposal is used: https://github.com/rhobs/observability-data-model/blob/main/network-observability.md#format-proposal .
-                              As there is currently no accepted standard for L3/4 enriched network logs, you can freely override it with your own.
+                              As there is currently no accepted standard for L3 or L4 enriched network logs, you can freely override it with your own.
                             items:
                               properties:
                                 input:
@@ -7181,7 +7181,7 @@ spec:
                           description: |-
                             Define secondary networks to be checked for resources identification.
                             In order to guarantee a correct identification, it is important that the indexed values form an unique identifier across the cluster.
-                            If there are collisions in the indexes (same index used by several resources), those resources might be wrongly labelled.
+                            If there are collisions in the indexes (same index used by several resources), those resources might be wrongly labeled.
                           items:
                             properties:
                               index:

config/crd/bases/flows.netobserv.io_flowmetrics.yaml

@@ -204,9 +204,9 @@ spec:
               remap:
                 additionalProperties:
                   type: string
-                description: '`remap` allows to use different names for the generated
-                  metric labels than the flow fields. Use the origin flow fields as
-                  keys, and the desired label names as values.'
+                description: Set the `remap` property to use different names for the
+                  generated metric labels than the flow fields. Use the origin flow
+                  fields as keys, and the desired label names as values.
                 type: object
               type:
                 description: |-

docs/FlowCollector.md

@@ -5958,8 +5958,8 @@ the kernel debug filesystem, so the eBPF agent pods have to run as privileged.
 If the `spec.agent.ebpf.privileged` parameter is not set, an error is reported.<br>
 - `DNSTracking`: enable the DNS tracking feature.<br>
 - `FlowRTT`: enable flow latency (sRTT) extraction in the eBPF agent from TCP traffic.<br>
-- `NetworkEvents`: enable the Network events monitoring feature. This feature requires mounting
-the kernel debug filesystem, so the eBPF pod has to run as privileged.
+- `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 have to run as privileged.
 It requires using the OVN-Kubernetes network plugin with the Observability feature.
 IMPORTANT: this feature is available as a Developer Preview.<br><br/>
         </td>
@@ -11993,7 +11993,7 @@ OpenTelemetry configuration, such as the IP address and port to send enriched lo
         <td>
           Custom fields mapping to an OpenTelemetry conformant format.
 By default, NetObserv format proposal is used: https://github.com/rhobs/observability-data-model/blob/main/network-observability.md#format-proposal .
-As there is currently no accepted standard for L3/4 enriched network logs, you can freely override it with your own.<br/>
+As there is currently no accepted standard for L3 or L4 enriched network logs, you can freely override it with your own.<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -14125,7 +14125,7 @@ By convention, some values are forbidden. It must be greater than 1024 and diffe
         <td>
           Define secondary networks to be checked for resources identification.
 In order to guarantee a correct identification, it is important that the indexed values form an unique identifier across the cluster.
-If there are collisions in the indexes (same index used by several resources), those resources might be wrongly labelled.<br/>
+If there are collisions in the indexes (same index used by several resources), those resources might be wrongly labeled.<br/>
         </td>
         <td>false</td>
       </tr></tbody>

docs/FlowMetric.md

@@ -167,7 +167,7 @@ Refer to the documentation for the list of available fields: https://docs.opensh
         <td><b>remap</b></td>
         <td>map[string]string</td>
         <td>
-          `remap` allows to use different names for the generated metric labels than the flow fields. Use the origin flow fields as keys, and the desired label names as values.<br/>
+          Set the `remap` property to use different names for the generated metric labels than the flow fields. Use the origin flow fields as keys, and the desired label names as values.<br/>
         </td>
         <td>false</td>
       </tr><tr>

docs/Metrics.md

@@ -68,7 +68,7 @@ Currently, `FlowMetric` resources need to be created in the namespace defined in
 
 ### Counter example
 
-Here is an example of a FlowMetric resource that generates a metric tracking ingress bytes received from cluster external sources, labelled by destination host and workload:
+Here is an example of a FlowMetric resource that generates a metric tracking ingress bytes received from cluster external sources, labeled by destination host and workload:
 
 ```yaml
 apiVersion: flows.netobserv.io/v1alpha1