forked from netobserv/netobserv-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrc.yaml
More file actions
1007 lines (978 loc) · 41 KB
/
rc.yaml
File metadata and controls
1007 lines (978 loc) · 41 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
image:
registry.redhat.io/network-observability/network-observability-operator-bundle@sha256:652c4315efe070dd4e3b91af036e9baa7bdeb9c6f1864b94b99f7795cfc5db88
name: network-observability-operator.v1.8.0
package: netobserv-operator
properties:
- type: olm.gvk
value:
group: flows.netobserv.io
kind: FlowCollector
version: v1beta1
- type: olm.gvk
value:
group: flows.netobserv.io
kind: FlowCollector
version: v1beta2
- type: olm.gvk
value:
group: flows.netobserv.io
kind: FlowMetric
version: v1alpha1
- type: olm.package
value:
packageName: netobserv-operator
version: 1.8.0
- type: olm.csv.metadata
value:
annotations:
alm-examples: |-
[
{
"apiVersion": "flows.netobserv.io/v1alpha1",
"kind": "FlowMetric",
"metadata": {
"labels": {
"app.kubernetes.io/created-by": "netobserv-operator",
"app.kubernetes.io/instance": "flowmetric-sample",
"app.kubernetes.io/managed-by": "kustomize",
"app.kubernetes.io/name": "flowmetric",
"app.kubernetes.io/part-of": "netobserv-operator"
},
"name": "flowmetric-sample"
},
"spec": {
"charts": [
{
"dashboardName": "Main",
"queries": [
{
"legend": "",
"promQL": "sum(rate($METRIC[2m]))"
}
],
"title": "External ingress traffic",
"type": "SingleStat",
"unit": "Bps"
},
{
"dashboardName": "Main",
"queries": [
{
"legend": "{{DstK8S_Namespace}} / {{DstK8S_OwnerName}}",
"promQL": "sum(rate($METRIC{DstK8S_Namespace!=\"\"}[2m])) by (DstK8S_Namespace, DstK8S_OwnerName)"
}
],
"sectionName": "External",
"title": "Top external ingress traffic per workload",
"type": "StackArea",
"unit": "Bps"
}
],
"direction": "Ingress",
"filters": [
{
"field": "SrcSubnetLabel",
"matchType": "Absence"
}
],
"labels": [
"DstK8S_HostName",
"DstK8S_Namespace",
"DstK8S_OwnerName",
"DstK8S_OwnerType"
],
"metricName": "cluster_external_ingress_bytes_total",
"type": "Counter",
"valueField": "Bytes"
}
},
{
"apiVersion": "flows.netobserv.io/v1beta1",
"kind": "FlowCollector",
"metadata": {
"name": "cluster"
},
"spec": {
"agent": {
"ebpf": {
"cacheActiveTimeout": "5s",
"cacheMaxFlows": 100000,
"excludeInterfaces": [
"lo"
],
"imagePullPolicy": "IfNotPresent",
"interfaces": [],
"kafkaBatchSize": 1048576,
"logLevel": "info",
"privileged": false,
"resources": {
"limits": {
"memory": "800Mi"
},
"requests": {
"cpu": "100m",
"memory": "50Mi"
}
},
"sampling": 50
},
"type": "EBPF"
},
"consolePlugin": {
"autoscaler": {
"maxReplicas": 3,
"metrics": [
{
"resource": {
"name": "cpu",
"target": {
"averageUtilization": 50,
"type": "Utilization"
}
},
"type": "Resource"
}
],
"minReplicas": 1,
"status": "DISABLED"
},
"enable": true,
"imagePullPolicy": "IfNotPresent",
"logLevel": "info",
"port": 9001,
"portNaming": {
"enable": true,
"portNames": {
"3100": "loki"
}
},
"quickFilters": [
{
"default": true,
"filter": {
"flow_layer": "app"
},
"name": "Applications"
},
{
"filter": {
"flow_layer": "infra"
},
"name": "Infrastructure"
},
{
"default": true,
"filter": {
"dst_kind": "Pod",
"src_kind": "Pod"
},
"name": "Pods network"
},
{
"filter": {
"dst_kind": "Service"
},
"name": "Services network"
}
],
"register": true
},
"deploymentModel": "DIRECT",
"exporters": [],
"kafka": {
"address": "kafka-cluster-kafka-bootstrap.netobserv",
"tls": {
"caCert": {
"certFile": "ca.crt",
"name": "kafka-cluster-cluster-ca-cert",
"type": "secret"
},
"enable": false,
"userCert": {
"certFile": "user.crt",
"certKey": "user.key",
"name": "flp-kafka",
"type": "secret"
}
},
"topic": "network-flows"
},
"loki": {
"batchSize": 10485760,
"batchWait": "1s",
"enable": true,
"maxBackoff": "5s",
"maxRetries": 2,
"minBackoff": "1s",
"statusTls": {
"caCert": {
"certFile": "service-ca.crt",
"name": "loki-ca-bundle",
"type": "configmap"
},
"enable": false,
"insecureSkipVerify": false,
"userCert": {
"certFile": "tls.crt",
"certKey": "tls.key",
"name": "loki-query-frontend-http",
"type": "secret"
}
},
"tls": {
"caCert": {
"certFile": "service-ca.crt",
"name": "loki-gateway-ca-bundle",
"type": "configmap"
},
"enable": false,
"insecureSkipVerify": false
},
"url": "http://loki.netobserv.svc:3100/"
},
"namespace": "netobserv",
"processor": {
"conversationEndTimeout": "10s",
"conversationHeartbeatInterval": "30s",
"conversationTerminatingTimeout": "5s",
"dropUnusedFields": true,
"imagePullPolicy": "IfNotPresent",
"kafkaConsumerAutoscaler": null,
"kafkaConsumerBatchSize": 10485760,
"kafkaConsumerQueueCapacity": 1000,
"kafkaConsumerReplicas": 3,
"logLevel": "info",
"logTypes": "FLOWS",
"metrics": {
"disableAlerts": [],
"includeList": [
"node_ingress_bytes_total",
"workload_ingress_bytes_total",
"namespace_flows_total"
],
"server": {
"port": 9102
}
},
"port": 2055,
"profilePort": 6060,
"resources": {
"limits": {
"memory": "800Mi"
},
"requests": {
"cpu": "100m",
"memory": "100Mi"
}
}
}
}
},
{
"apiVersion": "flows.netobserv.io/v1beta2",
"kind": "FlowCollector",
"metadata": {
"name": "cluster"
},
"spec": {
"agent": {
"ebpf": {
"cacheActiveTimeout": "5s",
"cacheMaxFlows": 100000,
"excludeInterfaces": [
"lo"
],
"imagePullPolicy": "IfNotPresent",
"interfaces": [],
"kafkaBatchSize": 1048576,
"logLevel": "info",
"metrics": {
"server": {
"port": 9400
}
},
"privileged": false,
"resources": {
"limits": {
"memory": "800Mi"
},
"requests": {
"cpu": "100m",
"memory": "50Mi"
}
},
"sampling": 50
},
"type": "eBPF"
},
"consolePlugin": {
"autoscaler": {
"maxReplicas": 3,
"metrics": [
{
"resource": {
"name": "cpu",
"target": {
"averageUtilization": 50,
"type": "Utilization"
}
},
"type": "Resource"
}
],
"minReplicas": 1,
"status": "Disabled"
},
"enable": true,
"imagePullPolicy": "IfNotPresent",
"logLevel": "info",
"portNaming": {
"enable": true,
"portNames": {
"3100": "loki"
}
},
"quickFilters": [
{
"default": true,
"filter": {
"flow_layer": "\"app\""
},
"name": "Applications"
},
{
"filter": {
"flow_layer": "\"infra\""
},
"name": "Infrastructure"
},
{
"default": true,
"filter": {
"dst_kind": "\"Pod\"",
"src_kind": "\"Pod\""
},
"name": "Pods network"
},
{
"filter": {
"dst_kind": "\"Service\""
},
"name": "Services network"
}
],
"replicas": 1,
"resources": {
"limits": {
"memory": "100Mi"
},
"requests": {
"cpu": "100m",
"memory": "50Mi"
}
}
},
"deploymentModel": "Direct",
"exporters": [],
"kafka": {
"address": "kafka-cluster-kafka-bootstrap.netobserv",
"tls": {
"caCert": {
"certFile": "ca.crt",
"name": "kafka-cluster-cluster-ca-cert",
"type": "secret"
},
"enable": false,
"userCert": {
"certFile": "user.crt",
"certKey": "user.key",
"name": "flp-kafka",
"type": "secret"
}
},
"topic": "network-flows"
},
"loki": {
"enable": true,
"lokiStack": {
"name": "loki"
},
"mode": "Monolithic",
"monolithic": {
"tenantID": "netobserv",
"tls": {
"caCert": {
"certFile": "service-ca.crt",
"name": "loki-gateway-ca-bundle",
"type": "configmap"
},
"enable": false
},
"url": "http://loki.netobserv.svc:3100/"
},
"readTimeout": "30s",
"writeBatchSize": 10485760,
"writeBatchWait": "1s",
"writeTimeout": "10s"
},
"namespace": "netobserv",
"networkPolicy": {
"additionalNamespaces": [],
"enable": false
},
"processor": {
"imagePullPolicy": "IfNotPresent",
"kafkaConsumerAutoscaler": null,
"kafkaConsumerBatchSize": 10485760,
"kafkaConsumerQueueCapacity": 1000,
"kafkaConsumerReplicas": 3,
"logLevel": "info",
"logTypes": "Flows",
"metrics": {
"disableAlerts": [],
"server": {
"port": 9401
}
},
"resources": {
"limits": {
"memory": "800Mi"
},
"requests": {
"cpu": "100m",
"memory": "100Mi"
}
}
},
"prometheus": {
"querier": {
"enable": true,
"mode": "Auto",
"timeout": "30s"
}
}
}
}
]
capabilities: Seamless Upgrades
categories: Monitoring, Networking
console.openshift.io/plugins: '["netobserv-plugin"]'
containerImage: ''
createdAt: 2024-11-15T09:48:09
description: Network flows collector and monitoring solution
features.operators.openshift.io/cnf: 'false'
features.operators.openshift.io/cni: 'false'
features.operators.openshift.io/csi: 'false'
features.operators.openshift.io/disconnected: 'true'
features.operators.openshift.io/fips-compliant: 'true'
features.operators.openshift.io/proxy-aware: 'false'
features.operators.openshift.io/tls-profiles: 'false'
features.operators.openshift.io/token-auth-aws: 'false'
features.operators.openshift.io/token-auth-azure: 'false'
features.operators.openshift.io/token-auth-gcp: 'false'
operatorframework.io/cluster-monitoring: 'true'
operatorframework.io/initialization-resource: '{"apiVersion":"flows.netobserv.io/v1beta2",
"kind":"FlowCollector","metadata":{"name":"cluster"},"spec": {}}'
operatorframework.io/suggested-namespace: openshift-netobserv-operator
operators.openshift.io/valid-subscription: '["OpenShift Kubernetes Engine",
"OpenShift Container Platform", "OpenShift Platform Plus"]'
operators.operatorframework.io/builder: operator-sdk-v1.25.3
operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
repository: https://github.com/netobserv/network-observability-operator
support: NetObserv team
apiServiceDefinitions: {}
crdDescriptions:
owned:
- description: '`FlowCollector` is the schema for the network flows collection
API, which pilots and configures the underlying deployments.'
displayName: Flow Collector
kind: FlowCollector
name: flowcollectors.flows.netobserv.io
version: v1beta1
- description: '`FlowCollector` is the schema for the network flows collection
API, which pilots and configures the underlying deployments.'
displayName: Flow Collector
kind: FlowCollector
name: flowcollectors.flows.netobserv.io
specDescriptors:
- description: defines the desired type of deployment for flow processing.
displayName: Deployment model
path: deploymentModel
- description: for flows extraction.
displayName: Agent configuration
path: agent
- path: agent.type
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- path: agent.ipfix
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- description: Settings related to the eBPF-based flow reporter.
displayName: eBPF Agent configuration
path: agent.ebpf
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:agent.type:eBPF
- displayName: Privileged mode
path: agent.ebpf.privileged
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- displayName: Cache active timeout
path: agent.ebpf.cacheActiveTimeout
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Cache max flows
path: agent.ebpf.cacheMaxFlows
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Kafka batch size
path: agent.ebpf.kafkaBatchSize
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:deploymentModel:Kafka
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Log level
path: agent.ebpf.logLevel
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Image pull policy
path: agent.ebpf.imagePullPolicy
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:imagePullPolicy
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Resource Requirements
path: agent.ebpf.resources
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:resourceRequirements
- path: agent.ebpf.advanced
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- path: agent.ebpf.flowFilter
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- path: agent.ebpf.metrics.enable
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- description: to use Kafka as a broker as part of the flow collection pipeline.
displayName: Kafka configuration
path: kafka
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:deploymentModel:Kafka
- displayName: TLS configuration
path: kafka.tls
- path: kafka.tls.enable
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- displayName: Insecure
path: kafka.tls.insecureSkipVerify
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:kafka.tls.enable:true
- displayName: User certificate when using mTLS
path: kafka.tls.userCert
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:kafka.tls.enable:true
- displayName: CA certificate
path: kafka.tls.caCert
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:kafka.tls.enable:true
- path: kafka.sasl
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- description: of the component that receives the flows from the agent, enriches
them, generates metrics, and forwards them to the Loki persistence layer
and/or any available exporter.
displayName: Processor configuration
path: processor
- displayName: Multi-cluster deployment
path: processor.multiClusterDeployment
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- displayName: Cluster name
path: processor.clusterName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:processor.multiClusterDeployment:true
- displayName: Availability zones
path: processor.addZone
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: processor.advanced
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- displayName: Metrics configuration
path: processor.metrics
- displayName: Server configuration
path: processor.metrics.server
- displayName: TLS configuration
path: processor.metrics.server.tls
- displayName: Insecure
path: processor.metrics.server.tls.insecureSkipVerify
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:processor.metrics.server.tls.type:Provided
- displayName: Cert
path: processor.metrics.server.tls.provided
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:processor.metrics.server.tls.type:Provided
- displayName: CA
path: processor.metrics.server.tls.providedCaFile
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:processor.metrics.server.tls.type:Provided
- displayName: Kafka consumer replicas
path: processor.kafkaConsumerReplicas
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:deploymentModel:Kafka
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: kafka consumer autoscaler
path: processor.kafkaConsumerAutoscaler
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:deploymentModel:Kafka
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Kafka consumer queue capacity
path: processor.kafkaConsumerQueueCapacity
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:deploymentModel:Kafka
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Kafka consumer batch size
path: processor.kafkaConsumerBatchSize
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:deploymentModel:Kafka
- urn:alm:descriptor:com.tectonic.ui:advanced
- path: processor.subnetLabels.openShiftAutoDetect
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- displayName: Log level
path: processor.logLevel
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Image pull policy
path: processor.imagePullPolicy
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:imagePullPolicy
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Resource Requirements
path: processor.resources
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:resourceRequirements
- description: for the flow store.
displayName: Loki client settings
path: loki
- displayName: Enable
path: loki.enable
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- displayName: Mode
path: loki.mode
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:loki.enable:true
- displayName: Loki stack
path: loki.lokiStack
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:loki.mode:LokiStack
- displayName: Monolithic
path: loki.monolithic
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:loki.mode:Monolithic
- displayName: Microservices
path: loki.microservices
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:loki.mode:Microservices
- displayName: Manual
path: loki.manual
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:loki.mode:Manual
- displayName: Write batch wait
path: loki.writeBatchWait
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:loki.enable:true
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Write batch size
path: loki.writeBatchSize
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:loki.enable:true
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Write timeout
path: loki.writeTimeout
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:loki.enable:true
- urn:alm:descriptor:com.tectonic.ui:advanced
- path: loki.advanced
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- description: related to the OpenShift Console integration.
displayName: Console plugin configuration
path: consolePlugin
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:loki.enable:true
- displayName: Enable
path: consolePlugin.enable
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- displayName: Port naming
path: consolePlugin.portNaming
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:consolePlugin.enable:true
- displayName: Quick filters
path: consolePlugin.quickFilters
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:consolePlugin.enable:true
- displayName: Replicas
path: consolePlugin.replicas
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:consolePlugin.enable:true
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Horizontal pod autoscaler
path: consolePlugin.autoscaler
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:consolePlugin.enable:true
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Log level
path: consolePlugin.logLevel
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:consolePlugin.enable:true
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Image pull policy
path: consolePlugin.imagePullPolicy
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:imagePullPolicy"
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:consolePlugin.enable:true
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Resource Requirements
path: consolePlugin.resources
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:resourceRequirements
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:consolePlugin.enable:true
- path: consolePlugin.advanced
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:hidden
- description: additional optional exporters for custom consumption or storage.
displayName: Exporters
path: exporters
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced
- displayName: Type
path: exporters[0].type
- displayName: IPFIX configuration
path: exporters[0].ipfix
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:exporters.type:IPFIX
- displayName: Kafka configuration
path: exporters[0].kafka
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldDependency:exporters.type:Kafka
- displayName: Exclude interfaces
path: agent.ebpf.excludeInterfaces
- displayName: Features
path: agent.ebpf.features
- displayName: Interfaces
path: agent.ebpf.interfaces
- displayName: Metrics
path: agent.ebpf.metrics
- displayName: Disable alerts
path: agent.ebpf.metrics.disableAlerts
- displayName: Server
path: agent.ebpf.metrics.server
- displayName: Port
path: agent.ebpf.metrics.server.port
- displayName: Sampling
path: agent.ebpf.sampling
- displayName: Enable
path: consolePlugin.portNaming.enable
- displayName: Port names
path: consolePlugin.portNaming.portNames
- displayName: Address
path: kafka.address
- displayName: Topic
path: kafka.topic
- displayName: Name
path: loki.lokiStack.name
- displayName: Namespace
path: loki.lokiStack.namespace
- displayName: Auth token
path: loki.manual.authToken
- displayName: Ingester url
path: loki.manual.ingesterUrl
- displayName: Querier url
path: loki.manual.querierUrl
- displayName: Status url
path: loki.manual.statusUrl
- displayName: TenantID
path: loki.manual.tenantID
- displayName: Ingester url
path: loki.microservices.ingesterUrl
- displayName: Querier url
path: loki.microservices.querierUrl
- displayName: TenantID
path: loki.microservices.tenantID
- displayName: TenantID
path: loki.monolithic.tenantID
- displayName: Url
path: loki.monolithic.url
- displayName: Read timeout
path: loki.readTimeout
- displayName: Namespace
path: namespace
- displayName: Network policy
path: networkPolicy
- displayName: Additional namespaces
path: networkPolicy.additionalNamespaces
- displayName: Enable
path: networkPolicy.enable
- displayName: Log types
path: processor.logTypes
- displayName: Disable alerts
path: processor.metrics.disableAlerts
- displayName: Include list
path: processor.metrics.includeList
- displayName: Port
path: processor.metrics.server.port
- displayName: Subnet labels
path: processor.subnetLabels
- displayName: Custom labels
path: processor.subnetLabels.customLabels
- displayName: Prometheus
path: prometheus
- displayName: Querier
path: prometheus.querier
- displayName: Enable
path: prometheus.querier.enable
- displayName: Manual
path: prometheus.querier.manual
- displayName: Forward user token
path: prometheus.querier.manual.forwardUserToken
- displayName: Url
path: prometheus.querier.manual.url
- displayName: Mode
path: prometheus.querier.mode
- displayName: Timeout
path: prometheus.querier.timeout
statusDescriptors:
- description: Namespace where console plugin and flowlogs-pipeline have been
deployed.
displayName: Namespace
path: namespace
x-descriptors:
- urn:alm:descriptor:text
- description: Conditions of the FlowCollector instance health.
displayName: Conditions
path: conditions
x-descriptors:
- urn:alm:descriptor:io.kubernetes.conditions
version: v1beta2
- description: '`FlowMetric` is the schema for the custom metrics API, which
allows to generate more metrics out of flow logs. You can find examples
here: https://github.com/netobserv/network-observability-operator/tree/main/config/samples/flowmetrics'
displayName: Flow Metric
kind: FlowMetric
name: flowmetrics.flows.netobserv.io
version: v1alpha1
description: |
Network Observability is an OpenShift operator that deploys a monitoring pipeline consisting in:
- an eBPF agent, that generates network flows from captured packets
- flowlogs-pipeline, a component that collects, enriches and exports these flows
- a Console plugin for flows visualization with powerful filtering options, a topology representation and more
Flow data is then available in multiple ways, each optional:
- As Cluster Monitoring metrics
- As raw flow logs stored in Grafana Loki
- As raw flow logs exported to a collector
## Dependencies
### Loki
[Loki](https://grafana.com/oss/loki/), from GrafanaLabs, can optionally be used as the backend to store all collected flows. The Network Observability operator does not install Loki directly, however we provide some guidance to help you there.
- For a production or production-like environment usage, refer to [the operator documentation](https://docs.openshift.com/container-platform/latest/network_observability/installing-operators.html).
- For a quick try that is not suitable for production and not scalable (it deploys a single pod, configures a 10GB storage PVC, with 24 hours of retention), you can simply run the following commands:
```
oc create namespace netobserv
oc apply -f <(curl -L https://raw.githubusercontent.com/netobserv/documents/5410e65b8e05aaabd1244a9524cfedd8ac8c56b5/examples/zero-click-loki/1-storage.yaml) -n netobserv
oc apply -f <(curl -L https://raw.githubusercontent.com/netobserv/documents/5410e65b8e05aaabd1244a9524cfedd8ac8c56b5/examples/zero-click-loki/2-loki.yaml) -n netobserv
```
If you prefer to not use Loki, you must set `spec.loki.enable` to `false` in `FlowCollector`.
In that case, you can still get the Prometheus metrics or export raw flows to a custom collector. But be aware that some of the Console plugin features will be disabled. For instance, you will not be able to view raw flows there, and the metrics / topology will have a more limited level of details, missing information such as pods or IPs.
### Kafka
[Apache Kafka](https://kafka.apache.org/) can optionally be used for a more resilient and scalable architecture. You can use for example [Strimzi](https://strimzi.io/), an operator-based distribution of Kafka for Kubernetes and OpenShift.
### Grafana
[Grafana](https://grafana.com/oss/grafana/) can optionally be installed for custom dashboards and query capabilities.
## Configuration
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.6.1-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.6.1-community/config/samples/flows_v1beta2_flowcollector.yaml).
To edit configuration in cluster, run:
```bash
oc edit flowcollector cluster
```
As it operates cluster-wide on every node, only a single `FlowCollector` is allowed, and it has to be named `cluster`.
A couple of settings deserve special attention:
- Sampling (`spec.agent.ebpf.sampling`): a value of `100` means: one flow every 100 is sampled. `1` means all flows are sampled. The lower it is, the more flows you get, and the more accurate are derived metrics, but the higher amount of resources are consumed. By default, sampling is set to 50 (ie. 1:50). Note that more sampled flows also means more storage needed. We recommend to start with default values and refine empirically, to figure out which setting your cluster can manage.
- Loki (`spec.loki`): configure here how to reach Loki. The default values match the Loki quick install paths mentioned above, but you might have to configure differently if you used another installation method. Make sure to disable it (`spec.loki.enable`) if you don't want to use Loki.
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.6.1-community/docs/QuickFilters.md).
- Kafka (`spec.deploymentModel: KAFKA` and `spec.kafka`): when enabled, integrates the flow collection pipeline with Kafka, by splitting ingestion from transformation (kube enrichment, derived metrics, ...). Kafka can provide better scalability, resiliency and high availability ([view more details](https://www.redhat.com/en/topics/integration/what-is-apache-kafka)). Assumes Kafka is already deployed and a topic is created.
- Exporters (`spec.exporters`) an optional list of exporters to which to send enriched flows. KAFKA and IPFIX exporters are supported. This allows you to define any custom storage or processing that can read from Kafka or use the IPFIX standard.
- To enable availability zones awareness, set `spec.processor.addZone` to `true`.
## Further reading
Please refer to the documentation on GitHub for more information.
This documentation includes:
- An [overview](https://github.com/netobserv/network-observability-operator#openshift-console) of the features, with screenshots
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.6.1-community/docs/Metrics.md).
- A [performance](https://github.com/netobserv/network-observability-operator#performance-fine-tuning) section, for fine-tuning
- A [security](https://github.com/netobserv/network-observability-operator#securing-data-and-communications) section
- An [F.A.Q.](https://github.com/netobserv/network-observability-operator#faq--troubleshooting) section
displayName: Network Observability
installModes:
- supported: false
type: OwnNamespace
- supported: false
type: SingleNamespace
- supported: false
type: MultiNamespace
- supported: true
type: AllNamespaces
keywords:
- network observability
- ebpf
- ipfix
- flow tracing
- flows
- topology
- network
- observability
labels:
operatorframework.io/arch.amd64: supported
operatorframework.io/arch.arm64: supported
operatorframework.io/arch.ppc64le: supported
operatorframework.io/arch.s390x: supported
operatorframework.io/os.linux: supported
links:
- name: Project page
url: https://github.com/netobserv/network-observability-operator
- name: Issue tracker
url: https://github.com/netobserv/network-observability-operator/issues
- name: Discussion board
url: https://github.com/netobserv/network-observability-operator/discussions
maintainers:
- email: jpinsonn@redhat.com
name: Julien Pinsonneau
- email: jtakvori@redhat.com
name: Joel Takvorian
- email: kmeth@redhat.com
name: Kalman Meth
- email: mmahmoud@redhat.com
name: Mohamed S. Mahmoud
- email: ocazade@redhat.com
name: Olivier Cazade
- email: rschaffe@redhat.com
name: Ronen Schaffer
- email: stlee@redhat.com
name: Steven Lee
maturity: stable
minKubeVersion: 1.23.0
provider:
name: Red Hat
url: https://www.redhat.com
relatedImages:
- image: registry.redhat.io/network-observability/network-observability-console-plugin-rhel9@sha256:625c61b35f6da4c363e97560562ea0483abbc9d656439a2a1a5e459f7c787d0c
name: console_plugin
- image: registry.redhat.io/network-observability/network-observability-ebpf-agent-rhel9@sha256:4357c47a999973c65e16f8ac9ae418140de5a57826431f7c0dbd9cda597479ee
name: ebpf_agent