/
retina.sh_captures.yaml
397 lines (397 loc) · 20.7 KB
/
retina.sh_captures.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
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.14.0
name: captures.retina.sh
spec:
group: retina.sh
names:
categories:
- retina
kind: Capture
listKind: CaptureList
plural: captures
singular: capture
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: Capture indicates the settings of a network trace.
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: CaptureSpec indicates the specification of Capture.
properties:
captureConfiguration:
description: CaptureConfiguration indicates the configurations of
the network capture.
properties:
captureOption:
description: CaptureOption lists the options of the capture.
properties:
duration:
description: Duration indicates length of time that the capture
should continue for.
pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
type: string
maxCaptureSize:
default: 100
description: MaxCaptureSize limits the capture file to MB
in size.
type: integer
packetSize:
description: PacketSize limits the each packet to bytes in
size and packets longer than PacketSize will be truncated.
type: integer
type: object
captureTarget:
description: CaptureTarget indicates the target on which the network
packets capture will be performed.
properties:
namespaceSelector:
description: |-
NamespaceSelector selects Namespaces using cluster-scoped labels. This field follows
standard label selector semantics.
NamespaceSelector and PodSelector pair selects a pod to capture pod network namespace traffic.
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.
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:
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
x-kubernetes-map-type: atomic
nodeSelector:
description: |-
NodeSelector is a selector which select the node to capture network packets.
Selector which must match a node's labels.
NodeSelector is incompatible with NamespaceSelector/PodSelector pair.
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.
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:
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
x-kubernetes-map-type: atomic
podSelector:
description: |-
This is a label selector which selects Pods. This field follows standard label
selector semantics.
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.
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:
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
x-kubernetes-map-type: atomic
type: object
filters:
description: Filters represent a range of filters to be included/excluded
in the capture.
properties:
exclude:
description: |-
Exclude specifies what IP or IP:port is excluded in the capture with wildcard support.
See Include for detailed explanation.
items:
type: string
type: array
include:
description: |-
Include specifies what IP or IP:port is included in the capture with wildcard support.
If a port not specified or is *, the port filter is excluded.
If an IP is specified as *, the host filter should be included.
Include and Exclude arguments will finally be translated into a logic like:
(include1 or include2) and not (exclude1 or exclude2)
items:
type: string
type: array
type: object
includeMetadata:
default: true
description: |-
IncludeMetadata represents whether or not networking metadata should be captured.
Networking metadata will consists of the following info, but is expected to grow:
- IP address configuration
- IP neighbor status
- IPtables rule dumps
- Network statistics information
type: boolean
tcpdumpFilter:
description: TcpdumpFilter is a raw tcpdump filter string.
type: string
required:
- captureTarget
type: object
outputConfiguration:
description: OutputConfiguration indicates the location capture will
be stored.
properties:
blobUpload:
description: BlobUpload is a secret containing the blob SAS URL
to the given blob container.
type: string
hostPath:
description: |-
HostPath stores the capture files into the specified host filesystem.
If nothing exists at the given path of the host, an empty directory will be created there.
type: string
persistentVolumeClaim:
description: PersistentVolumeClaim mounts the supplied PVC into
the pod on `/capture` and write the capture files there.
type: string
s3Upload:
description: S3Upload configures the details for uploading capture
files to an S3-compatible storage service.
properties:
bucket:
description: Bucket in which to store the capture.
type: string
endpoint:
description: Endpoint of S3 compatible storage service.
type: string
path:
description: Path specifies the prefix path within the S3
bucket where captures will be stored, e.g., "retina/captures".
type: string
region:
description: Region in which the S3 compatible bucket is located.
type: string
secretName:
description: SecretName is the name of secret which stores
S3 compliant storage access key and secret key.
type: string
type: object
type: object
required:
- captureConfiguration
type: object
status:
description: CaptureStatus describes the status of the capture.
properties:
active:
description: The number of pending and running jobs.
format: int32
type: integer
completionTime:
description: |-
Represents time when the Capture was completed, and it is determined by the last completed capture job.
The completion time is only set when the Capture finishes successfully.
format: date-time
type: string
conditions:
items:
description: "Condition contains details for one aspect of the current
state of this API Resource.\n---\nThis struct is intended for
direct use as an array at the field path .status.conditions. For
example,\n\n\n\ttype FooStatus struct{\n\t // Represents the
observations of a foo's current state.\n\t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\"\n\t //
+patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t
\ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\"
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t
\ // other fields\n\t}"
properties:
lastTransitionTime:
description: |-
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
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
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
type: integer
reason:
description: |-
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.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: |-
type of condition in CamelCase or in foo.example.com/CamelCase.
---
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
useful (see .node.status.conditions), the ability to deconflict is important.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
failed:
description: The number of failed jobs.
format: int32
type: integer
startTime:
description: Represents time when the Capture controller started processing
a job.
format: date-time
type: string
succeeded:
description: The number of completed jobs.
format: int32
type: integer
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}