/
cilium.io_tracingpolicies.yaml
2029 lines (2029 loc) · 96.6 KB
/
cilium.io_tracingpolicies.yaml
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.14.0
creationTimestamp: null
name: tracingpolicies.cilium.io
spec:
group: cilium.io
names:
kind: TracingPolicy
listKind: TracingPolicyList
plural: tracingpolicies
singular: tracingpolicy
scope: Cluster
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
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:
type: object
spec:
description: Tracing policy specification.
properties:
containerSelector:
description: ContainerSelector selects containers that this policy
applies to. A map of container fields will be constructed in the
same way as a map of labels. The name of the field represents the
label "key", and the value of the field - label "value". Currently,
only the "name" field is supported.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: A label selector requirement is a selector that
contains values, a key, and an operator that relates the key
and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: operator represents a key's relationship to
a set of values. Valid operators are In, NotIn, Exists
and DoesNotExist.
enum:
- In
- NotIn
- Exists
- DoesNotExist
type: string
values:
description: values is an array of string values. If the
operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values
array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
description: MatchLabelsValue represents the value from the
MatchLabels {key,value} pair.
maxLength: 63
pattern: ^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$
type: string
description: matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator
is "In", and the values array contains only "value". The requirements
are ANDed.
type: object
type: object
enforcers:
description: A killer spec.
items:
properties:
calls:
description: Calls where enforcer is executed in
items:
type: string
type: array
required:
- calls
type: object
type: array
kprobes:
description: A list of kprobe specs.
items:
properties:
args:
description: A list of function arguments to include in the
trace output.
items:
properties:
index:
description: Position of the argument.
format: int32
minimum: 0
type: integer
label:
description: Label to output in the JSON
type: string
maxData:
default: false
description: Read maximum possible data (currently 327360).
This field is only used for char_buff data. When this
value is false (default), the bpf program will fetch
at most 4096 bytes. In later kernels (>=5.4) tetragon
supports fetching up to 327360 bytes if this flag is
turned on
type: boolean
returnCopy:
default: false
description: This field is used only for char_buf and
char_iovec types. It indicates that this argument should
be read later (when the kretprobe for the symbol is
triggered) because it might not be populated when the
kprobe is triggered at the entrance of the function.
For example, a buffer supplied to read(2) won't have
content until kretprobe is triggered.
type: boolean
sizeArgIndex:
description: Specifies the position of the corresponding
size argument for this argument. This field is used
only for char_buf and char_iovec types.
format: int32
minimum: 0
type: integer
type:
default: auto
description: Argument type.
enum:
- auto
- int
- int8
- uint8
- int16
- uint16
- uint32
- int32
- uint64
- int64
- char_buf
- char_iovec
- size_t
- skb
- sock
- string
- fd
- file
- filename
- path
- nop
- bpf_attr
- perf_event
- bpf_map
- user_namespace
- capability
- kiocb
- iov_iter
- cred
- load_info
- module
- syscall64
- kernel_cap_t
- cap_inheritable
- cap_permitted
- cap_effective
- linux_binprm
- data_loc
- net_device
type: string
required:
- index
- type
type: object
type: array
call:
description: Name of the function to apply the kprobe spec to.
type: string
message:
description: A short message of 256 characters max that will
be included in the event output to inform users what is going
on.
type: string
return:
default: false
description: Indicates whether to collect return value of the
traced function.
type: boolean
returnArg:
description: A return argument to include in the trace output.
properties:
index:
description: Position of the argument.
format: int32
minimum: 0
type: integer
label:
description: Label to output in the JSON
type: string
maxData:
default: false
description: Read maximum possible data (currently 327360).
This field is only used for char_buff data. When this
value is false (default), the bpf program will fetch at
most 4096 bytes. In later kernels (>=5.4) tetragon supports
fetching up to 327360 bytes if this flag is turned on
type: boolean
returnCopy:
default: false
description: This field is used only for char_buf and char_iovec
types. It indicates that this argument should be read
later (when the kretprobe for the symbol is triggered)
because it might not be populated when the kprobe is triggered
at the entrance of the function. For example, a buffer
supplied to read(2) won't have content until kretprobe
is triggered.
type: boolean
sizeArgIndex:
description: Specifies the position of the corresponding
size argument for this argument. This field is used only
for char_buf and char_iovec types.
format: int32
minimum: 0
type: integer
type:
default: auto
description: Argument type.
enum:
- auto
- int
- int8
- uint8
- int16
- uint16
- uint32
- int32
- uint64
- int64
- char_buf
- char_iovec
- size_t
- skb
- sock
- string
- fd
- file
- filename
- path
- nop
- bpf_attr
- perf_event
- bpf_map
- user_namespace
- capability
- kiocb
- iov_iter
- cred
- load_info
- module
- syscall64
- kernel_cap_t
- cap_inheritable
- cap_permitted
- cap_effective
- linux_binprm
- data_loc
- net_device
type: string
required:
- index
- type
type: object
returnArgAction:
description: 'An action to perform on the return argument. Available
actions are: Post;TrackSock;UntrackSock'
type: string
selectors:
description: Selectors to apply before producing trace output.
Selectors are ORed.
items:
description: KProbeSelector selects function calls for kprobe
based on PIDs and function arguments. The results of MatchPIDs
and MatchArgs are ANDed.
properties:
matchActions:
description: A list of actions to execute when this selector
matches
items:
properties:
action:
description: Action to execute.
enum:
- Post
- FollowFD
- UnfollowFD
- Sigkill
- CopyFD
- Override
- GetUrl
- DnsLookup
- NoPost
- Signal
- TrackSock
- UntrackSock
- NotifyEnforcer
type: string
argError:
description: error value for override action
format: int32
type: integer
argFd:
description: An arg index for the fd for fdInstall
action
format: int32
type: integer
argFqdn:
description: A FQDN to lookup for the dnsLookup
action
type: string
argName:
description: An arg index for the filename for fdInstall
action
format: int32
type: integer
argSig:
description: A signal number for signal action
format: int32
type: integer
argSock:
description: An arg index for the sock for trackSock
and untrackSock actions
format: int32
type: integer
argUrl:
description: A URL for the getUrl action
type: string
kernelStackTrace:
description: Enable kernel stack trace export. Only
valid with the post action.
type: boolean
rateLimit:
description: A time period within which repeated
messages will not be posted. Can be specified
in seconds (default or with 's' suffix), minutes
('m' suffix) or hours ('h' suffix). Only valid
with the post action.
type: string
rateLimitScope:
description: The scope of the provided rate limit
argument. Can be "thread" (default), "process"
(all threads for the same process), or "global".
If "thread" is selected then rate limiting applies
per thread; if "process" is selected then rate
limiting applies per process; if "global" is selected
then rate limiting applies regardless of which
process or thread caused the action. Only valid
with the post action and with a rateLimit specified.
type: string
userStackTrace:
description: Enable user stack trace export. Only
valid with the post action.
type: boolean
required:
- action
type: object
type: array
matchArgs:
description: A list of argument filters. MatchArgs are
ANDed.
items:
properties:
index:
description: Position of the argument to apply fhe
filter to.
format: int32
minimum: 0
type: integer
operator:
description: Filter operation.
enum:
- Equal
- NotEqual
- Prefix
- NotPrefix
- Postfix
- NotPostfix
- GreaterThan
- LessThan
- GT
- LT
- Mask
- SPort
- NotSPort
- SPortPriv
- NotSportPriv
- DPort
- NotDPort
- DPortPriv
- NotDPortPriv
- SAddr
- NotSAddr
- DAddr
- NotDAddr
- Protocol
- Family
- State
- InMap
- NotInMap
type: string
values:
description: Value to compare the argument against.
items:
type: string
type: array
required:
- index
- operator
type: object
type: array
matchBinaries:
description: A list of binary exec name filters.
items:
properties:
operator:
description: Filter operation.
enum:
- In
- NotIn
- Prefix
- NotPrefix
type: string
values:
description: Value to compare the argument against.
items:
type: string
type: array
required:
- operator
- values
type: object
type: array
matchCapabilities:
description: A list of capabilities and IDs
items:
properties:
isNamespaceCapability:
default: false
description: Indicates whether these caps are namespace
caps.
type: boolean
operator:
description: Namespace selector operator.
enum:
- In
- NotIn
type: string
type:
default: Effective
description: Type of capabilities
enum:
- Effective
- Inheritable
- Permitted
type: string
values:
description: Capabilities to match.
items:
type: string
type: array
required:
- operator
- values
type: object
type: array
matchCapabilityChanges:
description: IDs for capabilities changes
items:
properties:
isNamespaceCapability:
default: false
description: Indicates whether these caps are namespace
caps.
type: boolean
operator:
description: Namespace selector operator.
enum:
- In
- NotIn
type: string
type:
default: Effective
description: Type of capabilities
enum:
- Effective
- Inheritable
- Permitted
type: string
values:
description: Capabilities to match.
items:
type: string
type: array
required:
- operator
- values
type: object
type: array
matchNamespaceChanges:
description: IDs for namespace changes
items:
properties:
operator:
description: Namespace selector operator.
enum:
- In
- NotIn
type: string
values:
description: Namespace types (e.g., Mnt, Pid) to
match.
items:
type: string
type: array
required:
- operator
- values
type: object
type: array
matchNamespaces:
description: A list of namespaces and IDs
items:
properties:
namespace:
description: Namespace selector name.
enum:
- Uts
- Ipc
- Mnt
- Pid
- PidForChildren
- Net
- Time
- TimeForChildren
- Cgroup
- User
type: string
operator:
description: Namespace selector operator.
enum:
- In
- NotIn
type: string
values:
description: Namespace IDs (or host_ns for host
namespace) of namespaces to match.
items:
type: string
type: array
required:
- namespace
- operator
- values
type: object
type: array
matchPIDs:
description: A list of process ID filters. MatchPIDs are
ANDed.
items:
properties:
followForks:
default: false
description: Matches any descendant processes of
the matching PIDs.
type: boolean
isNamespacePID:
default: false
description: Indicates whether PIDs are namespace
PIDs.
type: boolean
operator:
description: PID selector operator.
enum:
- In
- NotIn
type: string
values:
description: Process IDs to match.
items:
format: int32
type: integer
type: array
required:
- operator
- values
type: object
type: array
matchReturnActions:
description: A list of actions to execute when MatchReturnArgs
selector matches
items:
properties:
action:
description: Action to execute.
enum:
- Post
- FollowFD
- UnfollowFD
- Sigkill
- CopyFD
- Override
- GetUrl
- DnsLookup
- NoPost
- Signal
- TrackSock
- UntrackSock
- NotifyEnforcer
type: string
argError:
description: error value for override action
format: int32
type: integer
argFd:
description: An arg index for the fd for fdInstall
action
format: int32
type: integer
argFqdn:
description: A FQDN to lookup for the dnsLookup
action
type: string
argName:
description: An arg index for the filename for fdInstall
action
format: int32
type: integer
argSig:
description: A signal number for signal action
format: int32
type: integer
argSock:
description: An arg index for the sock for trackSock
and untrackSock actions
format: int32
type: integer
argUrl:
description: A URL for the getUrl action
type: string
kernelStackTrace:
description: Enable kernel stack trace export. Only
valid with the post action.
type: boolean
rateLimit:
description: A time period within which repeated
messages will not be posted. Can be specified
in seconds (default or with 's' suffix), minutes
('m' suffix) or hours ('h' suffix). Only valid
with the post action.
type: string
rateLimitScope:
description: The scope of the provided rate limit
argument. Can be "thread" (default), "process"
(all threads for the same process), or "global".
If "thread" is selected then rate limiting applies
per thread; if "process" is selected then rate
limiting applies per process; if "global" is selected
then rate limiting applies regardless of which
process or thread caused the action. Only valid
with the post action and with a rateLimit specified.
type: string
userStackTrace:
description: Enable user stack trace export. Only
valid with the post action.
type: boolean
required:
- action
type: object
type: array
matchReturnArgs:
description: A list of argument filters. MatchArgs are
ANDed.
items:
properties:
index:
description: Position of the argument to apply fhe
filter to.
format: int32
minimum: 0
type: integer
operator:
description: Filter operation.
enum:
- Equal
- NotEqual
- Prefix
- NotPrefix
- Postfix
- NotPostfix
- GreaterThan
- LessThan
- GT
- LT
- Mask
- SPort
- NotSPort
- SPortPriv
- NotSportPriv
- DPort
- NotDPort
- DPortPriv
- NotDPortPriv
- SAddr
- NotSAddr
- DAddr
- NotDAddr
- Protocol
- Family
- State
- InMap
- NotInMap
type: string
values:
description: Value to compare the argument against.
items:
type: string
type: array
required:
- index
- operator
type: object
type: array
type: object
type: array
syscall:
default: true
description: Indicates whether the traced function is a syscall.
type: boolean
tags:
description: Tags to categorize the event, will be include in
the event output. Maximum of 16 Tags are supported.
items:
type: string
maxItems: 16
type: array
required:
- call
type: object
type: array
lists:
description: A list of list specs.
items:
properties:
name:
description: Name of the list
type: string
pattern:
description: Pattern for 'generated' lists.
type: string
type:
description: Indicates the type of the list values.
enum:
- syscalls
- generated_syscalls
- generated_ftrace
type: string
validated:
description: List was validated
type: boolean
values:
description: Values of the list
items:
type: string
type: array
required:
- name
type: object
type: array
loader:
description: Enable loader events
type: boolean
options:
description: A list of overloaded options
items:
properties:
name:
description: Name of the option
type: string
value:
description: Value of the option
type: string
required:
- name
type: object
type: array
podSelector:
description: PodSelector selects pods that this policy applies to
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: A label selector requirement is a selector that
contains values, a key, and an operator that relates the key
and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: operator represents a key's relationship to
a set of values. Valid operators are In, NotIn, Exists
and DoesNotExist.
enum:
- In
- NotIn
- Exists
- DoesNotExist
type: string
values:
description: values is an array of string values. If the
operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values
array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
description: MatchLabelsValue represents the value from the
MatchLabels {key,value} pair.
maxLength: 63
pattern: ^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$
type: string
description: matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator
is "In", and the values array contains only "value". The requirements
are ANDed.
type: object
type: object
tracepoints:
description: A list of tracepoint specs.
items:
properties:
args:
description: A list of function arguments to include in the
trace output.
items:
properties:
index:
description: Position of the argument.
format: int32
minimum: 0
type: integer
label:
description: Label to output in the JSON
type: string
maxData:
default: false
description: Read maximum possible data (currently 327360).
This field is only used for char_buff data. When this
value is false (default), the bpf program will fetch
at most 4096 bytes. In later kernels (>=5.4) tetragon
supports fetching up to 327360 bytes if this flag is
turned on
type: boolean
returnCopy:
default: false
description: This field is used only for char_buf and
char_iovec types. It indicates that this argument should
be read later (when the kretprobe for the symbol is
triggered) because it might not be populated when the
kprobe is triggered at the entrance of the function.
For example, a buffer supplied to read(2) won't have
content until kretprobe is triggered.
type: boolean
sizeArgIndex:
description: Specifies the position of the corresponding
size argument for this argument. This field is used
only for char_buf and char_iovec types.
format: int32
minimum: 0
type: integer
type:
default: auto
description: Argument type.
enum:
- auto
- int
- int8
- uint8
- int16
- uint16
- uint32
- int32
- uint64
- int64
- char_buf
- char_iovec
- size_t
- skb
- sock
- string
- fd
- file
- filename
- path
- nop
- bpf_attr
- perf_event
- bpf_map
- user_namespace
- capability
- kiocb
- iov_iter
- cred
- load_info
- module
- syscall64
- kernel_cap_t
- cap_inheritable
- cap_permitted
- cap_effective
- linux_binprm
- data_loc
- net_device
type: string
required:
- index
- type
type: object
type: array
event:
description: Tracepoint event
type: string
message:
description: A short message of 256 characters max that will
be included in the event output to inform users what is going
on.
type: string
selectors:
description: Selectors to apply before producing trace output.
Selectors are ORed.
items:
description: KProbeSelector selects function calls for kprobe
based on PIDs and function arguments. The results of MatchPIDs
and MatchArgs are ANDed.
properties:
matchActions:
description: A list of actions to execute when this selector
matches
items:
properties:
action:
description: Action to execute.
enum:
- Post
- FollowFD
- UnfollowFD
- Sigkill
- CopyFD
- Override
- GetUrl
- DnsLookup
- NoPost
- Signal
- TrackSock
- UntrackSock
- NotifyEnforcer
type: string