API Reference
March 12, 2026 · View on GitHub
Packages:
flows.netobserv.io/v1alpha1
Resource Types:
FlowCollectorSlice
FlowCollectorSlice is the API allowing to decentralize some of the FlowCollector configuration per namespace tenant.
| Name | Type | Description | Required |
|---|---|---|---|
| apiVersion | string | flows.netobserv.io/v1alpha1 | true |
| kind | string | FlowCollectorSlice | true |
| metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
| spec | object |
FlowCollectorSliceSpec defines the desired state of FlowCollectorSlice |
false |
| status | object |
FlowCollectorSliceStatus defines the observed state of FlowCollectorSlice |
false |
FlowCollectorSlice.spec
FlowCollectorSliceSpec defines the desired state of FlowCollectorSlice
| Name | Type | Description | Required |
|---|---|---|---|
| sampling | integer |
`sampling` is an optional sampling interval to apply to this slice. For example, a value of `50` means that 1 matching flow in 50 is sampled. Format: int32 Minimum: 0 |
false |
| subnetLabels | []object |
`subnetLabels` allows you to customize subnets and IPs labeling, such as to identify cluster external workloads or web services.
External subnets must be labeled with the prefix `EXT:`, or not labeled at all, in order to work with default quick filters and some metrics examples provided. Beware that the subnet labels configured in FlowCollectorSlice are not limited to the flows of the related namespace: any flow in the whole cluster can be labeled using this configuration. However, subnet labels defined in the cluster-scoped FlowCollector take precedence in case of conflicting rules. |
false |
FlowCollectorSlice.spec.subnetLabels[index]
SubnetLabel allows to label subnets and IPs, such as to identify cluster-external workloads or web services.
| Name | Type | Description | Required |
|---|---|---|---|
| cidrs | []string |
List of CIDRs, such as `["1.2.3.4/32"]`. |
true |
| name | string |
Label name, used to flag matching flows.
External subnets must be labeled with the prefix `EXT:`, or not labeled at all, in order to work with default quick filters and some metrics examples provided. |
true |
FlowCollectorSlice.status
FlowCollectorSliceStatus defines the observed state of FlowCollectorSlice
| Name | Type | Description | Required |
|---|---|---|---|
| conditions | []object |
`conditions` represent the latest available observations of an object's state |
true |
| filterApplied | string |
Filter that is applied for flow collection |
false |
| subnetLabelsConfigured | integer |
Number of subnet labels configured |
false |
FlowCollectorSlice.status.conditions[index]
Condition contains details for one aspect of the current state of this API Resource.
| Name | Type | Description | Required |
|---|---|---|---|
| lastTransitionTime | string |
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time |
true |
| message | string |
message is a human readable message indicating details about the transition.
This may be an empty string. |
true |
| reason | string |
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty. |
true |
| status | enum |
status of the condition, one of True, False, Unknown. Enum: True, False, Unknown |
true |
| type | string |
type of condition in CamelCase or in foo.example.com/CamelCase. |
true |
| observedGeneration | integer |
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance. Format: int64 Minimum: 0 |
false |