forked from netobserv/netobserv-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathflows.netobserv.io_flowcollectors.yaml
More file actions
9099 lines (9087 loc) · 582 KB
/
flows.netobserv.io_flowcollectors.yaml
File metadata and controls
9099 lines (9087 loc) · 582 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.2
creationTimestamp: null
name: flowcollectors.flows.netobserv.io
spec:
conversion:
strategy: Webhook
webhook:
clientConfig:
service:
name: netobserv-webhook-service
namespace: netobserv
path: /convert
conversionReviewVersions:
- v1
group: flows.netobserv.io
names:
kind: FlowCollector
listKind: FlowCollectorList
plural: flowcollectors
singular: flowcollector
scope: Cluster
versions:
- additionalPrinterColumns:
- jsonPath: .spec.agent.type
name: Agent
type: string
- jsonPath: .spec.agent.ebpf.sampling
name: Sampling (EBPF)
type: string
- jsonPath: .spec.deploymentModel
name: Deployment Model
type: string
- jsonPath: .status.conditions[?(@.type=="Ready")].reason
name: Status
type: string
deprecated: true
name: v1beta1
schema:
openAPIV3Schema:
description: '`FlowCollector` is the schema for the network flows collection
API, which pilots and configures the underlying deployments.'
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
properties:
name:
pattern: ^cluster$
type: string
type: object
spec:
description: |-
Defines the desired state of the FlowCollector resource.
<br><br>
*: the mention of "unsupported", or "deprecated" for a feature throughout this document means that this feature
is not officially supported by Red Hat. It might have been, for example, contributed by the community
and accepted without a formal agreement for maintenance. The product maintainers might provide some support
for these features as a best effort only.
properties:
agent:
description: Agent configuration for flows extraction.
properties:
ebpf:
description: |-
`ebpf` describes the settings related to the eBPF-based flow reporter when `spec.agent.type`
is set to `EBPF`.
properties:
cacheActiveTimeout:
default: 5s
description: |-
`cacheActiveTimeout` is the max period during which the reporter aggregates flows before sending.
Increasing `cacheMaxFlows` and `cacheActiveTimeout` can decrease the network traffic overhead and the CPU load,
however you can expect higher memory consumption and an increased latency in the flow collection.
pattern: ^\d+(ns|ms|s|m)?$
type: string
cacheMaxFlows:
default: 100000
description: |-
`cacheMaxFlows` is the max number of flows in an aggregate; when reached, the reporter sends the flows.
Increasing `cacheMaxFlows` and `cacheActiveTimeout` can decrease the network traffic overhead and the CPU load,
however you can expect higher memory consumption and an increased latency in the flow collection.
format: int32
minimum: 1
type: integer
debug:
description: |-
`debug` allows setting some aspects of the internal configuration of the eBPF agent.
This section is aimed exclusively for debugging and fine-grained performance optimizations,
such as `GOGC` and `GOMAXPROCS` env vars. Set these values at your own risk.
properties:
env:
additionalProperties:
type: string
description: |-
`env` allows passing custom environment variables to underlying components. Useful for passing
some very concrete performance-tuning options, such as `GOGC` and `GOMAXPROCS`, that should not be
publicly exposed as part of the FlowCollector descriptor, as they are only useful
in edge debug or support scenarios.
type: object
type: object
excludeInterfaces:
default:
- lo
description: |-
`excludeInterfaces` contains the interface names that are excluded from flow tracing.
An entry enclosed by slashes, such as `/br-/`, is matched as a regular expression.
Otherwise it is matched as a case-sensitive string.
items:
type: string
type: array
features:
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.
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.
- `PacketTranslation`: enable enriching flows with packet's translation information. <br>
- `EbpfManager`: allow using eBPF manager to manage netobserv ebpf programs. <br>
- `UDNMapping`, to enable interfaces mappind to udn. <br>
items:
description: |-
Agent feature, can be one of:<br>
- `PacketDrop`, to track packet drops.<br>
- `DNSTracking`, to track specific information on DNS traffic.<br>
- `FlowRTT`, to track TCP latency [Unsupported (*)].<br>
- `NetworkEvents`, to track Network events.<br>
- `PacketTranslation`, to enrich flows with packets translation information. <br>
- `EbpfManager`, to enable using EBPF Manager to manage netobserv ebpf programs [Developer Preview].<br>
- `UDNMapping`, to enable interfaces mappind to udn [Developer Preview]. <br>
enum:
- PacketDrop
- DNSTracking
- FlowRTT
- NetworkEvents
- PacketTranslation
- EbpfManager
- UDNMapping
type: string
type: array
flowFilter:
description: '`flowFilter` defines the eBPF agent configuration
regarding flow filtering'
properties:
action:
description: '`action` defines the action to perform on
the flows that match the filter. The available options
are `Accept`, which is the default, and `Reject`.'
enum:
- Accept
- Reject
type: string
cidr:
description: |-
`cidr` defines the IP CIDR to filter flows by.
Examples: `10.10.10.0/24` or `100:100:100:100::/64`
type: string
destPorts:
anyOf:
- type: integer
- type: string
description: |-
`destPorts` optionally defines the destination ports to filter flows by.
To filter a single port, set a single port as an integer value. For example, `destPorts: 80`.
To filter a range of ports, use a "start-end" range in string format. For example, `destPorts: "80-100"`.
To filter two ports, use a "port1,port2" in string format. For example, `ports: "80,100"`.
x-kubernetes-int-or-string: true
direction:
description: '`direction` optionally defines a direction
to filter flows by. The available options are `Ingress`
and `Egress`.'
enum:
- Ingress
- Egress
type: string
enable:
description: Set `enable` to `true` to enable the eBPF
flow filtering feature.
type: boolean
icmpCode:
description: '`icmpCode`, for Internet Control Message
Protocol (ICMP) traffic, optionally defines the ICMP
code to filter flows by.'
type: integer
icmpType:
description: '`icmpType`, for ICMP traffic, optionally
defines the ICMP type to filter flows by.'
type: integer
peerIP:
description: |-
`peerIP` optionally defines the remote IP address to filter flows by.
Example: `10.10.10.10`.
type: string
pktDrops:
description: '`pktDrops` optionally filters only flows
containing packet drops.'
type: boolean
ports:
anyOf:
- type: integer
- type: string
description: |-
`ports` optionally defines the ports to filter flows by. It is used both for source and destination ports.
To filter a single port, set a single port as an integer value. For example, `ports: 80`.
To filter a range of ports, use a "start-end" range in string format. For example, `ports: "80-100"`.
To filter two ports, use a "port1,port2" in string format. For example, `ports: "80,100"`.
x-kubernetes-int-or-string: true
protocol:
description: '`protocol` optionally defines a protocol
to filter flows by. The available options are `TCP`,
`UDP`, `ICMP`, `ICMPv6`, and `SCTP`.'
enum:
- TCP
- UDP
- ICMP
- ICMPv6
- SCTP
type: string
rules:
description: '`flowFilterRules` defines a list of ebpf
agent flow filtering rules'
items:
description: '`EBPFFlowFilterRule` defines the desired
eBPF agent configuration regarding flow filtering
rule.'
properties:
action:
description: '`action` defines the action to perform
on the flows that match the filter. The available
options are `Accept`, which is the default, and
`Reject`.'
enum:
- Accept
- Reject
type: string
cidr:
description: |-
`cidr` defines the IP CIDR to filter flows by.
Examples: `10.10.10.0/24` or `100:100:100:100::/64`
type: string
destPorts:
anyOf:
- type: integer
- type: string
description: |-
`destPorts` optionally defines the destination ports to filter flows by.
To filter a single port, set a single port as an integer value. For example, `destPorts: 80`.
To filter a range of ports, use a "start-end" range in string format. For example, `destPorts: "80-100"`.
To filter two ports, use a "port1,port2" in string format. For example, `ports: "80,100"`.
x-kubernetes-int-or-string: true
direction:
description: '`direction` optionally defines a direction
to filter flows by. The available options are
`Ingress` and `Egress`.'
enum:
- Ingress
- Egress
type: string
icmpCode:
description: '`icmpCode`, for Internet Control Message
Protocol (ICMP) traffic, optionally defines the
ICMP code to filter flows by.'
type: integer
icmpType:
description: '`icmpType`, for ICMP traffic, optionally
defines the ICMP type to filter flows by.'
type: integer
peerIP:
description: |-
`peerIP` optionally defines the remote IP address to filter flows by.
Example: `10.10.10.10`.
type: string
pktDrops:
description: '`pktDrops` optionally filters only
flows containing packet drops.'
type: boolean
ports:
anyOf:
- type: integer
- type: string
description: |-
`ports` optionally defines the ports to filter flows by. It is used both for source and destination ports.
To filter a single port, set a single port as an integer value. For example, `ports: 80`.
To filter a range of ports, use a "start-end" range in string format. For example, `ports: "80-100"`.
To filter two ports, use a "port1,port2" in string format. For example, `ports: "80,100"`.
x-kubernetes-int-or-string: true
protocol:
description: '`protocol` optionally defines a protocol
to filter flows by. The available options are
`TCP`, `UDP`, `ICMP`, `ICMPv6`, and `SCTP`.'
enum:
- TCP
- UDP
- ICMP
- ICMPv6
- SCTP
type: string
sampling:
description: '`sampling` sampling rate for the matched
flow'
format: int32
type: integer
sourcePorts:
anyOf:
- type: integer
- type: string
description: |-
`sourcePorts` optionally defines the source ports to filter flows by.
To filter a single port, set a single port as an integer value. For example, `sourcePorts: 80`.
To filter a range of ports, use a "start-end" range in string format. For example, `sourcePorts: "80-100"`.
To filter two ports, use a "port1,port2" in string format. For example, `ports: "80,100"`.
x-kubernetes-int-or-string: true
tcpFlags:
description: |-
`tcpFlags` optionally defines TCP flags to filter flows by.
In addition to the standard flags (RFC-9293), you can also filter by one of the three following combinations: `SYN-ACK`, `FIN-ACK`, and `RST-ACK`.
enum:
- SYN
- SYN-ACK
- ACK
- FIN
- RST
- URG
- ECE
- CWR
- FIN-ACK
- RST-ACK
type: string
type: object
maxItems: 16
minItems: 1
type: array
sampling:
description: '`sampling` sampling rate for the matched
flow'
format: int32
type: integer
sourcePorts:
anyOf:
- type: integer
- type: string
description: |-
`sourcePorts` optionally defines the source ports to filter flows by.
To filter a single port, set a single port as an integer value. For example, `sourcePorts: 80`.
To filter a range of ports, use a "start-end" range in string format. For example, `sourcePorts: "80-100"`.
To filter two ports, use a "port1,port2" in string format. For example, `ports: "80,100"`.
x-kubernetes-int-or-string: true
tcpFlags:
description: |-
`tcpFlags` optionally defines TCP flags to filter flows by.
In addition to the standard flags (RFC-9293), you can also filter by one of the three following combinations: `SYN-ACK`, `FIN-ACK`, and `RST-ACK`.
enum:
- SYN
- SYN-ACK
- ACK
- FIN
- RST
- URG
- ECE
- CWR
- FIN-ACK
- RST-ACK
type: string
type: object
imagePullPolicy:
default: IfNotPresent
description: '`imagePullPolicy` is the Kubernetes pull policy
for the image defined above'
enum:
- IfNotPresent
- Always
- Never
type: string
interfaces:
description: |-
`interfaces` contains the interface names from where flows are collected. If empty, the agent
fetches all the interfaces in the system, excepting the ones listed in ExcludeInterfaces.
An entry enclosed by slashes, such as `/br-/`, is matched as a regular expression.
Otherwise it is matched as a case-sensitive string.
items:
type: string
type: array
kafkaBatchSize:
default: 1048576
description: '`kafkaBatchSize` limits the maximum size of
a request in bytes before being sent to a partition. Ignored
when not using Kafka. Default: 1MB.'
type: integer
logLevel:
default: info
description: '`logLevel` defines the log level for the NetObserv
eBPF Agent'
enum:
- trace
- debug
- info
- warn
- error
- fatal
- panic
type: string
metrics:
description: '`metrics` defines the eBPF agent configuration
regarding metrics'
properties:
disableAlerts:
description: |-
`disableAlerts` is a list of alerts that should be disabled.
Possible values are:<br>
`NetObservDroppedFlows`, which is triggered when the eBPF agent is missing packets or flows, such as when the BPF hashmap is busy or full, or the capacity limiter being triggered.<br>
items:
description: |-
Name of an eBPF agent alert.
Possible values are:<br>
`NetObservDroppedFlows`, which is triggered when the eBPF agent is missing packets or flows, such as when the BPF hashmap is busy or full, or the capacity limiter being triggered.<br>
enum:
- NetObservDroppedFlows
type: string
type: array
enable:
description: Set `enable` to `false` to disable eBPF agent
metrics collection, by default it's `true`.
type: boolean
server:
description: Metrics server endpoint configuration for
Prometheus scraper
properties:
port:
description: The prometheus HTTP port
format: int32
maximum: 65535
minimum: 1
type: integer
tls:
description: TLS configuration.
properties:
insecureSkipVerify:
default: false
description: |-
`insecureSkipVerify` allows skipping client-side verification of the provided certificate.
If set to `true`, the `providedCaFile` field is ignored.
type: boolean
provided:
description: TLS configuration when `type` is
set to `PROVIDED`.
properties:
certFile:
description: '`certFile` defines the path
to the certificate file name within the
config map or secret'
type: string
certKey:
description: '`certKey` defines the path to
the certificate private key file name within
the config map or secret. Omit when the
key is not necessary.'
type: string
name:
description: Name of the config map or secret
containing certificates
type: string
namespace:
default: ""
description: |-
Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed.
If the namespace is different, the config map or the secret is copied so that it can be mounted as required.
type: string
type:
description: 'Type for the certificate reference:
`configmap` or `secret`'
enum:
- configmap
- secret
type: string
type: object
providedCaFile:
description: Reference to the CA file when `type`
is set to `PROVIDED`.
properties:
file:
description: File name within the config map
or secret
type: string
name:
description: Name of the config map or secret
containing the file
type: string
namespace:
default: ""
description: |-
Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where NetObserv is deployed.
If the namespace is different, the config map or the secret is copied so that it can be mounted as required.
type: string
type:
description: 'Type for the file reference:
"configmap" or "secret"'
enum:
- configmap
- secret
type: string
type: object
type:
default: DISABLED
description: |-
Select the type of TLS configuration:<br>
- `DISABLED` (default) to not configure TLS for the endpoint.
- `PROVIDED` to manually provide cert file and a key file. [Unsupported (*)].
- `AUTO` to use OpenShift auto generated certificate using annotations.
enum:
- DISABLED
- PROVIDED
- AUTO
type: string
required:
- type
type: object
type: object
type: object
privileged:
description: |-
Privileged mode for the eBPF Agent container. When ignored or set to `false`, the operator sets
granular capabilities (BPF, PERFMON, NET_ADMIN, SYS_RESOURCE) to the container.
If for some reason these capabilities cannot be set, such as if an old kernel version not knowing CAP_BPF
is in use, then you can turn on this mode for more global privileges.
Some agent features require the privileged mode, such as packet drops tracking (see `features`) and SR-IOV support.
type: boolean
resources:
default:
limits:
memory: 800Mi
requests:
cpu: 100m
memory: 50Mi
description: |-
`resources` are the compute resources required by this container.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
properties:
claims:
description: |-
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This is an alpha field and requires enabling the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: |-
Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.
type: string
request:
description: |-
Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: |-
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: |-
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type: object
type: object
sampling:
default: 50
description: Sampling rate of the flow reporter. 100 means
one flow on 100 is sent. 0 or 1 means all flows are sampled.
format: int32
minimum: 0
type: integer
type: object
ipfix:
description: |-
`ipfix` [deprecated (*)] - describes the settings related to the IPFIX-based flow reporter when `spec.agent.type`
is set to `IPFIX`.
properties:
cacheActiveTimeout:
default: 20s
description: '`cacheActiveTimeout` is the max period during
which the reporter aggregates flows before sending.'
pattern: ^\d+(ns|ms|s|m)?$
type: string
cacheMaxFlows:
default: 400
description: '`cacheMaxFlows` is the max number of flows in
an aggregate; when reached, the reporter sends the flows.'
format: int32
minimum: 0
type: integer
clusterNetworkOperator:
description: '`clusterNetworkOperator` defines the settings
related to the OpenShift Cluster Network Operator, when
available.'
properties:
namespace:
default: openshift-network-operator
description: Namespace where the config map is going
to be deployed.
type: string
type: object
forceSampleAll:
default: false
description: |-
`forceSampleAll` allows disabling sampling in the IPFIX-based flow reporter.
It is not recommended to sample all the traffic with IPFIX, as it might generate cluster instability.
If you REALLY want to do that, set this flag to `true`. Use at your own risk.
When it is set to `true`, the value of `sampling` is ignored.
type: boolean
ovnKubernetes:
description: '`ovnKubernetes` defines the settings of the
OVN-Kubernetes CNI, when available. This configuration is
used when using OVN''s IPFIX exports, without OpenShift.
When using OpenShift, refer to the `clusterNetworkOperator`
property instead.'
properties:
containerName:
default: ovnkube-node
description: '`containerName` defines the name of the
container to configure for IPFIX.'
type: string
daemonSetName:
default: ovnkube-node
description: '`daemonSetName` defines the name of the
DaemonSet controlling the OVN-Kubernetes pods.'
type: string
namespace:
default: ovn-kubernetes
description: Namespace where OVN-Kubernetes pods are deployed.
type: string
type: object
sampling:
default: 400
description: |-
`sampling` is the sampling rate on the reporter. 100 means one flow on 100 is sent.
To ensure cluster stability, it is not possible to set a value below 2.
If you really want to sample every packet, which might impact the cluster stability,
refer to `forceSampleAll`. Alternatively, you can use the eBPF Agent instead of IPFIX.
format: int32
minimum: 2
type: integer
type: object
type:
default: EBPF
description: |-
`type` [deprecated (*)] selects the flows tracing agent. The only possible value is `EBPF` (default), to use NetObserv eBPF agent.<br>
Previously, using an IPFIX collector was allowed, but was deprecated and it is now removed.<br>
Setting `IPFIX` is ignored and still use the eBPF Agent.
Since there is only a single option here, this field will be remove in a future API version.
enum:
- EBPF
- IPFIX
type: string
type: object
consolePlugin:
description: '`consolePlugin` defines the settings related to the
OpenShift Console plugin, when available.'
properties:
autoscaler:
description: '`autoscaler` spec of a horizontal pod autoscaler
to set up for the plugin Deployment.'
properties:
maxReplicas:
default: 3
description: '`maxReplicas` is the upper limit for the number
of pods that can be set by the autoscaler; cannot be smaller
than MinReplicas.'
format: int32
type: integer
metrics:
description: Metrics used by the pod autoscaler. For documentation,
refer to https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2/
items:
properties:
containerResource:
properties:
container:
type: string
name:
type: string
target:
properties:
averageUtilization:
format: int32
type: integer
averageValue:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type:
type: string
value:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
required:
- type
type: object
required:
- container
- name
- target
type: object
external:
properties:
metric:
properties:
name:
type: string
selector:
properties:
matchExpressions:
items:
properties:
key:
type: string
operator:
type: string
values:
items:
type: string
type: array
x-kubernetes-list-type: atomic
required:
- key
- operator
type: object
type: array
x-kubernetes-list-type: atomic
matchLabels:
additionalProperties:
type: string
type: object
type: object
x-kubernetes-map-type: atomic
required:
- name
type: object
target:
properties:
averageUtilization:
format: int32
type: integer
averageValue:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type:
type: string
value:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
required:
- type
type: object
required:
- metric
- target
type: object
object:
properties:
describedObject:
properties:
apiVersion:
type: string
kind:
type: string
name:
type: string
required:
- kind
- name
type: object
metric:
properties:
name:
type: string
selector:
properties:
matchExpressions:
items:
properties:
key:
type: string
operator:
type: string
values:
items:
type: string
type: array
x-kubernetes-list-type: atomic
required:
- key
- operator
type: object
type: array
x-kubernetes-list-type: atomic
matchLabels:
additionalProperties:
type: string
type: object
type: object
x-kubernetes-map-type: atomic
required:
- name
type: object
target:
properties:
averageUtilization:
format: int32
type: integer
averageValue:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type:
type: string
value:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
required:
- type
type: object
required:
- describedObject
- metric
- target
type: object
pods:
properties:
metric:
properties:
name:
type: string
selector:
properties:
matchExpressions:
items:
properties:
key:
type: string
operator:
type: string
values:
items:
type: string
type: array
x-kubernetes-list-type: atomic
required:
- key
- operator
type: object
type: array
x-kubernetes-list-type: atomic
matchLabels:
additionalProperties:
type: string
type: object
type: object
x-kubernetes-map-type: atomic
required:
- name
type: object
target:
properties:
averageUtilization:
format: int32
type: integer
averageValue:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type:
type: string
value:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
required:
- type
type: object
required:
- metric
- target
type: object
resource:
properties:
name:
type: string
target:
properties:
averageUtilization:
format: int32
type: integer
averageValue:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type:
type: string
value:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
required:
- type
type: object
required:
- name
- target
type: object
type:
type: string
required:
- type
type: object
type: array
minReplicas:
description: |-
`minReplicas` is the lower limit for the number of replicas to which the autoscaler
can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the
alpha feature gate HPAScaleToZero is enabled and at least one Object or External
metric is configured. Scaling is active as long as at least one metric value is
available.
format: int32
type: integer
status:
default: DISABLED
description: |-