Skip to content

Reinject doc feedback #1653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jotak merged 2 commits into from
Jun 26, 2025
Merged

Reinject doc feedback #1653

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0395481
Reinject doc feedback
jotak Jun 20, 2025
45ff590
doc: mention privileged field path
jotak Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api/flowcollector/v1beta2/flowcollector_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ 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"`
Expand Down Expand Up @@ -694,7 +694,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"`
}
Expand Down Expand Up @@ -1064,7 +1064,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"`
}
Expand Down
6 changes: 3 additions & 3 deletions bundle/manifests/flows.netobserv.io_flowcollectors.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -4557,7 +4557,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: |-
Expand Down Expand Up @@ -7111,7 +7111,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
Expand Down
6 changes: 3 additions & 3 deletions config/crd/bases/flows.netobserv.io_flowcollectors.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -4176,7 +4176,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: |-
Expand Down Expand Up @@ -6515,7 +6515,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
Expand Down
12 changes: 6 additions & 6 deletions docs/FlowCollector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6204,7 +6204,7 @@ is set to `eBPF`.
<td>
`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.<br/>
</td>
<td>false</td>
Expand Down Expand Up @@ -6361,7 +6361,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.

<table>
Expand Down Expand Up @@ -8966,7 +8966,7 @@ refer to `forceSampleAll`. Alternatively, you can use the eBPF Agent instead of
<td>
`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.<br/>
such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk.<br/>
</td>
<td>false</td>
</tr><tr>
Expand Down Expand Up @@ -9055,7 +9055,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.

<table>
<thead>
Expand Down Expand Up @@ -14357,7 +14357,7 @@ This feature requires the "topology.kubernetes.io/zone" label to be set on nodes
<td>
`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.<br/>
such as `GOGC` and `GOMAXPROCS` environment variables. Set these values at your own risk.<br/>
</td>
<td>false</td>
</tr><tr>
Expand Down Expand Up @@ -14502,7 +14502,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.

<table>
<thead>
Expand Down
12 changes: 6 additions & 6 deletions docs/flowcollector-flows-netobserv-io-v1beta2.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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.
--

Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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::
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion docs/flows-format.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions helm/templates/flows.netobserv.io_flowcollectors.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -4190,7 +4190,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: |-
Expand Down Expand Up @@ -6529,7 +6529,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
Expand Down
6 changes: 3 additions & 3 deletions internal/controller/consoleplugin/config/static-frontend-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down