1apiVersion: v1
2kind: Namespace
3metadata:
4 name: fluent-operator
5 annotations:
6 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
7 pallet.edge.ncr.com/name: fluent-operator
8 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
9 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
10 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
11 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
12---
13apiVersion: apiextensions.k8s.io/v1
14kind: CustomResourceDefinition
15metadata:
16 name: clusterfilters.fluentbit.fluent.io
17 annotations:
18 controller-gen.kubebuilder.io/version: v0.11.3
19 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
20 pallet.edge.ncr.com/name: fluent-operator
21 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
22 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
23 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
24 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
25spec:
26 group: fluentbit.fluent.io
27 names:
28 kind: ClusterFilter
29 listKind: ClusterFilterList
30 plural: clusterfilters
31 shortNames:
32 - cfbf
33 singular: clusterfilter
34 scope: Cluster
35 versions:
36 - name: v1alpha2
37 schema:
38 openAPIV3Schema:
39 type: object
40 description: ClusterFilter defines a cluster-level Filter configuration.
41 properties:
42 apiVersion:
43 type: string
44 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'
45 kind:
46 type: string
47 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'
48 metadata:
49 type: object
50 spec:
51 type: object
52 description: Specification of desired Filter configuration.
53 properties:
54 filters:
55 type: array
56 description: A set of filter plugins in order.
57 items:
58 type: object
59 properties:
60 aws:
61 type: object
62 description: Aws defines a Aws configuration.
63 properties:
64 accountID:
65 type: boolean
66 description: The account ID for current EC2 instance.Default is false.
67 alias:
68 type: string
69 description: Alias for the plugin
70 amiID:
71 type: boolean
72 description: The EC2 instance image id.Default is false.
73 az:
74 type: boolean
75 description: The availability zone; for example, "us-east-1a". Default is true.
76 ec2InstanceID:
77 type: boolean
78 description: The EC2 instance ID.Default is true.
79 ec2InstanceType:
80 type: boolean
81 description: The EC2 instance type.Default is false.
82 hostName:
83 type: boolean
84 description: The hostname for current EC2 instance.Default is false.
85 imdsVersion:
86 type: string
87 description: Specify which version of the instance metadata service to use. Valid values are 'v1' or 'v2'.
88 enum:
89 - v1
90 - v2
91 privateIP:
92 type: boolean
93 description: The EC2 instance private ip.Default is false.
94 retryLimit:
95 type: string
96 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
97 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
98 vpcID:
99 type: boolean
100 description: The VPC ID for current EC2 instance.Default is false.
101 customPlugin:
102 type: object
103 description: CustomPlugin defines a Custom plugin configuration.
104 properties:
105 config:
106 type: string
107 grep:
108 type: object
109 description: Grep defines Grep Filter configuration.
110 properties:
111 alias:
112 type: string
113 description: Alias for the plugin
114 exclude:
115 type: string
116 description: 'Exclude records which field matches the regular expression. Value Format: FIELD REGEX'
117 regex:
118 type: string
119 description: 'Keep records which field matches the regular expression. Value Format: FIELD REGEX'
120 retryLimit:
121 type: string
122 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
123 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
124 kubernetes:
125 type: object
126 description: Kubernetes defines Kubernetes Filter configuration.
127 properties:
128 labels:
129 type: boolean
130 description: Include Kubernetes resource labels in the extra metadata.
131 annotations:
132 type: boolean
133 description: Include Kubernetes resource annotations in the extra metadata.
134 alias:
135 type: string
136 description: Alias for the plugin
137 bufferSize:
138 type: string
139 description: Set the buffer size for HTTP client when reading responses from Kubernetes API server.
140 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
141 cacheUseDockerId:
142 type: boolean
143 description: When enabled, metadata will be fetched from K8s when docker_id is changed.
144 dnsRetries:
145 type: integer
146 description: DNS lookup retries N times until the network start working
147 format: int32
148 dnsWaitTime:
149 type: integer
150 description: DNS lookup interval between network status checks
151 format: int32
152 dummyMeta:
153 type: boolean
154 description: If set, use dummy-meta data (for test/dev purposes)
155 k8sLoggingExclude:
156 type: boolean
157 description: Allow Kubernetes Pods to exclude their logs from the log processor (read more about it in Kubernetes Annotations section).
158 k8sLoggingParser:
159 type: boolean
160 description: Allow Kubernetes Pods to suggest a pre-defined Parser (read more about it in Kubernetes Annotations section)
161 keepLog:
162 type: boolean
163 description: When Keep_Log is disabled, the log field is removed from the incoming message once it has been successfully merged (Merge_Log must be enabled as well).
164 kubeCAFile:
165 type: string
166 description: CA certificate file
167 kubeCAPath:
168 type: string
169 description: Absolute path to scan for certificate files
170 kubeMetaCacheTTL:
171 type: string
172 description: configurable TTL for K8s cached metadata. By default, it is set to 0 which means TTL for cache entries is disabled and cache entries are evicted at random when capacity is reached. In order to enable this option, you should set the number to a time interval. For example, set this value to 60 or 60s and cache entries which have been created more than 60s will be evicted.
173 kubeMetaPreloadCacheDir:
174 type: string
175 description: If set, Kubernetes meta-data can be cached/pre-loaded from files in JSON format in this directory, named as namespace-pod.meta
176 kubeTagPrefix:
177 type: string
178 description: When the source records comes from Tail input plugin, this option allows to specify what's the prefix used in Tail configuration.
179 kubeTokenFile:
180 type: string
181 description: Token file
182 kubeTokenTTL:
183 type: string
184 description: configurable 'time to live' for the K8s token. By default, it is set to 600 seconds. After this time, the token is reloaded from Kube_Token_File or the Kube_Token_Command.
185 kubeURL:
186 type: string
187 description: API Server end-point
188 kubeletHost:
189 type: string
190 description: kubelet host using for HTTP request, this only works when Use_Kubelet set to On.
191 kubeletPort:
192 type: integer
193 description: kubelet port using for HTTP request, this only works when useKubelet is set to On.
194 format: int32
195 mergeLog:
196 type: boolean
197 description: When enabled, it checks if the log field content is a JSON string map, if so, it append the map fields as part of the log structure.
198 mergeLogKey:
199 type: string
200 description: When Merge_Log is enabled, the filter tries to assume the log field from the incoming message is a JSON string message and make a structured representation of it at the same level of the log field in the map. Now if Merge_Log_Key is set (a string name), all the new structured fields taken from the original log content are inserted under the new key.
201 mergeLogTrim:
202 type: boolean
203 description: When Merge_Log is enabled, trim (remove possible \n or \r) field values.
204 mergeParser:
205 type: string
206 description: Optional parser name to specify how to parse the data contained in the log key. Recommended use is for developers or testing only.
207 regexParser:
208 type: string
209 description: Set an alternative Parser to process record Tag and extract pod_name, namespace_name, container_name and docker_id. The parser must be registered in a parsers file (refer to parser filter-kube-test as an example).
210 retryLimit:
211 type: string
212 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
213 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
214 tlsDebug:
215 type: integer
216 description: Debug level between 0 (nothing) and 4 (every detail).
217 format: int32
218 tlsVerify:
219 type: boolean
220 description: When enabled, turns on certificate validation when connecting to the Kubernetes API server.
221 useJournal:
222 type: boolean
223 description: When enabled, the filter reads logs coming in Journald format.
224 useKubelet:
225 type: boolean
226 description: This is an optional feature flag to get metadata information from kubelet instead of calling Kube Server API to enhance the log. This could mitigate the Kube API heavy traffic issue for large cluster.
227 lua:
228 type: object
229 description: Lua defines Lua Filter configuration.
230 properties:
231 alias:
232 type: string
233 description: Alias for the plugin
234 call:
235 type: string
236 description: Lua function name that will be triggered to do filtering. It's assumed that the function is declared inside the Script defined above.
237 protectedMode:
238 type: boolean
239 description: If enabled, Lua script will be executed in protected mode. It prevents to crash when invalid Lua script is executed. Default is true.
240 retryLimit:
241 type: string
242 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
243 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
244 script:
245 type: object
246 description: Path to the Lua script that will be used.
247 properties:
248 name:
249 type: string
250 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
251 key:
252 type: string
253 description: The key to select.
254 optional:
255 type: boolean
256 description: Specify whether the ConfigMap or its key must be defined
257 required:
258 - key
259 x-kubernetes-map-type: atomic
260 timeAsTable:
261 type: boolean
262 description: By default when the Lua script is invoked, the record timestamp is passed as a Floating number which might lead to loss precision when the data is converted back. If you desire timestamp precision enabling this option will pass the timestamp as a Lua table with keys sec for seconds since epoch and nsec for nanoseconds.
263 typeIntKey:
264 type: array
265 description: If these keys are matched, the fields are converted to integer. If more than one key, delimit by space. Note that starting from Fluent Bit v1.6 integer data types are preserved and not converted to double as in previous versions.
266 items:
267 type: string
268 required:
269 - call
270 - script
271 modify:
272 type: object
273 description: Modify defines Modify Filter configuration.
274 properties:
275 alias:
276 type: string
277 description: Alias for the plugin
278 conditions:
279 type: array
280 description: All conditions have to be true for the rules to be applied.
281 items:
282 type: object
283 description: The plugin supports the following conditions
284 properties:
285 aKeyMatches:
286 type: string
287 description: Is true if a key matches regex KEY
288 keyDoesNotExist:
289 type: object
290 additionalProperties:
291 type: string
292 description: Is true if KEY does not exist
293 keyExists:
294 type: string
295 description: Is true if KEY exists
296 keyValueDoesNotEqual:
297 type: object
298 additionalProperties:
299 type: string
300 description: Is true if KEY exists and its value is not VALUE
301 keyValueDoesNotMatch:
302 type: object
303 additionalProperties:
304 type: string
305 description: Is true if key KEY exists and its value does not match VALUE
306 keyValueEquals:
307 type: object
308 additionalProperties:
309 type: string
310 description: Is true if KEY exists and its value is VALUE
311 keyValueMatches:
312 type: object
313 additionalProperties:
314 type: string
315 description: Is true if key KEY exists and its value matches VALUE
316 matchingKeysDoNotHaveMatchingValues:
317 type: object
318 additionalProperties:
319 type: string
320 description: Is true if all keys matching KEY have values that do not match VALUE
321 matchingKeysHaveMatchingValues:
322 type: object
323 additionalProperties:
324 type: string
325 description: Is true if all keys matching KEY have values that match VALUE
326 noKeyMatches:
327 type: string
328 description: Is true if no key matches regex KEY
329 retryLimit:
330 type: string
331 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
332 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
333 rules:
334 type: array
335 description: Rules are applied in the order they appear, with each rule operating on the result of the previous rule.
336 items:
337 type: object
338 description: The plugin supports the following rules
339 properties:
340 add:
341 type: object
342 additionalProperties:
343 type: string
344 description: Add a key/value pair with key KEY and value VALUE if KEY does not exist
345 copy:
346 type: object
347 additionalProperties:
348 type: string
349 description: Copy a key/value pair with key KEY to COPIED_KEY if KEY exists AND COPIED_KEY does not exist
350 hardCopy:
351 type: object
352 additionalProperties:
353 type: string
354 description: Copy a key/value pair with key KEY to COPIED_KEY if KEY exists. If COPIED_KEY already exists, this field is overwritten
355 hardRename:
356 type: object
357 additionalProperties:
358 type: string
359 description: Rename a key/value pair with key KEY to RENAMED_KEY if KEY exists. If RENAMED_KEY already exists, this field is overwritten
360 remove:
361 type: string
362 description: Remove a key/value pair with key KEY if it exists
363 removeRegex:
364 type: string
365 description: Remove all key/value pairs with key matching regexp KEY
366 removeWildcard:
367 type: string
368 description: Remove all key/value pairs with key matching wildcard KEY
369 rename:
370 type: object
371 additionalProperties:
372 type: string
373 description: Rename a key/value pair with key KEY to RENAMED_KEY if KEY exists AND RENAMED_KEY does not exist
374 set:
375 type: object
376 additionalProperties:
377 type: string
378 description: Add a key/value pair with key KEY and value VALUE. If KEY already exists, this field is overwritten
379 multiline:
380 type: object
381 description: Multiline defines a Multiline configuration.
382 properties:
383 alias:
384 type: string
385 description: Alias for the plugin
386 keyContent:
387 type: string
388 description: Key name that holds the content to process. Note that a Multiline Parser definition can already specify the key_content to use, but this option allows to overwrite that value for the purpose of the filter.
389 parser:
390 type: string
391 description: Specify one or multiple Multiline Parsing definitions to apply to the content. You can specify multiple multiline parsers to detect different formats by separating them with a comma.
392 retryLimit:
393 type: string
394 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
395 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
396 required:
397 - parser
398 nest:
399 type: object
400 description: Nest defines Nest Filter configuration.
401 properties:
402 addPrefix:
403 type: string
404 description: Prefix affected keys with this string
405 alias:
406 type: string
407 description: Alias for the plugin
408 nestUnder:
409 type: string
410 description: Nest records matching the Wildcard under this key
411 nestedUnder:
412 type: string
413 description: Lift records nested under the Nested_under key
414 operation:
415 type: string
416 description: Select the operation nest or lift
417 enum:
418 - nest
419 - lift
420 removePrefix:
421 type: string
422 description: Remove prefix from affected keys if it matches this string
423 retryLimit:
424 type: string
425 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
426 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
427 wildcard:
428 type: array
429 description: Nest records which field matches the wildcard
430 items:
431 type: string
432 parser:
433 type: object
434 description: Parser defines Parser Filter configuration.
435 properties:
436 alias:
437 type: string
438 description: Alias for the plugin
439 keyName:
440 type: string
441 description: Specify field name in record to parse.
442 parser:
443 type: string
444 description: Specify the parser name to interpret the field. Multiple Parser entries are allowed (split by comma).
445 preserveKey:
446 type: boolean
447 description: Keep original Key_Name field in the parsed result. If false, the field will be removed.
448 reserveData:
449 type: boolean
450 description: Keep all other original fields in the parsed result. If false, all other original fields will be removed.
451 retryLimit:
452 type: string
453 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
454 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
455 unescapeKey:
456 type: boolean
457 description: 'If the key is a escaped string (e.g: stringify JSON), unescape the string before to apply the parser.'
458 recordModifier:
459 type: object
460 description: RecordModifier defines Record Modifier Filter configuration.
461 properties:
462 alias:
463 type: string
464 description: Alias for the plugin
465 allowlistKeys:
466 type: array
467 description: If the key is not matched, that field is removed.
468 items:
469 type: string
470 records:
471 type: array
472 description: Append fields. This parameter needs key and value pair.
473 items:
474 type: string
475 removeKeys:
476 type: array
477 description: If the key is matched, that field is removed.
478 items:
479 type: string
480 retryLimit:
481 type: string
482 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
483 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
484 uuidKeys:
485 type: array
486 description: If set, the plugin appends uuid to each record. The value assigned becomes the key in the map.
487 items:
488 type: string
489 whitelistKeys:
490 type: array
491 description: An alias of allowlistKeys for backwards compatibility.
492 items:
493 type: string
494 rewriteTag:
495 type: object
496 description: RewriteTag defines a RewriteTag configuration.
497 properties:
498 alias:
499 type: string
500 description: Alias for the plugin
501 emitterName:
502 type: string
503 description: When the filter emits a record under the new Tag, there is an internal emitter plugin that takes care of the job. Since this emitter expose metrics as any other component of the pipeline, you can use this property to configure an optional name for it.
504 retryLimit:
505 type: string
506 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
507 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
508 rules:
509 type: array
510 description: 'Defines the matching criteria and the format of the Tag for the matching record. The Rule format have four components: KEY REGEX NEW_TAG KEEP.'
511 items:
512 type: string
513 throttle:
514 type: object
515 description: Throttle defines a Throttle configuration.
516 properties:
517 alias:
518 type: string
519 description: Alias for the plugin
520 interval:
521 type: string
522 description: Interval is the time interval expressed in "sleep" format. e.g. 3s, 1.5m, 0.5h, etc.
523 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
524 printStatus:
525 type: boolean
526 description: PrintStatus represents whether to print status messages with current rate and the limits to information logs.
527 rate:
528 type: integer
529 description: Rate is the amount of messages for the time.
530 format: int64
531 retryLimit:
532 type: string
533 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
534 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
535 window:
536 type: integer
537 description: Window is the amount of intervals to calculate average over.
538 format: int64
539 logLevel:
540 type: string
541 enum:
542 - "off"
543 - error
544 - warning
545 - info
546 - debug
547 - trace
548 match:
549 type: string
550 description: A pattern to match against the tags of incoming records. It's case-sensitive and support the star (*) character as a wildcard.
551 matchRegex:
552 type: string
553 description: A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax.
554 served: true
555 storage: true
556---
557apiVersion: apiextensions.k8s.io/v1
558kind: CustomResourceDefinition
559metadata:
560 name: clusterfilters.fluentd.fluent.io
561 annotations:
562 controller-gen.kubebuilder.io/version: v0.11.3
563 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
564 pallet.edge.ncr.com/name: fluent-operator
565 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
566 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
567 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
568 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
569spec:
570 group: fluentd.fluent.io
571 names:
572 kind: ClusterFilter
573 listKind: ClusterFilterList
574 plural: clusterfilters
575 shortNames:
576 - cfdf
577 singular: clusterfilter
578 scope: Cluster
579 versions:
580 - name: v1alpha1
581 schema:
582 openAPIV3Schema:
583 type: object
584 description: ClusterFilter is the Schema for the clusterfilters API
585 properties:
586 apiVersion:
587 type: string
588 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'
589 kind:
590 type: string
591 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'
592 metadata:
593 type: object
594 spec:
595 type: object
596 description: ClusterFilterSpec defines the desired state of ClusterFilter
597 properties:
598 filters:
599 type: array
600 items:
601 type: object
602 description: Filter defines all available filter plugins and their parameters.
603 properties:
604 customPlugin:
605 type: object
606 description: Custom plugin type
607 properties:
608 config:
609 type: string
610 required:
611 - config
612 grep:
613 type: object
614 description: The filter_grep filter plugin
615 properties:
616 and:
617 type: array
618 items:
619 type: object
620 description: And defines the parameters for the "and" plugin
621 properties:
622 exclude:
623 type: object
624 description: Exclude defines the parameters for the exclude plugin
625 properties:
626 key:
627 type: string
628 pattern:
629 type: string
630 regexp:
631 type: object
632 description: Regexp defines the parameters for the regexp plugin
633 properties:
634 key:
635 type: string
636 pattern:
637 type: string
638 exclude:
639 type: array
640 items:
641 type: object
642 description: Exclude defines the parameters for the exclude plugin
643 properties:
644 key:
645 type: string
646 pattern:
647 type: string
648 or:
649 type: array
650 items:
651 type: object
652 description: Or defines the parameters for the "or" plugin
653 properties:
654 exclude:
655 type: object
656 description: Exclude defines the parameters for the exclude plugin
657 properties:
658 key:
659 type: string
660 pattern:
661 type: string
662 regexp:
663 type: object
664 description: Regexp defines the parameters for the regexp plugin
665 properties:
666 key:
667 type: string
668 pattern:
669 type: string
670 regexp:
671 type: array
672 items:
673 type: object
674 description: Regexp defines the parameters for the regexp plugin
675 properties:
676 key:
677 type: string
678 pattern:
679 type: string
680 logLevel:
681 type: string
682 description: The @log_level parameter specifies the plugin-specific logging level
683 parser:
684 type: object
685 description: The filter_parser filter plugin
686 properties:
687 emitInvalidRecordToError:
688 type: boolean
689 description: 'Emits invalid record to @ERROR label. Invalid cases are: key does not exist;the format is not matched;an unexpected error. If you want to ignore these errors, set false.'
690 hashValueField:
691 type: string
692 description: Stores the parsed values as a hash value in a field.
693 injectKeyPrefix:
694 type: string
695 description: Stores the parsed values with the specified key name prefix.
696 keyName:
697 type: string
698 description: 'Specifies the field name in the record to parse. Required parameter. i.e: If set keyName to log, {"key":"value","log":"{\"time\":1622473200,\"user\":1}"} => {"user":1}'
699 parse:
700 type: object
701 description: Parse defines various parameters for the parse plugin
702 properties:
703 type:
704 type: string
705 description: The @type parameter specifies the type of the plugin.
706 enum:
707 - regexp
708 - apache2
709 - apache_error
710 - nginx
711 - syslog
712 - csv
713 - tsv
714 - ltsv
715 - json
716 - multiline
717 - none
718 estimateCurrentEvent:
719 type: boolean
720 description: If true, use Fluent::Eventnow(current time) as a timestamp when time_key is specified.
721 expression:
722 type: string
723 description: Specifies the regular expression for matching logs. Regular expression also supports i and m suffix.
724 id:
725 type: string
726 description: The @id parameter specifies a unique name for the configuration.
727 keepTimeKey:
728 type: boolean
729 description: If true, keep time field in th record.
730 localtime:
731 type: boolean
732 description: If true, uses local time.
733 logLevel:
734 type: string
735 description: The @log_level parameter specifies the plugin-specific logging level
736 timeFormat:
737 type: string
738 description: Process value according to the specified format. This is available only when time_type is string
739 timeFormatFallbacks:
740 type: string
741 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
742 timeKey:
743 type: string
744 description: Specify time field for event time. If the event doesn't have this field, current time is used.
745 timeType:
746 type: string
747 description: parses/formats value according to this type, default is string
748 enum:
749 - float
750 - unixtime
751 - string
752 - mixed
753 timeout:
754 type: string
755 description: Specify timeout for parse processing.
756 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
757 timezone:
758 type: string
759 description: Uses the specified timezone.
760 types:
761 type: string
762 description: 'Specify types for converting field into another, i.e: types user_id:integer,paid:bool,paid_usd_amount:float'
763 utc:
764 type: boolean
765 description: If true, uses UTC.
766 required:
767 - type
768 removeKeyNameField:
769 type: boolean
770 description: Removes key_name field when parsing is succeeded.
771 replaceInvalidSequence:
772 type: boolean
773 description: If true, invalid string is replaced with safe characters and re-parse it.
774 reserveData:
775 type: boolean
776 description: 'Keeps the original key-value pair in the parsed result. Default is false. i.e: If set keyName to log, reverseData to true, {"key":"value","log":"{\"user\":1,\"num\":2}"} => {"key":"value","log":"{\"user\":1,\"num\":2}","user":1,"num":2}'
777 reserveTime:
778 type: boolean
779 description: Keeps the original event time in the parsed result. Default is false.
780 required:
781 - keyName
782 - parse
783 recordTransformer:
784 type: object
785 description: The filter_record_transformer filter plugin
786 properties:
787 autoTypecast:
788 type: boolean
789 description: Automatically casts the field types. Default is false. This option is effective only for field values comprised of a single placeholder.
790 enableRuby:
791 type: boolean
792 description: 'When set to true, the full Ruby syntax is enabled in the ${...} expression. The default value is false. i.e: jsonized_record ${record.to_json}'
793 keepKeys:
794 type: string
795 description: A list of keys to keep. Only relevant if renew_record is set to true.
796 records:
797 type: array
798 items:
799 type: object
800 description: The parameters inside <record> directives are considered to be new key-value pairs
801 properties:
802 value:
803 type: string
804 description: The value must from Record properties. See https://docs.fluentd.org/filter/record_transformer#less-than-record-greater-than-directive
805 key:
806 type: string
807 description: New field can be defined as key
808 required:
809 - key
810 - value
811 removeKeys:
812 type: string
813 description: A list of keys to delete. Supports nested field via record_accessor syntax since v1.1.0.
814 renewRecord:
815 type: boolean
816 description: By default, the record transformer filter mutates the incoming data. However, if this parameter is set to true, it modifies a new empty hash instead.
817 renewTimeKey:
818 type: string
819 description: renew_time_key foo overwrites the time of events with a value of the record field foo if exists. The value of foo must be a Unix timestamp.
820 stdout:
821 type: object
822 description: The filter_stdout filter plugin
823 properties:
824 format:
825 type: object
826 description: The format section
827 properties:
828 type:
829 type: string
830 description: The @type parameter specifies the type of the plugin.
831 enum:
832 - out_file
833 - json
834 - ltsv
835 - csv
836 - msgpack
837 - hash
838 - single_value
839 delimiter:
840 type: string
841 description: Delimiter for each field.
842 id:
843 type: string
844 description: The @id parameter specifies a unique name for the configuration.
845 localtime:
846 type: boolean
847 description: If true, uses local time.
848 logLevel:
849 type: string
850 description: The @log_level parameter specifies the plugin-specific logging level
851 newline:
852 type: string
853 description: Specify newline characters.
854 enum:
855 - lf
856 - crlf
857 outputTag:
858 type: boolean
859 description: Output tag field if true.
860 outputTime:
861 type: boolean
862 description: Output time field if true.
863 timeFormat:
864 type: string
865 description: Process value according to the specified format. This is available only when time_type is string
866 timeFormatFallbacks:
867 type: string
868 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
869 timeType:
870 type: string
871 description: parses/formats value according to this type, default is string
872 enum:
873 - float
874 - unixtime
875 - string
876 - mixed
877 timezone:
878 type: string
879 description: Uses the specified timezone.
880 utc:
881 type: boolean
882 description: If true, uses UTC.
883 inject:
884 type: object
885 description: The inject section
886 properties:
887 hostname:
888 type: string
889 description: Hostname value
890 hostnameKey:
891 type: string
892 description: The field name to inject hostname
893 inline:
894 type: object
895 description: Time section
896 properties:
897 localtime:
898 type: boolean
899 description: If true, uses local time.
900 timeFormat:
901 type: string
902 description: Process value according to the specified format. This is available only when time_type is string
903 timeFormatFallbacks:
904 type: string
905 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
906 timeType:
907 type: string
908 description: parses/formats value according to this type, default is string
909 enum:
910 - float
911 - unixtime
912 - string
913 - mixed
914 timezone:
915 type: string
916 description: Uses the specified timezone.
917 utc:
918 type: boolean
919 description: If true, uses UTC.
920 tagKey:
921 type: string
922 description: The field name to inject tag
923 timeKey:
924 type: string
925 description: The field name to inject time
926 workerIdKey:
927 type: string
928 description: The field name to inject worker_id
929 tag:
930 type: string
931 description: Which tag to be matched.
932 status:
933 type: object
934 description: ClusterFilterStatus defines the observed state of ClusterFilter
935 served: true
936 storage: true
937 subresources:
938 status: {}
939---
940apiVersion: apiextensions.k8s.io/v1
941kind: CustomResourceDefinition
942metadata:
943 name: clusterfluentbitconfigs.fluentbit.fluent.io
944 annotations:
945 controller-gen.kubebuilder.io/version: v0.11.3
946 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
947 pallet.edge.ncr.com/name: fluent-operator
948 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
949 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
950 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
951 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
952spec:
953 group: fluentbit.fluent.io
954 names:
955 kind: ClusterFluentBitConfig
956 listKind: ClusterFluentBitConfigList
957 plural: clusterfluentbitconfigs
958 shortNames:
959 - cfbc
960 singular: clusterfluentbitconfig
961 scope: Cluster
962 versions:
963 - name: v1alpha2
964 schema:
965 openAPIV3Schema:
966 type: object
967 description: ClusterFluentBitConfig is the Schema for the cluster-level fluentbitconfigs API
968 properties:
969 apiVersion:
970 type: string
971 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'
972 kind:
973 type: string
974 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'
975 metadata:
976 type: object
977 spec:
978 type: object
979 description: FluentBitConfigSpec defines the desired state of ClusterFluentBitConfig
980 properties:
981 namespace:
982 type: string
983 description: If namespace is defined, then the configmap and secret for fluent-bit is in this namespace. If it is not defined, it is in the namespace of the fluentd-operator
984 service:
985 type: object
986 description: Service defines the global behaviour of the Fluent Bit engine.
987 properties:
988 daemon:
989 type: boolean
990 description: If true go to background on start
991 flushSeconds:
992 type: integer
993 description: Interval to flush output
994 format: int64
995 graceSeconds:
996 type: integer
997 description: Wait time on exit
998 format: int64
999 hcErrorsCount:
1000 type: integer
1001 description: 'the error count to meet the unhealthy requirement, this is a sum for all output plugins in a defined HC_Period, example for output error: [2022/02/16 10:44:10] [ warn] [engine] failed to flush chunk ''1-1645008245.491540684.flb'', retry in 7 seconds: task_id=0, input=forward.1 > output=cloudwatch_logs.3 (out_id=3)'
1002 format: int64
1003 minimum: 1
1004 hcPeriod:
1005 type: integer
1006 description: The time period by second to count the error and retry failure data point
1007 format: int64
1008 minimum: 1
1009 hcRetryFailureCount:
1010 type: integer
1011 description: 'the retry failure count to meet the unhealthy requirement, this is a sum for all output plugins in a defined HC_Period, example for retry failure: [2022/02/16 20:11:36] [ warn] [engine] chunk ''1-1645042288.260516436.flb'' cannot be retried: task_id=0, input=tcp.3 > output=cloudwatch_logs.1'
1012 format: int64
1013 minimum: 1
1014 healthCheck:
1015 type: boolean
1016 description: 'enable Health check feature at http://127.0.0.1:2020/api/v1/health Note: Enabling this will not automatically configure kubernetes to use fluentbit''s healthcheck endpoint'
1017 httpListen:
1018 type: string
1019 description: Address to listen
1020 pattern: ^\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}$
1021 httpPort:
1022 type: integer
1023 description: Port to listen
1024 format: int32
1025 maximum: 65535
1026 minimum: 1
1027 httpServer:
1028 type: boolean
1029 description: If true enable statistics HTTP server
1030 logFile:
1031 type: string
1032 description: File to log diagnostic output
1033 logLevel:
1034 type: string
1035 description: Diagnostic level (error/warning/info/debug/trace)
1036 enum:
1037 - "off"
1038 - error
1039 - warning
1040 - info
1041 - debug
1042 - trace
1043 parsersFile:
1044 type: string
1045 description: Optional 'parsers' config file (can be multiple)
1046 storage:
1047 type: object
1048 description: Configure a global environment for the storage layer in Service. It is recommended to configure the volume and volumeMount separately for this storage. The hostPath type should be used for that Volume in Fluentbit daemon set.
1049 properties:
1050 backlogMemLimit:
1051 type: string
1052 description: This option configure a hint of maximum value of memory to use when processing these records
1053 checksum:
1054 type: string
1055 description: Enable the data integrity check when writing and reading data from the filesystem
1056 enum:
1057 - "on"
1058 - "off"
1059 deleteIrrecoverableChunks:
1060 type: string
1061 description: When enabled, irrecoverable chunks will be deleted during runtime, and any other irrecoverable chunk located in the configured storage path directory will be deleted when Fluent-Bit starts.
1062 enum:
1063 - "on"
1064 - "off"
1065 maxChunksUp:
1066 type: integer
1067 description: If the input plugin has enabled filesystem storage type, this property sets the maximum number of Chunks that can be up in memory
1068 format: int64
1069 metrics:
1070 type: string
1071 description: If http_server option has been enabled in the Service section, this option registers a new endpoint where internal metrics of the storage layer can be consumed
1072 enum:
1073 - "on"
1074 - "off"
1075 path:
1076 type: string
1077 description: Select an optional location in the file system to store streams and chunks of data/
1078 sync:
1079 type: string
1080 description: Configure the synchronization mode used to store the data into the file system
1081 enum:
1082 - normal
1083 - full
1084 filterSelector:
1085 type: object
1086 description: Select filter plugins
1087 properties:
1088 matchExpressions:
1089 type: array
1090 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
1091 items:
1092 type: object
1093 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
1094 properties:
1095 key:
1096 type: string
1097 description: key is the label key that the selector applies to.
1098 operator:
1099 type: string
1100 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
1101 values:
1102 type: array
1103 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.
1104 items:
1105 type: string
1106 required:
1107 - key
1108 - operator
1109 matchLabels:
1110 type: object
1111 additionalProperties:
1112 type: string
1113 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.
1114 x-kubernetes-map-type: atomic
1115 inputSelector:
1116 type: object
1117 description: Select input plugins
1118 properties:
1119 matchExpressions:
1120 type: array
1121 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
1122 items:
1123 type: object
1124 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
1125 properties:
1126 key:
1127 type: string
1128 description: key is the label key that the selector applies to.
1129 operator:
1130 type: string
1131 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
1132 values:
1133 type: array
1134 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.
1135 items:
1136 type: string
1137 required:
1138 - key
1139 - operator
1140 matchLabels:
1141 type: object
1142 additionalProperties:
1143 type: string
1144 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.
1145 x-kubernetes-map-type: atomic
1146 outputSelector:
1147 type: object
1148 description: Select output plugins
1149 properties:
1150 matchExpressions:
1151 type: array
1152 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
1153 items:
1154 type: object
1155 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
1156 properties:
1157 key:
1158 type: string
1159 description: key is the label key that the selector applies to.
1160 operator:
1161 type: string
1162 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
1163 values:
1164 type: array
1165 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.
1166 items:
1167 type: string
1168 required:
1169 - key
1170 - operator
1171 matchLabels:
1172 type: object
1173 additionalProperties:
1174 type: string
1175 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.
1176 x-kubernetes-map-type: atomic
1177 parserSelector:
1178 type: object
1179 description: Select parser plugins
1180 properties:
1181 matchExpressions:
1182 type: array
1183 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
1184 items:
1185 type: object
1186 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
1187 properties:
1188 key:
1189 type: string
1190 description: key is the label key that the selector applies to.
1191 operator:
1192 type: string
1193 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
1194 values:
1195 type: array
1196 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.
1197 items:
1198 type: string
1199 required:
1200 - key
1201 - operator
1202 matchLabels:
1203 type: object
1204 additionalProperties:
1205 type: string
1206 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.
1207 x-kubernetes-map-type: atomic
1208 served: true
1209 storage: true
1210---
1211apiVersion: apiextensions.k8s.io/v1
1212kind: CustomResourceDefinition
1213metadata:
1214 name: clusterfluentdconfigs.fluentd.fluent.io
1215 annotations:
1216 controller-gen.kubebuilder.io/version: v0.11.3
1217 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
1218 pallet.edge.ncr.com/name: fluent-operator
1219 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
1220 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
1221 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
1222 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
1223spec:
1224 group: fluentd.fluent.io
1225 names:
1226 kind: ClusterFluentdConfig
1227 listKind: ClusterFluentdConfigList
1228 plural: clusterfluentdconfigs
1229 shortNames:
1230 - cfdc
1231 singular: clusterfluentdconfig
1232 scope: Cluster
1233 versions:
1234 - name: v1alpha1
1235 schema:
1236 openAPIV3Schema:
1237 type: object
1238 description: ClusterFluentdConfig is the Schema for the clusterfluentdconfigs API
1239 properties:
1240 apiVersion:
1241 type: string
1242 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'
1243 kind:
1244 type: string
1245 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'
1246 metadata:
1247 type: object
1248 spec:
1249 type: object
1250 description: ClusterFluentdConfigSpec defines the desired state of ClusterFluentdConfig
1251 properties:
1252 clusterFilterSelector:
1253 type: object
1254 description: Select cluster filter plugins
1255 properties:
1256 matchExpressions:
1257 type: array
1258 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
1259 items:
1260 type: object
1261 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
1262 properties:
1263 key:
1264 type: string
1265 description: key is the label key that the selector applies to.
1266 operator:
1267 type: string
1268 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
1269 values:
1270 type: array
1271 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.
1272 items:
1273 type: string
1274 required:
1275 - key
1276 - operator
1277 matchLabels:
1278 type: object
1279 additionalProperties:
1280 type: string
1281 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.
1282 x-kubernetes-map-type: atomic
1283 clusterOutputSelector:
1284 type: object
1285 description: Select cluster output plugins
1286 properties:
1287 matchExpressions:
1288 type: array
1289 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
1290 items:
1291 type: object
1292 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
1293 properties:
1294 key:
1295 type: string
1296 description: key is the label key that the selector applies to.
1297 operator:
1298 type: string
1299 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
1300 values:
1301 type: array
1302 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.
1303 items:
1304 type: string
1305 required:
1306 - key
1307 - operator
1308 matchLabels:
1309 type: object
1310 additionalProperties:
1311 type: string
1312 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.
1313 x-kubernetes-map-type: atomic
1314 emit_mode:
1315 type: string
1316 description: 'Emit mode. If batch, the plugin will emit events per labels matched. Enum: record, batch. will make no effect if EnableFilterKubernetes is set false.'
1317 enum:
1318 - record
1319 - batch
1320 stickyTags:
1321 type: string
1322 description: Sticky tags will match only one record from an event stream. The same tag will be treated the same way. will make no effect if EnableFilterKubernetes is set false.
1323 watchedConstainers:
1324 type: array
1325 description: A set of container names. Ignored if left empty.
1326 items:
1327 type: string
1328 watchedHosts:
1329 type: array
1330 description: A set of hosts. Ignored if left empty.
1331 items:
1332 type: string
1333 watchedLabels:
1334 type: object
1335 additionalProperties:
1336 type: string
1337 description: Use this field to filter the logs, will make no effect if EnableFilterKubernetes is set false.
1338 watchedNamespaces:
1339 type: array
1340 description: A set of namespaces. The whole namespaces would be watched if left empty.
1341 items:
1342 type: string
1343 status:
1344 type: object
1345 description: ClusterFluentdConfigStatus defines the observed state of ClusterFluentdConfig
1346 properties:
1347 messages:
1348 type: string
1349 description: Messages defines the plugin errors which is selected by this fluentdconfig
1350 state:
1351 type: string
1352 description: The state of this fluentd config
1353 served: true
1354 storage: true
1355 subresources:
1356 status: {}
1357---
1358apiVersion: apiextensions.k8s.io/v1
1359kind: CustomResourceDefinition
1360metadata:
1361 name: clusterinputs.fluentbit.fluent.io
1362 annotations:
1363 controller-gen.kubebuilder.io/version: v0.11.3
1364 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
1365 pallet.edge.ncr.com/name: fluent-operator
1366 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
1367 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
1368 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
1369 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
1370spec:
1371 group: fluentbit.fluent.io
1372 names:
1373 kind: ClusterInput
1374 listKind: ClusterInputList
1375 plural: clusterinputs
1376 shortNames:
1377 - cfbi
1378 singular: clusterinput
1379 scope: Cluster
1380 versions:
1381 - name: v1alpha2
1382 schema:
1383 openAPIV3Schema:
1384 type: object
1385 description: ClusterInput is the Schema for the inputs API
1386 properties:
1387 apiVersion:
1388 type: string
1389 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'
1390 kind:
1391 type: string
1392 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'
1393 metadata:
1394 type: object
1395 spec:
1396 type: object
1397 description: InputSpec defines the desired state of ClusterInput
1398 properties:
1399 alias:
1400 type: string
1401 description: A user friendly alias name for this input plugin. Used in metrics for distinction of each configured input.
1402 customPlugin:
1403 type: object
1404 description: CustomPlugin defines Custom Input configuration.
1405 properties:
1406 config:
1407 type: string
1408 dummy:
1409 type: object
1410 description: Dummy defines Dummy Input configuration.
1411 properties:
1412 dummy:
1413 type: string
1414 description: Dummy JSON record.
1415 rate:
1416 type: integer
1417 description: Events number generated per second.
1418 format: int32
1419 samples:
1420 type: integer
1421 description: Sample events to generate.
1422 format: int32
1423 tag:
1424 type: string
1425 description: Tag name associated to all records comming from this plugin.
1426 fluentBitMetrics:
1427 type: object
1428 description: FluentBitMetrics defines Fluent Bit Metrics Input configuration.
1429 properties:
1430 scrapeInterval:
1431 type: string
1432 description: The rate at which metrics are collected from the host operating system. default is 2 seconds.
1433 scrapeOnStart:
1434 type: boolean
1435 description: Scrape metrics upon start, useful to avoid waiting for 'scrape_interval' for the first round of metrics.
1436 tag:
1437 type: string
1438 logLevel:
1439 type: string
1440 enum:
1441 - "off"
1442 - error
1443 - warning
1444 - info
1445 - debug
1446 - trace
1447 nodeExporterMetrics:
1448 type: object
1449 description: NodeExporterMetrics defines Node Exporter Metrics Input configuration.
1450 properties:
1451 path:
1452 type: object
1453 properties:
1454 procfs:
1455 type: string
1456 description: The mount point used to collect process information and metrics.
1457 sysfs:
1458 type: string
1459 description: The path in the filesystem used to collect system metrics.
1460 scrapeInterval:
1461 type: string
1462 description: The rate at which metrics are collected from the host operating system, default is 5 seconds.
1463 tag:
1464 type: string
1465 description: Tag name associated to all records comming from this plugin.
1466 prometheusScrapeMetrics:
1467 type: object
1468 description: PrometheusScrapeMetrics defines Prometheus Scrape Metrics Input configuration.
1469 properties:
1470 port:
1471 type: integer
1472 description: The port of the promethes metric endpoint that you want to scrape
1473 format: int32
1474 maximum: 65535
1475 minimum: 1
1476 host:
1477 type: string
1478 description: The host of the prometheus metric endpoint that you want to scrape
1479 metricsPath:
1480 type: string
1481 description: 'The metrics URI endpoint, that must start with a forward slash, deflaut: /metrics'
1482 scrapeInterval:
1483 type: string
1484 description: 'The interval to scrape metrics, default: 10s'
1485 tag:
1486 type: string
1487 description: Tag name associated to all records comming from this plugin
1488 systemd:
1489 type: object
1490 description: Systemd defines Systemd Input configuration.
1491 properties:
1492 db:
1493 type: string
1494 description: Specify the database file to keep track of monitored files and offsets.
1495 dbSync:
1496 type: string
1497 description: 'Set a default synchronization (I/O) method. values: Extra, Full, Normal, Off. This flag affects how the internal SQLite engine do synchronization to disk, for more details about each option please refer to this section. note: this option was introduced on Fluent Bit v1.4.6.'
1498 enum:
1499 - Extra
1500 - Full
1501 - Normal
1502 - "Off"
1503 maxEntries:
1504 type: integer
1505 description: When Fluent Bit starts, the Journal might have a high number of logs in the queue. In order to avoid delays and reduce memory usage, this option allows to specify the maximum number of log entries that can be processed per round. Once the limit is reached, Fluent Bit will continue processing the remaining log entries once Journald performs the notification.
1506 maxFields:
1507 type: integer
1508 description: Set a maximum number of fields (keys) allowed per record.
1509 path:
1510 type: string
1511 description: Optional path to the Systemd journal directory, if not set, the plugin will use default paths to read local-only logs.
1512 pauseOnChunksOverlimit:
1513 type: string
1514 description: Specifies if the input plugin should be paused (stop ingesting new data) when the storage.max_chunks_up value is reached.
1515 enum:
1516 - "on"
1517 - "off"
1518 readFromTail:
1519 type: string
1520 description: Start reading new entries. Skip entries already stored in Journald.
1521 enum:
1522 - "on"
1523 - "off"
1524 storageType:
1525 type: string
1526 description: Specify the buffering mechanism to use. It can be memory or filesystem
1527 enum:
1528 - filesystem
1529 - memory
1530 stripUnderscores:
1531 type: string
1532 description: Remove the leading underscore of the Journald field (key). For example the Journald field _PID becomes the key PID.
1533 enum:
1534 - "on"
1535 - "off"
1536 systemdFilter:
1537 type: array
1538 description: 'Allows to perform a query over logs that contains a specific Journald key/value pairs, e.g: _SYSTEMD_UNIT=UNIT. The Systemd_Filter option can be specified multiple times in the input section to apply multiple filters as required.'
1539 items:
1540 type: string
1541 systemdFilterType:
1542 type: string
1543 description: Define the filter type when Systemd_Filter is specified multiple times. Allowed values are And and Or. With And a record is matched only when all of the Systemd_Filter have a match. With Or a record is matched when any of the Systemd_Filter has a match.
1544 enum:
1545 - And
1546 - Or
1547 tag:
1548 type: string
1549 description: 'The tag is used to route messages but on Systemd plugin there is an extra functionality: if the tag includes a star/wildcard, it will be expanded with the Systemd Unit file (e.g: host.* => host.UNIT_NAME).'
1550 tail:
1551 type: object
1552 description: Tail defines Tail Input configuration.
1553 properties:
1554 bufferChunkSize:
1555 type: string
1556 description: Set the initial buffer size to read files data. This value is used too to increase buffer size. The value must be according to the Unit Size specification.
1557 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
1558 bufferMaxSize:
1559 type: string
1560 description: 'Set the limit of the buffer size per monitored file. When a buffer needs to be increased (e.g: very long lines), this value is used to restrict how much the memory buffer can grow. If reading a file exceed this limit, the file is removed from the monitored file list The value must be according to the Unit Size specification.'
1561 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
1562 db:
1563 type: string
1564 description: Specify the database file to keep track of monitored files and offsets.
1565 dbSync:
1566 type: string
1567 description: 'Set a default synchronization (I/O) method. Values: Extra, Full, Normal, Off.'
1568 enum:
1569 - Extra
1570 - Full
1571 - Normal
1572 - "Off"
1573 disableInotifyWatcher:
1574 type: boolean
1575 description: DisableInotifyWatcher will disable inotify and use the file stat watcher instead.
1576 dockerMode:
1577 type: boolean
1578 description: If enabled, the plugin will recombine split Docker log lines before passing them to any parser as configured above. This mode cannot be used at the same time as Multiline.
1579 dockerModeFlushSeconds:
1580 type: integer
1581 description: Wait period time in seconds to flush queued unfinished split lines.
1582 format: int64
1583 dockerModeParser:
1584 type: string
1585 description: Specify an optional parser for the first line of the docker multiline mode. The parser name to be specified must be registered in the parsers.conf file.
1586 excludePath:
1587 type: string
1588 description: 'Set one or multiple shell patterns separated by commas to exclude files matching a certain criteria, e.g: exclude_path=*.gz,*.zip'
1589 ignoredOlder:
1590 type: string
1591 description: Ignores records which are older than this time in seconds. Supports m,h,d (minutes, hours, days) syntax. Default behavior is to read all records from specified files. Only available when a Parser is specificied and it can parse the time of a record.
1592 pattern: ^\d+(m|h|d)?$
1593 key:
1594 type: string
1595 description: When a message is unstructured (no parser applied), it's appended as a string under the key name log. This option allows to define an alternative name for that key.
1596 memBufLimit:
1597 type: string
1598 description: Set a limit of memory that Tail plugin can use when appending data to the Engine. If the limit is reach, it will be paused; when the data is flushed it resumes.
1599 multiline:
1600 type: boolean
1601 description: If enabled, the plugin will try to discover multiline messages and use the proper parsers to compose the outgoing messages. Note that when this option is enabled the Parser option is not used.
1602 multilineFlushSeconds:
1603 type: integer
1604 description: Wait period time in seconds to process queued multiline messages
1605 format: int64
1606 multilineParser:
1607 type: string
1608 description: This will help to reassembly multiline messages originally split by Docker or CRI Specify one or Multiline Parser definition to apply to the content.
1609 parser:
1610 type: string
1611 description: Specify the name of a parser to interpret the entry as a structured message.
1612 parserFirstline:
1613 type: string
1614 description: Name of the parser that matchs the beginning of a multiline message. Note that the regular expression defined in the parser must include a group name (named capture)
1615 parserN:
1616 type: array
1617 description: Optional-extra parser to interpret and structure multiline entries. This option can be used to define multiple parsers.
1618 items:
1619 type: string
1620 path:
1621 type: string
1622 description: Pattern specifying a specific log files or multiple ones through the use of common wildcards.
1623 pathKey:
1624 type: string
1625 description: If enabled, it appends the name of the monitored file as part of the record. The value assigned becomes the key in the map.
1626 pauseOnChunksOverlimit:
1627 type: string
1628 description: Specifies if the input plugin should be paused (stop ingesting new data) when the storage.max_chunks_up value is reached.
1629 enum:
1630 - "on"
1631 - "off"
1632 readFromHead:
1633 type: boolean
1634 description: For new discovered files on start (without a database offset/position), read the content from the head of the file, not tail.
1635 refreshIntervalSeconds:
1636 type: integer
1637 description: The interval of refreshing the list of watched files in seconds.
1638 format: int64
1639 rotateWaitSeconds:
1640 type: integer
1641 description: Specify the number of extra time in seconds to monitor a file once is rotated in case some pending data is flushed.
1642 format: int64
1643 skipLongLines:
1644 type: boolean
1645 description: When a monitored file reach it buffer capacity due to a very long line (Buffer_Max_Size), the default behavior is to stop monitoring that file. Skip_Long_Lines alter that behavior and instruct Fluent Bit to skip long lines and continue processing other lines that fits into the buffer size.
1646 storageType:
1647 type: string
1648 description: Specify the buffering mechanism to use. It can be memory or filesystem
1649 enum:
1650 - filesystem
1651 - memory
1652 tag:
1653 type: string
1654 description: Set a tag (with regex-extract fields) that will be placed on lines read. E.g. kube.<namespace_name>.<pod_name>.<container_name>
1655 tagRegex:
1656 type: string
1657 description: Set a regex to exctract fields from the file
1658 served: true
1659 storage: true
1660---
1661apiVersion: apiextensions.k8s.io/v1
1662kind: CustomResourceDefinition
1663metadata:
1664 name: clusteroutputs.fluentbit.fluent.io
1665 annotations:
1666 controller-gen.kubebuilder.io/version: v0.11.3
1667 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
1668 pallet.edge.ncr.com/name: fluent-operator
1669 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
1670 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
1671 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
1672 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
1673spec:
1674 group: fluentbit.fluent.io
1675 names:
1676 kind: ClusterOutput
1677 listKind: ClusterOutputList
1678 plural: clusteroutputs
1679 shortNames:
1680 - cfbo
1681 singular: clusteroutput
1682 scope: Cluster
1683 versions:
1684 - name: v1alpha2
1685 schema:
1686 openAPIV3Schema:
1687 type: object
1688 description: ClusterOutput is the Schema for the cluster-level outputs API
1689 properties:
1690 apiVersion:
1691 type: string
1692 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'
1693 kind:
1694 type: string
1695 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'
1696 metadata:
1697 type: object
1698 spec:
1699 type: object
1700 description: OutputSpec defines the desired state of ClusterOutput
1701 properties:
1702 alias:
1703 type: string
1704 description: A user friendly alias name for this output plugin. Used in metrics for distinction of each configured output.
1705 azureBlob:
1706 type: object
1707 description: AzureBlob defines AzureBlob Output Configuration
1708 properties:
1709 accountName:
1710 type: string
1711 description: Azure Storage account name
1712 autoCreateContainer:
1713 type: boolean
1714 description: Creates container if ContainerName is not set.
1715 blobType:
1716 type: string
1717 description: Specify the desired blob type. Must be `appendblob` or `blockblob`
1718 containerName:
1719 type: string
1720 description: Name of the container that will contain the blobs
1721 emulatorMode:
1722 type: boolean
1723 description: Optional toggle to use an Azure emulator
1724 endpoint:
1725 type: string
1726 description: HTTP Service of the endpoint (if using EmulatorMode)
1727 path:
1728 type: string
1729 description: Optional path to store the blobs.
1730 sharedKey:
1731 type: object
1732 description: Specify the Azure Storage Shared Key to authenticate against the storage account
1733 properties:
1734 valueFrom:
1735 type: object
1736 description: ValueSource defines how to find a value's key.
1737 properties:
1738 secretKeyRef:
1739 type: object
1740 description: Selects a key of a secret in the pod's namespace
1741 properties:
1742 name:
1743 type: string
1744 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
1745 key:
1746 type: string
1747 description: The key of the secret to select from. Must be a valid secret key.
1748 optional:
1749 type: boolean
1750 description: Specify whether the Secret or its key must be defined
1751 required:
1752 - key
1753 x-kubernetes-map-type: atomic
1754 tls:
1755 type: boolean
1756 description: Enable/Disable TLS Encryption. Azure services require TLS to be enabled.
1757 required:
1758 - accountName
1759 - containerName
1760 - sharedKey
1761 azureLogAnalytics:
1762 type: object
1763 description: AzureLogAnalytics defines AzureLogAnalytics Output Configuration
1764 properties:
1765 customerID:
1766 type: object
1767 description: Customer ID or Workspace ID
1768 properties:
1769 valueFrom:
1770 type: object
1771 description: ValueSource defines how to find a value's key.
1772 properties:
1773 secretKeyRef:
1774 type: object
1775 description: Selects a key of a secret in the pod's namespace
1776 properties:
1777 name:
1778 type: string
1779 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
1780 key:
1781 type: string
1782 description: The key of the secret to select from. Must be a valid secret key.
1783 optional:
1784 type: boolean
1785 description: Specify whether the Secret or its key must be defined
1786 required:
1787 - key
1788 x-kubernetes-map-type: atomic
1789 logType:
1790 type: string
1791 description: Name of the event type.
1792 sharedKey:
1793 type: object
1794 description: Specify the primary or the secondary client authentication key
1795 properties:
1796 valueFrom:
1797 type: object
1798 description: ValueSource defines how to find a value's key.
1799 properties:
1800 secretKeyRef:
1801 type: object
1802 description: Selects a key of a secret in the pod's namespace
1803 properties:
1804 name:
1805 type: string
1806 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
1807 key:
1808 type: string
1809 description: The key of the secret to select from. Must be a valid secret key.
1810 optional:
1811 type: boolean
1812 description: Specify whether the Secret or its key must be defined
1813 required:
1814 - key
1815 x-kubernetes-map-type: atomic
1816 timeGenerated:
1817 type: boolean
1818 description: If set, overrides the timeKey value with the `time-generated-field` HTTP header value.
1819 timeKey:
1820 type: string
1821 description: Specify the name of the key where the timestamp is stored.
1822 required:
1823 - customerID
1824 - sharedKey
1825 cloudWatch:
1826 type: object
1827 description: CloudWatch defines CloudWatch Output Configuration
1828 properties:
1829 autoCreateGroup:
1830 type: boolean
1831 description: Automatically create the log group. Defaults to False.
1832 autoRetryRequests:
1833 type: boolean
1834 description: Automatically retry failed requests to CloudWatch once. Defaults to True.
1835 endpoint:
1836 type: string
1837 description: Custom endpoint for CloudWatch logs API
1838 externalID:
1839 type: string
1840 description: Specify an external ID for the STS API.
1841 logFormat:
1842 type: string
1843 description: Optional parameter to tell CloudWatch the format of the data
1844 logGroupName:
1845 type: string
1846 description: Name of Cloudwatch Log Group to send log records to
1847 logGroupTemplate:
1848 type: string
1849 description: Template for Log Group name, overrides LogGroupName if set.
1850 logKey:
1851 type: string
1852 description: If set, only the value of the key will be sent to CloudWatch
1853 logRetentionDays:
1854 type: integer
1855 description: Number of days logs are retained for
1856 enum:
1857 - 1
1858 - 3
1859 - 5
1860 - 7
1861 - 14
1862 - 30
1863 - 60
1864 - 90
1865 - 120
1866 - 150
1867 - 180
1868 - 365
1869 - 400
1870 - 545
1871 - 731
1872 - 1827
1873 - 3653
1874 format: int32
1875 logStreamName:
1876 type: string
1877 description: The name of the CloudWatch Log Stream to send log records to
1878 logStreamPrefix:
1879 type: string
1880 description: Prefix for the Log Stream name. Not compatible with LogStreamName setting
1881 logStreamTemplate:
1882 type: string
1883 description: Template for Log Stream name. Overrides LogStreamPrefix and LogStreamName if set.
1884 metricDimensions:
1885 type: string
1886 description: Optional lists of lists for dimension keys to be added to all metrics. Use comma separated strings for one list of dimensions and semicolon separated strings for list of lists dimensions.
1887 metricNamespace:
1888 type: string
1889 description: Optional string to represent the CloudWatch namespace.
1890 region:
1891 type: string
1892 description: AWS Region
1893 roleArn:
1894 type: string
1895 description: Role ARN to use for cross-account access
1896 stsEndpoint:
1897 type: string
1898 description: Specify a custom STS endpoint for the AWS STS API
1899 required:
1900 - region
1901 customPlugin:
1902 type: object
1903 description: CustomPlugin defines Custom Output configuration.
1904 properties:
1905 config:
1906 type: string
1907 datadog:
1908 type: object
1909 description: DataDog defines DataDog Output configuration.
1910 properties:
1911 apikey:
1912 type: string
1913 description: Your Datadog API key.
1914 compress:
1915 type: string
1916 description: Compress the payload in GZIP format. Datadog supports and recommends setting this to gzip.
1917 dd_message_key:
1918 type: string
1919 description: By default, the plugin searches for the key 'log' and remap the value to the key 'message'. If the property is set, the plugin will search the property name key.
1920 dd_service:
1921 type: string
1922 description: The human readable name for your service generating the logs.
1923 dd_source:
1924 type: string
1925 description: A human readable name for the underlying technology of your service.
1926 dd_tags:
1927 type: string
1928 description: The tags you want to assign to your logs in Datadog.
1929 host:
1930 type: string
1931 description: Host is the Datadog server where you are sending your logs.
1932 include_tag_key:
1933 type: boolean
1934 description: If enabled, a tag is appended to output. The key name is used tag_key property.
1935 json_date_key:
1936 type: string
1937 description: Date key name for output.
1938 provider:
1939 type: string
1940 description: To activate the remapping, specify configuration flag provider.
1941 proxy:
1942 type: string
1943 description: Specify an HTTP Proxy.
1944 tag_key:
1945 type: string
1946 description: The key name of tag. If include_tag_key is false, This property is ignored.
1947 tls:
1948 type: boolean
1949 description: TLS controls whether to use end-to-end security communications security protocol. Datadog recommends setting this to on.
1950 es:
1951 type: object
1952 description: Elasticsearch defines Elasticsearch Output configuration.
1953 properties:
1954 type:
1955 type: string
1956 description: Type name
1957 port:
1958 type: integer
1959 description: TCP port of the target Elasticsearch instance
1960 format: int32
1961 maximum: 65535
1962 minimum: 1
1963 awsAuth:
1964 type: string
1965 description: Enable AWS Sigv4 Authentication for Amazon ElasticSearch Service.
1966 awsExternalID:
1967 type: string
1968 description: External ID for the AWS IAM Role specified with aws_role_arn.
1969 awsRegion:
1970 type: string
1971 description: Specify the AWS region for Amazon ElasticSearch Service.
1972 awsRoleARN:
1973 type: string
1974 description: AWS IAM Role to assume to put records to your Amazon ES cluster.
1975 awsSTSEndpoint:
1976 type: string
1977 description: Specify the custom sts endpoint to be used with STS API for Amazon ElasticSearch Service.
1978 bufferSize:
1979 type: string
1980 description: Specify the buffer size used to read the response from the Elasticsearch HTTP service. This option is useful for debugging purposes where is required to read full responses, note that response size grows depending of the number of records inserted. To set an unlimited amount of memory set this value to False, otherwise the value must be according to the Unit Size specification.
1981 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
1982 cloudAuth:
1983 type: string
1984 description: Specify the credentials to use to connect to Elastic's Elasticsearch Service running on Elastic Cloud.
1985 cloudID:
1986 type: string
1987 description: If you are using Elastic's Elasticsearch Service you can specify the cloud_id of the cluster running.
1988 currentTimeIndex:
1989 type: boolean
1990 description: Use current time for index generation instead of message record
1991 generateID:
1992 type: boolean
1993 description: When enabled, generate _id for outgoing records. This prevents duplicate records when retrying ES.
1994 host:
1995 type: string
1996 description: IP address or hostname of the target Elasticsearch instance
1997 httpPassword:
1998 type: object
1999 description: Password for user defined in HTTP_User
2000 properties:
2001 valueFrom:
2002 type: object
2003 description: ValueSource defines how to find a value's key.
2004 properties:
2005 secretKeyRef:
2006 type: object
2007 description: Selects a key of a secret in the pod's namespace
2008 properties:
2009 name:
2010 type: string
2011 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2012 key:
2013 type: string
2014 description: The key of the secret to select from. Must be a valid secret key.
2015 optional:
2016 type: boolean
2017 description: Specify whether the Secret or its key must be defined
2018 required:
2019 - key
2020 x-kubernetes-map-type: atomic
2021 httpUser:
2022 type: object
2023 description: Optional username credential for Elastic X-Pack access
2024 properties:
2025 valueFrom:
2026 type: object
2027 description: ValueSource defines how to find a value's key.
2028 properties:
2029 secretKeyRef:
2030 type: object
2031 description: Selects a key of a secret in the pod's namespace
2032 properties:
2033 name:
2034 type: string
2035 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2036 key:
2037 type: string
2038 description: The key of the secret to select from. Must be a valid secret key.
2039 optional:
2040 type: boolean
2041 description: Specify whether the Secret or its key must be defined
2042 required:
2043 - key
2044 x-kubernetes-map-type: atomic
2045 idKey:
2046 type: string
2047 description: If set, _id will be the value of the key from incoming record and Generate_ID option is ignored.
2048 includeTagKey:
2049 type: boolean
2050 description: When enabled, it append the Tag name to the record.
2051 index:
2052 type: string
2053 description: Index name
2054 logstashDateFormat:
2055 type: string
2056 description: Time format (based on strftime) to generate the second part of the Index name.
2057 logstashFormat:
2058 type: boolean
2059 description: 'Enable Logstash format compatibility. This option takes a boolean value: True/False, On/Off'
2060 logstashPrefix:
2061 type: string
2062 description: 'When Logstash_Format is enabled, the Index name is composed using a prefix and the date, e.g: If Logstash_Prefix is equals to ''mydata'' your index will become ''mydata-YYYY.MM.DD''. The last string appended belongs to the date when the data is being generated.'
2063 logstashPrefixKey:
2064 type: string
2065 description: Prefix keys with this string
2066 path:
2067 type: string
2068 description: Elasticsearch accepts new data on HTTP query path "/_bulk". But it is also possible to serve Elasticsearch behind a reverse proxy on a subpath. This option defines such path on the fluent-bit side. It simply adds a path prefix in the indexing HTTP POST URI.
2069 pipeline:
2070 type: string
2071 description: Newer versions of Elasticsearch allows setting up filters called pipelines. This option allows defining which pipeline the database should use. For performance reasons is strongly suggested parsing and filtering on Fluent Bit side, avoid pipelines.
2072 replaceDots:
2073 type: boolean
2074 description: When enabled, replace field name dots with underscore, required by Elasticsearch 2.0-2.3.
2075 suppressTypeName:
2076 type: string
2077 description: When enabled, mapping types is removed and Type option is ignored. Types are deprecated in APIs in v7.0. This options is for v7.0 or later.
2078 tagKey:
2079 type: string
2080 description: When Include_Tag_Key is enabled, this property defines the key name for the tag.
2081 timeKey:
2082 type: string
2083 description: When Logstash_Format is enabled, each record will get a new timestamp field. The Time_Key property defines the name of that field.
2084 timeKeyFormat:
2085 type: string
2086 description: When Logstash_Format is enabled, this property defines the format of the timestamp.
2087 timeKeyNanos:
2088 type: boolean
2089 description: When Logstash_Format is enabled, enabling this property sends nanosecond precision timestamps.
2090 tls:
2091 type: object
2092 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
2093 properties:
2094 caFile:
2095 type: string
2096 description: Absolute path to CA certificate file
2097 caPath:
2098 type: string
2099 description: Absolute path to scan for certificate files
2100 crtFile:
2101 type: string
2102 description: Absolute path to Certificate file
2103 debug:
2104 type: integer
2105 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
2106 enum:
2107 - 0
2108 - 1
2109 - 2
2110 - 3
2111 - 4
2112 format: int32
2113 keyFile:
2114 type: string
2115 description: Absolute path to private Key file
2116 keyPassword:
2117 type: object
2118 description: Optional password for tls.key_file file
2119 properties:
2120 valueFrom:
2121 type: object
2122 description: ValueSource defines how to find a value's key.
2123 properties:
2124 secretKeyRef:
2125 type: object
2126 description: Selects a key of a secret in the pod's namespace
2127 properties:
2128 name:
2129 type: string
2130 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2131 key:
2132 type: string
2133 description: The key of the secret to select from. Must be a valid secret key.
2134 optional:
2135 type: boolean
2136 description: Specify whether the Secret or its key must be defined
2137 required:
2138 - key
2139 x-kubernetes-map-type: atomic
2140 verify:
2141 type: boolean
2142 description: Force certificate validation
2143 vhost:
2144 type: string
2145 description: Hostname to be used for TLS SNI extension
2146 traceError:
2147 type: boolean
2148 description: When enabled print the elasticsearch API calls to stdout when elasticsearch returns an error
2149 traceOutput:
2150 type: boolean
2151 description: When enabled print the elasticsearch API calls to stdout (for diag only)
2152 file:
2153 type: object
2154 description: File defines File Output configuration.
2155 properties:
2156 template:
2157 type: string
2158 description: The format string. Applicable only if format is template.
2159 delimiter:
2160 type: string
2161 description: The character to separate each pair. Applicable only if format is csv or ltsv.
2162 file:
2163 type: string
2164 description: Set file name to store the records. If not set, the file name will be the tag associated with the records.
2165 format:
2166 type: string
2167 description: 'The format of the file content. See also Format section. Default: out_file.'
2168 enum:
2169 - out_file
2170 - plain
2171 - csv
2172 - ltsv
2173 - template
2174 labelDelimiter:
2175 type: string
2176 description: The character to separate each pair. Applicable only if format is ltsv.
2177 path:
2178 type: string
2179 description: Absolute directory path to store files. If not set, Fluent Bit will write the files on it's own positioned directory.
2180 firehose:
2181 type: object
2182 description: Firehose defines Firehose Output configuration.
2183 properties:
2184 autoRetryRequests:
2185 type: boolean
2186 description: Immediately retry failed requests to AWS services once. This option does not affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which may help improve throughput when there are transient/random networking issues.
2187 dataKeys:
2188 type: string
2189 description: By default, the whole log record will be sent to Kinesis. If you specify a key name(s) with this option, then only those keys and values will be sent to Kinesis. For example, if you are using the Fluentd Docker log driver, you can specify data_keys log and only the log message will be sent to Kinesis. If you specify multiple keys, they should be comma delimited.
2190 deliveryStream:
2191 type: string
2192 description: The name of the Kinesis Firehose Delivery stream that you want log records sent to.
2193 endpoint:
2194 type: string
2195 description: Specify a custom endpoint for the Kinesis Firehose API.
2196 logKey:
2197 type: string
2198 description: By default, the whole log record will be sent to Firehose. If you specify a key name with this option, then only the value of that key will be sent to Firehose. For example, if you are using the Fluentd Docker log driver, you can specify log_key log and only the log message will be sent to Firehose.
2199 region:
2200 type: string
2201 description: The AWS region.
2202 roleARN:
2203 type: string
2204 description: ARN of an IAM role to assume (for cross account access).
2205 stsEndpoint:
2206 type: string
2207 description: Specify a custom endpoint for the STS API; used to assume your custom role provided with role_arn.
2208 timeKey:
2209 type: string
2210 description: Add the timestamp to the record under this key. By default, the timestamp from Fluent Bit will not be added to records sent to Kinesis.
2211 timeKeyFormat:
2212 type: string
2213 description: strftime compliant format string for the timestamp; for example, %Y-%m-%dT%H *string This option is used with time_key. You can also use %L for milliseconds and %f for microseconds. If you are using ECS FireLens, make sure you are running Amazon ECS Container Agent v1.42.0 or later, otherwise the timestamps associated with your container logs will only have second precision.
2214 required:
2215 - deliveryStream
2216 - region
2217 forward:
2218 type: object
2219 description: Forward defines Forward Output configuration.
2220 properties:
2221 port:
2222 type: integer
2223 description: TCP Port of the target service.
2224 format: int32
2225 maximum: 65535
2226 minimum: 1
2227 emptySharedKey:
2228 type: boolean
2229 description: Use this option to connect to Fluentd with a zero-length secret.
2230 host:
2231 type: string
2232 description: Target host where Fluent-Bit or Fluentd are listening for Forward messages.
2233 password:
2234 type: object
2235 description: Specify the password corresponding to the username.
2236 properties:
2237 valueFrom:
2238 type: object
2239 description: ValueSource defines how to find a value's key.
2240 properties:
2241 secretKeyRef:
2242 type: object
2243 description: Selects a key of a secret in the pod's namespace
2244 properties:
2245 name:
2246 type: string
2247 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2248 key:
2249 type: string
2250 description: The key of the secret to select from. Must be a valid secret key.
2251 optional:
2252 type: boolean
2253 description: Specify whether the Secret or its key must be defined
2254 required:
2255 - key
2256 x-kubernetes-map-type: atomic
2257 requireAckResponse:
2258 type: boolean
2259 description: Send "chunk"-option and wait for "ack" response from server. Enables at-least-once and receiving server can control rate of traffic. (Requires Fluentd v0.14.0+ server)
2260 selfHostname:
2261 type: string
2262 description: Default value of the auto-generated certificate common name (CN).
2263 sendOptions:
2264 type: boolean
2265 description: Always send options (with "size"=count of messages)
2266 sharedKey:
2267 type: string
2268 description: A key string known by the remote Fluentd used for authorization.
2269 timeAsInteger:
2270 type: boolean
2271 description: Set timestamps in integer format, it enable compatibility mode for Fluentd v0.12 series.
2272 tls:
2273 type: object
2274 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
2275 properties:
2276 caFile:
2277 type: string
2278 description: Absolute path to CA certificate file
2279 caPath:
2280 type: string
2281 description: Absolute path to scan for certificate files
2282 crtFile:
2283 type: string
2284 description: Absolute path to Certificate file
2285 debug:
2286 type: integer
2287 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
2288 enum:
2289 - 0
2290 - 1
2291 - 2
2292 - 3
2293 - 4
2294 format: int32
2295 keyFile:
2296 type: string
2297 description: Absolute path to private Key file
2298 keyPassword:
2299 type: object
2300 description: Optional password for tls.key_file file
2301 properties:
2302 valueFrom:
2303 type: object
2304 description: ValueSource defines how to find a value's key.
2305 properties:
2306 secretKeyRef:
2307 type: object
2308 description: Selects a key of a secret in the pod's namespace
2309 properties:
2310 name:
2311 type: string
2312 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2313 key:
2314 type: string
2315 description: The key of the secret to select from. Must be a valid secret key.
2316 optional:
2317 type: boolean
2318 description: Specify whether the Secret or its key must be defined
2319 required:
2320 - key
2321 x-kubernetes-map-type: atomic
2322 verify:
2323 type: boolean
2324 description: Force certificate validation
2325 vhost:
2326 type: string
2327 description: Hostname to be used for TLS SNI extension
2328 username:
2329 type: object
2330 description: Specify the username to present to a Fluentd server that enables user_auth.
2331 properties:
2332 valueFrom:
2333 type: object
2334 description: ValueSource defines how to find a value's key.
2335 properties:
2336 secretKeyRef:
2337 type: object
2338 description: Selects a key of a secret in the pod's namespace
2339 properties:
2340 name:
2341 type: string
2342 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2343 key:
2344 type: string
2345 description: The key of the secret to select from. Must be a valid secret key.
2346 optional:
2347 type: boolean
2348 description: Specify whether the Secret or its key must be defined
2349 required:
2350 - key
2351 x-kubernetes-map-type: atomic
2352 http:
2353 type: object
2354 description: HTTP defines HTTP Output configuration.
2355 properties:
2356 port:
2357 type: integer
2358 description: TCP port of the target HTTP Server
2359 format: int32
2360 maximum: 65535
2361 minimum: 1
2362 allowDuplicatedHeaders:
2363 type: boolean
2364 description: Specify if duplicated headers are allowed. If a duplicated header is found, the latest key/value set is preserved.
2365 compress:
2366 type: string
2367 description: Set payload compression mechanism. Option available is 'gzip'
2368 format:
2369 type: string
2370 description: Specify the data format to be used in the HTTP request body, by default it uses msgpack. Other supported formats are json, json_stream and json_lines and gelf.
2371 enum:
2372 - msgpack
2373 - json
2374 - json_stream
2375 - json_lines
2376 - gelf
2377 gelfFullMessageKey:
2378 type: string
2379 description: Specify the key to use for the full message in gelf format
2380 gelfHostKey:
2381 type: string
2382 description: Specify the key to use for the host in gelf format
2383 gelfLevelKey:
2384 type: string
2385 description: Specify the key to use for the level in gelf format
2386 gelfShortMessageKey:
2387 type: string
2388 description: Specify the key to use as the short message in gelf format
2389 gelfTimestampKey:
2390 type: string
2391 description: Specify the key to use for timestamp in gelf format
2392 headerTag:
2393 type: string
2394 description: Specify an optional HTTP header field for the original message tag.
2395 headers:
2396 type: object
2397 additionalProperties:
2398 type: string
2399 description: Add a HTTP header key/value pair. Multiple headers can be set.
2400 host:
2401 type: string
2402 description: IP address or hostname of the target HTTP Server
2403 httpPassword:
2404 type: object
2405 description: Basic Auth Password. Requires HTTP_User to be set
2406 properties:
2407 valueFrom:
2408 type: object
2409 description: ValueSource defines how to find a value's key.
2410 properties:
2411 secretKeyRef:
2412 type: object
2413 description: Selects a key of a secret in the pod's namespace
2414 properties:
2415 name:
2416 type: string
2417 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2418 key:
2419 type: string
2420 description: The key of the secret to select from. Must be a valid secret key.
2421 optional:
2422 type: boolean
2423 description: Specify whether the Secret or its key must be defined
2424 required:
2425 - key
2426 x-kubernetes-map-type: atomic
2427 httpUser:
2428 type: object
2429 description: Basic Auth Username
2430 properties:
2431 valueFrom:
2432 type: object
2433 description: ValueSource defines how to find a value's key.
2434 properties:
2435 secretKeyRef:
2436 type: object
2437 description: Selects a key of a secret in the pod's namespace
2438 properties:
2439 name:
2440 type: string
2441 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2442 key:
2443 type: string
2444 description: The key of the secret to select from. Must be a valid secret key.
2445 optional:
2446 type: boolean
2447 description: Specify whether the Secret or its key must be defined
2448 required:
2449 - key
2450 x-kubernetes-map-type: atomic
2451 jsonDateFormat:
2452 type: string
2453 description: 'Specify the format of the date. Supported formats are double, epoch and iso8601 (eg: 2018-05-30T09:39:52.000681Z)'
2454 jsonDateKey:
2455 type: string
2456 description: Specify the name of the time key in the output record. To disable the time key just set the value to false.
2457 proxy:
2458 type: string
2459 description: Specify an HTTP Proxy. The expected format of this value is http://host:port. Note that https is not supported yet.
2460 tls:
2461 type: object
2462 description: HTTP output plugin supports TTL/SSL, for more details about the properties available and general configuration, please refer to the TLS/SSL section.
2463 properties:
2464 caFile:
2465 type: string
2466 description: Absolute path to CA certificate file
2467 caPath:
2468 type: string
2469 description: Absolute path to scan for certificate files
2470 crtFile:
2471 type: string
2472 description: Absolute path to Certificate file
2473 debug:
2474 type: integer
2475 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
2476 enum:
2477 - 0
2478 - 1
2479 - 2
2480 - 3
2481 - 4
2482 format: int32
2483 keyFile:
2484 type: string
2485 description: Absolute path to private Key file
2486 keyPassword:
2487 type: object
2488 description: Optional password for tls.key_file file
2489 properties:
2490 valueFrom:
2491 type: object
2492 description: ValueSource defines how to find a value's key.
2493 properties:
2494 secretKeyRef:
2495 type: object
2496 description: Selects a key of a secret in the pod's namespace
2497 properties:
2498 name:
2499 type: string
2500 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2501 key:
2502 type: string
2503 description: The key of the secret to select from. Must be a valid secret key.
2504 optional:
2505 type: boolean
2506 description: Specify whether the Secret or its key must be defined
2507 required:
2508 - key
2509 x-kubernetes-map-type: atomic
2510 verify:
2511 type: boolean
2512 description: Force certificate validation
2513 vhost:
2514 type: string
2515 description: Hostname to be used for TLS SNI extension
2516 uri:
2517 type: string
2518 description: 'Specify an optional HTTP URI for the target web server, e.g: /something'
2519 influxDB:
2520 type: object
2521 description: InfluxDB defines InfluxDB Output configuration.
2522 properties:
2523 port:
2524 type: integer
2525 description: TCP port of the target InfluxDB service.
2526 format: int32
2527 maximum: 65536
2528 minimum: 0
2529 autoTags:
2530 type: boolean
2531 description: Automatically tag keys where value is string.
2532 bucket:
2533 type: string
2534 description: InfluxDB bucket name where records will be inserted - if specified, database is ignored and v2 of API is used
2535 database:
2536 type: string
2537 description: InfluxDB database name where records will be inserted.
2538 host:
2539 type: string
2540 description: IP address or hostname of the target InfluxDB service.
2541 format: ipv6
2542 httpPassword:
2543 type: object
2544 description: Password for user defined in HTTP_User
2545 properties:
2546 valueFrom:
2547 type: object
2548 description: ValueSource defines how to find a value's key.
2549 properties:
2550 secretKeyRef:
2551 type: object
2552 description: Selects a key of a secret in the pod's namespace
2553 properties:
2554 name:
2555 type: string
2556 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2557 key:
2558 type: string
2559 description: The key of the secret to select from. Must be a valid secret key.
2560 optional:
2561 type: boolean
2562 description: Specify whether the Secret or its key must be defined
2563 required:
2564 - key
2565 x-kubernetes-map-type: atomic
2566 httpToken:
2567 type: object
2568 description: Authentication token used with InfluxDB v2 - if specified, both HTTPUser and HTTPPasswd are ignored
2569 properties:
2570 valueFrom:
2571 type: object
2572 description: ValueSource defines how to find a value's key.
2573 properties:
2574 secretKeyRef:
2575 type: object
2576 description: Selects a key of a secret in the pod's namespace
2577 properties:
2578 name:
2579 type: string
2580 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2581 key:
2582 type: string
2583 description: The key of the secret to select from. Must be a valid secret key.
2584 optional:
2585 type: boolean
2586 description: Specify whether the Secret or its key must be defined
2587 required:
2588 - key
2589 x-kubernetes-map-type: atomic
2590 httpUser:
2591 type: object
2592 description: Optional username for HTTP Basic Authentication
2593 properties:
2594 valueFrom:
2595 type: object
2596 description: ValueSource defines how to find a value's key.
2597 properties:
2598 secretKeyRef:
2599 type: object
2600 description: Selects a key of a secret in the pod's namespace
2601 properties:
2602 name:
2603 type: string
2604 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2605 key:
2606 type: string
2607 description: The key of the secret to select from. Must be a valid secret key.
2608 optional:
2609 type: boolean
2610 description: Specify whether the Secret or its key must be defined
2611 required:
2612 - key
2613 x-kubernetes-map-type: atomic
2614 org:
2615 type: string
2616 description: InfluxDB organization name where the bucket is (v2 only)
2617 sequenceTag:
2618 type: string
2619 description: The name of the tag whose value is incremented for the consecutive simultaneous events.
2620 tagKeys:
2621 type: array
2622 description: List of keys that needs to be tagged
2623 items:
2624 type: string
2625 tagListKey:
2626 type: string
2627 description: Key of the string array optionally contained within each log record that contains tag keys for that record
2628 tagsListEnabled:
2629 type: boolean
2630 description: Dynamically tag keys which are in the string array at Tags_List_Key key.
2631 tls:
2632 type: object
2633 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
2634 properties:
2635 caFile:
2636 type: string
2637 description: Absolute path to CA certificate file
2638 caPath:
2639 type: string
2640 description: Absolute path to scan for certificate files
2641 crtFile:
2642 type: string
2643 description: Absolute path to Certificate file
2644 debug:
2645 type: integer
2646 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
2647 enum:
2648 - 0
2649 - 1
2650 - 2
2651 - 3
2652 - 4
2653 format: int32
2654 keyFile:
2655 type: string
2656 description: Absolute path to private Key file
2657 keyPassword:
2658 type: object
2659 description: Optional password for tls.key_file file
2660 properties:
2661 valueFrom:
2662 type: object
2663 description: ValueSource defines how to find a value's key.
2664 properties:
2665 secretKeyRef:
2666 type: object
2667 description: Selects a key of a secret in the pod's namespace
2668 properties:
2669 name:
2670 type: string
2671 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2672 key:
2673 type: string
2674 description: The key of the secret to select from. Must be a valid secret key.
2675 optional:
2676 type: boolean
2677 description: Specify whether the Secret or its key must be defined
2678 required:
2679 - key
2680 x-kubernetes-map-type: atomic
2681 verify:
2682 type: boolean
2683 description: Force certificate validation
2684 vhost:
2685 type: string
2686 description: Hostname to be used for TLS SNI extension
2687 required:
2688 - host
2689 kafka:
2690 type: object
2691 description: Kafka defines Kafka Output configuration.
2692 properties:
2693 brokers:
2694 type: string
2695 description: 'Single of multiple list of Kafka Brokers, e.g: 192.168.1.3:9092, 192.168.1.4:9092.'
2696 dynamicTopic:
2697 type: boolean
2698 description: adds unknown topics (found in Topic_Key) to Topics. So in Topics only a default topic needs to be configured
2699 format:
2700 type: string
2701 description: 'Specify data format, options available: json, msgpack.'
2702 messageKey:
2703 type: string
2704 description: Optional key to store the message
2705 messageKeyField:
2706 type: string
2707 description: If set, the value of Message_Key_Field in the record will indicate the message key. If not set nor found in the record, Message_Key will be used (if set).
2708 queueFullRetries:
2709 type: integer
2710 description: Fluent Bit queues data into rdkafka library, if for some reason the underlying library cannot flush the records the queue might fills up blocking new addition of records. The queue_full_retries option set the number of local retries to enqueue the data. The default value is 10 times, the interval between each retry is 1 second. Setting the queue_full_retries value to 0 set's an unlimited number of retries.
2711 format: int64
2712 rdkafka:
2713 type: object
2714 additionalProperties:
2715 type: string
2716 description: '{property} can be any librdkafka properties'
2717 timestampFormat:
2718 type: string
2719 description: iso8601 or double
2720 timestampKey:
2721 type: string
2722 description: Set the key to store the record timestamp
2723 topicKey:
2724 type: string
2725 description: 'If multiple Topics exists, the value of Topic_Key in the record will indicate the topic to use. E.g: if Topic_Key is router and the record is {"key1": 123, "router": "route_2"}, Fluent Bit will use topic route_2. Note that if the value of Topic_Key is not present in Topics, then by default the first topic in the Topics list will indicate the topic to be used.'
2726 topics:
2727 type: string
2728 description: Single entry or list of topics separated by comma (,) that Fluent Bit will use to send messages to Kafka. If only one topic is set, that one will be used for all records. Instead if multiple topics exists, the one set in the record by Topic_Key will be used.
2729 kinesis:
2730 type: object
2731 description: Kinesis defines Kinesis Output configuration.
2732 properties:
2733 autoRetryRequests:
2734 type: boolean
2735 description: Immediately retry failed requests to AWS services once. This option does not affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which may help improve throughput when there are transient/random networking issues. This option defaults to true.
2736 endpoint:
2737 type: string
2738 description: Specify a custom endpoint for the Kinesis API.
2739 externalID:
2740 type: string
2741 description: Specify an external ID for the STS API, can be used with the role_arn parameter if your role requires an external ID.
2742 logKey:
2743 type: string
2744 description: By default, the whole log record will be sent to Kinesis. If you specify a key name with this option, then only the value of that key will be sent to Kinesis. For example, if you are using the Fluentd Docker log driver, you can specify log_key log and only the log message will be sent to Kinesis.
2745 region:
2746 type: string
2747 description: The AWS region.
2748 roleARN:
2749 type: string
2750 description: ARN of an IAM role to assume (for cross account access).
2751 stream:
2752 type: string
2753 description: The name of the Kinesis Streams Delivery stream that you want log records sent to.
2754 stsEndpoint:
2755 type: string
2756 description: Custom endpoint for the STS API.
2757 timeKey:
2758 type: string
2759 description: Add the timestamp to the record under this key. By default the timestamp from Fluent Bit will not be added to records sent to Kinesis.
2760 timeKeyFormat:
2761 type: string
2762 description: strftime compliant format string for the timestamp; for example, the default is '%Y-%m-%dT%H:%M:%S'. Supports millisecond precision with '%3N' and supports nanosecond precision with '%9N' and '%L'; for example, adding '%3N' to support millisecond '%Y-%m-%dT%H:%M:%S.%3N'. This option is used with time_key.
2763 required:
2764 - region
2765 - stream
2766 logLevel:
2767 type: string
2768 description: 'Set the plugin''s logging verbosity level. Allowed values are: off, error, warn, info, debug and trace, Defaults to the SERVICE section''s Log_Level'
2769 enum:
2770 - "off"
2771 - error
2772 - warning
2773 - info
2774 - debug
2775 - trace
2776 loki:
2777 type: object
2778 description: Loki defines Loki Output configuration.
2779 properties:
2780 labels:
2781 type: array
2782 description: Stream labels for API request. It can be multiple comma separated of strings specifying key=value pairs. In addition to fixed parameters, it also allows to add custom record keys (similar to label_keys property).
2783 items:
2784 type: string
2785 port:
2786 type: integer
2787 description: Loki TCP port
2788 format: int32
2789 maximum: 65535
2790 minimum: 1
2791 autoKubernetesLabels:
2792 type: string
2793 description: If set to true, it will add all Kubernetes labels to the Stream labels.
2794 enum:
2795 - "on"
2796 - "off"
2797 dropSingleKey:
2798 type: string
2799 description: If set to true and after extracting labels only a single key remains, the log line sent to Loki will be the value of that key in line_format.
2800 enum:
2801 - "on"
2802 - "off"
2803 host:
2804 type: string
2805 description: Loki hostname or IP address.
2806 httpPassword:
2807 type: object
2808 description: Password for user defined in HTTP_User Set HTTP basic authentication password
2809 properties:
2810 valueFrom:
2811 type: object
2812 description: ValueSource defines how to find a value's key.
2813 properties:
2814 secretKeyRef:
2815 type: object
2816 description: Selects a key of a secret in the pod's namespace
2817 properties:
2818 name:
2819 type: string
2820 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2821 key:
2822 type: string
2823 description: The key of the secret to select from. Must be a valid secret key.
2824 optional:
2825 type: boolean
2826 description: Specify whether the Secret or its key must be defined
2827 required:
2828 - key
2829 x-kubernetes-map-type: atomic
2830 httpUser:
2831 type: object
2832 description: Set HTTP basic authentication user name.
2833 properties:
2834 valueFrom:
2835 type: object
2836 description: ValueSource defines how to find a value's key.
2837 properties:
2838 secretKeyRef:
2839 type: object
2840 description: Selects a key of a secret in the pod's namespace
2841 properties:
2842 name:
2843 type: string
2844 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2845 key:
2846 type: string
2847 description: The key of the secret to select from. Must be a valid secret key.
2848 optional:
2849 type: boolean
2850 description: Specify whether the Secret or its key must be defined
2851 required:
2852 - key
2853 x-kubernetes-map-type: atomic
2854 labelKeys:
2855 type: array
2856 description: Optional list of record keys that will be placed as stream labels. This configuration property is for records key only.
2857 items:
2858 type: string
2859 labelMapPath:
2860 type: string
2861 description: Specify the label map file path. The file defines how to extract labels from each record.
2862 lineFormat:
2863 type: string
2864 description: Format to use when flattening the record to a log line. Valid values are json or key_value. If set to json, the log line sent to Loki will be the Fluent Bit record dumped as JSON. If set to key_value, the log line will be each item in the record concatenated together (separated by a single space) in the format.
2865 enum:
2866 - json
2867 - key_value
2868 removeKeys:
2869 type: array
2870 description: Optional list of keys to remove.
2871 items:
2872 type: string
2873 tenantID:
2874 type: object
2875 description: Tenant ID used by default to push logs to Loki. If omitted or empty it assumes Loki is running in single-tenant mode and no X-Scope-OrgID header is sent.
2876 properties:
2877 valueFrom:
2878 type: object
2879 description: ValueSource defines how to find a value's key.
2880 properties:
2881 secretKeyRef:
2882 type: object
2883 description: Selects a key of a secret in the pod's namespace
2884 properties:
2885 name:
2886 type: string
2887 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2888 key:
2889 type: string
2890 description: The key of the secret to select from. Must be a valid secret key.
2891 optional:
2892 type: boolean
2893 description: Specify whether the Secret or its key must be defined
2894 required:
2895 - key
2896 x-kubernetes-map-type: atomic
2897 tenantIDKey:
2898 type: string
2899 description: Specify the name of the key from the original record that contains the Tenant ID. The value of the key is set as X-Scope-OrgID of HTTP header. It is useful to set Tenant ID dynamically.
2900 tls:
2901 type: object
2902 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
2903 properties:
2904 caFile:
2905 type: string
2906 description: Absolute path to CA certificate file
2907 caPath:
2908 type: string
2909 description: Absolute path to scan for certificate files
2910 crtFile:
2911 type: string
2912 description: Absolute path to Certificate file
2913 debug:
2914 type: integer
2915 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
2916 enum:
2917 - 0
2918 - 1
2919 - 2
2920 - 3
2921 - 4
2922 format: int32
2923 keyFile:
2924 type: string
2925 description: Absolute path to private Key file
2926 keyPassword:
2927 type: object
2928 description: Optional password for tls.key_file file
2929 properties:
2930 valueFrom:
2931 type: object
2932 description: ValueSource defines how to find a value's key.
2933 properties:
2934 secretKeyRef:
2935 type: object
2936 description: Selects a key of a secret in the pod's namespace
2937 properties:
2938 name:
2939 type: string
2940 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
2941 key:
2942 type: string
2943 description: The key of the secret to select from. Must be a valid secret key.
2944 optional:
2945 type: boolean
2946 description: Specify whether the Secret or its key must be defined
2947 required:
2948 - key
2949 x-kubernetes-map-type: atomic
2950 verify:
2951 type: boolean
2952 description: Force certificate validation
2953 vhost:
2954 type: string
2955 description: Hostname to be used for TLS SNI extension
2956 required:
2957 - host
2958 match:
2959 type: string
2960 description: A pattern to match against the tags of incoming records. It's case sensitive and support the star (*) character as a wildcard.
2961 matchRegex:
2962 type: string
2963 description: A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax.
2964 "null":
2965 type: object
2966 description: Null defines Null Output configuration.
2967 opensearch:
2968 type: object
2969 description: OpenSearch defines OpenSearch Output configuration.
2970 properties:
2971 type:
2972 type: string
2973 description: Type name
2974 port:
2975 type: integer
2976 description: TCP port of the target OpenSearch instance, default `9200`
2977 format: int32
2978 maximum: 65535
2979 minimum: 1
2980 Workers:
2981 type: integer
2982 description: Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0.
2983 format: int32
2984 awsAuth:
2985 type: string
2986 description: Enable AWS Sigv4 Authentication for Amazon OpenSearch Service.
2987 awsExternalID:
2988 type: string
2989 description: External ID for the AWS IAM Role specified with aws_role_arn.
2990 awsRegion:
2991 type: string
2992 description: Specify the AWS region for Amazon OpenSearch Service.
2993 awsRoleARN:
2994 type: string
2995 description: AWS IAM Role to assume to put records to your Amazon cluster.
2996 awsSTSEndpoint:
2997 type: string
2998 description: Specify the custom sts endpoint to be used with STS API for Amazon OpenSearch Service.
2999 bufferSize:
3000 type: string
3001 description: Specify the buffer size used to read the response from the OpenSearch HTTP service. This option is useful for debugging purposes where is required to read full responses, note that response size grows depending of the number of records inserted. To set an unlimited amount of memory set this value to False, otherwise the value must be according to the Unit Size specification.
3002 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
3003 currentTimeIndex:
3004 type: boolean
3005 description: Use current time for index generation instead of message record
3006 generateID:
3007 type: boolean
3008 description: When enabled, generate _id for outgoing records. This prevents duplicate records when retrying OpenSearch.
3009 host:
3010 type: string
3011 description: IP address or hostname of the target OpenSearch instance, default `127.0.0.1`
3012 httpPassword:
3013 type: object
3014 description: Password for user defined in HTTP_User
3015 properties:
3016 valueFrom:
3017 type: object
3018 description: ValueSource defines how to find a value's key.
3019 properties:
3020 secretKeyRef:
3021 type: object
3022 description: Selects a key of a secret in the pod's namespace
3023 properties:
3024 name:
3025 type: string
3026 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3027 key:
3028 type: string
3029 description: The key of the secret to select from. Must be a valid secret key.
3030 optional:
3031 type: boolean
3032 description: Specify whether the Secret or its key must be defined
3033 required:
3034 - key
3035 x-kubernetes-map-type: atomic
3036 httpUser:
3037 type: object
3038 description: Optional username credential for access
3039 properties:
3040 valueFrom:
3041 type: object
3042 description: ValueSource defines how to find a value's key.
3043 properties:
3044 secretKeyRef:
3045 type: object
3046 description: Selects a key of a secret in the pod's namespace
3047 properties:
3048 name:
3049 type: string
3050 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3051 key:
3052 type: string
3053 description: The key of the secret to select from. Must be a valid secret key.
3054 optional:
3055 type: boolean
3056 description: Specify whether the Secret or its key must be defined
3057 required:
3058 - key
3059 x-kubernetes-map-type: atomic
3060 idKey:
3061 type: string
3062 description: If set, _id will be the value of the key from incoming record and Generate_ID option is ignored.
3063 includeTagKey:
3064 type: boolean
3065 description: When enabled, it append the Tag name to the record.
3066 index:
3067 type: string
3068 description: Index name
3069 logstashDateFormat:
3070 type: string
3071 description: Time format (based on strftime) to generate the second part of the Index name.
3072 logstashFormat:
3073 type: boolean
3074 description: 'Enable Logstash format compatibility. This option takes a boolean value: True/False, On/Off'
3075 logstashPrefix:
3076 type: string
3077 description: 'When Logstash_Format is enabled, the Index name is composed using a prefix and the date, e.g: If Logstash_Prefix is equals to ''mydata'' your index will become ''mydata-YYYY.MM.DD''. The last string appended belongs to the date when the data is being generated.'
3078 logstashPrefixKey:
3079 type: string
3080 description: Prefix keys with this string
3081 path:
3082 type: string
3083 description: OpenSearch accepts new data on HTTP query path "/_bulk". But it is also possible to serve OpenSearch behind a reverse proxy on a subpath. This option defines such path on the fluent-bit side. It simply adds a path prefix in the indexing HTTP POST URI.
3084 pipeline:
3085 type: string
3086 description: OpenSearch allows to setup filters called pipelines. This option allows to define which pipeline the database should use. For performance reasons is strongly suggested to do parsing and filtering on Fluent Bit side, avoid pipelines.
3087 replaceDots:
3088 type: boolean
3089 description: When enabled, replace field name dots with underscore, required by Elasticsearch 2.0-2.3.
3090 suppressTypeName:
3091 type: boolean
3092 description: When enabled, mapping types is removed and Type option is ignored. Types are deprecated in APIs in v7.0. This options is for v7.0 or later.
3093 tagKey:
3094 type: string
3095 description: When Include_Tag_Key is enabled, this property defines the key name for the tag.
3096 timeKey:
3097 type: string
3098 description: When Logstash_Format is enabled, each record will get a new timestamp field. The Time_Key property defines the name of that field.
3099 timeKeyFormat:
3100 type: string
3101 description: When Logstash_Format is enabled, this property defines the format of the timestamp.
3102 timeKeyNanos:
3103 type: boolean
3104 description: When Logstash_Format is enabled, enabling this property sends nanosecond precision timestamps.
3105 tls:
3106 type: object
3107 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
3108 properties:
3109 caFile:
3110 type: string
3111 description: Absolute path to CA certificate file
3112 caPath:
3113 type: string
3114 description: Absolute path to scan for certificate files
3115 crtFile:
3116 type: string
3117 description: Absolute path to Certificate file
3118 debug:
3119 type: integer
3120 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
3121 enum:
3122 - 0
3123 - 1
3124 - 2
3125 - 3
3126 - 4
3127 format: int32
3128 keyFile:
3129 type: string
3130 description: Absolute path to private Key file
3131 keyPassword:
3132 type: object
3133 description: Optional password for tls.key_file file
3134 properties:
3135 valueFrom:
3136 type: object
3137 description: ValueSource defines how to find a value's key.
3138 properties:
3139 secretKeyRef:
3140 type: object
3141 description: Selects a key of a secret in the pod's namespace
3142 properties:
3143 name:
3144 type: string
3145 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3146 key:
3147 type: string
3148 description: The key of the secret to select from. Must be a valid secret key.
3149 optional:
3150 type: boolean
3151 description: Specify whether the Secret or its key must be defined
3152 required:
3153 - key
3154 x-kubernetes-map-type: atomic
3155 verify:
3156 type: boolean
3157 description: Force certificate validation
3158 vhost:
3159 type: string
3160 description: Hostname to be used for TLS SNI extension
3161 totalLimitSize:
3162 type: string
3163 description: Limit the maximum number of Chunks in the filesystem for the current output logical destination.
3164 traceError:
3165 type: boolean
3166 description: When enabled print the elasticsearch API calls to stdout when elasticsearch returns an error
3167 traceOutput:
3168 type: boolean
3169 description: When enabled print the elasticsearch API calls to stdout (for diag only)
3170 writeOperation:
3171 type: string
3172 description: Operation to use to write in bulk requests.
3173 opentelemetry:
3174 type: object
3175 description: OpenTelemetry defines OpenTelemetry Output configuration.
3176 properties:
3177 port:
3178 type: integer
3179 description: TCP port of the target OpenSearch instance, default `80`
3180 format: int32
3181 maximum: 65535
3182 minimum: 1
3183 addLabel:
3184 type: object
3185 additionalProperties:
3186 type: string
3187 description: This allows you to add custom labels to all metrics exposed through the OpenTelemetry exporter. You may have multiple of these fields.
3188 header:
3189 type: object
3190 additionalProperties:
3191 type: string
3192 description: Add a HTTP header key/value pair. Multiple headers can be set.
3193 host:
3194 type: string
3195 description: IP address or hostname of the target HTTP Server, default `127.0.0.1`
3196 httpPassword:
3197 type: object
3198 description: Password for user defined in HTTP_User
3199 properties:
3200 valueFrom:
3201 type: object
3202 description: ValueSource defines how to find a value's key.
3203 properties:
3204 secretKeyRef:
3205 type: object
3206 description: Selects a key of a secret in the pod's namespace
3207 properties:
3208 name:
3209 type: string
3210 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3211 key:
3212 type: string
3213 description: The key of the secret to select from. Must be a valid secret key.
3214 optional:
3215 type: boolean
3216 description: Specify whether the Secret or its key must be defined
3217 required:
3218 - key
3219 x-kubernetes-map-type: atomic
3220 httpUser:
3221 type: object
3222 description: Optional username credential for access
3223 properties:
3224 valueFrom:
3225 type: object
3226 description: ValueSource defines how to find a value's key.
3227 properties:
3228 secretKeyRef:
3229 type: object
3230 description: Selects a key of a secret in the pod's namespace
3231 properties:
3232 name:
3233 type: string
3234 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3235 key:
3236 type: string
3237 description: The key of the secret to select from. Must be a valid secret key.
3238 optional:
3239 type: boolean
3240 description: Specify whether the Secret or its key must be defined
3241 required:
3242 - key
3243 x-kubernetes-map-type: atomic
3244 logResponsePayload:
3245 type: boolean
3246 description: Log the response payload within the Fluent Bit log.
3247 logsUri:
3248 type: string
3249 description: 'Specify an optional HTTP URI for the target web server listening for logs, e.g: /v1/logs'
3250 metricsUri:
3251 type: string
3252 description: 'Specify an optional HTTP URI for the target web server listening for metrics, e.g: /v1/metrics'
3253 proxy:
3254 type: string
3255 description: Specify an HTTP Proxy. The expected format of this value is http://HOST:PORT. Note that HTTPS is not currently supported. It is recommended not to set this and to configure the HTTP proxy environment variables instead as they support both HTTP and HTTPS.
3256 tls:
3257 type: object
3258 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
3259 properties:
3260 caFile:
3261 type: string
3262 description: Absolute path to CA certificate file
3263 caPath:
3264 type: string
3265 description: Absolute path to scan for certificate files
3266 crtFile:
3267 type: string
3268 description: Absolute path to Certificate file
3269 debug:
3270 type: integer
3271 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
3272 enum:
3273 - 0
3274 - 1
3275 - 2
3276 - 3
3277 - 4
3278 format: int32
3279 keyFile:
3280 type: string
3281 description: Absolute path to private Key file
3282 keyPassword:
3283 type: object
3284 description: Optional password for tls.key_file file
3285 properties:
3286 valueFrom:
3287 type: object
3288 description: ValueSource defines how to find a value's key.
3289 properties:
3290 secretKeyRef:
3291 type: object
3292 description: Selects a key of a secret in the pod's namespace
3293 properties:
3294 name:
3295 type: string
3296 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3297 key:
3298 type: string
3299 description: The key of the secret to select from. Must be a valid secret key.
3300 optional:
3301 type: boolean
3302 description: Specify whether the Secret or its key must be defined
3303 required:
3304 - key
3305 x-kubernetes-map-type: atomic
3306 verify:
3307 type: boolean
3308 description: Force certificate validation
3309 vhost:
3310 type: string
3311 description: Hostname to be used for TLS SNI extension
3312 tracesUri:
3313 type: string
3314 description: 'Specify an optional HTTP URI for the target web server listening for traces, e.g: /v1/traces'
3315 prometheusRemoteWrite:
3316 type: object
3317 description: PrometheusRemoteWrite_types defines Prometheus Remote Write configuration.
3318 properties:
3319 port:
3320 type: integer
3321 description: TCP port of the target HTTP Serveri, default:80
3322 format: int32
3323 maximum: 65535
3324 minimum: 1
3325 addLabels:
3326 type: object
3327 additionalProperties:
3328 type: string
3329 description: This allows you to add custom labels to all metrics exposed through the prometheus exporter. You may have multiple of these fields
3330 headers:
3331 type: object
3332 additionalProperties:
3333 type: string
3334 description: Add a HTTP header key/value pair. Multiple headers can be set.
3335 host:
3336 type: string
3337 description: 'IP address or hostname of the target HTTP Server, default: 127.0.0.1'
3338 httpPasswd:
3339 type: object
3340 description: Basic Auth Password. Requires HTTP_user to be se
3341 properties:
3342 valueFrom:
3343 type: object
3344 description: ValueSource defines how to find a value's key.
3345 properties:
3346 secretKeyRef:
3347 type: object
3348 description: Selects a key of a secret in the pod's namespace
3349 properties:
3350 name:
3351 type: string
3352 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3353 key:
3354 type: string
3355 description: The key of the secret to select from. Must be a valid secret key.
3356 optional:
3357 type: boolean
3358 description: Specify whether the Secret or its key must be defined
3359 required:
3360 - key
3361 x-kubernetes-map-type: atomic
3362 httpUser:
3363 type: object
3364 description: Basic Auth Username
3365 properties:
3366 valueFrom:
3367 type: object
3368 description: ValueSource defines how to find a value's key.
3369 properties:
3370 secretKeyRef:
3371 type: object
3372 description: Selects a key of a secret in the pod's namespace
3373 properties:
3374 name:
3375 type: string
3376 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3377 key:
3378 type: string
3379 description: The key of the secret to select from. Must be a valid secret key.
3380 optional:
3381 type: boolean
3382 description: Specify whether the Secret or its key must be defined
3383 required:
3384 - key
3385 x-kubernetes-map-type: atomic
3386 logResponsePayload:
3387 type: boolean
3388 description: 'Log the response payload within the Fluent Bit log,default: false'
3389 proxy:
3390 type: string
3391 description: Specify an HTTP Proxy. The expected format of this value is http://HOST:PORT.
3392 tls:
3393 type: object
3394 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
3395 properties:
3396 caFile:
3397 type: string
3398 description: Absolute path to CA certificate file
3399 caPath:
3400 type: string
3401 description: Absolute path to scan for certificate files
3402 crtFile:
3403 type: string
3404 description: Absolute path to Certificate file
3405 debug:
3406 type: integer
3407 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
3408 enum:
3409 - 0
3410 - 1
3411 - 2
3412 - 3
3413 - 4
3414 format: int32
3415 keyFile:
3416 type: string
3417 description: Absolute path to private Key file
3418 keyPassword:
3419 type: object
3420 description: Optional password for tls.key_file file
3421 properties:
3422 valueFrom:
3423 type: object
3424 description: ValueSource defines how to find a value's key.
3425 properties:
3426 secretKeyRef:
3427 type: object
3428 description: Selects a key of a secret in the pod's namespace
3429 properties:
3430 name:
3431 type: string
3432 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3433 key:
3434 type: string
3435 description: The key of the secret to select from. Must be a valid secret key.
3436 optional:
3437 type: boolean
3438 description: Specify whether the Secret or its key must be defined
3439 required:
3440 - key
3441 x-kubernetes-map-type: atomic
3442 verify:
3443 type: boolean
3444 description: Force certificate validation
3445 vhost:
3446 type: string
3447 description: Hostname to be used for TLS SNI extension
3448 uri:
3449 type: string
3450 description: 'Specify an optional HTTP URI for the target web server, e.g: /something ,default: /'
3451 workers:
3452 type: integer
3453 description: 'Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0,default : 2'
3454 format: int32
3455 required:
3456 - host
3457 retry_limit:
3458 type: string
3459 description: RetryLimit represents configuration for the scheduler which can be set independently on each output section. This option allows to disable retries or impose a limit to try N times and then discard the data after reaching that limit.
3460 s3:
3461 type: object
3462 description: S3 defines S3 Output configuration.
3463 properties:
3464 AutoRetryRequests:
3465 type: boolean
3466 description: Immediately retry failed requests to AWS services once.
3467 Bucket:
3468 type: string
3469 description: S3 Bucket name
3470 CannedAcl:
3471 type: string
3472 description: Predefined Canned ACL Policy for S3 objects.
3473 Compression:
3474 type: string
3475 description: Compression type for S3 objects.
3476 ContentType:
3477 type: string
3478 description: A standard MIME type for the S3 object; this will be set as the Content-Type HTTP header.
3479 Endpoint:
3480 type: string
3481 description: Custom endpoint for the S3 API.
3482 ExternalId:
3483 type: string
3484 description: Specify an external ID for the STS API, can be used with the role_arn parameter if your role requires an external ID.
3485 JsonDateFormat:
3486 type: string
3487 description: 'Specify the format of the date. Supported formats are double, epoch, iso8601 (eg: 2018-05-30T09:39:52.000681Z) and java_sql_timestamp (eg: 2018-05-30 09:39:52.000681)'
3488 JsonDateKey:
3489 type: string
3490 description: Specify the name of the time key in the output record. To disable the time key just set the value to false.
3491 LogKey:
3492 type: string
3493 description: By default, the whole log record will be sent to S3. If you specify a key name with this option, then only the value of that key will be sent to S3.
3494 PreserveDataOrdering:
3495 type: boolean
3496 description: Normally, when an upload request fails, there is a high chance for the last received chunk to be swapped with a later chunk, resulting in data shuffling. This feature prevents this shuffling by using a queue logic for uploads.
3497 Region:
3498 type: string
3499 description: The AWS region of your S3 bucket
3500 RetryLimit:
3501 type: integer
3502 description: Integer value to set the maximum number of retries allowed.
3503 format: int32
3504 RoleArn:
3505 type: string
3506 description: ARN of an IAM role to assume
3507 S3KeyFormat:
3508 type: string
3509 description: Format string for keys in S3.
3510 S3KeyFormatTagDelimiters:
3511 type: string
3512 description: A series of characters which will be used to split the tag into 'parts' for use with the s3_key_format option.
3513 SendContentMd5:
3514 type: boolean
3515 description: Send the Content-MD5 header with PutObject and UploadPart requests, as is required when Object Lock is enabled.
3516 StaticFilePath:
3517 type: boolean
3518 description: Disables behavior where UUID string is automatically appended to end of S3 key name when $UUID is not provided in s3_key_format. $UUID, time formatters, $TAG, and other dynamic key formatters all work as expected while this feature is set to true.
3519 StorageClass:
3520 type: string
3521 description: Specify the storage class for S3 objects. If this option is not specified, objects will be stored with the default 'STANDARD' storage class.
3522 StoreDir:
3523 type: string
3524 description: Directory to locally buffer data before sending.
3525 StoreDirLimitSize:
3526 type: string
3527 description: The size of the limitation for disk usage in S3.
3528 StsEndpoint:
3529 type: string
3530 description: Custom endpoint for the STS API.
3531 TotalFileSize:
3532 type: string
3533 description: Specifies the size of files in S3. Minimum size is 1M. With use_put_object On the maximum size is 1G. With multipart upload mode, the maximum size is 50G.
3534 UploadChunkSize:
3535 type: string
3536 description: 'The size of each ''part'' for multipart uploads. Max: 50M'
3537 UploadTimeout:
3538 type: string
3539 description: Whenever this amount of time has elapsed, Fluent Bit will complete an upload and create a new file in S3. For example, set this value to 60m and you will get a new file every hour.
3540 UsePutObject:
3541 type: boolean
3542 description: Use the S3 PutObject API, instead of the multipart upload API.
3543 required:
3544 - Bucket
3545 - Region
3546 splunk:
3547 type: object
3548 description: Splunk defines Splunk Output Configuration
3549 properties:
3550 port:
3551 type: integer
3552 description: TCP port of the target Splunk instance, default `8088`
3553 format: int32
3554 maximum: 65535
3555 minimum: 1
3556 Workers:
3557 type: integer
3558 description: Enables dedicated thread(s) for this output. Default value `2` is set since version 1.8.13. For previous versions is 0.
3559 format: int32
3560 channel:
3561 type: string
3562 description: Specify X-Splunk-Request-Channel Header for the HTTP Event Collector interface.
3563 compress:
3564 type: string
3565 description: Set payload compression mechanism. The only available option is gzip.
3566 eventFields:
3567 type: array
3568 description: Set event fields for the record. This option is an array and the format is "key_name record_accessor_pattern".
3569 items:
3570 type: string
3571 eventHost:
3572 type: string
3573 description: Specify the key name that contains the host value. This option allows a record accessors pattern.
3574 eventIndex:
3575 type: string
3576 description: The name of the index by which the event data is to be indexed.
3577 eventIndexKey:
3578 type: string
3579 description: Set a record key that will populate the index field. If the key is found, it will have precedence over the value set in event_index.
3580 eventKey:
3581 type: string
3582 description: Specify the key name that will be used to send a single value as part of the record.
3583 eventSource:
3584 type: string
3585 description: Set the source value to assign to the event data.
3586 eventSourcetype:
3587 type: string
3588 description: Set the sourcetype value to assign to the event data.
3589 eventSourcetypeKey:
3590 type: string
3591 description: Set a record key that will populate 'sourcetype'. If the key is found, it will have precedence over the value set in event_sourcetype.
3592 host:
3593 type: string
3594 description: IP address or hostname of the target OpenSearch instance, default `127.0.0.1`
3595 httpBufferSize:
3596 type: string
3597 description: 'Buffer size used to receive Splunk HTTP responses: Default `2M`'
3598 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
3599 httpDebugBadRequest:
3600 type: boolean
3601 description: If the HTTP server response code is 400 (bad request) and this flag is enabled, it will print the full HTTP request and response to the stdout interface. This feature is available for debugging purposes.
3602 httpPassword:
3603 type: object
3604 description: Password for user defined in HTTP_User
3605 properties:
3606 valueFrom:
3607 type: object
3608 description: ValueSource defines how to find a value's key.
3609 properties:
3610 secretKeyRef:
3611 type: object
3612 description: Selects a key of a secret in the pod's namespace
3613 properties:
3614 name:
3615 type: string
3616 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3617 key:
3618 type: string
3619 description: The key of the secret to select from. Must be a valid secret key.
3620 optional:
3621 type: boolean
3622 description: Specify whether the Secret or its key must be defined
3623 required:
3624 - key
3625 x-kubernetes-map-type: atomic
3626 httpUser:
3627 type: object
3628 description: Optional username credential for access
3629 properties:
3630 valueFrom:
3631 type: object
3632 description: ValueSource defines how to find a value's key.
3633 properties:
3634 secretKeyRef:
3635 type: object
3636 description: Selects a key of a secret in the pod's namespace
3637 properties:
3638 name:
3639 type: string
3640 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3641 key:
3642 type: string
3643 description: The key of the secret to select from. Must be a valid secret key.
3644 optional:
3645 type: boolean
3646 description: Specify whether the Secret or its key must be defined
3647 required:
3648 - key
3649 x-kubernetes-map-type: atomic
3650 splunkSendRaw:
3651 type: boolean
3652 description: When enabled, the record keys and values are set in the top level of the map instead of under the event key. Refer to the Sending Raw Events section from the docs more details to make this option work properly.
3653 splunkToken:
3654 type: object
3655 description: Specify the Authentication Token for the HTTP Event Collector interface.
3656 properties:
3657 valueFrom:
3658 type: object
3659 description: ValueSource defines how to find a value's key.
3660 properties:
3661 secretKeyRef:
3662 type: object
3663 description: Selects a key of a secret in the pod's namespace
3664 properties:
3665 name:
3666 type: string
3667 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3668 key:
3669 type: string
3670 description: The key of the secret to select from. Must be a valid secret key.
3671 optional:
3672 type: boolean
3673 description: Specify whether the Secret or its key must be defined
3674 required:
3675 - key
3676 x-kubernetes-map-type: atomic
3677 tls:
3678 type: object
3679 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
3680 properties:
3681 caFile:
3682 type: string
3683 description: Absolute path to CA certificate file
3684 caPath:
3685 type: string
3686 description: Absolute path to scan for certificate files
3687 crtFile:
3688 type: string
3689 description: Absolute path to Certificate file
3690 debug:
3691 type: integer
3692 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
3693 enum:
3694 - 0
3695 - 1
3696 - 2
3697 - 3
3698 - 4
3699 format: int32
3700 keyFile:
3701 type: string
3702 description: Absolute path to private Key file
3703 keyPassword:
3704 type: object
3705 description: Optional password for tls.key_file file
3706 properties:
3707 valueFrom:
3708 type: object
3709 description: ValueSource defines how to find a value's key.
3710 properties:
3711 secretKeyRef:
3712 type: object
3713 description: Selects a key of a secret in the pod's namespace
3714 properties:
3715 name:
3716 type: string
3717 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3718 key:
3719 type: string
3720 description: The key of the secret to select from. Must be a valid secret key.
3721 optional:
3722 type: boolean
3723 description: Specify whether the Secret or its key must be defined
3724 required:
3725 - key
3726 x-kubernetes-map-type: atomic
3727 verify:
3728 type: boolean
3729 description: Force certificate validation
3730 vhost:
3731 type: string
3732 description: Hostname to be used for TLS SNI extension
3733 stackdriver:
3734 type: object
3735 description: Stackdriver defines Stackdriver Output Configuration
3736 properties:
3737 namespace:
3738 type: string
3739 description: Namespace identifier. Required if Resource is generic_node or generic_task
3740 labels:
3741 type: array
3742 description: Optional list of comma separated of strings for key/value pairs
3743 items:
3744 type: string
3745 autoformatStackdriverTrace:
3746 type: boolean
3747 description: Rewrite the trace field to be formatted for use with GCP Cloud Trace
3748 customK8sRegex:
3749 type: string
3750 description: A custom regex to extract fields from the local_resource_id of the logs
3751 exportToProjectID:
3752 type: string
3753 description: The GCP Project that should receive the logs
3754 googleServiceCredentials:
3755 type: string
3756 description: Path to GCP Credentials JSON file
3757 job:
3758 type: string
3759 description: Identifier for a grouping of tasks. Required if Resource is generic_task
3760 k8sClusterLocation:
3761 type: string
3762 description: Location of the cluster that contains the pods/nodes. Required if Resource is k8s_container, k8s_node, or k8s_pod
3763 k8sClusterName:
3764 type: string
3765 description: Name of the cluster that the pod is running in. Required if Resource is k8s_container, k8s_node, or k8s_pod
3766 labelsKey:
3767 type: string
3768 description: Used by Stackdriver to find related labels and extract them to LogEntry Labels
3769 location:
3770 type: string
3771 description: GCP/AWS region to store data. Required if Resource is generic_node or generic_task
3772 logNameKey:
3773 type: string
3774 description: The value of this field is set as the logName field in Stackdriver
3775 metadataServer:
3776 type: string
3777 description: Metadata Server Prefix
3778 nodeID:
3779 type: string
3780 description: Node identifier within the namespace. Required if Resource is generic_node or generic_task
3781 resource:
3782 type: string
3783 description: Set resource types of data
3784 resourceLabels:
3785 type: array
3786 description: Optional list of comma seperated strings. Setting these fields overrides the Stackdriver monitored resource API values
3787 items:
3788 type: string
3789 serviceAccountEmail:
3790 type: object
3791 description: Email associated with the service
3792 properties:
3793 valueFrom:
3794 type: object
3795 description: ValueSource defines how to find a value's key.
3796 properties:
3797 secretKeyRef:
3798 type: object
3799 description: Selects a key of a secret in the pod's namespace
3800 properties:
3801 name:
3802 type: string
3803 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3804 key:
3805 type: string
3806 description: The key of the secret to select from. Must be a valid secret key.
3807 optional:
3808 type: boolean
3809 description: Specify whether the Secret or its key must be defined
3810 required:
3811 - key
3812 x-kubernetes-map-type: atomic
3813 serviceAccountSecret:
3814 type: object
3815 description: Private Key associated with the service
3816 properties:
3817 valueFrom:
3818 type: object
3819 description: ValueSource defines how to find a value's key.
3820 properties:
3821 secretKeyRef:
3822 type: object
3823 description: Selects a key of a secret in the pod's namespace
3824 properties:
3825 name:
3826 type: string
3827 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3828 key:
3829 type: string
3830 description: The key of the secret to select from. Must be a valid secret key.
3831 optional:
3832 type: boolean
3833 description: Specify whether the Secret or its key must be defined
3834 required:
3835 - key
3836 x-kubernetes-map-type: atomic
3837 severityKey:
3838 type: string
3839 description: Specify the key that contains the severity information for the logs
3840 tagPrefix:
3841 type: string
3842 description: Used to validate the tags of logs that when the Resource is k8s_container, k8s_node, or k8s_pod
3843 taskID:
3844 type: string
3845 description: Identifier for a task within a namespace. Required if Resource is generic_task
3846 workers:
3847 type: integer
3848 description: Number of dedicated threads for the Stackdriver Output Plugin
3849 format: int32
3850 stdout:
3851 type: object
3852 description: Stdout defines Stdout Output configuration.
3853 properties:
3854 format:
3855 type: string
3856 description: Specify the data format to be printed. Supported formats are msgpack json, json_lines and json_stream.
3857 enum:
3858 - msgpack
3859 - json
3860 - json_lines
3861 - json_stream
3862 jsonDateFormat:
3863 type: string
3864 description: 'Specify the format of the date. Supported formats are double, iso8601 (eg: 2018-05-30T09:39:52.000681Z) and epoch.'
3865 enum:
3866 - double
3867 - iso8601
3868 - epoch
3869 jsonDateKey:
3870 type: string
3871 description: Specify the name of the date field in output.
3872 syslog:
3873 type: object
3874 description: Syslog defines Syslog Output configuration.
3875 properties:
3876 port:
3877 type: integer
3878 description: TCP or UDP port of the remote Syslog server.
3879 format: int32
3880 maximum: 65535
3881 minimum: 1
3882 host:
3883 type: string
3884 description: Host domain or IP address of the remote Syslog server.
3885 mode:
3886 type: string
3887 description: Mode of the desired transport type, the available options are tcp, tls and udp.
3888 syslogAppnameKey:
3889 type: string
3890 description: Key name from the original record that contains the application name that generated the message.
3891 syslogFacilityKey:
3892 type: string
3893 description: Key from the original record that contains the Syslog facility number.
3894 syslogFormat:
3895 type: string
3896 description: Syslog protocol format to use, the available options are rfc3164 and rfc5424.
3897 syslogHostnameKey:
3898 type: string
3899 description: Key name from the original record that contains the hostname that generated the message.
3900 syslogMaxSize:
3901 type: integer
3902 description: Maximum size allowed per message, in bytes.
3903 format: int32
3904 syslogMessageIDKey:
3905 type: string
3906 description: Key name from the original record that contains the Message ID associated to the message.
3907 syslogMessageKey:
3908 type: string
3909 description: Key key name that contains the message to deliver.
3910 syslogProcessIDKey:
3911 type: string
3912 description: Key name from the original record that contains the Process ID that generated the message.
3913 syslogSDKey:
3914 type: string
3915 description: Key name from the original record that contains the Structured Data (SD) content.
3916 syslogSeverityKey:
3917 type: string
3918 description: Key from the original record that contains the Syslog severity number.
3919 tls:
3920 type: object
3921 description: Syslog output plugin supports TTL/SSL, for more details about the properties available and general configuration, please refer to the TLS/SSL section.
3922 properties:
3923 caFile:
3924 type: string
3925 description: Absolute path to CA certificate file
3926 caPath:
3927 type: string
3928 description: Absolute path to scan for certificate files
3929 crtFile:
3930 type: string
3931 description: Absolute path to Certificate file
3932 debug:
3933 type: integer
3934 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
3935 enum:
3936 - 0
3937 - 1
3938 - 2
3939 - 3
3940 - 4
3941 format: int32
3942 keyFile:
3943 type: string
3944 description: Absolute path to private Key file
3945 keyPassword:
3946 type: object
3947 description: Optional password for tls.key_file file
3948 properties:
3949 valueFrom:
3950 type: object
3951 description: ValueSource defines how to find a value's key.
3952 properties:
3953 secretKeyRef:
3954 type: object
3955 description: Selects a key of a secret in the pod's namespace
3956 properties:
3957 name:
3958 type: string
3959 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
3960 key:
3961 type: string
3962 description: The key of the secret to select from. Must be a valid secret key.
3963 optional:
3964 type: boolean
3965 description: Specify whether the Secret or its key must be defined
3966 required:
3967 - key
3968 x-kubernetes-map-type: atomic
3969 verify:
3970 type: boolean
3971 description: Force certificate validation
3972 vhost:
3973 type: string
3974 description: Hostname to be used for TLS SNI extension
3975 tcp:
3976 type: object
3977 description: TCP defines TCP Output configuration.
3978 properties:
3979 port:
3980 type: integer
3981 description: TCP Port of the target service.
3982 format: int32
3983 maximum: 65535
3984 minimum: 1
3985 format:
3986 type: string
3987 description: Specify the data format to be printed. Supported formats are msgpack json, json_lines and json_stream.
3988 enum:
3989 - msgpack
3990 - json
3991 - json_lines
3992 - json_stream
3993 host:
3994 type: string
3995 description: Target host where Fluent-Bit or Fluentd are listening for Forward messages.
3996 jsonDateFormat:
3997 type: string
3998 description: 'Specify the format of the date. Supported formats are double, epoch and iso8601 (eg: 2018-05-30T09:39:52.000681Z)'
3999 enum:
4000 - double
4001 - epoch
4002 - iso8601
4003 jsonDateKey:
4004 type: string
4005 description: TSpecify the name of the time key in the output record. To disable the time key just set the value to false.
4006 tls:
4007 type: object
4008 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
4009 properties:
4010 caFile:
4011 type: string
4012 description: Absolute path to CA certificate file
4013 caPath:
4014 type: string
4015 description: Absolute path to scan for certificate files
4016 crtFile:
4017 type: string
4018 description: Absolute path to Certificate file
4019 debug:
4020 type: integer
4021 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
4022 enum:
4023 - 0
4024 - 1
4025 - 2
4026 - 3
4027 - 4
4028 format: int32
4029 keyFile:
4030 type: string
4031 description: Absolute path to private Key file
4032 keyPassword:
4033 type: object
4034 description: Optional password for tls.key_file file
4035 properties:
4036 valueFrom:
4037 type: object
4038 description: ValueSource defines how to find a value's key.
4039 properties:
4040 secretKeyRef:
4041 type: object
4042 description: Selects a key of a secret in the pod's namespace
4043 properties:
4044 name:
4045 type: string
4046 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4047 key:
4048 type: string
4049 description: The key of the secret to select from. Must be a valid secret key.
4050 optional:
4051 type: boolean
4052 description: Specify whether the Secret or its key must be defined
4053 required:
4054 - key
4055 x-kubernetes-map-type: atomic
4056 verify:
4057 type: boolean
4058 description: Force certificate validation
4059 vhost:
4060 type: string
4061 description: Hostname to be used for TLS SNI extension
4062 served: true
4063 storage: true
4064---
4065apiVersion: apiextensions.k8s.io/v1
4066kind: CustomResourceDefinition
4067metadata:
4068 name: clusteroutputs.fluentd.fluent.io
4069 annotations:
4070 controller-gen.kubebuilder.io/version: v0.11.3
4071 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
4072 pallet.edge.ncr.com/name: fluent-operator
4073 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
4074 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
4075 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
4076 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
4077spec:
4078 group: fluentd.fluent.io
4079 names:
4080 kind: ClusterOutput
4081 listKind: ClusterOutputList
4082 plural: clusteroutputs
4083 shortNames:
4084 - cfdo
4085 singular: clusteroutput
4086 scope: Cluster
4087 versions:
4088 - name: v1alpha1
4089 schema:
4090 openAPIV3Schema:
4091 type: object
4092 description: ClusterOutput is the Schema for the clusteroutputs API
4093 properties:
4094 apiVersion:
4095 type: string
4096 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'
4097 kind:
4098 type: string
4099 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'
4100 metadata:
4101 type: object
4102 spec:
4103 type: object
4104 description: ClusterOutputSpec defines the desired state of ClusterOutput
4105 properties:
4106 outputs:
4107 type: array
4108 items:
4109 type: object
4110 description: Output defines all available output plugins and their parameters
4111 properties:
4112 buffer:
4113 type: object
4114 description: buffer section
4115 properties:
4116 type:
4117 type: string
4118 description: The @type parameter specifies the type of the plugin.
4119 enum:
4120 - file
4121 - memory
4122 - file_single
4123 calcNumRecords:
4124 type: string
4125 description: Calculates the number of records, chunk size, during chunk resume.
4126 chunkFormat:
4127 type: string
4128 description: ChunkFormat specifies the chunk format for calc_num_records.
4129 enum:
4130 - msgpack
4131 - text
4132 - auto
4133 chunkLimitRecords:
4134 type: string
4135 description: The max number of events that each chunks can store in it.
4136 pattern: ^\d+(KB|MB|GB|TB)$
4137 chunkLimitSize:
4138 type: string
4139 description: 'Buffer parameters The max size of each chunks: events will be written into chunks until the size of chunks become this size Default: 8MB (memory) / 256MB (file)'
4140 pattern: ^\d+(KB|MB|GB|TB)$
4141 compress:
4142 type: string
4143 description: Fluentd will decompress these compressed chunks automatically before passing them to the output plugin If gzip is set, Fluentd compresses data records before writing to buffer chunks. Default:text.
4144 enum:
4145 - text
4146 - gzip
4147 delayedCommitTimeout:
4148 type: string
4149 description: The timeout (seconds) until output plugin decides if the async write operation has failed. Default is 60s
4150 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4151 disableChunkBackup:
4152 type: boolean
4153 description: Instead of storing unrecoverable chunks in the backup directory, just discard them. This option is new in Fluentd v1.2.6.
4154 flushAtShutdown:
4155 type: boolean
4156 description: Flush parameters This specifies whether to flush/write all buffer chunks on shutdown or not.
4157 flushInterval:
4158 type: string
4159 description: FlushInterval defines the flush interval
4160 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4161 flushMode:
4162 type: string
4163 description: 'FlushMode defines the flush mode: lazy: flushes/writes chunks once per timekey interval: flushes/writes chunks per specified time via flush_interval immediate: flushes/writes chunks immediately after events are appended into chunks default: equals to lazy if time is specified as chunk key, interval otherwise'
4164 enum:
4165 - default
4166 - lazy
4167 - interval
4168 - immediate
4169 flushThreadCount:
4170 type: string
4171 description: The number of threads to flush/write chunks in parallel
4172 pattern: ^\d+$
4173 id:
4174 type: string
4175 description: The @id parameter specifies a unique name for the configuration.
4176 localtime:
4177 type: boolean
4178 description: If true, uses local time.
4179 logLevel:
4180 type: string
4181 description: The @log_level parameter specifies the plugin-specific logging level
4182 overflowAction:
4183 type: string
4184 description: 'OverflowAtction defines the output plugin behave when its buffer queue is full. Default: throw_exception'
4185 path:
4186 type: string
4187 description: The path where buffer chunks are stored. This field would make no effect in memory buffer plugin.
4188 pathSuffix:
4189 type: string
4190 description: Changes the suffix of the buffer file.
4191 queueLimitLength:
4192 type: string
4193 description: 'The queue length limitation of this buffer plugin instance. Default: 0.95'
4194 pattern: ^\d+.?\d+$
4195 queuedChunksLimitSize:
4196 type: integer
4197 description: 'Limit the number of queued chunks. Default: 1 If a smaller flush_interval is set, e.g. 1s, there are lots of small queued chunks in the buffer. With file buffer, it may consume a lot of fd resources when output destination has a problem. This parameter mitigates such situations.'
4198 minimum: 1
4199 retryExponentialBackoffBase:
4200 type: string
4201 description: The base number of exponential backoff for retries.
4202 pattern: ^\d+(\.[0-9]{0,2})?$
4203 retryForever:
4204 type: boolean
4205 description: If true, plugin will ignore retry_timeout and retry_max_times options and retry flushing forever.
4206 retryMaxInterval:
4207 type: string
4208 description: The maximum interval (seconds) for exponential backoff between retries while failing
4209 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4210 retryMaxTimes:
4211 type: integer
4212 description: 'The maximum number of times to retry to flush the failed chunks. Default: none'
4213 retryRandomize:
4214 type: boolean
4215 description: If true, the output plugin will retry after randomized interval not to do burst retries
4216 retrySecondaryThreshold:
4217 type: string
4218 description: The ratio of retry_timeout to switch to use the secondary while failing.
4219 pattern: ^\d+.?\d+$
4220 retryTimeout:
4221 type: string
4222 description: Retry parameters The maximum time (seconds) to retry to flush again the failed chunks, until the plugin discards the buffer chunks
4223 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4224 retryType:
4225 type: string
4226 description: Output plugin will retry periodically with fixed intervals.
4227 retryWait:
4228 type: string
4229 description: Wait in seconds before the next retry to flush or constant factor of exponential backoff
4230 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4231 tag:
4232 type: string
4233 description: The output plugins group events into chunks. Chunk keys, specified as the argument of <buffer> section, control how to group events into chunks. If tag is empty, which means blank Chunk Keys. Tag also supports Nested Field, combination of Chunk Keys, placeholders, etc. See https://docs.fluentd.org/configuration/buffer-section.
4234 timeFormat:
4235 type: string
4236 description: Process value according to the specified format. This is available only when time_type is string
4237 timeFormatFallbacks:
4238 type: string
4239 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
4240 timeType:
4241 type: string
4242 description: parses/formats value according to this type, default is string
4243 enum:
4244 - float
4245 - unixtime
4246 - string
4247 - mixed
4248 timekey:
4249 type: string
4250 description: Output plugin will flush chunks per specified time (enabled when time is specified in chunk keys)
4251 timekeyWait:
4252 type: string
4253 description: Output plugin will write chunks after timekey_wait seconds later after timekey expiration
4254 timezone:
4255 type: string
4256 description: Uses the specified timezone.
4257 totalLimitSize:
4258 type: string
4259 description: 'The size limitation of this buffer plugin instance Default: 512MB (memory) / 64GB (file)'
4260 pattern: ^\d+(KB|MB|GB|TB)$
4261 utc:
4262 type: boolean
4263 description: If true, uses UTC.
4264 required:
4265 - type
4266 cloudWatch:
4267 type: object
4268 description: out_cloudwatch plugin
4269 properties:
4270 autoCreateStream:
4271 type: boolean
4272 awsEcsAuthentication:
4273 type: boolean
4274 awsKeyId:
4275 type: object
4276 description: Secret defines the key of a value.
4277 properties:
4278 valueFrom:
4279 type: object
4280 description: ValueSource defines how to find a value's key.
4281 properties:
4282 secretKeyRef:
4283 type: object
4284 description: Selects a key of a secret in the pod's namespace
4285 properties:
4286 name:
4287 type: string
4288 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4289 key:
4290 type: string
4291 description: The key of the secret to select from. Must be a valid secret key.
4292 optional:
4293 type: boolean
4294 description: Specify whether the Secret or its key must be defined
4295 required:
4296 - key
4297 x-kubernetes-map-type: atomic
4298 awsSecKey:
4299 type: object
4300 description: Secret defines the key of a value.
4301 properties:
4302 valueFrom:
4303 type: object
4304 description: ValueSource defines how to find a value's key.
4305 properties:
4306 secretKeyRef:
4307 type: object
4308 description: Selects a key of a secret in the pod's namespace
4309 properties:
4310 name:
4311 type: string
4312 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4313 key:
4314 type: string
4315 description: The key of the secret to select from. Must be a valid secret key.
4316 optional:
4317 type: boolean
4318 description: Specify whether the Secret or its key must be defined
4319 required:
4320 - key
4321 x-kubernetes-map-type: atomic
4322 awsStsDurationSeconds:
4323 type: string
4324 awsStsEndpointUrl:
4325 type: string
4326 awsStsExternalId:
4327 type: string
4328 awsStsPolicy:
4329 type: string
4330 awsStsRoleArn:
4331 type: string
4332 awsStsSessionName:
4333 type: string
4334 awsUseSts:
4335 type: boolean
4336 concurrency:
4337 type: integer
4338 durationSeconds:
4339 type: string
4340 endpoint:
4341 type: string
4342 description: Specify an AWS endpoint to send data to.
4343 httpProxy:
4344 type: string
4345 includeTimeKey:
4346 type: boolean
4347 jsonHandler:
4348 type: string
4349 localtime:
4350 type: boolean
4351 logGroupAwsTags:
4352 type: string
4353 logGroupAwsTagsKey:
4354 type: string
4355 logGroupName:
4356 type: string
4357 logGroupNameKey:
4358 type: string
4359 logRejectedRequest:
4360 type: string
4361 logStreamName:
4362 type: string
4363 logStreamNameKey:
4364 type: string
4365 maxEventsPerBatch:
4366 type: string
4367 maxMessageLength:
4368 type: string
4369 messageKeys:
4370 type: string
4371 policy:
4372 type: string
4373 putLogEventsDisableRetryLimit:
4374 type: boolean
4375 putLogEventsRetryLimit:
4376 type: string
4377 putLogEventsRetryWait:
4378 type: string
4379 region:
4380 type: string
4381 description: The AWS region.
4382 removeLogGroupAwsTagsKey:
4383 type: boolean
4384 removeLogGroupNameKey:
4385 type: boolean
4386 removeLogStreamNameKey:
4387 type: boolean
4388 removeRetentionInDaysKey:
4389 type: boolean
4390 retentionInDays:
4391 type: string
4392 retentionInDaysKey:
4393 type: string
4394 roleArn:
4395 type: string
4396 description: ARN of an IAM role to assume (for cross account access).
4397 roleSessionName:
4398 type: string
4399 description: Role Session name
4400 sslVerifyPeer:
4401 type: boolean
4402 useTagAsGroup:
4403 type: string
4404 useTagAsStream:
4405 type: string
4406 webIdentityTokenFile:
4407 type: string
4408 description: Web identity token file
4409 customPlugin:
4410 type: object
4411 description: Custom plugin type
4412 properties:
4413 config:
4414 type: string
4415 required:
4416 - config
4417 datadog:
4418 type: object
4419 description: datadog plugin
4420 properties:
4421 service:
4422 type: string
4423 description: Used by Datadog to correlate between logs, traces and metrics.
4424 port:
4425 type: integer
4426 description: Proxy port when logs are not directly forwarded to Datadog and ssl is not used
4427 format: int32
4428 maximum: 65535
4429 minimum: 1
4430 apiKey:
4431 type: object
4432 description: This parameter is required in order to authenticate your fluent agent.
4433 properties:
4434 valueFrom:
4435 type: object
4436 description: ValueSource defines how to find a value's key.
4437 properties:
4438 secretKeyRef:
4439 type: object
4440 description: Selects a key of a secret in the pod's namespace
4441 properties:
4442 name:
4443 type: string
4444 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4445 key:
4446 type: string
4447 description: The key of the secret to select from. Must be a valid secret key.
4448 optional:
4449 type: boolean
4450 description: Specify whether the Secret or its key must be defined
4451 required:
4452 - key
4453 x-kubernetes-map-type: atomic
4454 compressionLevel:
4455 type: integer
4456 description: Set the log compression level for HTTP (1 to 9, 9 being the best ratio)
4457 format: int32
4458 ddHostname:
4459 type: string
4460 description: Used by Datadog to identify the host submitting the logs.
4461 ddSource:
4462 type: string
4463 description: This tells Datadog what integration it is
4464 ddSourcecategory:
4465 type: string
4466 description: Multiple value attribute. Can be used to refine the source attribute
4467 ddTags:
4468 type: string
4469 description: Custom tags with the following format "key1:value1, key2:value2"
4470 host:
4471 type: string
4472 description: Proxy endpoint when logs are not directly forwarded to Datadog
4473 httpProxy:
4474 type: string
4475 description: HTTP proxy, only takes effect if HTTP forwarding is enabled (use_http). Defaults to HTTP_PROXY/http_proxy env vars.
4476 includeTagKey:
4477 type: boolean
4478 description: Automatically include the Fluentd tag in the record.
4479 maxBackoff:
4480 type: integer
4481 description: The maximum time waited between each retry in seconds
4482 format: int32
4483 maxRetries:
4484 type: integer
4485 description: The number of retries before the output plugin stops. Set to -1 for unlimited retries
4486 format: int32
4487 noSSLValidation:
4488 type: boolean
4489 description: Disable SSL validation (useful for proxy forwarding)
4490 sslPort:
4491 type: integer
4492 description: Port used to send logs over a SSL encrypted connection to Datadog. If use_http is disabled, use 10516 for the US region and 443 for the EU region.
4493 format: int32
4494 maximum: 65535
4495 minimum: 1
4496 tagKey:
4497 type: string
4498 description: Where to store the Fluentd tag.
4499 timestampKey:
4500 type: string
4501 description: Name of the attribute which will contain timestamp of the log event. If nil, timestamp attribute is not added.
4502 useCompression:
4503 type: boolean
4504 description: Enable log compression for HTTP
4505 useHTTP:
4506 type: boolean
4507 description: Enable HTTP forwarding. If you disable it, make sure to change the port to 10514 or ssl_port to 10516
4508 useJson:
4509 type: boolean
4510 description: Event format, if true, the event is sent in json format. Othwerwise, in plain text.
4511 useSSL:
4512 type: boolean
4513 description: If true, the agent initializes a secure connection to Datadog. In clear TCP otherwise.
4514 elasticsearch:
4515 type: object
4516 description: out_es plugin
4517 properties:
4518 port:
4519 type: integer
4520 description: 'The port number of your Elasticsearch node (default: 9200).'
4521 format: int32
4522 maximum: 65535
4523 minimum: 1
4524 host:
4525 type: string
4526 description: 'The hostname of your Elasticsearch node (default: localhost).'
4527 hosts:
4528 type: string
4529 description: Hosts defines a list of hosts if you want to connect to more than one Elasticsearch nodes
4530 indexName:
4531 type: string
4532 description: IndexName defines the placeholder syntax of Fluentd plugin API. See https://docs.fluentd.org/configuration/buffer-section.
4533 logstashFormat:
4534 type: boolean
4535 description: 'If true, Fluentd uses the conventional index name format logstash-%Y.%m.%d (default: false). This option supersedes the index_name option.'
4536 logstashPrefix:
4537 type: string
4538 description: 'LogstashPrefix defines the logstash prefix index name to write events when logstash_format is true (default: logstash).'
4539 password:
4540 type: object
4541 description: Optional, The login credentials to connect to Elasticsearch
4542 properties:
4543 valueFrom:
4544 type: object
4545 description: ValueSource defines how to find a value's key.
4546 properties:
4547 secretKeyRef:
4548 type: object
4549 description: Selects a key of a secret in the pod's namespace
4550 properties:
4551 name:
4552 type: string
4553 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4554 key:
4555 type: string
4556 description: The key of the secret to select from. Must be a valid secret key.
4557 optional:
4558 type: boolean
4559 description: Specify whether the Secret or its key must be defined
4560 required:
4561 - key
4562 x-kubernetes-map-type: atomic
4563 path:
4564 type: string
4565 description: 'Path defines the REST API endpoint of Elasticsearch to post write requests (default: nil).'
4566 scheme:
4567 type: string
4568 description: 'Specify https if your Elasticsearch endpoint supports SSL (default: http).'
4569 user:
4570 type: object
4571 description: Optional, The login credentials to connect to Elasticsearch
4572 properties:
4573 valueFrom:
4574 type: object
4575 description: ValueSource defines how to find a value's key.
4576 properties:
4577 secretKeyRef:
4578 type: object
4579 description: Selects a key of a secret in the pod's namespace
4580 properties:
4581 name:
4582 type: string
4583 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4584 key:
4585 type: string
4586 description: The key of the secret to select from. Must be a valid secret key.
4587 optional:
4588 type: boolean
4589 description: Specify whether the Secret or its key must be defined
4590 required:
4591 - key
4592 x-kubernetes-map-type: atomic
4593 format:
4594 type: object
4595 description: format section
4596 properties:
4597 type:
4598 type: string
4599 description: The @type parameter specifies the type of the plugin.
4600 enum:
4601 - out_file
4602 - json
4603 - ltsv
4604 - csv
4605 - msgpack
4606 - hash
4607 - single_value
4608 delimiter:
4609 type: string
4610 description: Delimiter for each field.
4611 id:
4612 type: string
4613 description: The @id parameter specifies a unique name for the configuration.
4614 localtime:
4615 type: boolean
4616 description: If true, uses local time.
4617 logLevel:
4618 type: string
4619 description: The @log_level parameter specifies the plugin-specific logging level
4620 newline:
4621 type: string
4622 description: Specify newline characters.
4623 enum:
4624 - lf
4625 - crlf
4626 outputTag:
4627 type: boolean
4628 description: Output tag field if true.
4629 outputTime:
4630 type: boolean
4631 description: Output time field if true.
4632 timeFormat:
4633 type: string
4634 description: Process value according to the specified format. This is available only when time_type is string
4635 timeFormatFallbacks:
4636 type: string
4637 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
4638 timeType:
4639 type: string
4640 description: parses/formats value according to this type, default is string
4641 enum:
4642 - float
4643 - unixtime
4644 - string
4645 - mixed
4646 timezone:
4647 type: string
4648 description: Uses the specified timezone.
4649 utc:
4650 type: boolean
4651 description: If true, uses UTC.
4652 forward:
4653 type: object
4654 description: out_forward plugin
4655 properties:
4656 ackResponseTimeout:
4657 type: string
4658 description: This option is used when require_ack_response is true. This default value is based on popular tcp_syn_retries.
4659 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4660 connectTimeout:
4661 type: string
4662 description: The connection timeout for the socket. When the connection is timed out during the connection establishment, Errno::ETIMEDOUT error is raised.
4663 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4664 dnsRoundRobin:
4665 type: boolean
4666 description: Enable client-side DNS round robin. Uniform randomly pick an IP address to send data when a hostname has several IP addresses. heartbeat_type udp is not available with dns_round_robintrue. Use heartbeat_type tcp or heartbeat_type none.
4667 expireDnsCache:
4668 type: string
4669 description: Sets TTL to expire DNS cache in seconds. Set 0 not to use DNS Cache.
4670 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4671 hardTimeout:
4672 type: string
4673 description: The hard timeout used to detect server failure. The default value is equal to the send_timeout parameter.
4674 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4675 heartbeatInterval:
4676 type: string
4677 description: The interval of the heartbeat packer.
4678 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4679 heartbeatType:
4680 type: string
4681 description: Specifies the transport protocol for heartbeats. Set none to disable.
4682 enum:
4683 - transport
4684 - tcp
4685 - udp
4686 - none
4687 ignoreNetworkErrorsAtStartup:
4688 type: boolean
4689 description: Ignores DNS resolution and errors at startup time.
4690 keepalive:
4691 type: boolean
4692 description: Enables the keepalive connection.
4693 keepaliveTimeout:
4694 type: string
4695 description: Timeout for keepalive. Default value is nil which means to keep the connection alive as long as possible.
4696 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4697 phiFailureDetector:
4698 type: boolean
4699 description: Use the "Phi accrual failure detector" to detect server failure.
4700 phiThreshold:
4701 type: integer
4702 description: The threshold parameter used to detect server faults.
4703 recoverWait:
4704 type: string
4705 description: The wait time before accepting a server fault recovery.
4706 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4707 requireAckResponse:
4708 type: boolean
4709 description: Changes the protocol to at-least-once. The plugin waits the ack from destination's in_forward plugin.
4710 security:
4711 type: object
4712 description: ServiceDiscovery defines the security section
4713 properties:
4714 allowAnonymousSource:
4715 type: string
4716 description: Allows the anonymous source. <client> sections are required, if disabled.
4717 selfHostname:
4718 type: string
4719 description: The hostname.
4720 sharedKey:
4721 type: string
4722 description: The shared key for authentication.
4723 user:
4724 type: object
4725 description: Defines user section directly.
4726 properties:
4727 password:
4728 type: object
4729 description: Secret defines the key of a value.
4730 properties:
4731 valueFrom:
4732 type: object
4733 description: ValueSource defines how to find a value's key.
4734 properties:
4735 secretKeyRef:
4736 type: object
4737 description: Selects a key of a secret in the pod's namespace
4738 properties:
4739 name:
4740 type: string
4741 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4742 key:
4743 type: string
4744 description: The key of the secret to select from. Must be a valid secret key.
4745 optional:
4746 type: boolean
4747 description: Specify whether the Secret or its key must be defined
4748 required:
4749 - key
4750 x-kubernetes-map-type: atomic
4751 username:
4752 type: object
4753 description: Secret defines the key of a value.
4754 properties:
4755 valueFrom:
4756 type: object
4757 description: ValueSource defines how to find a value's key.
4758 properties:
4759 secretKeyRef:
4760 type: object
4761 description: Selects a key of a secret in the pod's namespace
4762 properties:
4763 name:
4764 type: string
4765 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4766 key:
4767 type: string
4768 description: The key of the secret to select from. Must be a valid secret key.
4769 optional:
4770 type: boolean
4771 description: Specify whether the Secret or its key must be defined
4772 required:
4773 - key
4774 x-kubernetes-map-type: atomic
4775 userAuth:
4776 type: string
4777 description: If true, user-based authentication is used.
4778 sendTimeout:
4779 type: string
4780 description: The timeout time when sending event logs.
4781 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
4782 servers:
4783 type: array
4784 description: Servers defines the servers section, at least one is required
4785 items:
4786 type: object
4787 description: Server defines the common parameters for the server plugin
4788 properties:
4789 name:
4790 type: string
4791 description: Name defines the name of the server. Used for logging and certificate verification in TLS transport (when the host is the address).
4792 type:
4793 type: string
4794 description: The @type parameter specifies the type of the plugin.
4795 port:
4796 type: string
4797 description: Port defines the port number of the host. Note that both TCP packets (event stream) and UDP packets (heartbeat messages) are sent to this port.
4798 host:
4799 type: string
4800 description: Host defines the IP address or host name of the server.
4801 id:
4802 type: string
4803 description: The @id parameter specifies a unique name for the configuration.
4804 logLevel:
4805 type: string
4806 description: The @log_level parameter specifies the plugin-specific logging level
4807 password:
4808 type: object
4809 description: Password defines the password for authentication.
4810 properties:
4811 valueFrom:
4812 type: object
4813 description: ValueSource defines how to find a value's key.
4814 properties:
4815 secretKeyRef:
4816 type: object
4817 description: Selects a key of a secret in the pod's namespace
4818 properties:
4819 name:
4820 type: string
4821 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4822 key:
4823 type: string
4824 description: The key of the secret to select from. Must be a valid secret key.
4825 optional:
4826 type: boolean
4827 description: Specify whether the Secret or its key must be defined
4828 required:
4829 - key
4830 x-kubernetes-map-type: atomic
4831 sharedKey:
4832 type: string
4833 description: SharedKey defines the shared key per server.
4834 standby:
4835 type: string
4836 description: Standby marks a node as the standby node for an Active-Standby model between Fluentd nodes.
4837 username:
4838 type: object
4839 description: Username defines the username for authentication.
4840 properties:
4841 valueFrom:
4842 type: object
4843 description: ValueSource defines how to find a value's key.
4844 properties:
4845 secretKeyRef:
4846 type: object
4847 description: Selects a key of a secret in the pod's namespace
4848 properties:
4849 name:
4850 type: string
4851 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4852 key:
4853 type: string
4854 description: The key of the secret to select from. Must be a valid secret key.
4855 optional:
4856 type: boolean
4857 description: Specify whether the Secret or its key must be defined
4858 required:
4859 - key
4860 x-kubernetes-map-type: atomic
4861 weight:
4862 type: string
4863 description: Weight defines the load balancing weight
4864 serviceDiscovery:
4865 type: object
4866 description: ServiceDiscovery defines the service_discovery section
4867 properties:
4868 type:
4869 type: string
4870 description: The @type parameter specifies the type of the plugin.
4871 enum:
4872 - static
4873 - file
4874 - srv
4875 service:
4876 type: string
4877 description: Service without the underscore in RFC2782.
4878 hostname:
4879 type: string
4880 description: The name in RFC2782.
4881 confEncoding:
4882 type: string
4883 description: The encoding of the configuration file.
4884 dnsLookup:
4885 type: string
4886 description: DnsLookup resolves the hostname to IP address of the SRV's Target.
4887 dnsServerHost:
4888 type: string
4889 description: DnsServerHost defines the hostname of the DNS server to request the SRV record.
4890 id:
4891 type: string
4892 description: The @id parameter specifies a unique name for the configuration.
4893 interval:
4894 type: string
4895 description: Interval defines the interval of sending requests to DNS server.
4896 logLevel:
4897 type: string
4898 description: The @log_level parameter specifies the plugin-specific logging level
4899 path:
4900 type: string
4901 description: The path of the target list. Default is '/etc/fluent/sd.yaml'
4902 proto:
4903 type: string
4904 description: Proto without the underscore in RFC2782.
4905 server:
4906 type: object
4907 description: The server section of this plugin
4908 properties:
4909 name:
4910 type: string
4911 description: Name defines the name of the server. Used for logging and certificate verification in TLS transport (when the host is the address).
4912 type:
4913 type: string
4914 description: The @type parameter specifies the type of the plugin.
4915 port:
4916 type: string
4917 description: Port defines the port number of the host. Note that both TCP packets (event stream) and UDP packets (heartbeat messages) are sent to this port.
4918 host:
4919 type: string
4920 description: Host defines the IP address or host name of the server.
4921 id:
4922 type: string
4923 description: The @id parameter specifies a unique name for the configuration.
4924 logLevel:
4925 type: string
4926 description: The @log_level parameter specifies the plugin-specific logging level
4927 password:
4928 type: object
4929 description: Password defines the password for authentication.
4930 properties:
4931 valueFrom:
4932 type: object
4933 description: ValueSource defines how to find a value's key.
4934 properties:
4935 secretKeyRef:
4936 type: object
4937 description: Selects a key of a secret in the pod's namespace
4938 properties:
4939 name:
4940 type: string
4941 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4942 key:
4943 type: string
4944 description: The key of the secret to select from. Must be a valid secret key.
4945 optional:
4946 type: boolean
4947 description: Specify whether the Secret or its key must be defined
4948 required:
4949 - key
4950 x-kubernetes-map-type: atomic
4951 sharedKey:
4952 type: string
4953 description: SharedKey defines the shared key per server.
4954 standby:
4955 type: string
4956 description: Standby marks a node as the standby node for an Active-Standby model between Fluentd nodes.
4957 username:
4958 type: object
4959 description: Username defines the username for authentication.
4960 properties:
4961 valueFrom:
4962 type: object
4963 description: ValueSource defines how to find a value's key.
4964 properties:
4965 secretKeyRef:
4966 type: object
4967 description: Selects a key of a secret in the pod's namespace
4968 properties:
4969 name:
4970 type: string
4971 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
4972 key:
4973 type: string
4974 description: The key of the secret to select from. Must be a valid secret key.
4975 optional:
4976 type: boolean
4977 description: Specify whether the Secret or its key must be defined
4978 required:
4979 - key
4980 x-kubernetes-map-type: atomic
4981 weight:
4982 type: string
4983 description: Weight defines the load balancing weight
4984 required:
4985 - type
4986 tlsAllowSelfSignedCert:
4987 type: boolean
4988 description: Allows self-signed certificates or not.
4989 tlsCertLogicalStoreName:
4990 type: string
4991 description: The certificate logical store name on Windows system certstore. This parameter is for Windows only.
4992 tlsCertPath:
4993 type: string
4994 description: The additional CA certificate path for TLS.
4995 tlsCertThumbprint:
4996 type: string
4997 description: The certificate thumbprint for searching from Windows system certstore. This parameter is for Windows only.
4998 tlsCertUseEnterpriseStore:
4999 type: boolean
5000 description: Enables the certificate enterprise store on Windows system certstore. This parameter is for Windows only.
5001 tlsCiphers:
5002 type: string
5003 description: The cipher configuration of TLS transport.
5004 tlsClientCertPath:
5005 type: string
5006 description: The client certificate path for TLS.
5007 tlsClientPrivateKeyPassphrase:
5008 type: string
5009 description: The TLS private key passphrase for the client.
5010 tlsClientPrivateKeyPath:
5011 type: string
5012 description: The client private key path for TLS.
5013 tlsInsecureMode:
5014 type: boolean
5015 description: Skips all verification of certificates or not.
5016 tlsVerifyHostname:
5017 type: boolean
5018 description: Verifies hostname of servers and certificates or not in TLS transport.
5019 tlsVersion:
5020 type: string
5021 description: The default version of TLS transport.
5022 enum:
5023 - TLSv1_1
5024 - TLSv1_2
5025 verifyConnectionAtStartup:
5026 type: boolean
5027 description: Verify that a connection can be made with one of out_forward nodes at the time of startup.
5028 required:
5029 - servers
5030 http:
5031 type: object
5032 description: out_http plugin
5033 properties:
5034 auth:
5035 type: object
5036 description: Auth section for this plugin
5037 properties:
5038 auth:
5039 type: string
5040 description: The method for HTTP authentication. Now only basic.
5041 password:
5042 type: object
5043 description: The password for basic authentication.
5044 properties:
5045 valueFrom:
5046 type: object
5047 description: ValueSource defines how to find a value's key.
5048 properties:
5049 secretKeyRef:
5050 type: object
5051 description: Selects a key of a secret in the pod's namespace
5052 properties:
5053 name:
5054 type: string
5055 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5056 key:
5057 type: string
5058 description: The key of the secret to select from. Must be a valid secret key.
5059 optional:
5060 type: boolean
5061 description: Specify whether the Secret or its key must be defined
5062 required:
5063 - key
5064 x-kubernetes-map-type: atomic
5065 username:
5066 type: object
5067 description: The username for basic authentication.
5068 properties:
5069 valueFrom:
5070 type: object
5071 description: ValueSource defines how to find a value's key.
5072 properties:
5073 secretKeyRef:
5074 type: object
5075 description: Selects a key of a secret in the pod's namespace
5076 properties:
5077 name:
5078 type: string
5079 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5080 key:
5081 type: string
5082 description: The key of the secret to select from. Must be a valid secret key.
5083 optional:
5084 type: boolean
5085 description: Specify whether the Secret or its key must be defined
5086 required:
5087 - key
5088 x-kubernetes-map-type: atomic
5089 contentType:
5090 type: string
5091 description: ContentType defines Content-Type for HTTP request. out_http automatically set Content-Type for built-in formatters when this parameter is not specified.
5092 endpoint:
5093 type: string
5094 description: Endpoint defines the endpoint for HTTP request. If you want to use HTTPS, use https prefix.
5095 errorResponseAsUnrecoverable:
5096 type: boolean
5097 description: Raise UnrecoverableError when the response code is not SUCCESS.
5098 headers:
5099 type: string
5100 description: Headers defines the additional headers for HTTP request.
5101 headersFromPlaceholders:
5102 type: string
5103 description: Additional placeholder based headers for HTTP request. If you want to use tag or record field, use this parameter instead of headers.
5104 httpMethod:
5105 type: string
5106 description: HttpMethod defines the method for HTTP request.
5107 enum:
5108 - post
5109 - put
5110 jsonArray:
5111 type: boolean
5112 description: JsonArray defines whether to use the array format of JSON or not
5113 openTimeout:
5114 type: integer
5115 description: OpenTimeout defines the connection open timeout in seconds.
5116 proxy:
5117 type: string
5118 description: Proxy defines the proxy for HTTP request.
5119 readTimeout:
5120 type: integer
5121 description: ReadTimeout defines the read timeout in seconds.
5122 retryableResponseCodes:
5123 type: string
5124 description: The list of retryable response codes. If the response code is included in this list, out_http retries the buffer flush.
5125 sslTimeout:
5126 type: integer
5127 description: SslTimeout defines the TLS timeout in seconds.
5128 tlsCaCertPath:
5129 type: string
5130 description: TlsCaCertPath defines the CA certificate path for TLS.
5131 tlsCiphers:
5132 type: string
5133 description: TlsCiphers defines the cipher suites configuration of TLS.
5134 tlsClientCertPath:
5135 type: string
5136 description: TlsClientCertPath defines the client certificate path for TLS.
5137 tlsPrivateKeyPassphrase:
5138 type: string
5139 description: TlsPrivateKeyPassphrase defines the client private key passphrase for TLS.
5140 tlsPrivateKeyPath:
5141 type: string
5142 description: TlsPrivateKeyPath defines the client private key path for TLS.
5143 tlsVerifyMode:
5144 type: string
5145 description: TlsVerifyMode defines the verify mode of TLS.
5146 enum:
5147 - peer
5148 - none
5149 tlsVersion:
5150 type: string
5151 description: TlsVersion defines the default version of TLS transport.
5152 enum:
5153 - TLSv1_1
5154 - TLSv1_2
5155 inject:
5156 type: object
5157 description: inject section
5158 properties:
5159 hostname:
5160 type: string
5161 description: Hostname value
5162 hostnameKey:
5163 type: string
5164 description: The field name to inject hostname
5165 inline:
5166 type: object
5167 description: Time section
5168 properties:
5169 localtime:
5170 type: boolean
5171 description: If true, uses local time.
5172 timeFormat:
5173 type: string
5174 description: Process value according to the specified format. This is available only when time_type is string
5175 timeFormatFallbacks:
5176 type: string
5177 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
5178 timeType:
5179 type: string
5180 description: parses/formats value according to this type, default is string
5181 enum:
5182 - float
5183 - unixtime
5184 - string
5185 - mixed
5186 timezone:
5187 type: string
5188 description: Uses the specified timezone.
5189 utc:
5190 type: boolean
5191 description: If true, uses UTC.
5192 tagKey:
5193 type: string
5194 description: The field name to inject tag
5195 timeKey:
5196 type: string
5197 description: The field name to inject time
5198 workerIdKey:
5199 type: string
5200 description: The field name to inject worker_id
5201 kafka:
5202 type: object
5203 description: out_kafka plugin
5204 properties:
5205 brokers:
5206 type: string
5207 description: 'The list of all seed brokers, with their host and port information. Default: localhost:9092'
5208 compressionCodec:
5209 type: string
5210 description: 'The codec the producer uses to compress messages (default: nil).'
5211 enum:
5212 - gzip
5213 - snappy
5214 defaultTopic:
5215 type: string
5216 description: 'The name of the default topic. (default: nil)'
5217 requiredAcks:
5218 type: integer
5219 description: The number of acks required per request.
5220 topicKey:
5221 type: string
5222 description: The field name for the target topic. If the field value is app, this plugin writes events to the app topic.
5223 useEventTime:
5224 type: boolean
5225 description: Set fluentd event time to Kafka's CreateTime.
5226 logLevel:
5227 type: string
5228 description: The @log_level parameter specifies the plugin-specific logging level
5229 loki:
5230 type: object
5231 description: out_loki plugin
5232 properties:
5233 labels:
5234 type: array
5235 description: Stream labels for API request. It can be multiple comma separated of strings specifying key=value pairs. In addition to fixed parameters, it also allows to add custom record keys (similar to label_keys property).
5236 items:
5237 type: string
5238 dropSingleKey:
5239 type: boolean
5240 description: If a record only has 1 key, then just set the log line to the value and discard the key.
5241 extractKubernetesLabels:
5242 type: boolean
5243 description: If set to true, it will add all Kubernetes labels to the Stream labels.
5244 httpPassword:
5245 type: object
5246 description: Password for user defined in HTTP_User Set HTTP basic authentication password
5247 properties:
5248 valueFrom:
5249 type: object
5250 description: ValueSource defines how to find a value's key.
5251 properties:
5252 secretKeyRef:
5253 type: object
5254 description: Selects a key of a secret in the pod's namespace
5255 properties:
5256 name:
5257 type: string
5258 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5259 key:
5260 type: string
5261 description: The key of the secret to select from. Must be a valid secret key.
5262 optional:
5263 type: boolean
5264 description: Specify whether the Secret or its key must be defined
5265 required:
5266 - key
5267 x-kubernetes-map-type: atomic
5268 httpUser:
5269 type: object
5270 description: Set HTTP basic authentication user name.
5271 properties:
5272 valueFrom:
5273 type: object
5274 description: ValueSource defines how to find a value's key.
5275 properties:
5276 secretKeyRef:
5277 type: object
5278 description: Selects a key of a secret in the pod's namespace
5279 properties:
5280 name:
5281 type: string
5282 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5283 key:
5284 type: string
5285 description: The key of the secret to select from. Must be a valid secret key.
5286 optional:
5287 type: boolean
5288 description: Specify whether the Secret or its key must be defined
5289 required:
5290 - key
5291 x-kubernetes-map-type: atomic
5292 includeThreadLabel:
5293 type: boolean
5294 description: Whether or not to include the fluentd_thread label when multiple threads are used for flushing
5295 insecure:
5296 type: boolean
5297 description: Disable certificate validation
5298 labelKeys:
5299 type: array
5300 description: Optional list of record keys that will be placed as stream labels. This configuration property is for records key only.
5301 items:
5302 type: string
5303 lineFormat:
5304 type: string
5305 description: Format to use when flattening the record to a log line. Valid values are json or key_value. If set to json, the log line sent to Loki will be the Fluentd record dumped as JSON. If set to key_value, the log line will be each item in the record concatenated together (separated by a single space) in the format.
5306 enum:
5307 - json
5308 - key_value
5309 removeKeys:
5310 type: array
5311 description: Optional list of record keys that will be removed from stream labels. This configuration property is for records key only.
5312 items:
5313 type: string
5314 tenantID:
5315 type: object
5316 description: Tenant ID used by default to push logs to Loki. If omitted or empty it assumes Loki is running in single-tenant mode and no X-Scope-OrgID header is sent.
5317 properties:
5318 valueFrom:
5319 type: object
5320 description: ValueSource defines how to find a value's key.
5321 properties:
5322 secretKeyRef:
5323 type: object
5324 description: Selects a key of a secret in the pod's namespace
5325 properties:
5326 name:
5327 type: string
5328 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5329 key:
5330 type: string
5331 description: The key of the secret to select from. Must be a valid secret key.
5332 optional:
5333 type: boolean
5334 description: Specify whether the Secret or its key must be defined
5335 required:
5336 - key
5337 x-kubernetes-map-type: atomic
5338 tlsCaCertFile:
5339 type: string
5340 description: TlsCaCert defines the CA certificate file for TLS.
5341 tlsClientCertFile:
5342 type: string
5343 description: TlsClientCert defines the client certificate file for TLS.
5344 tlsPrivateKeyFile:
5345 type: string
5346 description: TlsPrivateKey defines the client private key file for TLS.
5347 url:
5348 type: string
5349 description: Loki URL.
5350 required:
5351 - url
5352 opensearch:
5353 type: object
5354 description: out_opensearch plugin
5355 properties:
5356 port:
5357 type: integer
5358 description: 'The port number of your Opensearch node (default: 9200).'
5359 format: int32
5360 maximum: 65535
5361 minimum: 1
5362 host:
5363 type: string
5364 description: 'The hostname of your Opensearch node (default: localhost).'
5365 hosts:
5366 type: string
5367 description: Hosts defines a list of hosts if you want to connect to more than one Openearch nodes
5368 indexName:
5369 type: string
5370 description: IndexName defines the placeholder syntax of Fluentd plugin API. See https://docs.fluentd.org/configuration/buffer-section.
5371 logstashFormat:
5372 type: boolean
5373 description: 'If true, Fluentd uses the conventional index name format logstash-%Y.%m.%d (default: false). This option supersedes the index_name option.'
5374 logstashPrefix:
5375 type: string
5376 description: 'LogstashPrefix defines the logstash prefix index name to write events when logstash_format is true (default: logstash).'
5377 password:
5378 type: object
5379 description: Optional, The login credentials to connect to Opensearch
5380 properties:
5381 valueFrom:
5382 type: object
5383 description: ValueSource defines how to find a value's key.
5384 properties:
5385 secretKeyRef:
5386 type: object
5387 description: Selects a key of a secret in the pod's namespace
5388 properties:
5389 name:
5390 type: string
5391 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5392 key:
5393 type: string
5394 description: The key of the secret to select from. Must be a valid secret key.
5395 optional:
5396 type: boolean
5397 description: Specify whether the Secret or its key must be defined
5398 required:
5399 - key
5400 x-kubernetes-map-type: atomic
5401 path:
5402 type: string
5403 description: 'Path defines the REST API endpoint of Opensearch to post write requests (default: nil).'
5404 scheme:
5405 type: string
5406 description: 'Specify https if your Opensearch endpoint supports SSL (default: http).'
5407 user:
5408 type: object
5409 description: Optional, The login credentials to connect to Opensearch
5410 properties:
5411 valueFrom:
5412 type: object
5413 description: ValueSource defines how to find a value's key.
5414 properties:
5415 secretKeyRef:
5416 type: object
5417 description: Selects a key of a secret in the pod's namespace
5418 properties:
5419 name:
5420 type: string
5421 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5422 key:
5423 type: string
5424 description: The key of the secret to select from. Must be a valid secret key.
5425 optional:
5426 type: boolean
5427 description: Specify whether the Secret or its key must be defined
5428 required:
5429 - key
5430 x-kubernetes-map-type: atomic
5431 s3:
5432 type: object
5433 description: out_s3 plugin
5434 properties:
5435 awsKeyId:
5436 type: string
5437 description: The AWS access key id.
5438 awsSecKey:
5439 type: string
5440 description: The AWS secret key.
5441 path:
5442 type: string
5443 description: The path prefix of the files on S3.
5444 proxyUri:
5445 type: string
5446 description: The proxy URL.
5447 s3Bucket:
5448 type: string
5449 description: The Amazon S3 bucket name.
5450 s3ObjectKeyFormat:
5451 type: string
5452 description: The actual S3 path. This is interpolated to the actual path.
5453 s3Region:
5454 type: string
5455 description: The Amazon S3 region name
5456 sslVerifyPeer:
5457 type: boolean
5458 description: Verify the SSL certificate of the endpoint.
5459 storeAs:
5460 type: string
5461 description: The compression type.
5462 enum:
5463 - gzip
5464 - lzo
5465 - json
5466 - txt
5467 stdout:
5468 type: object
5469 description: out_stdout plugin
5470 tag:
5471 type: string
5472 description: Which tag to be matched.
5473 status:
5474 type: object
5475 description: ClusterOutputStatus defines the observed state of ClusterOutput
5476 served: true
5477 storage: true
5478 subresources:
5479 status: {}
5480---
5481apiVersion: apiextensions.k8s.io/v1
5482kind: CustomResourceDefinition
5483metadata:
5484 name: clusterparsers.fluentbit.fluent.io
5485 annotations:
5486 controller-gen.kubebuilder.io/version: v0.11.3
5487 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
5488 pallet.edge.ncr.com/name: fluent-operator
5489 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
5490 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
5491 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
5492 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
5493spec:
5494 group: fluentbit.fluent.io
5495 names:
5496 kind: ClusterParser
5497 listKind: ClusterParserList
5498 plural: clusterparsers
5499 shortNames:
5500 - cfbp
5501 singular: clusterparser
5502 scope: Cluster
5503 versions:
5504 - name: v1alpha2
5505 schema:
5506 openAPIV3Schema:
5507 type: object
5508 description: ClusterParser is the Schema for the cluster-level parsers API
5509 properties:
5510 apiVersion:
5511 type: string
5512 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'
5513 kind:
5514 type: string
5515 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'
5516 metadata:
5517 type: object
5518 spec:
5519 type: object
5520 description: ParserSpec defines the desired state of ClusterParser
5521 properties:
5522 decoders:
5523 type: array
5524 description: 'Decoders are a built-in feature available through the Parsers file, each Parser definition can optionally set one or multiple decoders. There are two type of decoders type: Decode_Field and Decode_Field_As.'
5525 items:
5526 type: object
5527 properties:
5528 decodeField:
5529 type: string
5530 description: If the content can be decoded in a structured message, append that structure message (keys and values) to the original log message.
5531 decodeFieldAs:
5532 type: string
5533 description: Any content decoded (unstructured or structured) will be replaced in the same key/value, no extra keys are added.
5534 json:
5535 type: object
5536 description: JSON defines json parser configuration.
5537 properties:
5538 timeFormat:
5539 type: string
5540 description: Time_Format, eg. %Y-%m-%dT%H:%M:%S %z
5541 timeKeep:
5542 type: boolean
5543 description: Time_Keep
5544 timeKey:
5545 type: string
5546 description: Time_Key
5547 logfmt:
5548 type: object
5549 description: Logfmt defines logfmt parser configuration.
5550 ltsv:
5551 type: object
5552 description: LTSV defines ltsv parser configuration.
5553 properties:
5554 timeFormat:
5555 type: string
5556 description: Time_Format, eg. %Y-%m-%dT%H:%M:%S %z
5557 timeKeep:
5558 type: boolean
5559 description: Time_Keep
5560 timeKey:
5561 type: string
5562 description: Time_Key
5563 types:
5564 type: string
5565 regex:
5566 type: object
5567 description: Regex defines regex parser configuration.
5568 properties:
5569 regex:
5570 type: string
5571 timeFormat:
5572 type: string
5573 description: Time_Format, eg. %Y-%m-%dT%H:%M:%S %z
5574 timeKeep:
5575 type: boolean
5576 description: Time_Keep
5577 timeKey:
5578 type: string
5579 description: Time_Key
5580 timeOffset:
5581 type: string
5582 description: Time_Offset, eg. +0200
5583 types:
5584 type: string
5585 served: true
5586 storage: true
5587---
5588apiVersion: apiextensions.k8s.io/v1
5589kind: CustomResourceDefinition
5590metadata:
5591 name: collectors.fluentbit.fluent.io
5592 annotations:
5593 controller-gen.kubebuilder.io/version: v0.11.3
5594 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
5595 pallet.edge.ncr.com/name: fluent-operator
5596 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
5597 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
5598 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
5599 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
5600spec:
5601 group: fluentbit.fluent.io
5602 names:
5603 kind: Collector
5604 listKind: CollectorList
5605 plural: collectors
5606 shortNames:
5607 - co
5608 singular: collector
5609 scope: Namespaced
5610 versions:
5611 - name: v1alpha2
5612 schema:
5613 openAPIV3Schema:
5614 type: object
5615 description: Collector is the Schema for the fluentbits API
5616 properties:
5617 apiVersion:
5618 type: string
5619 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'
5620 kind:
5621 type: string
5622 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'
5623 metadata:
5624 type: object
5625 spec:
5626 type: object
5627 description: CollectorSpec defines the desired state of FluentBit
5628 properties:
5629 annotations:
5630 type: object
5631 additionalProperties:
5632 type: string
5633 description: Annotations to add to each Fluentbit pod.
5634 service:
5635 type: object
5636 description: Service represents configurations on the fluent-bit service.
5637 properties:
5638 name:
5639 type: string
5640 description: Name is the name of the FluentBit service.
5641 labels:
5642 type: object
5643 additionalProperties:
5644 type: string
5645 description: Labels to add to each FluentBit service
5646 annotations:
5647 type: object
5648 additionalProperties:
5649 type: string
5650 description: Annotations to add to each Fluentbit service.
5651 hostNetwork:
5652 type: boolean
5653 description: Host networking is requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
5654 schedulerName:
5655 type: string
5656 description: SchedulerName represents the desired scheduler for the Fluentbit collector pods
5657 priorityClassName:
5658 type: string
5659 description: PriorityClassName represents the pod's priority class.
5660 runtimeClassName:
5661 type: string
5662 description: RuntimeClassName represents the container runtime configuration.
5663 nodeSelector:
5664 type: object
5665 additionalProperties:
5666 type: string
5667 description: NodeSelector
5668 volumes:
5669 type: array
5670 description: List of volumes that can be mounted by containers belonging to the pod.
5671 items:
5672 type: object
5673 description: Volume represents a named volume in a pod that may be accessed by any container in the pod.
5674 properties:
5675 name:
5676 type: string
5677 description: 'name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
5678 awsElasticBlockStore:
5679 type: object
5680 description: 'awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
5681 properties:
5682 readOnly:
5683 type: boolean
5684 description: 'readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
5685 fsType:
5686 type: string
5687 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine'
5688 partition:
5689 type: integer
5690 description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).'
5691 format: int32
5692 volumeID:
5693 type: string
5694 description: 'volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
5695 required:
5696 - volumeID
5697 azureDisk:
5698 type: object
5699 description: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
5700 properties:
5701 kind:
5702 type: string
5703 description: 'kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared'
5704 readOnly:
5705 type: boolean
5706 description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
5707 cachingMode:
5708 type: string
5709 description: 'cachingMode is the Host Caching mode: None, Read Only, Read Write.'
5710 diskName:
5711 type: string
5712 description: diskName is the Name of the data disk in the blob storage
5713 diskURI:
5714 type: string
5715 description: diskURI is the URI of data disk in the blob storage
5716 fsType:
5717 type: string
5718 description: fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
5719 required:
5720 - diskName
5721 - diskURI
5722 azureFile:
5723 type: object
5724 description: azureFile represents an Azure File Service mount on the host and bind mount to the pod.
5725 properties:
5726 readOnly:
5727 type: boolean
5728 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
5729 secretName:
5730 type: string
5731 description: secretName is the name of secret that contains Azure Storage Account Name and Key
5732 shareName:
5733 type: string
5734 description: shareName is the azure share Name
5735 required:
5736 - secretName
5737 - shareName
5738 cephfs:
5739 type: object
5740 description: cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
5741 properties:
5742 readOnly:
5743 type: boolean
5744 description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
5745 secretRef:
5746 type: object
5747 description: 'secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
5748 properties:
5749 name:
5750 type: string
5751 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5752 x-kubernetes-map-type: atomic
5753 monitors:
5754 type: array
5755 description: 'monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
5756 items:
5757 type: string
5758 path:
5759 type: string
5760 description: 'path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
5761 secretFile:
5762 type: string
5763 description: 'secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
5764 user:
5765 type: string
5766 description: 'user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
5767 required:
5768 - monitors
5769 cinder:
5770 type: object
5771 description: 'cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
5772 properties:
5773 readOnly:
5774 type: boolean
5775 description: 'readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
5776 secretRef:
5777 type: object
5778 description: 'secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.'
5779 properties:
5780 name:
5781 type: string
5782 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5783 x-kubernetes-map-type: atomic
5784 fsType:
5785 type: string
5786 description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
5787 volumeID:
5788 type: string
5789 description: 'volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
5790 required:
5791 - volumeID
5792 configMap:
5793 type: object
5794 description: configMap represents a configMap that should populate this volume
5795 properties:
5796 name:
5797 type: string
5798 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5799 defaultMode:
5800 type: integer
5801 description: 'defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
5802 format: int32
5803 items:
5804 type: array
5805 description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
5806 items:
5807 type: object
5808 description: Maps a string key to a path within a volume.
5809 properties:
5810 key:
5811 type: string
5812 description: key is the key to project.
5813 mode:
5814 type: integer
5815 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
5816 format: int32
5817 path:
5818 type: string
5819 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
5820 required:
5821 - key
5822 - path
5823 optional:
5824 type: boolean
5825 description: optional specify whether the ConfigMap or its keys must be defined
5826 x-kubernetes-map-type: atomic
5827 csi:
5828 type: object
5829 description: csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
5830 properties:
5831 readOnly:
5832 type: boolean
5833 description: readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
5834 driver:
5835 type: string
5836 description: driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
5837 fsType:
5838 type: string
5839 description: fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
5840 nodePublishSecretRef:
5841 type: object
5842 description: nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
5843 properties:
5844 name:
5845 type: string
5846 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
5847 x-kubernetes-map-type: atomic
5848 volumeAttributes:
5849 type: object
5850 additionalProperties:
5851 type: string
5852 description: volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
5853 required:
5854 - driver
5855 downwardAPI:
5856 type: object
5857 description: downwardAPI represents downward API about the pod that should populate this volume
5858 properties:
5859 defaultMode:
5860 type: integer
5861 description: 'Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
5862 format: int32
5863 items:
5864 type: array
5865 description: Items is a list of downward API volume file
5866 items:
5867 type: object
5868 description: DownwardAPIVolumeFile represents information to create the file containing the pod field
5869 properties:
5870 fieldRef:
5871 type: object
5872 description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
5873 properties:
5874 apiVersion:
5875 type: string
5876 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
5877 fieldPath:
5878 type: string
5879 description: Path of the field to select in the specified API version.
5880 required:
5881 - fieldPath
5882 x-kubernetes-map-type: atomic
5883 resourceFieldRef:
5884 type: object
5885 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
5886 properties:
5887 containerName:
5888 type: string
5889 description: 'Container name: required for volumes, optional for env vars'
5890 divisor:
5891 anyOf:
5892 - type: integer
5893 - type: string
5894 description: Specifies the output format of the exposed resources, defaults to "1"
5895 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
5896 x-kubernetes-int-or-string: true
5897 resource:
5898 type: string
5899 description: 'Required: resource to select'
5900 required:
5901 - resource
5902 x-kubernetes-map-type: atomic
5903 mode:
5904 type: integer
5905 description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
5906 format: int32
5907 path:
5908 type: string
5909 description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
5910 required:
5911 - path
5912 emptyDir:
5913 type: object
5914 description: 'emptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
5915 properties:
5916 medium:
5917 type: string
5918 description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
5919 sizeLimit:
5920 anyOf:
5921 - type: integer
5922 - type: string
5923 description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
5924 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
5925 x-kubernetes-int-or-string: true
5926 ephemeral:
5927 type: object
5928 description: "ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."
5929 properties:
5930 volumeClaimTemplate:
5931 type: object
5932 description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
5933 properties:
5934 metadata:
5935 type: object
5936 description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
5937 properties:
5938 name:
5939 type: string
5940 namespace:
5941 type: string
5942 labels:
5943 type: object
5944 additionalProperties:
5945 type: string
5946 annotations:
5947 type: object
5948 additionalProperties:
5949 type: string
5950 finalizers:
5951 type: array
5952 items:
5953 type: string
5954 spec:
5955 type: object
5956 description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
5957 properties:
5958 selector:
5959 type: object
5960 description: selector is a label query over volumes to consider for binding.
5961 properties:
5962 matchExpressions:
5963 type: array
5964 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
5965 items:
5966 type: object
5967 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
5968 properties:
5969 key:
5970 type: string
5971 description: key is the label key that the selector applies to.
5972 operator:
5973 type: string
5974 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
5975 values:
5976 type: array
5977 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.
5978 items:
5979 type: string
5980 required:
5981 - key
5982 - operator
5983 matchLabels:
5984 type: object
5985 additionalProperties:
5986 type: string
5987 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.
5988 x-kubernetes-map-type: atomic
5989 resources:
5990 type: object
5991 description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
5992 properties:
5993 claims:
5994 type: array
5995 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
5996 items:
5997 type: object
5998 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
5999 properties:
6000 name:
6001 type: string
6002 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.
6003 required:
6004 - name
6005 x-kubernetes-list-map-keys:
6006 - name
6007 x-kubernetes-list-type: map
6008 limits:
6009 type: object
6010 additionalProperties:
6011 anyOf:
6012 - type: integer
6013 - type: string
6014 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
6015 x-kubernetes-int-or-string: true
6016 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
6017 requests:
6018 type: object
6019 additionalProperties:
6020 anyOf:
6021 - type: integer
6022 - type: string
6023 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
6024 x-kubernetes-int-or-string: true
6025 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
6026 accessModes:
6027 type: array
6028 description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
6029 items:
6030 type: string
6031 dataSource:
6032 type: object
6033 description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
6034 properties:
6035 name:
6036 type: string
6037 description: Name is the name of resource being referenced
6038 kind:
6039 type: string
6040 description: Kind is the type of resource being referenced
6041 apiGroup:
6042 type: string
6043 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
6044 required:
6045 - kind
6046 - name
6047 x-kubernetes-map-type: atomic
6048 dataSourceRef:
6049 type: object
6050 description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
6051 properties:
6052 name:
6053 type: string
6054 description: Name is the name of resource being referenced
6055 namespace:
6056 type: string
6057 description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
6058 kind:
6059 type: string
6060 description: Kind is the type of resource being referenced
6061 apiGroup:
6062 type: string
6063 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
6064 required:
6065 - kind
6066 - name
6067 storageClassName:
6068 type: string
6069 description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
6070 volumeMode:
6071 type: string
6072 description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
6073 volumeName:
6074 type: string
6075 description: volumeName is the binding reference to the PersistentVolume backing this claim.
6076 required:
6077 - spec
6078 fc:
6079 type: object
6080 description: fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
6081 properties:
6082 readOnly:
6083 type: boolean
6084 description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
6085 fsType:
6086 type: string
6087 description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
6088 lun:
6089 type: integer
6090 description: 'lun is Optional: FC target lun number'
6091 format: int32
6092 targetWWNs:
6093 type: array
6094 description: 'targetWWNs is Optional: FC target worldwide names (WWNs)'
6095 items:
6096 type: string
6097 wwids:
6098 type: array
6099 description: 'wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
6100 items:
6101 type: string
6102 flexVolume:
6103 type: object
6104 description: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
6105 properties:
6106 readOnly:
6107 type: boolean
6108 description: 'readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
6109 secretRef:
6110 type: object
6111 description: 'secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.'
6112 properties:
6113 name:
6114 type: string
6115 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
6116 x-kubernetes-map-type: atomic
6117 driver:
6118 type: string
6119 description: driver is the name of the driver to use for this volume.
6120 fsType:
6121 type: string
6122 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
6123 options:
6124 type: object
6125 additionalProperties:
6126 type: string
6127 description: 'options is Optional: this field holds extra command options if any.'
6128 required:
6129 - driver
6130 flocker:
6131 type: object
6132 description: flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
6133 properties:
6134 datasetName:
6135 type: string
6136 description: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
6137 datasetUUID:
6138 type: string
6139 description: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
6140 gcePersistentDisk:
6141 type: object
6142 description: 'gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
6143 properties:
6144 readOnly:
6145 type: boolean
6146 description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
6147 fsType:
6148 type: string
6149 description: 'fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine'
6150 partition:
6151 type: integer
6152 description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
6153 format: int32
6154 pdName:
6155 type: string
6156 description: 'pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
6157 required:
6158 - pdName
6159 gitRepo:
6160 type: object
6161 description: 'gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod''s container.'
6162 properties:
6163 revision:
6164 type: string
6165 description: revision is the commit hash for the specified revision.
6166 directory:
6167 type: string
6168 description: directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
6169 repository:
6170 type: string
6171 description: repository is the URL
6172 required:
6173 - repository
6174 glusterfs:
6175 type: object
6176 description: 'glusterfs represents a Glusterfs mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
6177 properties:
6178 readOnly:
6179 type: boolean
6180 description: 'readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
6181 endpoints:
6182 type: string
6183 description: 'endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
6184 path:
6185 type: string
6186 description: 'path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
6187 required:
6188 - endpoints
6189 - path
6190 hostPath:
6191 type: object
6192 description: 'hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.'
6193 properties:
6194 type:
6195 type: string
6196 description: 'type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
6197 path:
6198 type: string
6199 description: 'path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
6200 required:
6201 - path
6202 iscsi:
6203 type: object
6204 description: 'iscsi represents an ISCSI Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
6205 properties:
6206 readOnly:
6207 type: boolean
6208 description: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
6209 secretRef:
6210 type: object
6211 description: secretRef is the CHAP Secret for iSCSI target and initiator authentication
6212 properties:
6213 name:
6214 type: string
6215 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
6216 x-kubernetes-map-type: atomic
6217 chapAuthDiscovery:
6218 type: boolean
6219 description: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
6220 chapAuthSession:
6221 type: boolean
6222 description: chapAuthSession defines whether support iSCSI Session CHAP authentication
6223 fsType:
6224 type: string
6225 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
6226 initiatorName:
6227 type: string
6228 description: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
6229 iqn:
6230 type: string
6231 description: iqn is the target iSCSI Qualified Name.
6232 iscsiInterface:
6233 type: string
6234 description: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
6235 lun:
6236 type: integer
6237 description: lun represents iSCSI Target Lun number.
6238 format: int32
6239 portals:
6240 type: array
6241 description: portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
6242 items:
6243 type: string
6244 targetPortal:
6245 type: string
6246 description: targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
6247 required:
6248 - iqn
6249 - lun
6250 - targetPortal
6251 nfs:
6252 type: object
6253 description: 'nfs represents an NFS mount on the host that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
6254 properties:
6255 readOnly:
6256 type: boolean
6257 description: 'readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
6258 path:
6259 type: string
6260 description: 'path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
6261 server:
6262 type: string
6263 description: 'server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
6264 required:
6265 - path
6266 - server
6267 persistentVolumeClaim:
6268 type: object
6269 description: 'persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
6270 properties:
6271 readOnly:
6272 type: boolean
6273 description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
6274 claimName:
6275 type: string
6276 description: 'claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
6277 required:
6278 - claimName
6279 photonPersistentDisk:
6280 type: object
6281 description: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
6282 properties:
6283 fsType:
6284 type: string
6285 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
6286 pdID:
6287 type: string
6288 description: pdID is the ID that identifies Photon Controller persistent disk
6289 required:
6290 - pdID
6291 portworxVolume:
6292 type: object
6293 description: portworxVolume represents a portworx volume attached and mounted on kubelets host machine
6294 properties:
6295 readOnly:
6296 type: boolean
6297 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
6298 fsType:
6299 type: string
6300 description: fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
6301 volumeID:
6302 type: string
6303 description: volumeID uniquely identifies a Portworx volume
6304 required:
6305 - volumeID
6306 projected:
6307 type: object
6308 description: projected items for all in one resources secrets, configmaps, and downward API
6309 properties:
6310 defaultMode:
6311 type: integer
6312 description: defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
6313 format: int32
6314 sources:
6315 type: array
6316 description: sources is the list of volume projections
6317 items:
6318 type: object
6319 description: Projection that may be projected along with other supported volume types
6320 properties:
6321 configMap:
6322 type: object
6323 description: configMap information about the configMap data to project
6324 properties:
6325 name:
6326 type: string
6327 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
6328 items:
6329 type: array
6330 description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
6331 items:
6332 type: object
6333 description: Maps a string key to a path within a volume.
6334 properties:
6335 key:
6336 type: string
6337 description: key is the key to project.
6338 mode:
6339 type: integer
6340 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
6341 format: int32
6342 path:
6343 type: string
6344 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
6345 required:
6346 - key
6347 - path
6348 optional:
6349 type: boolean
6350 description: optional specify whether the ConfigMap or its keys must be defined
6351 x-kubernetes-map-type: atomic
6352 downwardAPI:
6353 type: object
6354 description: downwardAPI information about the downwardAPI data to project
6355 properties:
6356 items:
6357 type: array
6358 description: Items is a list of DownwardAPIVolume file
6359 items:
6360 type: object
6361 description: DownwardAPIVolumeFile represents information to create the file containing the pod field
6362 properties:
6363 fieldRef:
6364 type: object
6365 description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
6366 properties:
6367 apiVersion:
6368 type: string
6369 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
6370 fieldPath:
6371 type: string
6372 description: Path of the field to select in the specified API version.
6373 required:
6374 - fieldPath
6375 x-kubernetes-map-type: atomic
6376 resourceFieldRef:
6377 type: object
6378 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
6379 properties:
6380 containerName:
6381 type: string
6382 description: 'Container name: required for volumes, optional for env vars'
6383 divisor:
6384 anyOf:
6385 - type: integer
6386 - type: string
6387 description: Specifies the output format of the exposed resources, defaults to "1"
6388 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
6389 x-kubernetes-int-or-string: true
6390 resource:
6391 type: string
6392 description: 'Required: resource to select'
6393 required:
6394 - resource
6395 x-kubernetes-map-type: atomic
6396 mode:
6397 type: integer
6398 description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
6399 format: int32
6400 path:
6401 type: string
6402 description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
6403 required:
6404 - path
6405 secret:
6406 type: object
6407 description: secret information about the secret data to project
6408 properties:
6409 name:
6410 type: string
6411 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
6412 items:
6413 type: array
6414 description: items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
6415 items:
6416 type: object
6417 description: Maps a string key to a path within a volume.
6418 properties:
6419 key:
6420 type: string
6421 description: key is the key to project.
6422 mode:
6423 type: integer
6424 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
6425 format: int32
6426 path:
6427 type: string
6428 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
6429 required:
6430 - key
6431 - path
6432 optional:
6433 type: boolean
6434 description: optional field specify whether the Secret or its key must be defined
6435 x-kubernetes-map-type: atomic
6436 serviceAccountToken:
6437 type: object
6438 description: serviceAccountToken is information about the serviceAccountToken data to project
6439 properties:
6440 audience:
6441 type: string
6442 description: audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
6443 expirationSeconds:
6444 type: integer
6445 description: expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
6446 format: int64
6447 path:
6448 type: string
6449 description: path is the path relative to the mount point of the file to project the token into.
6450 required:
6451 - path
6452 quobyte:
6453 type: object
6454 description: quobyte represents a Quobyte mount on the host that shares a pod's lifetime
6455 properties:
6456 readOnly:
6457 type: boolean
6458 description: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
6459 group:
6460 type: string
6461 description: group to map volume access to Default is no group
6462 registry:
6463 type: string
6464 description: registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
6465 tenant:
6466 type: string
6467 description: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
6468 user:
6469 type: string
6470 description: user to map volume access to Defaults to serivceaccount user
6471 volume:
6472 type: string
6473 description: volume is a string that references an already created Quobyte volume by name.
6474 required:
6475 - registry
6476 - volume
6477 rbd:
6478 type: object
6479 description: 'rbd represents a Rados Block Device mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
6480 properties:
6481 image:
6482 type: string
6483 description: 'image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
6484 readOnly:
6485 type: boolean
6486 description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
6487 secretRef:
6488 type: object
6489 description: 'secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
6490 properties:
6491 name:
6492 type: string
6493 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
6494 x-kubernetes-map-type: atomic
6495 fsType:
6496 type: string
6497 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
6498 keyring:
6499 type: string
6500 description: 'keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
6501 monitors:
6502 type: array
6503 description: 'monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
6504 items:
6505 type: string
6506 pool:
6507 type: string
6508 description: 'pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
6509 user:
6510 type: string
6511 description: 'user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
6512 required:
6513 - image
6514 - monitors
6515 scaleIO:
6516 type: object
6517 description: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
6518 properties:
6519 readOnly:
6520 type: boolean
6521 description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
6522 secretRef:
6523 type: object
6524 description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
6525 properties:
6526 name:
6527 type: string
6528 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
6529 x-kubernetes-map-type: atomic
6530 fsType:
6531 type: string
6532 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
6533 gateway:
6534 type: string
6535 description: gateway is the host address of the ScaleIO API Gateway.
6536 protectionDomain:
6537 type: string
6538 description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
6539 sslEnabled:
6540 type: boolean
6541 description: sslEnabled Flag enable/disable SSL communication with Gateway, default false
6542 storageMode:
6543 type: string
6544 description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
6545 storagePool:
6546 type: string
6547 description: storagePool is the ScaleIO Storage Pool associated with the protection domain.
6548 system:
6549 type: string
6550 description: system is the name of the storage system as configured in ScaleIO.
6551 volumeName:
6552 type: string
6553 description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
6554 required:
6555 - gateway
6556 - secretRef
6557 - system
6558 secret:
6559 type: object
6560 description: 'secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
6561 properties:
6562 defaultMode:
6563 type: integer
6564 description: 'defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
6565 format: int32
6566 items:
6567 type: array
6568 description: items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
6569 items:
6570 type: object
6571 description: Maps a string key to a path within a volume.
6572 properties:
6573 key:
6574 type: string
6575 description: key is the key to project.
6576 mode:
6577 type: integer
6578 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
6579 format: int32
6580 path:
6581 type: string
6582 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
6583 required:
6584 - key
6585 - path
6586 optional:
6587 type: boolean
6588 description: optional field specify whether the Secret or its keys must be defined
6589 secretName:
6590 type: string
6591 description: 'secretName is the name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
6592 storageos:
6593 type: object
6594 description: storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
6595 properties:
6596 readOnly:
6597 type: boolean
6598 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
6599 secretRef:
6600 type: object
6601 description: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
6602 properties:
6603 name:
6604 type: string
6605 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
6606 x-kubernetes-map-type: atomic
6607 fsType:
6608 type: string
6609 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
6610 volumeName:
6611 type: string
6612 description: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
6613 volumeNamespace:
6614 type: string
6615 description: volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
6616 vsphereVolume:
6617 type: object
6618 description: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
6619 properties:
6620 fsType:
6621 type: string
6622 description: fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
6623 storagePolicyID:
6624 type: string
6625 description: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
6626 storagePolicyName:
6627 type: string
6628 description: storagePolicyName is the storage Policy Based Management (SPBM) profile name.
6629 volumePath:
6630 type: string
6631 description: volumePath is the path that identifies vSphere volume vmdk
6632 required:
6633 - volumePath
6634 required:
6635 - name
6636 imagePullSecrets:
6637 type: array
6638 description: Fluent Bit image pull secret
6639 items:
6640 type: object
6641 description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
6642 properties:
6643 name:
6644 type: string
6645 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
6646 x-kubernetes-map-type: atomic
6647 affinity:
6648 type: object
6649 description: Pod's scheduling constraints.
6650 properties:
6651 nodeAffinity:
6652 type: object
6653 description: Describes node affinity scheduling rules for the pod.
6654 properties:
6655 preferredDuringSchedulingIgnoredDuringExecution:
6656 type: array
6657 description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
6658 items:
6659 type: object
6660 description: An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
6661 properties:
6662 preference:
6663 type: object
6664 description: A node selector term, associated with the corresponding weight.
6665 properties:
6666 matchExpressions:
6667 type: array
6668 description: A list of node selector requirements by node's labels.
6669 items:
6670 type: object
6671 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
6672 properties:
6673 key:
6674 type: string
6675 description: The label key that the selector applies to.
6676 operator:
6677 type: string
6678 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
6679 values:
6680 type: array
6681 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
6682 items:
6683 type: string
6684 required:
6685 - key
6686 - operator
6687 matchFields:
6688 type: array
6689 description: A list of node selector requirements by node's fields.
6690 items:
6691 type: object
6692 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
6693 properties:
6694 key:
6695 type: string
6696 description: The label key that the selector applies to.
6697 operator:
6698 type: string
6699 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
6700 values:
6701 type: array
6702 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
6703 items:
6704 type: string
6705 required:
6706 - key
6707 - operator
6708 x-kubernetes-map-type: atomic
6709 weight:
6710 type: integer
6711 description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
6712 format: int32
6713 required:
6714 - preference
6715 - weight
6716 requiredDuringSchedulingIgnoredDuringExecution:
6717 type: object
6718 description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
6719 properties:
6720 nodeSelectorTerms:
6721 type: array
6722 description: Required. A list of node selector terms. The terms are ORed.
6723 items:
6724 type: object
6725 description: A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
6726 properties:
6727 matchExpressions:
6728 type: array
6729 description: A list of node selector requirements by node's labels.
6730 items:
6731 type: object
6732 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
6733 properties:
6734 key:
6735 type: string
6736 description: The label key that the selector applies to.
6737 operator:
6738 type: string
6739 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
6740 values:
6741 type: array
6742 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
6743 items:
6744 type: string
6745 required:
6746 - key
6747 - operator
6748 matchFields:
6749 type: array
6750 description: A list of node selector requirements by node's fields.
6751 items:
6752 type: object
6753 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
6754 properties:
6755 key:
6756 type: string
6757 description: The label key that the selector applies to.
6758 operator:
6759 type: string
6760 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
6761 values:
6762 type: array
6763 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
6764 items:
6765 type: string
6766 required:
6767 - key
6768 - operator
6769 x-kubernetes-map-type: atomic
6770 required:
6771 - nodeSelectorTerms
6772 x-kubernetes-map-type: atomic
6773 podAffinity:
6774 type: object
6775 description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
6776 properties:
6777 preferredDuringSchedulingIgnoredDuringExecution:
6778 type: array
6779 description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
6780 items:
6781 type: object
6782 description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
6783 properties:
6784 podAffinityTerm:
6785 type: object
6786 description: Required. A pod affinity term, associated with the corresponding weight.
6787 properties:
6788 labelSelector:
6789 type: object
6790 description: A label query over a set of resources, in this case pods.
6791 properties:
6792 matchExpressions:
6793 type: array
6794 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
6795 items:
6796 type: object
6797 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
6798 properties:
6799 key:
6800 type: string
6801 description: key is the label key that the selector applies to.
6802 operator:
6803 type: string
6804 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
6805 values:
6806 type: array
6807 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.
6808 items:
6809 type: string
6810 required:
6811 - key
6812 - operator
6813 matchLabels:
6814 type: object
6815 additionalProperties:
6816 type: string
6817 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.
6818 x-kubernetes-map-type: atomic
6819 namespaceSelector:
6820 type: object
6821 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
6822 properties:
6823 matchExpressions:
6824 type: array
6825 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
6826 items:
6827 type: object
6828 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
6829 properties:
6830 key:
6831 type: string
6832 description: key is the label key that the selector applies to.
6833 operator:
6834 type: string
6835 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
6836 values:
6837 type: array
6838 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.
6839 items:
6840 type: string
6841 required:
6842 - key
6843 - operator
6844 matchLabels:
6845 type: object
6846 additionalProperties:
6847 type: string
6848 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.
6849 x-kubernetes-map-type: atomic
6850 namespaces:
6851 type: array
6852 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
6853 items:
6854 type: string
6855 topologyKey:
6856 type: string
6857 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
6858 required:
6859 - topologyKey
6860 weight:
6861 type: integer
6862 description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
6863 format: int32
6864 required:
6865 - podAffinityTerm
6866 - weight
6867 requiredDuringSchedulingIgnoredDuringExecution:
6868 type: array
6869 description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
6870 items:
6871 type: object
6872 description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
6873 properties:
6874 labelSelector:
6875 type: object
6876 description: A label query over a set of resources, in this case pods.
6877 properties:
6878 matchExpressions:
6879 type: array
6880 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
6881 items:
6882 type: object
6883 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
6884 properties:
6885 key:
6886 type: string
6887 description: key is the label key that the selector applies to.
6888 operator:
6889 type: string
6890 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
6891 values:
6892 type: array
6893 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.
6894 items:
6895 type: string
6896 required:
6897 - key
6898 - operator
6899 matchLabels:
6900 type: object
6901 additionalProperties:
6902 type: string
6903 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.
6904 x-kubernetes-map-type: atomic
6905 namespaceSelector:
6906 type: object
6907 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
6908 properties:
6909 matchExpressions:
6910 type: array
6911 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
6912 items:
6913 type: object
6914 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
6915 properties:
6916 key:
6917 type: string
6918 description: key is the label key that the selector applies to.
6919 operator:
6920 type: string
6921 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
6922 values:
6923 type: array
6924 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.
6925 items:
6926 type: string
6927 required:
6928 - key
6929 - operator
6930 matchLabels:
6931 type: object
6932 additionalProperties:
6933 type: string
6934 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.
6935 x-kubernetes-map-type: atomic
6936 namespaces:
6937 type: array
6938 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
6939 items:
6940 type: string
6941 topologyKey:
6942 type: string
6943 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
6944 required:
6945 - topologyKey
6946 podAntiAffinity:
6947 type: object
6948 description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
6949 properties:
6950 preferredDuringSchedulingIgnoredDuringExecution:
6951 type: array
6952 description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
6953 items:
6954 type: object
6955 description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
6956 properties:
6957 podAffinityTerm:
6958 type: object
6959 description: Required. A pod affinity term, associated with the corresponding weight.
6960 properties:
6961 labelSelector:
6962 type: object
6963 description: A label query over a set of resources, in this case pods.
6964 properties:
6965 matchExpressions:
6966 type: array
6967 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
6968 items:
6969 type: object
6970 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
6971 properties:
6972 key:
6973 type: string
6974 description: key is the label key that the selector applies to.
6975 operator:
6976 type: string
6977 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
6978 values:
6979 type: array
6980 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.
6981 items:
6982 type: string
6983 required:
6984 - key
6985 - operator
6986 matchLabels:
6987 type: object
6988 additionalProperties:
6989 type: string
6990 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.
6991 x-kubernetes-map-type: atomic
6992 namespaceSelector:
6993 type: object
6994 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
6995 properties:
6996 matchExpressions:
6997 type: array
6998 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
6999 items:
7000 type: object
7001 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
7002 properties:
7003 key:
7004 type: string
7005 description: key is the label key that the selector applies to.
7006 operator:
7007 type: string
7008 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
7009 values:
7010 type: array
7011 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.
7012 items:
7013 type: string
7014 required:
7015 - key
7016 - operator
7017 matchLabels:
7018 type: object
7019 additionalProperties:
7020 type: string
7021 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.
7022 x-kubernetes-map-type: atomic
7023 namespaces:
7024 type: array
7025 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
7026 items:
7027 type: string
7028 topologyKey:
7029 type: string
7030 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
7031 required:
7032 - topologyKey
7033 weight:
7034 type: integer
7035 description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
7036 format: int32
7037 required:
7038 - podAffinityTerm
7039 - weight
7040 requiredDuringSchedulingIgnoredDuringExecution:
7041 type: array
7042 description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
7043 items:
7044 type: object
7045 description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
7046 properties:
7047 labelSelector:
7048 type: object
7049 description: A label query over a set of resources, in this case pods.
7050 properties:
7051 matchExpressions:
7052 type: array
7053 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
7054 items:
7055 type: object
7056 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
7057 properties:
7058 key:
7059 type: string
7060 description: key is the label key that the selector applies to.
7061 operator:
7062 type: string
7063 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
7064 values:
7065 type: array
7066 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.
7067 items:
7068 type: string
7069 required:
7070 - key
7071 - operator
7072 matchLabels:
7073 type: object
7074 additionalProperties:
7075 type: string
7076 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.
7077 x-kubernetes-map-type: atomic
7078 namespaceSelector:
7079 type: object
7080 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
7081 properties:
7082 matchExpressions:
7083 type: array
7084 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
7085 items:
7086 type: object
7087 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
7088 properties:
7089 key:
7090 type: string
7091 description: key is the label key that the selector applies to.
7092 operator:
7093 type: string
7094 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
7095 values:
7096 type: array
7097 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.
7098 items:
7099 type: string
7100 required:
7101 - key
7102 - operator
7103 matchLabels:
7104 type: object
7105 additionalProperties:
7106 type: string
7107 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.
7108 x-kubernetes-map-type: atomic
7109 namespaces:
7110 type: array
7111 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
7112 items:
7113 type: string
7114 topologyKey:
7115 type: string
7116 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
7117 required:
7118 - topologyKey
7119 tolerations:
7120 type: array
7121 description: Tolerations
7122 items:
7123 type: object
7124 description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
7125 properties:
7126 value:
7127 type: string
7128 description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
7129 effect:
7130 type: string
7131 description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
7132 key:
7133 type: string
7134 description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
7135 operator:
7136 type: string
7137 description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
7138 tolerationSeconds:
7139 type: integer
7140 description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
7141 format: int64
7142 image:
7143 type: string
7144 description: Fluent Bit image.
7145 args:
7146 type: array
7147 description: Fluent Bit Watcher command line arguments.
7148 items:
7149 type: string
7150 ports:
7151 type: array
7152 description: Ports represents the pod's ports.
7153 items:
7154 type: object
7155 description: ContainerPort represents a network port in a single container.
7156 properties:
7157 name:
7158 type: string
7159 description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
7160 protocol:
7161 type: string
7162 default: TCP
7163 description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
7164 hostPort:
7165 type: integer
7166 description: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
7167 format: int32
7168 containerPort:
7169 type: integer
7170 description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
7171 format: int32
7172 hostIP:
7173 type: string
7174 description: What host IP to bind the external port to.
7175 required:
7176 - containerPort
7177 resources:
7178 type: object
7179 description: Compute Resources required by container.
7180 properties:
7181 claims:
7182 type: array
7183 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
7184 items:
7185 type: object
7186 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
7187 properties:
7188 name:
7189 type: string
7190 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.
7191 required:
7192 - name
7193 x-kubernetes-list-map-keys:
7194 - name
7195 x-kubernetes-list-type: map
7196 limits:
7197 type: object
7198 additionalProperties:
7199 anyOf:
7200 - type: integer
7201 - type: string
7202 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
7203 x-kubernetes-int-or-string: true
7204 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
7205 requests:
7206 type: object
7207 additionalProperties:
7208 anyOf:
7209 - type: integer
7210 - type: string
7211 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
7212 x-kubernetes-int-or-string: true
7213 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
7214 imagePullPolicy:
7215 type: string
7216 description: Fluent Bit image pull policy.
7217 securityContext:
7218 type: object
7219 description: SecurityContext holds pod-level security attributes and common container settings.
7220 properties:
7221 fsGroup:
7222 type: integer
7223 description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows."
7224 format: int64
7225 fsGroupChangePolicy:
7226 type: string
7227 description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.'
7228 runAsGroup:
7229 type: integer
7230 description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
7231 format: int64
7232 runAsNonRoot:
7233 type: boolean
7234 description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
7235 runAsUser:
7236 type: integer
7237 description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
7238 format: int64
7239 seLinuxOptions:
7240 type: object
7241 description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
7242 properties:
7243 type:
7244 type: string
7245 description: Type is a SELinux type label that applies to the container.
7246 level:
7247 type: string
7248 description: Level is SELinux level label that applies to the container.
7249 role:
7250 type: string
7251 description: Role is a SELinux role label that applies to the container.
7252 user:
7253 type: string
7254 description: User is a SELinux user label that applies to the container.
7255 seccompProfile:
7256 type: object
7257 description: The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
7258 properties:
7259 type:
7260 type: string
7261 description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
7262 localhostProfile:
7263 type: string
7264 description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
7265 required:
7266 - type
7267 supplementalGroups:
7268 type: array
7269 description: A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
7270 items:
7271 type: integer
7272 format: int64
7273 sysctls:
7274 type: array
7275 description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
7276 items:
7277 type: object
7278 description: Sysctl defines a kernel parameter to be set
7279 properties:
7280 name:
7281 type: string
7282 description: Name of a property to set
7283 value:
7284 type: string
7285 description: Value of a property to set
7286 required:
7287 - name
7288 - value
7289 windowsOptions:
7290 type: object
7291 description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
7292 properties:
7293 gmsaCredentialSpec:
7294 type: string
7295 description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
7296 gmsaCredentialSpecName:
7297 type: string
7298 description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
7299 hostProcess:
7300 type: boolean
7301 description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
7302 runAsUserName:
7303 type: string
7304 description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
7305 bufferPath:
7306 type: string
7307 description: The path where buffer chunks are stored.
7308 disableService:
7309 type: boolean
7310 description: By default will build the related service according to the globalinputs definition.
7311 fluentBitConfigName:
7312 type: string
7313 description: Fluentbitconfig object associated with this Fluentbit
7314 pvc:
7315 type: object
7316 description: PVC definition
7317 properties:
7318 apiVersion:
7319 type: string
7320 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'
7321 kind:
7322 type: string
7323 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'
7324 metadata:
7325 type: object
7326 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata'
7327 properties:
7328 name:
7329 type: string
7330 namespace:
7331 type: string
7332 labels:
7333 type: object
7334 additionalProperties:
7335 type: string
7336 annotations:
7337 type: object
7338 additionalProperties:
7339 type: string
7340 finalizers:
7341 type: array
7342 items:
7343 type: string
7344 spec:
7345 type: object
7346 description: 'spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
7347 properties:
7348 selector:
7349 type: object
7350 description: selector is a label query over volumes to consider for binding.
7351 properties:
7352 matchExpressions:
7353 type: array
7354 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
7355 items:
7356 type: object
7357 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
7358 properties:
7359 key:
7360 type: string
7361 description: key is the label key that the selector applies to.
7362 operator:
7363 type: string
7364 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
7365 values:
7366 type: array
7367 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.
7368 items:
7369 type: string
7370 required:
7371 - key
7372 - operator
7373 matchLabels:
7374 type: object
7375 additionalProperties:
7376 type: string
7377 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.
7378 x-kubernetes-map-type: atomic
7379 resources:
7380 type: object
7381 description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
7382 properties:
7383 claims:
7384 type: array
7385 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
7386 items:
7387 type: object
7388 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
7389 properties:
7390 name:
7391 type: string
7392 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.
7393 required:
7394 - name
7395 x-kubernetes-list-map-keys:
7396 - name
7397 x-kubernetes-list-type: map
7398 limits:
7399 type: object
7400 additionalProperties:
7401 anyOf:
7402 - type: integer
7403 - type: string
7404 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
7405 x-kubernetes-int-or-string: true
7406 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
7407 requests:
7408 type: object
7409 additionalProperties:
7410 anyOf:
7411 - type: integer
7412 - type: string
7413 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
7414 x-kubernetes-int-or-string: true
7415 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
7416 accessModes:
7417 type: array
7418 description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
7419 items:
7420 type: string
7421 dataSource:
7422 type: object
7423 description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
7424 properties:
7425 name:
7426 type: string
7427 description: Name is the name of resource being referenced
7428 kind:
7429 type: string
7430 description: Kind is the type of resource being referenced
7431 apiGroup:
7432 type: string
7433 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
7434 required:
7435 - kind
7436 - name
7437 x-kubernetes-map-type: atomic
7438 dataSourceRef:
7439 type: object
7440 description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
7441 properties:
7442 name:
7443 type: string
7444 description: Name is the name of resource being referenced
7445 namespace:
7446 type: string
7447 description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
7448 kind:
7449 type: string
7450 description: Kind is the type of resource being referenced
7451 apiGroup:
7452 type: string
7453 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
7454 required:
7455 - kind
7456 - name
7457 storageClassName:
7458 type: string
7459 description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
7460 volumeMode:
7461 type: string
7462 description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
7463 volumeName:
7464 type: string
7465 description: volumeName is the binding reference to the PersistentVolume backing this claim.
7466 status:
7467 type: object
7468 description: 'status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
7469 properties:
7470 accessModes:
7471 type: array
7472 description: 'accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
7473 items:
7474 type: string
7475 allocatedResources:
7476 type: object
7477 additionalProperties:
7478 anyOf:
7479 - type: integer
7480 - type: string
7481 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
7482 x-kubernetes-int-or-string: true
7483 description: allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
7484 capacity:
7485 type: object
7486 additionalProperties:
7487 anyOf:
7488 - type: integer
7489 - type: string
7490 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
7491 x-kubernetes-int-or-string: true
7492 description: capacity represents the actual resources of the underlying volume.
7493 conditions:
7494 type: array
7495 description: conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
7496 items:
7497 type: object
7498 description: PersistentVolumeClaimCondition contails details about state of pvc
7499 properties:
7500 type:
7501 type: string
7502 description: PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
7503 status:
7504 type: string
7505 lastProbeTime:
7506 type: string
7507 description: lastProbeTime is the time we probed the condition.
7508 format: date-time
7509 lastTransitionTime:
7510 type: string
7511 description: lastTransitionTime is the time the condition transitioned from one status to another.
7512 format: date-time
7513 message:
7514 type: string
7515 description: message is the human-readable message indicating details about last transition.
7516 reason:
7517 type: string
7518 description: reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
7519 required:
7520 - status
7521 - type
7522 phase:
7523 type: string
7524 description: phase represents the current phase of PersistentVolumeClaim.
7525 resizeStatus:
7526 type: string
7527 description: resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
7528 rbacRules:
7529 type: array
7530 description: RBACRules represents additional rbac rules which will be applied to the fluent-bit clusterrole.
7531 items:
7532 type: object
7533 description: PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
7534 properties:
7535 resources:
7536 type: array
7537 description: Resources is a list of resources this rule applies to. '*' represents all resources.
7538 items:
7539 type: string
7540 apiGroups:
7541 type: array
7542 description: APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
7543 items:
7544 type: string
7545 nonResourceURLs:
7546 type: array
7547 description: NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
7548 items:
7549 type: string
7550 resourceNames:
7551 type: array
7552 description: ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
7553 items:
7554 type: string
7555 verbs:
7556 type: array
7557 description: Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.
7558 items:
7559 type: string
7560 required:
7561 - verbs
7562 secrets:
7563 type: array
7564 description: The Secrets are mounted into /fluent-bit/secrets/<secret-name>.
7565 items:
7566 type: string
7567 serviceAccountAnnotations:
7568 type: object
7569 additionalProperties:
7570 type: string
7571 description: Annotations to add to the Fluentbit service account
7572 volumesMounts:
7573 type: array
7574 description: Pod volumes to mount into the container's filesystem.
7575 items:
7576 type: object
7577 description: VolumeMount describes a mounting of a Volume within a container.
7578 properties:
7579 name:
7580 type: string
7581 description: This must match the Name of a Volume.
7582 readOnly:
7583 type: boolean
7584 description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
7585 mountPath:
7586 type: string
7587 description: Path within the container at which the volume should be mounted. Must not contain ':'.
7588 subPath:
7589 type: string
7590 description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
7591 subPathExpr:
7592 type: string
7593 description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
7594 mountPropagation:
7595 type: string
7596 description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
7597 required:
7598 - mountPath
7599 - name
7600 status:
7601 type: object
7602 description: CollectorStatus defines the observed state of FluentBit
7603 served: true
7604 storage: true
7605---
7606apiVersion: apiextensions.k8s.io/v1
7607kind: CustomResourceDefinition
7608metadata:
7609 name: filters.fluentbit.fluent.io
7610 annotations:
7611 controller-gen.kubebuilder.io/version: v0.11.3
7612 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
7613 pallet.edge.ncr.com/name: fluent-operator
7614 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
7615 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
7616 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
7617 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
7618spec:
7619 group: fluentbit.fluent.io
7620 names:
7621 kind: Filter
7622 listKind: FilterList
7623 plural: filters
7624 shortNames:
7625 - fbf
7626 singular: filter
7627 scope: Namespaced
7628 versions:
7629 - name: v1alpha2
7630 schema:
7631 openAPIV3Schema:
7632 type: object
7633 description: Filter is the Schema for namespace level filter API
7634 properties:
7635 apiVersion:
7636 type: string
7637 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'
7638 kind:
7639 type: string
7640 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'
7641 metadata:
7642 type: object
7643 spec:
7644 type: object
7645 description: FilterSpec defines the desired state of ClusterFilter
7646 properties:
7647 filters:
7648 type: array
7649 description: A set of filter plugins in order.
7650 items:
7651 type: object
7652 properties:
7653 aws:
7654 type: object
7655 description: Aws defines a Aws configuration.
7656 properties:
7657 accountID:
7658 type: boolean
7659 description: The account ID for current EC2 instance.Default is false.
7660 alias:
7661 type: string
7662 description: Alias for the plugin
7663 amiID:
7664 type: boolean
7665 description: The EC2 instance image id.Default is false.
7666 az:
7667 type: boolean
7668 description: The availability zone; for example, "us-east-1a". Default is true.
7669 ec2InstanceID:
7670 type: boolean
7671 description: The EC2 instance ID.Default is true.
7672 ec2InstanceType:
7673 type: boolean
7674 description: The EC2 instance type.Default is false.
7675 hostName:
7676 type: boolean
7677 description: The hostname for current EC2 instance.Default is false.
7678 imdsVersion:
7679 type: string
7680 description: Specify which version of the instance metadata service to use. Valid values are 'v1' or 'v2'.
7681 enum:
7682 - v1
7683 - v2
7684 privateIP:
7685 type: boolean
7686 description: The EC2 instance private ip.Default is false.
7687 retryLimit:
7688 type: string
7689 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
7690 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
7691 vpcID:
7692 type: boolean
7693 description: The VPC ID for current EC2 instance.Default is false.
7694 customPlugin:
7695 type: object
7696 description: CustomPlugin defines a Custom plugin configuration.
7697 properties:
7698 config:
7699 type: string
7700 grep:
7701 type: object
7702 description: Grep defines Grep Filter configuration.
7703 properties:
7704 alias:
7705 type: string
7706 description: Alias for the plugin
7707 exclude:
7708 type: string
7709 description: 'Exclude records which field matches the regular expression. Value Format: FIELD REGEX'
7710 regex:
7711 type: string
7712 description: 'Keep records which field matches the regular expression. Value Format: FIELD REGEX'
7713 retryLimit:
7714 type: string
7715 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
7716 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
7717 kubernetes:
7718 type: object
7719 description: Kubernetes defines Kubernetes Filter configuration.
7720 properties:
7721 labels:
7722 type: boolean
7723 description: Include Kubernetes resource labels in the extra metadata.
7724 annotations:
7725 type: boolean
7726 description: Include Kubernetes resource annotations in the extra metadata.
7727 alias:
7728 type: string
7729 description: Alias for the plugin
7730 bufferSize:
7731 type: string
7732 description: Set the buffer size for HTTP client when reading responses from Kubernetes API server.
7733 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
7734 cacheUseDockerId:
7735 type: boolean
7736 description: When enabled, metadata will be fetched from K8s when docker_id is changed.
7737 dnsRetries:
7738 type: integer
7739 description: DNS lookup retries N times until the network start working
7740 format: int32
7741 dnsWaitTime:
7742 type: integer
7743 description: DNS lookup interval between network status checks
7744 format: int32
7745 dummyMeta:
7746 type: boolean
7747 description: If set, use dummy-meta data (for test/dev purposes)
7748 k8sLoggingExclude:
7749 type: boolean
7750 description: Allow Kubernetes Pods to exclude their logs from the log processor (read more about it in Kubernetes Annotations section).
7751 k8sLoggingParser:
7752 type: boolean
7753 description: Allow Kubernetes Pods to suggest a pre-defined Parser (read more about it in Kubernetes Annotations section)
7754 keepLog:
7755 type: boolean
7756 description: When Keep_Log is disabled, the log field is removed from the incoming message once it has been successfully merged (Merge_Log must be enabled as well).
7757 kubeCAFile:
7758 type: string
7759 description: CA certificate file
7760 kubeCAPath:
7761 type: string
7762 description: Absolute path to scan for certificate files
7763 kubeMetaCacheTTL:
7764 type: string
7765 description: configurable TTL for K8s cached metadata. By default, it is set to 0 which means TTL for cache entries is disabled and cache entries are evicted at random when capacity is reached. In order to enable this option, you should set the number to a time interval. For example, set this value to 60 or 60s and cache entries which have been created more than 60s will be evicted.
7766 kubeMetaPreloadCacheDir:
7767 type: string
7768 description: If set, Kubernetes meta-data can be cached/pre-loaded from files in JSON format in this directory, named as namespace-pod.meta
7769 kubeTagPrefix:
7770 type: string
7771 description: When the source records comes from Tail input plugin, this option allows to specify what's the prefix used in Tail configuration.
7772 kubeTokenFile:
7773 type: string
7774 description: Token file
7775 kubeTokenTTL:
7776 type: string
7777 description: configurable 'time to live' for the K8s token. By default, it is set to 600 seconds. After this time, the token is reloaded from Kube_Token_File or the Kube_Token_Command.
7778 kubeURL:
7779 type: string
7780 description: API Server end-point
7781 kubeletHost:
7782 type: string
7783 description: kubelet host using for HTTP request, this only works when Use_Kubelet set to On.
7784 kubeletPort:
7785 type: integer
7786 description: kubelet port using for HTTP request, this only works when useKubelet is set to On.
7787 format: int32
7788 mergeLog:
7789 type: boolean
7790 description: When enabled, it checks if the log field content is a JSON string map, if so, it append the map fields as part of the log structure.
7791 mergeLogKey:
7792 type: string
7793 description: When Merge_Log is enabled, the filter tries to assume the log field from the incoming message is a JSON string message and make a structured representation of it at the same level of the log field in the map. Now if Merge_Log_Key is set (a string name), all the new structured fields taken from the original log content are inserted under the new key.
7794 mergeLogTrim:
7795 type: boolean
7796 description: When Merge_Log is enabled, trim (remove possible \n or \r) field values.
7797 mergeParser:
7798 type: string
7799 description: Optional parser name to specify how to parse the data contained in the log key. Recommended use is for developers or testing only.
7800 regexParser:
7801 type: string
7802 description: Set an alternative Parser to process record Tag and extract pod_name, namespace_name, container_name and docker_id. The parser must be registered in a parsers file (refer to parser filter-kube-test as an example).
7803 retryLimit:
7804 type: string
7805 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
7806 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
7807 tlsDebug:
7808 type: integer
7809 description: Debug level between 0 (nothing) and 4 (every detail).
7810 format: int32
7811 tlsVerify:
7812 type: boolean
7813 description: When enabled, turns on certificate validation when connecting to the Kubernetes API server.
7814 useJournal:
7815 type: boolean
7816 description: When enabled, the filter reads logs coming in Journald format.
7817 useKubelet:
7818 type: boolean
7819 description: This is an optional feature flag to get metadata information from kubelet instead of calling Kube Server API to enhance the log. This could mitigate the Kube API heavy traffic issue for large cluster.
7820 lua:
7821 type: object
7822 description: Lua defines Lua Filter configuration.
7823 properties:
7824 alias:
7825 type: string
7826 description: Alias for the plugin
7827 call:
7828 type: string
7829 description: Lua function name that will be triggered to do filtering. It's assumed that the function is declared inside the Script defined above.
7830 protectedMode:
7831 type: boolean
7832 description: If enabled, Lua script will be executed in protected mode. It prevents to crash when invalid Lua script is executed. Default is true.
7833 retryLimit:
7834 type: string
7835 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
7836 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
7837 script:
7838 type: object
7839 description: Path to the Lua script that will be used.
7840 properties:
7841 name:
7842 type: string
7843 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
7844 key:
7845 type: string
7846 description: The key to select.
7847 optional:
7848 type: boolean
7849 description: Specify whether the ConfigMap or its key must be defined
7850 required:
7851 - key
7852 x-kubernetes-map-type: atomic
7853 timeAsTable:
7854 type: boolean
7855 description: By default when the Lua script is invoked, the record timestamp is passed as a Floating number which might lead to loss precision when the data is converted back. If you desire timestamp precision enabling this option will pass the timestamp as a Lua table with keys sec for seconds since epoch and nsec for nanoseconds.
7856 typeIntKey:
7857 type: array
7858 description: If these keys are matched, the fields are converted to integer. If more than one key, delimit by space. Note that starting from Fluent Bit v1.6 integer data types are preserved and not converted to double as in previous versions.
7859 items:
7860 type: string
7861 required:
7862 - call
7863 - script
7864 modify:
7865 type: object
7866 description: Modify defines Modify Filter configuration.
7867 properties:
7868 alias:
7869 type: string
7870 description: Alias for the plugin
7871 conditions:
7872 type: array
7873 description: All conditions have to be true for the rules to be applied.
7874 items:
7875 type: object
7876 description: The plugin supports the following conditions
7877 properties:
7878 aKeyMatches:
7879 type: string
7880 description: Is true if a key matches regex KEY
7881 keyDoesNotExist:
7882 type: object
7883 additionalProperties:
7884 type: string
7885 description: Is true if KEY does not exist
7886 keyExists:
7887 type: string
7888 description: Is true if KEY exists
7889 keyValueDoesNotEqual:
7890 type: object
7891 additionalProperties:
7892 type: string
7893 description: Is true if KEY exists and its value is not VALUE
7894 keyValueDoesNotMatch:
7895 type: object
7896 additionalProperties:
7897 type: string
7898 description: Is true if key KEY exists and its value does not match VALUE
7899 keyValueEquals:
7900 type: object
7901 additionalProperties:
7902 type: string
7903 description: Is true if KEY exists and its value is VALUE
7904 keyValueMatches:
7905 type: object
7906 additionalProperties:
7907 type: string
7908 description: Is true if key KEY exists and its value matches VALUE
7909 matchingKeysDoNotHaveMatchingValues:
7910 type: object
7911 additionalProperties:
7912 type: string
7913 description: Is true if all keys matching KEY have values that do not match VALUE
7914 matchingKeysHaveMatchingValues:
7915 type: object
7916 additionalProperties:
7917 type: string
7918 description: Is true if all keys matching KEY have values that match VALUE
7919 noKeyMatches:
7920 type: string
7921 description: Is true if no key matches regex KEY
7922 retryLimit:
7923 type: string
7924 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
7925 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
7926 rules:
7927 type: array
7928 description: Rules are applied in the order they appear, with each rule operating on the result of the previous rule.
7929 items:
7930 type: object
7931 description: The plugin supports the following rules
7932 properties:
7933 add:
7934 type: object
7935 additionalProperties:
7936 type: string
7937 description: Add a key/value pair with key KEY and value VALUE if KEY does not exist
7938 copy:
7939 type: object
7940 additionalProperties:
7941 type: string
7942 description: Copy a key/value pair with key KEY to COPIED_KEY if KEY exists AND COPIED_KEY does not exist
7943 hardCopy:
7944 type: object
7945 additionalProperties:
7946 type: string
7947 description: Copy a key/value pair with key KEY to COPIED_KEY if KEY exists. If COPIED_KEY already exists, this field is overwritten
7948 hardRename:
7949 type: object
7950 additionalProperties:
7951 type: string
7952 description: Rename a key/value pair with key KEY to RENAMED_KEY if KEY exists. If RENAMED_KEY already exists, this field is overwritten
7953 remove:
7954 type: string
7955 description: Remove a key/value pair with key KEY if it exists
7956 removeRegex:
7957 type: string
7958 description: Remove all key/value pairs with key matching regexp KEY
7959 removeWildcard:
7960 type: string
7961 description: Remove all key/value pairs with key matching wildcard KEY
7962 rename:
7963 type: object
7964 additionalProperties:
7965 type: string
7966 description: Rename a key/value pair with key KEY to RENAMED_KEY if KEY exists AND RENAMED_KEY does not exist
7967 set:
7968 type: object
7969 additionalProperties:
7970 type: string
7971 description: Add a key/value pair with key KEY and value VALUE. If KEY already exists, this field is overwritten
7972 multiline:
7973 type: object
7974 description: Multiline defines a Multiline configuration.
7975 properties:
7976 alias:
7977 type: string
7978 description: Alias for the plugin
7979 keyContent:
7980 type: string
7981 description: Key name that holds the content to process. Note that a Multiline Parser definition can already specify the key_content to use, but this option allows to overwrite that value for the purpose of the filter.
7982 parser:
7983 type: string
7984 description: Specify one or multiple Multiline Parsing definitions to apply to the content. You can specify multiple multiline parsers to detect different formats by separating them with a comma.
7985 retryLimit:
7986 type: string
7987 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
7988 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
7989 required:
7990 - parser
7991 nest:
7992 type: object
7993 description: Nest defines Nest Filter configuration.
7994 properties:
7995 addPrefix:
7996 type: string
7997 description: Prefix affected keys with this string
7998 alias:
7999 type: string
8000 description: Alias for the plugin
8001 nestUnder:
8002 type: string
8003 description: Nest records matching the Wildcard under this key
8004 nestedUnder:
8005 type: string
8006 description: Lift records nested under the Nested_under key
8007 operation:
8008 type: string
8009 description: Select the operation nest or lift
8010 enum:
8011 - nest
8012 - lift
8013 removePrefix:
8014 type: string
8015 description: Remove prefix from affected keys if it matches this string
8016 retryLimit:
8017 type: string
8018 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
8019 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
8020 wildcard:
8021 type: array
8022 description: Nest records which field matches the wildcard
8023 items:
8024 type: string
8025 parser:
8026 type: object
8027 description: Parser defines Parser Filter configuration.
8028 properties:
8029 alias:
8030 type: string
8031 description: Alias for the plugin
8032 keyName:
8033 type: string
8034 description: Specify field name in record to parse.
8035 parser:
8036 type: string
8037 description: Specify the parser name to interpret the field. Multiple Parser entries are allowed (split by comma).
8038 preserveKey:
8039 type: boolean
8040 description: Keep original Key_Name field in the parsed result. If false, the field will be removed.
8041 reserveData:
8042 type: boolean
8043 description: Keep all other original fields in the parsed result. If false, all other original fields will be removed.
8044 retryLimit:
8045 type: string
8046 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
8047 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
8048 unescapeKey:
8049 type: boolean
8050 description: 'If the key is a escaped string (e.g: stringify JSON), unescape the string before to apply the parser.'
8051 recordModifier:
8052 type: object
8053 description: RecordModifier defines Record Modifier Filter configuration.
8054 properties:
8055 alias:
8056 type: string
8057 description: Alias for the plugin
8058 allowlistKeys:
8059 type: array
8060 description: If the key is not matched, that field is removed.
8061 items:
8062 type: string
8063 records:
8064 type: array
8065 description: Append fields. This parameter needs key and value pair.
8066 items:
8067 type: string
8068 removeKeys:
8069 type: array
8070 description: If the key is matched, that field is removed.
8071 items:
8072 type: string
8073 retryLimit:
8074 type: string
8075 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
8076 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
8077 uuidKeys:
8078 type: array
8079 description: If set, the plugin appends uuid to each record. The value assigned becomes the key in the map.
8080 items:
8081 type: string
8082 whitelistKeys:
8083 type: array
8084 description: An alias of allowlistKeys for backwards compatibility.
8085 items:
8086 type: string
8087 rewriteTag:
8088 type: object
8089 description: RewriteTag defines a RewriteTag configuration.
8090 properties:
8091 alias:
8092 type: string
8093 description: Alias for the plugin
8094 emitterName:
8095 type: string
8096 description: When the filter emits a record under the new Tag, there is an internal emitter plugin that takes care of the job. Since this emitter expose metrics as any other component of the pipeline, you can use this property to configure an optional name for it.
8097 retryLimit:
8098 type: string
8099 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
8100 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
8101 rules:
8102 type: array
8103 description: 'Defines the matching criteria and the format of the Tag for the matching record. The Rule format have four components: KEY REGEX NEW_TAG KEEP.'
8104 items:
8105 type: string
8106 throttle:
8107 type: object
8108 description: Throttle defines a Throttle configuration.
8109 properties:
8110 alias:
8111 type: string
8112 description: Alias for the plugin
8113 interval:
8114 type: string
8115 description: Interval is the time interval expressed in "sleep" format. e.g. 3s, 1.5m, 0.5h, etc.
8116 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
8117 printStatus:
8118 type: boolean
8119 description: PrintStatus represents whether to print status messages with current rate and the limits to information logs.
8120 rate:
8121 type: integer
8122 description: Rate is the amount of messages for the time.
8123 format: int64
8124 retryLimit:
8125 type: string
8126 description: 'RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1.'
8127 pattern: ^(((f|F)alse)|(no_limits)|(no_retries)|([1-9]+[0-9]*))$
8128 window:
8129 type: integer
8130 description: Window is the amount of intervals to calculate average over.
8131 format: int64
8132 logLevel:
8133 type: string
8134 enum:
8135 - "off"
8136 - error
8137 - warning
8138 - info
8139 - debug
8140 - trace
8141 match:
8142 type: string
8143 description: A pattern to match against the tags of incoming records. It's case-sensitive and support the star (*) character as a wildcard.
8144 matchRegex:
8145 type: string
8146 description: A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax.
8147 served: true
8148 storage: true
8149---
8150apiVersion: apiextensions.k8s.io/v1
8151kind: CustomResourceDefinition
8152metadata:
8153 name: filters.fluentd.fluent.io
8154 annotations:
8155 controller-gen.kubebuilder.io/version: v0.11.3
8156 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
8157 pallet.edge.ncr.com/name: fluent-operator
8158 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
8159 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
8160 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
8161 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
8162spec:
8163 group: fluentd.fluent.io
8164 names:
8165 kind: Filter
8166 listKind: FilterList
8167 plural: filters
8168 shortNames:
8169 - fdf
8170 singular: filter
8171 scope: Namespaced
8172 versions:
8173 - name: v1alpha1
8174 schema:
8175 openAPIV3Schema:
8176 type: object
8177 description: Filter is the Schema for the filters API
8178 properties:
8179 apiVersion:
8180 type: string
8181 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'
8182 kind:
8183 type: string
8184 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'
8185 metadata:
8186 type: object
8187 spec:
8188 type: object
8189 description: FilterSpec defines the desired state of Filter
8190 properties:
8191 filters:
8192 type: array
8193 items:
8194 type: object
8195 description: Filter defines all available filter plugins and their parameters.
8196 properties:
8197 customPlugin:
8198 type: object
8199 description: Custom plugin type
8200 properties:
8201 config:
8202 type: string
8203 required:
8204 - config
8205 grep:
8206 type: object
8207 description: The filter_grep filter plugin
8208 properties:
8209 and:
8210 type: array
8211 items:
8212 type: object
8213 description: And defines the parameters for the "and" plugin
8214 properties:
8215 exclude:
8216 type: object
8217 description: Exclude defines the parameters for the exclude plugin
8218 properties:
8219 key:
8220 type: string
8221 pattern:
8222 type: string
8223 regexp:
8224 type: object
8225 description: Regexp defines the parameters for the regexp plugin
8226 properties:
8227 key:
8228 type: string
8229 pattern:
8230 type: string
8231 exclude:
8232 type: array
8233 items:
8234 type: object
8235 description: Exclude defines the parameters for the exclude plugin
8236 properties:
8237 key:
8238 type: string
8239 pattern:
8240 type: string
8241 or:
8242 type: array
8243 items:
8244 type: object
8245 description: Or defines the parameters for the "or" plugin
8246 properties:
8247 exclude:
8248 type: object
8249 description: Exclude defines the parameters for the exclude plugin
8250 properties:
8251 key:
8252 type: string
8253 pattern:
8254 type: string
8255 regexp:
8256 type: object
8257 description: Regexp defines the parameters for the regexp plugin
8258 properties:
8259 key:
8260 type: string
8261 pattern:
8262 type: string
8263 regexp:
8264 type: array
8265 items:
8266 type: object
8267 description: Regexp defines the parameters for the regexp plugin
8268 properties:
8269 key:
8270 type: string
8271 pattern:
8272 type: string
8273 logLevel:
8274 type: string
8275 description: The @log_level parameter specifies the plugin-specific logging level
8276 parser:
8277 type: object
8278 description: The filter_parser filter plugin
8279 properties:
8280 emitInvalidRecordToError:
8281 type: boolean
8282 description: 'Emits invalid record to @ERROR label. Invalid cases are: key does not exist;the format is not matched;an unexpected error. If you want to ignore these errors, set false.'
8283 hashValueField:
8284 type: string
8285 description: Stores the parsed values as a hash value in a field.
8286 injectKeyPrefix:
8287 type: string
8288 description: Stores the parsed values with the specified key name prefix.
8289 keyName:
8290 type: string
8291 description: 'Specifies the field name in the record to parse. Required parameter. i.e: If set keyName to log, {"key":"value","log":"{\"time\":1622473200,\"user\":1}"} => {"user":1}'
8292 parse:
8293 type: object
8294 description: Parse defines various parameters for the parse plugin
8295 properties:
8296 type:
8297 type: string
8298 description: The @type parameter specifies the type of the plugin.
8299 enum:
8300 - regexp
8301 - apache2
8302 - apache_error
8303 - nginx
8304 - syslog
8305 - csv
8306 - tsv
8307 - ltsv
8308 - json
8309 - multiline
8310 - none
8311 estimateCurrentEvent:
8312 type: boolean
8313 description: If true, use Fluent::Eventnow(current time) as a timestamp when time_key is specified.
8314 expression:
8315 type: string
8316 description: Specifies the regular expression for matching logs. Regular expression also supports i and m suffix.
8317 id:
8318 type: string
8319 description: The @id parameter specifies a unique name for the configuration.
8320 keepTimeKey:
8321 type: boolean
8322 description: If true, keep time field in th record.
8323 localtime:
8324 type: boolean
8325 description: If true, uses local time.
8326 logLevel:
8327 type: string
8328 description: The @log_level parameter specifies the plugin-specific logging level
8329 timeFormat:
8330 type: string
8331 description: Process value according to the specified format. This is available only when time_type is string
8332 timeFormatFallbacks:
8333 type: string
8334 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
8335 timeKey:
8336 type: string
8337 description: Specify time field for event time. If the event doesn't have this field, current time is used.
8338 timeType:
8339 type: string
8340 description: parses/formats value according to this type, default is string
8341 enum:
8342 - float
8343 - unixtime
8344 - string
8345 - mixed
8346 timeout:
8347 type: string
8348 description: Specify timeout for parse processing.
8349 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
8350 timezone:
8351 type: string
8352 description: Uses the specified timezone.
8353 types:
8354 type: string
8355 description: 'Specify types for converting field into another, i.e: types user_id:integer,paid:bool,paid_usd_amount:float'
8356 utc:
8357 type: boolean
8358 description: If true, uses UTC.
8359 required:
8360 - type
8361 removeKeyNameField:
8362 type: boolean
8363 description: Removes key_name field when parsing is succeeded.
8364 replaceInvalidSequence:
8365 type: boolean
8366 description: If true, invalid string is replaced with safe characters and re-parse it.
8367 reserveData:
8368 type: boolean
8369 description: 'Keeps the original key-value pair in the parsed result. Default is false. i.e: If set keyName to log, reverseData to true, {"key":"value","log":"{\"user\":1,\"num\":2}"} => {"key":"value","log":"{\"user\":1,\"num\":2}","user":1,"num":2}'
8370 reserveTime:
8371 type: boolean
8372 description: Keeps the original event time in the parsed result. Default is false.
8373 required:
8374 - keyName
8375 - parse
8376 recordTransformer:
8377 type: object
8378 description: The filter_record_transformer filter plugin
8379 properties:
8380 autoTypecast:
8381 type: boolean
8382 description: Automatically casts the field types. Default is false. This option is effective only for field values comprised of a single placeholder.
8383 enableRuby:
8384 type: boolean
8385 description: 'When set to true, the full Ruby syntax is enabled in the ${...} expression. The default value is false. i.e: jsonized_record ${record.to_json}'
8386 keepKeys:
8387 type: string
8388 description: A list of keys to keep. Only relevant if renew_record is set to true.
8389 records:
8390 type: array
8391 items:
8392 type: object
8393 description: The parameters inside <record> directives are considered to be new key-value pairs
8394 properties:
8395 value:
8396 type: string
8397 description: The value must from Record properties. See https://docs.fluentd.org/filter/record_transformer#less-than-record-greater-than-directive
8398 key:
8399 type: string
8400 description: New field can be defined as key
8401 required:
8402 - key
8403 - value
8404 removeKeys:
8405 type: string
8406 description: A list of keys to delete. Supports nested field via record_accessor syntax since v1.1.0.
8407 renewRecord:
8408 type: boolean
8409 description: By default, the record transformer filter mutates the incoming data. However, if this parameter is set to true, it modifies a new empty hash instead.
8410 renewTimeKey:
8411 type: string
8412 description: renew_time_key foo overwrites the time of events with a value of the record field foo if exists. The value of foo must be a Unix timestamp.
8413 stdout:
8414 type: object
8415 description: The filter_stdout filter plugin
8416 properties:
8417 format:
8418 type: object
8419 description: The format section
8420 properties:
8421 type:
8422 type: string
8423 description: The @type parameter specifies the type of the plugin.
8424 enum:
8425 - out_file
8426 - json
8427 - ltsv
8428 - csv
8429 - msgpack
8430 - hash
8431 - single_value
8432 delimiter:
8433 type: string
8434 description: Delimiter for each field.
8435 id:
8436 type: string
8437 description: The @id parameter specifies a unique name for the configuration.
8438 localtime:
8439 type: boolean
8440 description: If true, uses local time.
8441 logLevel:
8442 type: string
8443 description: The @log_level parameter specifies the plugin-specific logging level
8444 newline:
8445 type: string
8446 description: Specify newline characters.
8447 enum:
8448 - lf
8449 - crlf
8450 outputTag:
8451 type: boolean
8452 description: Output tag field if true.
8453 outputTime:
8454 type: boolean
8455 description: Output time field if true.
8456 timeFormat:
8457 type: string
8458 description: Process value according to the specified format. This is available only when time_type is string
8459 timeFormatFallbacks:
8460 type: string
8461 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
8462 timeType:
8463 type: string
8464 description: parses/formats value according to this type, default is string
8465 enum:
8466 - float
8467 - unixtime
8468 - string
8469 - mixed
8470 timezone:
8471 type: string
8472 description: Uses the specified timezone.
8473 utc:
8474 type: boolean
8475 description: If true, uses UTC.
8476 inject:
8477 type: object
8478 description: The inject section
8479 properties:
8480 hostname:
8481 type: string
8482 description: Hostname value
8483 hostnameKey:
8484 type: string
8485 description: The field name to inject hostname
8486 inline:
8487 type: object
8488 description: Time section
8489 properties:
8490 localtime:
8491 type: boolean
8492 description: If true, uses local time.
8493 timeFormat:
8494 type: string
8495 description: Process value according to the specified format. This is available only when time_type is string
8496 timeFormatFallbacks:
8497 type: string
8498 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
8499 timeType:
8500 type: string
8501 description: parses/formats value according to this type, default is string
8502 enum:
8503 - float
8504 - unixtime
8505 - string
8506 - mixed
8507 timezone:
8508 type: string
8509 description: Uses the specified timezone.
8510 utc:
8511 type: boolean
8512 description: If true, uses UTC.
8513 tagKey:
8514 type: string
8515 description: The field name to inject tag
8516 timeKey:
8517 type: string
8518 description: The field name to inject time
8519 workerIdKey:
8520 type: string
8521 description: The field name to inject worker_id
8522 tag:
8523 type: string
8524 description: Which tag to be matched.
8525 status:
8526 type: object
8527 description: FilterStatus defines the observed state of Filter
8528 served: true
8529 storage: true
8530 subresources:
8531 status: {}
8532---
8533apiVersion: apiextensions.k8s.io/v1
8534kind: CustomResourceDefinition
8535metadata:
8536 name: fluentbitconfigs.fluentbit.fluent.io
8537 annotations:
8538 controller-gen.kubebuilder.io/version: v0.11.3
8539 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
8540 pallet.edge.ncr.com/name: fluent-operator
8541 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
8542 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
8543 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
8544 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
8545spec:
8546 group: fluentbit.fluent.io
8547 names:
8548 kind: FluentBitConfig
8549 listKind: FluentBitConfigList
8550 plural: fluentbitconfigs
8551 shortNames:
8552 - fbc
8553 singular: fluentbitconfig
8554 scope: Namespaced
8555 versions:
8556 - name: v1alpha2
8557 schema:
8558 openAPIV3Schema:
8559 type: object
8560 description: FluentBitConfig is the Schema for the API
8561 properties:
8562 apiVersion:
8563 type: string
8564 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'
8565 kind:
8566 type: string
8567 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'
8568 metadata:
8569 type: object
8570 spec:
8571 type: object
8572 description: NamespacedFluentBitCfgSpec defines the desired state of FluentBit
8573 properties:
8574 clusterParserSelector:
8575 type: object
8576 description: Select cluster level parser config
8577 properties:
8578 matchExpressions:
8579 type: array
8580 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
8581 items:
8582 type: object
8583 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
8584 properties:
8585 key:
8586 type: string
8587 description: key is the label key that the selector applies to.
8588 operator:
8589 type: string
8590 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
8591 values:
8592 type: array
8593 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.
8594 items:
8595 type: string
8596 required:
8597 - key
8598 - operator
8599 matchLabels:
8600 type: object
8601 additionalProperties:
8602 type: string
8603 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.
8604 x-kubernetes-map-type: atomic
8605 filterSelector:
8606 type: object
8607 description: Select filter plugins
8608 properties:
8609 matchExpressions:
8610 type: array
8611 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
8612 items:
8613 type: object
8614 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
8615 properties:
8616 key:
8617 type: string
8618 description: key is the label key that the selector applies to.
8619 operator:
8620 type: string
8621 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
8622 values:
8623 type: array
8624 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.
8625 items:
8626 type: string
8627 required:
8628 - key
8629 - operator
8630 matchLabels:
8631 type: object
8632 additionalProperties:
8633 type: string
8634 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.
8635 x-kubernetes-map-type: atomic
8636 outputSelector:
8637 type: object
8638 description: Select output plugins
8639 properties:
8640 matchExpressions:
8641 type: array
8642 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
8643 items:
8644 type: object
8645 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
8646 properties:
8647 key:
8648 type: string
8649 description: key is the label key that the selector applies to.
8650 operator:
8651 type: string
8652 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
8653 values:
8654 type: array
8655 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.
8656 items:
8657 type: string
8658 required:
8659 - key
8660 - operator
8661 matchLabels:
8662 type: object
8663 additionalProperties:
8664 type: string
8665 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.
8666 x-kubernetes-map-type: atomic
8667 parserSelector:
8668 type: object
8669 description: Select parser plugins
8670 properties:
8671 matchExpressions:
8672 type: array
8673 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
8674 items:
8675 type: object
8676 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
8677 properties:
8678 key:
8679 type: string
8680 description: key is the label key that the selector applies to.
8681 operator:
8682 type: string
8683 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
8684 values:
8685 type: array
8686 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.
8687 items:
8688 type: string
8689 required:
8690 - key
8691 - operator
8692 matchLabels:
8693 type: object
8694 additionalProperties:
8695 type: string
8696 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.
8697 x-kubernetes-map-type: atomic
8698 served: true
8699 storage: true
8700---
8701apiVersion: apiextensions.k8s.io/v1
8702kind: CustomResourceDefinition
8703metadata:
8704 name: fluentbits.fluentbit.fluent.io
8705 annotations:
8706 controller-gen.kubebuilder.io/version: v0.11.3
8707 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
8708 pallet.edge.ncr.com/name: fluent-operator
8709 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
8710 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
8711 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
8712 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
8713spec:
8714 group: fluentbit.fluent.io
8715 names:
8716 kind: FluentBit
8717 listKind: FluentBitList
8718 plural: fluentbits
8719 shortNames:
8720 - fb
8721 singular: fluentbit
8722 scope: Namespaced
8723 versions:
8724 - name: v1alpha2
8725 schema:
8726 openAPIV3Schema:
8727 type: object
8728 description: FluentBit is the Schema for the fluentbits API
8729 properties:
8730 apiVersion:
8731 type: string
8732 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'
8733 kind:
8734 type: string
8735 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'
8736 metadata:
8737 type: object
8738 spec:
8739 type: object
8740 description: FluentBitSpec defines the desired state of FluentBit
8741 properties:
8742 labels:
8743 type: object
8744 additionalProperties:
8745 type: string
8746 description: Labels to add to each FluentBit pod
8747 annotations:
8748 type: object
8749 additionalProperties:
8750 type: string
8751 description: Annotations to add to each Fluentbit pod.
8752 service:
8753 type: object
8754 description: Service represents configurations on the fluent-bit service.
8755 properties:
8756 name:
8757 type: string
8758 description: Name is the name of the FluentBit service.
8759 labels:
8760 type: object
8761 additionalProperties:
8762 type: string
8763 description: Labels to add to each FluentBit service
8764 annotations:
8765 type: object
8766 additionalProperties:
8767 type: string
8768 description: Annotations to add to each Fluentbit service.
8769 dnsPolicy:
8770 type: string
8771 description: Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'.
8772 hostNetwork:
8773 type: boolean
8774 description: Host networking is requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
8775 schedulerName:
8776 type: string
8777 description: SchedulerName represents the desired scheduler for fluent-bit pods.
8778 priorityClassName:
8779 type: string
8780 description: PriorityClassName represents the pod's priority class.
8781 runtimeClassName:
8782 type: string
8783 description: RuntimeClassName represents the container runtime configuration.
8784 nodeSelector:
8785 type: object
8786 additionalProperties:
8787 type: string
8788 description: NodeSelector
8789 initContainers:
8790 type: array
8791 description: InitContainers represents the pod's init containers.
8792 items:
8793 type: object
8794 description: A single application container that you want to run within a pod.
8795 properties:
8796 name:
8797 type: string
8798 description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
8799 image:
8800 type: string
8801 description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.'
8802 command:
8803 type: array
8804 description: 'Entrypoint array. Not executed within a shell. The container image''s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
8805 items:
8806 type: string
8807 args:
8808 type: array
8809 description: 'Arguments to the entrypoint. The container image''s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
8810 items:
8811 type: string
8812 workingDir:
8813 type: string
8814 description: Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
8815 ports:
8816 type: array
8817 description: List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
8818 items:
8819 type: object
8820 description: ContainerPort represents a network port in a single container.
8821 properties:
8822 name:
8823 type: string
8824 description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
8825 protocol:
8826 type: string
8827 default: TCP
8828 description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
8829 hostPort:
8830 type: integer
8831 description: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
8832 format: int32
8833 containerPort:
8834 type: integer
8835 description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
8836 format: int32
8837 hostIP:
8838 type: string
8839 description: What host IP to bind the external port to.
8840 required:
8841 - containerPort
8842 x-kubernetes-list-map-keys:
8843 - containerPort
8844 - protocol
8845 x-kubernetes-list-type: map
8846 envFrom:
8847 type: array
8848 description: List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
8849 items:
8850 type: object
8851 description: EnvFromSource represents the source of a set of ConfigMaps
8852 properties:
8853 prefix:
8854 type: string
8855 description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
8856 configMapRef:
8857 type: object
8858 description: The ConfigMap to select from
8859 properties:
8860 name:
8861 type: string
8862 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
8863 optional:
8864 type: boolean
8865 description: Specify whether the ConfigMap must be defined
8866 x-kubernetes-map-type: atomic
8867 secretRef:
8868 type: object
8869 description: The Secret to select from
8870 properties:
8871 name:
8872 type: string
8873 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
8874 optional:
8875 type: boolean
8876 description: Specify whether the Secret must be defined
8877 x-kubernetes-map-type: atomic
8878 env:
8879 type: array
8880 description: List of environment variables to set in the container. Cannot be updated.
8881 items:
8882 type: object
8883 description: EnvVar represents an environment variable present in a Container.
8884 properties:
8885 name:
8886 type: string
8887 description: Name of the environment variable. Must be a C_IDENTIFIER.
8888 value:
8889 type: string
8890 description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
8891 valueFrom:
8892 type: object
8893 description: Source for the environment variable's value. Cannot be used if value is not empty.
8894 properties:
8895 fieldRef:
8896 type: object
8897 description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.'
8898 properties:
8899 apiVersion:
8900 type: string
8901 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
8902 fieldPath:
8903 type: string
8904 description: Path of the field to select in the specified API version.
8905 required:
8906 - fieldPath
8907 x-kubernetes-map-type: atomic
8908 resourceFieldRef:
8909 type: object
8910 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.'
8911 properties:
8912 containerName:
8913 type: string
8914 description: 'Container name: required for volumes, optional for env vars'
8915 divisor:
8916 anyOf:
8917 - type: integer
8918 - type: string
8919 description: Specifies the output format of the exposed resources, defaults to "1"
8920 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
8921 x-kubernetes-int-or-string: true
8922 resource:
8923 type: string
8924 description: 'Required: resource to select'
8925 required:
8926 - resource
8927 x-kubernetes-map-type: atomic
8928 configMapKeyRef:
8929 type: object
8930 description: Selects a key of a ConfigMap.
8931 properties:
8932 name:
8933 type: string
8934 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
8935 key:
8936 type: string
8937 description: The key to select.
8938 optional:
8939 type: boolean
8940 description: Specify whether the ConfigMap or its key must be defined
8941 required:
8942 - key
8943 x-kubernetes-map-type: atomic
8944 secretKeyRef:
8945 type: object
8946 description: Selects a key of a secret in the pod's namespace
8947 properties:
8948 name:
8949 type: string
8950 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
8951 key:
8952 type: string
8953 description: The key of the secret to select from. Must be a valid secret key.
8954 optional:
8955 type: boolean
8956 description: Specify whether the Secret or its key must be defined
8957 required:
8958 - key
8959 x-kubernetes-map-type: atomic
8960 required:
8961 - name
8962 resources:
8963 type: object
8964 description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
8965 properties:
8966 claims:
8967 type: array
8968 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
8969 items:
8970 type: object
8971 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
8972 properties:
8973 name:
8974 type: string
8975 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.
8976 required:
8977 - name
8978 x-kubernetes-list-map-keys:
8979 - name
8980 x-kubernetes-list-type: map
8981 limits:
8982 type: object
8983 additionalProperties:
8984 anyOf:
8985 - type: integer
8986 - type: string
8987 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
8988 x-kubernetes-int-or-string: true
8989 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
8990 requests:
8991 type: object
8992 additionalProperties:
8993 anyOf:
8994 - type: integer
8995 - type: string
8996 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
8997 x-kubernetes-int-or-string: true
8998 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
8999 volumeMounts:
9000 type: array
9001 description: Pod volumes to mount into the container's filesystem. Cannot be updated.
9002 items:
9003 type: object
9004 description: VolumeMount describes a mounting of a Volume within a container.
9005 properties:
9006 name:
9007 type: string
9008 description: This must match the Name of a Volume.
9009 readOnly:
9010 type: boolean
9011 description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
9012 mountPath:
9013 type: string
9014 description: Path within the container at which the volume should be mounted. Must not contain ':'.
9015 subPath:
9016 type: string
9017 description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
9018 subPathExpr:
9019 type: string
9020 description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
9021 mountPropagation:
9022 type: string
9023 description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
9024 required:
9025 - mountPath
9026 - name
9027 volumeDevices:
9028 type: array
9029 description: volumeDevices is the list of block devices to be used by the container.
9030 items:
9031 type: object
9032 description: volumeDevice describes a mapping of a raw block device within a container.
9033 properties:
9034 name:
9035 type: string
9036 description: name must match the name of a persistentVolumeClaim in the pod
9037 devicePath:
9038 type: string
9039 description: devicePath is the path inside of the container that the device will be mapped to.
9040 required:
9041 - devicePath
9042 - name
9043 livenessProbe:
9044 type: object
9045 description: 'Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
9046 properties:
9047 terminationGracePeriodSeconds:
9048 type: integer
9049 description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
9050 format: int64
9051 exec:
9052 type: object
9053 description: Exec specifies the action to take.
9054 properties:
9055 command:
9056 type: array
9057 description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
9058 items:
9059 type: string
9060 failureThreshold:
9061 type: integer
9062 description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
9063 format: int32
9064 grpc:
9065 type: object
9066 description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
9067 properties:
9068 service:
9069 type: string
9070 description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
9071 port:
9072 type: integer
9073 description: Port number of the gRPC service. Number must be in the range 1 to 65535.
9074 format: int32
9075 required:
9076 - port
9077 httpGet:
9078 type: object
9079 description: HTTPGet specifies the http request to perform.
9080 properties:
9081 port:
9082 anyOf:
9083 - type: integer
9084 - type: string
9085 description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9086 x-kubernetes-int-or-string: true
9087 host:
9088 type: string
9089 description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
9090 httpHeaders:
9091 type: array
9092 description: Custom headers to set in the request. HTTP allows repeated headers.
9093 items:
9094 type: object
9095 description: HTTPHeader describes a custom header to be used in HTTP probes
9096 properties:
9097 name:
9098 type: string
9099 description: The header field name
9100 value:
9101 type: string
9102 description: The header field value
9103 required:
9104 - name
9105 - value
9106 path:
9107 type: string
9108 description: Path to access on the HTTP server.
9109 scheme:
9110 type: string
9111 description: Scheme to use for connecting to the host. Defaults to HTTP.
9112 required:
9113 - port
9114 initialDelaySeconds:
9115 type: integer
9116 description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
9117 format: int32
9118 periodSeconds:
9119 type: integer
9120 description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
9121 format: int32
9122 successThreshold:
9123 type: integer
9124 description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
9125 format: int32
9126 tcpSocket:
9127 type: object
9128 description: TCPSocket specifies an action involving a TCP port.
9129 properties:
9130 port:
9131 anyOf:
9132 - type: integer
9133 - type: string
9134 description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9135 x-kubernetes-int-or-string: true
9136 host:
9137 type: string
9138 description: 'Optional: Host name to connect to, defaults to the pod IP.'
9139 required:
9140 - port
9141 timeoutSeconds:
9142 type: integer
9143 description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
9144 format: int32
9145 readinessProbe:
9146 type: object
9147 description: 'Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
9148 properties:
9149 terminationGracePeriodSeconds:
9150 type: integer
9151 description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
9152 format: int64
9153 exec:
9154 type: object
9155 description: Exec specifies the action to take.
9156 properties:
9157 command:
9158 type: array
9159 description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
9160 items:
9161 type: string
9162 failureThreshold:
9163 type: integer
9164 description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
9165 format: int32
9166 grpc:
9167 type: object
9168 description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
9169 properties:
9170 service:
9171 type: string
9172 description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
9173 port:
9174 type: integer
9175 description: Port number of the gRPC service. Number must be in the range 1 to 65535.
9176 format: int32
9177 required:
9178 - port
9179 httpGet:
9180 type: object
9181 description: HTTPGet specifies the http request to perform.
9182 properties:
9183 port:
9184 anyOf:
9185 - type: integer
9186 - type: string
9187 description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9188 x-kubernetes-int-or-string: true
9189 host:
9190 type: string
9191 description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
9192 httpHeaders:
9193 type: array
9194 description: Custom headers to set in the request. HTTP allows repeated headers.
9195 items:
9196 type: object
9197 description: HTTPHeader describes a custom header to be used in HTTP probes
9198 properties:
9199 name:
9200 type: string
9201 description: The header field name
9202 value:
9203 type: string
9204 description: The header field value
9205 required:
9206 - name
9207 - value
9208 path:
9209 type: string
9210 description: Path to access on the HTTP server.
9211 scheme:
9212 type: string
9213 description: Scheme to use for connecting to the host. Defaults to HTTP.
9214 required:
9215 - port
9216 initialDelaySeconds:
9217 type: integer
9218 description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
9219 format: int32
9220 periodSeconds:
9221 type: integer
9222 description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
9223 format: int32
9224 successThreshold:
9225 type: integer
9226 description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
9227 format: int32
9228 tcpSocket:
9229 type: object
9230 description: TCPSocket specifies an action involving a TCP port.
9231 properties:
9232 port:
9233 anyOf:
9234 - type: integer
9235 - type: string
9236 description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9237 x-kubernetes-int-or-string: true
9238 host:
9239 type: string
9240 description: 'Optional: Host name to connect to, defaults to the pod IP.'
9241 required:
9242 - port
9243 timeoutSeconds:
9244 type: integer
9245 description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
9246 format: int32
9247 lifecycle:
9248 type: object
9249 description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
9250 properties:
9251 postStart:
9252 type: object
9253 description: 'PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
9254 properties:
9255 exec:
9256 type: object
9257 description: Exec specifies the action to take.
9258 properties:
9259 command:
9260 type: array
9261 description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
9262 items:
9263 type: string
9264 httpGet:
9265 type: object
9266 description: HTTPGet specifies the http request to perform.
9267 properties:
9268 port:
9269 anyOf:
9270 - type: integer
9271 - type: string
9272 description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9273 x-kubernetes-int-or-string: true
9274 host:
9275 type: string
9276 description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
9277 httpHeaders:
9278 type: array
9279 description: Custom headers to set in the request. HTTP allows repeated headers.
9280 items:
9281 type: object
9282 description: HTTPHeader describes a custom header to be used in HTTP probes
9283 properties:
9284 name:
9285 type: string
9286 description: The header field name
9287 value:
9288 type: string
9289 description: The header field value
9290 required:
9291 - name
9292 - value
9293 path:
9294 type: string
9295 description: Path to access on the HTTP server.
9296 scheme:
9297 type: string
9298 description: Scheme to use for connecting to the host. Defaults to HTTP.
9299 required:
9300 - port
9301 tcpSocket:
9302 type: object
9303 description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
9304 properties:
9305 port:
9306 anyOf:
9307 - type: integer
9308 - type: string
9309 description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9310 x-kubernetes-int-or-string: true
9311 host:
9312 type: string
9313 description: 'Optional: Host name to connect to, defaults to the pod IP.'
9314 required:
9315 - port
9316 preStop:
9317 type: object
9318 description: 'PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod''s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
9319 properties:
9320 exec:
9321 type: object
9322 description: Exec specifies the action to take.
9323 properties:
9324 command:
9325 type: array
9326 description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
9327 items:
9328 type: string
9329 httpGet:
9330 type: object
9331 description: HTTPGet specifies the http request to perform.
9332 properties:
9333 port:
9334 anyOf:
9335 - type: integer
9336 - type: string
9337 description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9338 x-kubernetes-int-or-string: true
9339 host:
9340 type: string
9341 description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
9342 httpHeaders:
9343 type: array
9344 description: Custom headers to set in the request. HTTP allows repeated headers.
9345 items:
9346 type: object
9347 description: HTTPHeader describes a custom header to be used in HTTP probes
9348 properties:
9349 name:
9350 type: string
9351 description: The header field name
9352 value:
9353 type: string
9354 description: The header field value
9355 required:
9356 - name
9357 - value
9358 path:
9359 type: string
9360 description: Path to access on the HTTP server.
9361 scheme:
9362 type: string
9363 description: Scheme to use for connecting to the host. Defaults to HTTP.
9364 required:
9365 - port
9366 tcpSocket:
9367 type: object
9368 description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
9369 properties:
9370 port:
9371 anyOf:
9372 - type: integer
9373 - type: string
9374 description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9375 x-kubernetes-int-or-string: true
9376 host:
9377 type: string
9378 description: 'Optional: Host name to connect to, defaults to the pod IP.'
9379 required:
9380 - port
9381 terminationMessagePath:
9382 type: string
9383 description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
9384 terminationMessagePolicy:
9385 type: string
9386 description: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
9387 imagePullPolicy:
9388 type: string
9389 description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
9390 securityContext:
9391 type: object
9392 description: 'SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
9393 properties:
9394 allowPrivilegeEscalation:
9395 type: boolean
9396 description: 'AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.'
9397 capabilities:
9398 type: object
9399 description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
9400 properties:
9401 add:
9402 type: array
9403 description: Added capabilities
9404 items:
9405 type: string
9406 description: Capability represent POSIX capabilities type
9407 drop:
9408 type: array
9409 description: Removed capabilities
9410 items:
9411 type: string
9412 description: Capability represent POSIX capabilities type
9413 privileged:
9414 type: boolean
9415 description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
9416 procMount:
9417 type: string
9418 description: procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
9419 readOnlyRootFilesystem:
9420 type: boolean
9421 description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
9422 runAsGroup:
9423 type: integer
9424 description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
9425 format: int64
9426 runAsNonRoot:
9427 type: boolean
9428 description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
9429 runAsUser:
9430 type: integer
9431 description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
9432 format: int64
9433 seLinuxOptions:
9434 type: object
9435 description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
9436 properties:
9437 type:
9438 type: string
9439 description: Type is a SELinux type label that applies to the container.
9440 level:
9441 type: string
9442 description: Level is SELinux level label that applies to the container.
9443 role:
9444 type: string
9445 description: Role is a SELinux role label that applies to the container.
9446 user:
9447 type: string
9448 description: User is a SELinux user label that applies to the container.
9449 seccompProfile:
9450 type: object
9451 description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
9452 properties:
9453 type:
9454 type: string
9455 description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
9456 localhostProfile:
9457 type: string
9458 description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
9459 required:
9460 - type
9461 windowsOptions:
9462 type: object
9463 description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
9464 properties:
9465 gmsaCredentialSpec:
9466 type: string
9467 description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
9468 gmsaCredentialSpecName:
9469 type: string
9470 description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
9471 hostProcess:
9472 type: boolean
9473 description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
9474 runAsUserName:
9475 type: string
9476 description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
9477 stdin:
9478 type: boolean
9479 description: Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
9480 stdinOnce:
9481 type: boolean
9482 description: Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
9483 tty:
9484 type: boolean
9485 description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
9486 startupProbe:
9487 type: object
9488 description: 'StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod''s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
9489 properties:
9490 terminationGracePeriodSeconds:
9491 type: integer
9492 description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
9493 format: int64
9494 exec:
9495 type: object
9496 description: Exec specifies the action to take.
9497 properties:
9498 command:
9499 type: array
9500 description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
9501 items:
9502 type: string
9503 failureThreshold:
9504 type: integer
9505 description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
9506 format: int32
9507 grpc:
9508 type: object
9509 description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
9510 properties:
9511 service:
9512 type: string
9513 description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
9514 port:
9515 type: integer
9516 description: Port number of the gRPC service. Number must be in the range 1 to 65535.
9517 format: int32
9518 required:
9519 - port
9520 httpGet:
9521 type: object
9522 description: HTTPGet specifies the http request to perform.
9523 properties:
9524 port:
9525 anyOf:
9526 - type: integer
9527 - type: string
9528 description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9529 x-kubernetes-int-or-string: true
9530 host:
9531 type: string
9532 description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
9533 httpHeaders:
9534 type: array
9535 description: Custom headers to set in the request. HTTP allows repeated headers.
9536 items:
9537 type: object
9538 description: HTTPHeader describes a custom header to be used in HTTP probes
9539 properties:
9540 name:
9541 type: string
9542 description: The header field name
9543 value:
9544 type: string
9545 description: The header field value
9546 required:
9547 - name
9548 - value
9549 path:
9550 type: string
9551 description: Path to access on the HTTP server.
9552 scheme:
9553 type: string
9554 description: Scheme to use for connecting to the host. Defaults to HTTP.
9555 required:
9556 - port
9557 initialDelaySeconds:
9558 type: integer
9559 description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
9560 format: int32
9561 periodSeconds:
9562 type: integer
9563 description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
9564 format: int32
9565 successThreshold:
9566 type: integer
9567 description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
9568 format: int32
9569 tcpSocket:
9570 type: object
9571 description: TCPSocket specifies an action involving a TCP port.
9572 properties:
9573 port:
9574 anyOf:
9575 - type: integer
9576 - type: string
9577 description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
9578 x-kubernetes-int-or-string: true
9579 host:
9580 type: string
9581 description: 'Optional: Host name to connect to, defaults to the pod IP.'
9582 required:
9583 - port
9584 timeoutSeconds:
9585 type: integer
9586 description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
9587 format: int32
9588 required:
9589 - name
9590 volumes:
9591 type: array
9592 description: List of volumes that can be mounted by containers belonging to the pod.
9593 items:
9594 type: object
9595 description: Volume represents a named volume in a pod that may be accessed by any container in the pod.
9596 properties:
9597 name:
9598 type: string
9599 description: 'name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
9600 awsElasticBlockStore:
9601 type: object
9602 description: 'awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
9603 properties:
9604 readOnly:
9605 type: boolean
9606 description: 'readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
9607 fsType:
9608 type: string
9609 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine'
9610 partition:
9611 type: integer
9612 description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).'
9613 format: int32
9614 volumeID:
9615 type: string
9616 description: 'volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
9617 required:
9618 - volumeID
9619 azureDisk:
9620 type: object
9621 description: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
9622 properties:
9623 kind:
9624 type: string
9625 description: 'kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared'
9626 readOnly:
9627 type: boolean
9628 description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
9629 cachingMode:
9630 type: string
9631 description: 'cachingMode is the Host Caching mode: None, Read Only, Read Write.'
9632 diskName:
9633 type: string
9634 description: diskName is the Name of the data disk in the blob storage
9635 diskURI:
9636 type: string
9637 description: diskURI is the URI of data disk in the blob storage
9638 fsType:
9639 type: string
9640 description: fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
9641 required:
9642 - diskName
9643 - diskURI
9644 azureFile:
9645 type: object
9646 description: azureFile represents an Azure File Service mount on the host and bind mount to the pod.
9647 properties:
9648 readOnly:
9649 type: boolean
9650 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
9651 secretName:
9652 type: string
9653 description: secretName is the name of secret that contains Azure Storage Account Name and Key
9654 shareName:
9655 type: string
9656 description: shareName is the azure share Name
9657 required:
9658 - secretName
9659 - shareName
9660 cephfs:
9661 type: object
9662 description: cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
9663 properties:
9664 readOnly:
9665 type: boolean
9666 description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
9667 secretRef:
9668 type: object
9669 description: 'secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
9670 properties:
9671 name:
9672 type: string
9673 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
9674 x-kubernetes-map-type: atomic
9675 monitors:
9676 type: array
9677 description: 'monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
9678 items:
9679 type: string
9680 path:
9681 type: string
9682 description: 'path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
9683 secretFile:
9684 type: string
9685 description: 'secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
9686 user:
9687 type: string
9688 description: 'user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
9689 required:
9690 - monitors
9691 cinder:
9692 type: object
9693 description: 'cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
9694 properties:
9695 readOnly:
9696 type: boolean
9697 description: 'readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
9698 secretRef:
9699 type: object
9700 description: 'secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.'
9701 properties:
9702 name:
9703 type: string
9704 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
9705 x-kubernetes-map-type: atomic
9706 fsType:
9707 type: string
9708 description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
9709 volumeID:
9710 type: string
9711 description: 'volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
9712 required:
9713 - volumeID
9714 configMap:
9715 type: object
9716 description: configMap represents a configMap that should populate this volume
9717 properties:
9718 name:
9719 type: string
9720 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
9721 defaultMode:
9722 type: integer
9723 description: 'defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
9724 format: int32
9725 items:
9726 type: array
9727 description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
9728 items:
9729 type: object
9730 description: Maps a string key to a path within a volume.
9731 properties:
9732 key:
9733 type: string
9734 description: key is the key to project.
9735 mode:
9736 type: integer
9737 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
9738 format: int32
9739 path:
9740 type: string
9741 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
9742 required:
9743 - key
9744 - path
9745 optional:
9746 type: boolean
9747 description: optional specify whether the ConfigMap or its keys must be defined
9748 x-kubernetes-map-type: atomic
9749 csi:
9750 type: object
9751 description: csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
9752 properties:
9753 readOnly:
9754 type: boolean
9755 description: readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
9756 driver:
9757 type: string
9758 description: driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
9759 fsType:
9760 type: string
9761 description: fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
9762 nodePublishSecretRef:
9763 type: object
9764 description: nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
9765 properties:
9766 name:
9767 type: string
9768 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
9769 x-kubernetes-map-type: atomic
9770 volumeAttributes:
9771 type: object
9772 additionalProperties:
9773 type: string
9774 description: volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
9775 required:
9776 - driver
9777 downwardAPI:
9778 type: object
9779 description: downwardAPI represents downward API about the pod that should populate this volume
9780 properties:
9781 defaultMode:
9782 type: integer
9783 description: 'Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
9784 format: int32
9785 items:
9786 type: array
9787 description: Items is a list of downward API volume file
9788 items:
9789 type: object
9790 description: DownwardAPIVolumeFile represents information to create the file containing the pod field
9791 properties:
9792 fieldRef:
9793 type: object
9794 description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
9795 properties:
9796 apiVersion:
9797 type: string
9798 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
9799 fieldPath:
9800 type: string
9801 description: Path of the field to select in the specified API version.
9802 required:
9803 - fieldPath
9804 x-kubernetes-map-type: atomic
9805 resourceFieldRef:
9806 type: object
9807 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
9808 properties:
9809 containerName:
9810 type: string
9811 description: 'Container name: required for volumes, optional for env vars'
9812 divisor:
9813 anyOf:
9814 - type: integer
9815 - type: string
9816 description: Specifies the output format of the exposed resources, defaults to "1"
9817 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
9818 x-kubernetes-int-or-string: true
9819 resource:
9820 type: string
9821 description: 'Required: resource to select'
9822 required:
9823 - resource
9824 x-kubernetes-map-type: atomic
9825 mode:
9826 type: integer
9827 description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
9828 format: int32
9829 path:
9830 type: string
9831 description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
9832 required:
9833 - path
9834 emptyDir:
9835 type: object
9836 description: 'emptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
9837 properties:
9838 medium:
9839 type: string
9840 description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
9841 sizeLimit:
9842 anyOf:
9843 - type: integer
9844 - type: string
9845 description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
9846 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
9847 x-kubernetes-int-or-string: true
9848 ephemeral:
9849 type: object
9850 description: "ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."
9851 properties:
9852 volumeClaimTemplate:
9853 type: object
9854 description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
9855 properties:
9856 metadata:
9857 type: object
9858 description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
9859 properties:
9860 name:
9861 type: string
9862 namespace:
9863 type: string
9864 labels:
9865 type: object
9866 additionalProperties:
9867 type: string
9868 annotations:
9869 type: object
9870 additionalProperties:
9871 type: string
9872 finalizers:
9873 type: array
9874 items:
9875 type: string
9876 spec:
9877 type: object
9878 description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
9879 properties:
9880 selector:
9881 type: object
9882 description: selector is a label query over volumes to consider for binding.
9883 properties:
9884 matchExpressions:
9885 type: array
9886 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
9887 items:
9888 type: object
9889 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
9890 properties:
9891 key:
9892 type: string
9893 description: key is the label key that the selector applies to.
9894 operator:
9895 type: string
9896 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
9897 values:
9898 type: array
9899 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.
9900 items:
9901 type: string
9902 required:
9903 - key
9904 - operator
9905 matchLabels:
9906 type: object
9907 additionalProperties:
9908 type: string
9909 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.
9910 x-kubernetes-map-type: atomic
9911 resources:
9912 type: object
9913 description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
9914 properties:
9915 claims:
9916 type: array
9917 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
9918 items:
9919 type: object
9920 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
9921 properties:
9922 name:
9923 type: string
9924 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.
9925 required:
9926 - name
9927 x-kubernetes-list-map-keys:
9928 - name
9929 x-kubernetes-list-type: map
9930 limits:
9931 type: object
9932 additionalProperties:
9933 anyOf:
9934 - type: integer
9935 - type: string
9936 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
9937 x-kubernetes-int-or-string: true
9938 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
9939 requests:
9940 type: object
9941 additionalProperties:
9942 anyOf:
9943 - type: integer
9944 - type: string
9945 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
9946 x-kubernetes-int-or-string: true
9947 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
9948 accessModes:
9949 type: array
9950 description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
9951 items:
9952 type: string
9953 dataSource:
9954 type: object
9955 description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
9956 properties:
9957 name:
9958 type: string
9959 description: Name is the name of resource being referenced
9960 kind:
9961 type: string
9962 description: Kind is the type of resource being referenced
9963 apiGroup:
9964 type: string
9965 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
9966 required:
9967 - kind
9968 - name
9969 x-kubernetes-map-type: atomic
9970 dataSourceRef:
9971 type: object
9972 description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
9973 properties:
9974 name:
9975 type: string
9976 description: Name is the name of resource being referenced
9977 namespace:
9978 type: string
9979 description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
9980 kind:
9981 type: string
9982 description: Kind is the type of resource being referenced
9983 apiGroup:
9984 type: string
9985 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
9986 required:
9987 - kind
9988 - name
9989 storageClassName:
9990 type: string
9991 description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
9992 volumeMode:
9993 type: string
9994 description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
9995 volumeName:
9996 type: string
9997 description: volumeName is the binding reference to the PersistentVolume backing this claim.
9998 required:
9999 - spec
10000 fc:
10001 type: object
10002 description: fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
10003 properties:
10004 readOnly:
10005 type: boolean
10006 description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
10007 fsType:
10008 type: string
10009 description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
10010 lun:
10011 type: integer
10012 description: 'lun is Optional: FC target lun number'
10013 format: int32
10014 targetWWNs:
10015 type: array
10016 description: 'targetWWNs is Optional: FC target worldwide names (WWNs)'
10017 items:
10018 type: string
10019 wwids:
10020 type: array
10021 description: 'wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
10022 items:
10023 type: string
10024 flexVolume:
10025 type: object
10026 description: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
10027 properties:
10028 readOnly:
10029 type: boolean
10030 description: 'readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
10031 secretRef:
10032 type: object
10033 description: 'secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.'
10034 properties:
10035 name:
10036 type: string
10037 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
10038 x-kubernetes-map-type: atomic
10039 driver:
10040 type: string
10041 description: driver is the name of the driver to use for this volume.
10042 fsType:
10043 type: string
10044 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
10045 options:
10046 type: object
10047 additionalProperties:
10048 type: string
10049 description: 'options is Optional: this field holds extra command options if any.'
10050 required:
10051 - driver
10052 flocker:
10053 type: object
10054 description: flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
10055 properties:
10056 datasetName:
10057 type: string
10058 description: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
10059 datasetUUID:
10060 type: string
10061 description: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
10062 gcePersistentDisk:
10063 type: object
10064 description: 'gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
10065 properties:
10066 readOnly:
10067 type: boolean
10068 description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
10069 fsType:
10070 type: string
10071 description: 'fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine'
10072 partition:
10073 type: integer
10074 description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
10075 format: int32
10076 pdName:
10077 type: string
10078 description: 'pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
10079 required:
10080 - pdName
10081 gitRepo:
10082 type: object
10083 description: 'gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod''s container.'
10084 properties:
10085 revision:
10086 type: string
10087 description: revision is the commit hash for the specified revision.
10088 directory:
10089 type: string
10090 description: directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
10091 repository:
10092 type: string
10093 description: repository is the URL
10094 required:
10095 - repository
10096 glusterfs:
10097 type: object
10098 description: 'glusterfs represents a Glusterfs mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
10099 properties:
10100 readOnly:
10101 type: boolean
10102 description: 'readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
10103 endpoints:
10104 type: string
10105 description: 'endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
10106 path:
10107 type: string
10108 description: 'path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
10109 required:
10110 - endpoints
10111 - path
10112 hostPath:
10113 type: object
10114 description: 'hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.'
10115 properties:
10116 type:
10117 type: string
10118 description: 'type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
10119 path:
10120 type: string
10121 description: 'path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
10122 required:
10123 - path
10124 iscsi:
10125 type: object
10126 description: 'iscsi represents an ISCSI Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
10127 properties:
10128 readOnly:
10129 type: boolean
10130 description: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
10131 secretRef:
10132 type: object
10133 description: secretRef is the CHAP Secret for iSCSI target and initiator authentication
10134 properties:
10135 name:
10136 type: string
10137 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
10138 x-kubernetes-map-type: atomic
10139 chapAuthDiscovery:
10140 type: boolean
10141 description: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
10142 chapAuthSession:
10143 type: boolean
10144 description: chapAuthSession defines whether support iSCSI Session CHAP authentication
10145 fsType:
10146 type: string
10147 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
10148 initiatorName:
10149 type: string
10150 description: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
10151 iqn:
10152 type: string
10153 description: iqn is the target iSCSI Qualified Name.
10154 iscsiInterface:
10155 type: string
10156 description: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
10157 lun:
10158 type: integer
10159 description: lun represents iSCSI Target Lun number.
10160 format: int32
10161 portals:
10162 type: array
10163 description: portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
10164 items:
10165 type: string
10166 targetPortal:
10167 type: string
10168 description: targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
10169 required:
10170 - iqn
10171 - lun
10172 - targetPortal
10173 nfs:
10174 type: object
10175 description: 'nfs represents an NFS mount on the host that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
10176 properties:
10177 readOnly:
10178 type: boolean
10179 description: 'readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
10180 path:
10181 type: string
10182 description: 'path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
10183 server:
10184 type: string
10185 description: 'server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
10186 required:
10187 - path
10188 - server
10189 persistentVolumeClaim:
10190 type: object
10191 description: 'persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
10192 properties:
10193 readOnly:
10194 type: boolean
10195 description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
10196 claimName:
10197 type: string
10198 description: 'claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
10199 required:
10200 - claimName
10201 photonPersistentDisk:
10202 type: object
10203 description: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
10204 properties:
10205 fsType:
10206 type: string
10207 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
10208 pdID:
10209 type: string
10210 description: pdID is the ID that identifies Photon Controller persistent disk
10211 required:
10212 - pdID
10213 portworxVolume:
10214 type: object
10215 description: portworxVolume represents a portworx volume attached and mounted on kubelets host machine
10216 properties:
10217 readOnly:
10218 type: boolean
10219 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
10220 fsType:
10221 type: string
10222 description: fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
10223 volumeID:
10224 type: string
10225 description: volumeID uniquely identifies a Portworx volume
10226 required:
10227 - volumeID
10228 projected:
10229 type: object
10230 description: projected items for all in one resources secrets, configmaps, and downward API
10231 properties:
10232 defaultMode:
10233 type: integer
10234 description: defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
10235 format: int32
10236 sources:
10237 type: array
10238 description: sources is the list of volume projections
10239 items:
10240 type: object
10241 description: Projection that may be projected along with other supported volume types
10242 properties:
10243 configMap:
10244 type: object
10245 description: configMap information about the configMap data to project
10246 properties:
10247 name:
10248 type: string
10249 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
10250 items:
10251 type: array
10252 description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
10253 items:
10254 type: object
10255 description: Maps a string key to a path within a volume.
10256 properties:
10257 key:
10258 type: string
10259 description: key is the key to project.
10260 mode:
10261 type: integer
10262 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
10263 format: int32
10264 path:
10265 type: string
10266 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
10267 required:
10268 - key
10269 - path
10270 optional:
10271 type: boolean
10272 description: optional specify whether the ConfigMap or its keys must be defined
10273 x-kubernetes-map-type: atomic
10274 downwardAPI:
10275 type: object
10276 description: downwardAPI information about the downwardAPI data to project
10277 properties:
10278 items:
10279 type: array
10280 description: Items is a list of DownwardAPIVolume file
10281 items:
10282 type: object
10283 description: DownwardAPIVolumeFile represents information to create the file containing the pod field
10284 properties:
10285 fieldRef:
10286 type: object
10287 description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
10288 properties:
10289 apiVersion:
10290 type: string
10291 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
10292 fieldPath:
10293 type: string
10294 description: Path of the field to select in the specified API version.
10295 required:
10296 - fieldPath
10297 x-kubernetes-map-type: atomic
10298 resourceFieldRef:
10299 type: object
10300 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
10301 properties:
10302 containerName:
10303 type: string
10304 description: 'Container name: required for volumes, optional for env vars'
10305 divisor:
10306 anyOf:
10307 - type: integer
10308 - type: string
10309 description: Specifies the output format of the exposed resources, defaults to "1"
10310 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
10311 x-kubernetes-int-or-string: true
10312 resource:
10313 type: string
10314 description: 'Required: resource to select'
10315 required:
10316 - resource
10317 x-kubernetes-map-type: atomic
10318 mode:
10319 type: integer
10320 description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
10321 format: int32
10322 path:
10323 type: string
10324 description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
10325 required:
10326 - path
10327 secret:
10328 type: object
10329 description: secret information about the secret data to project
10330 properties:
10331 name:
10332 type: string
10333 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
10334 items:
10335 type: array
10336 description: items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
10337 items:
10338 type: object
10339 description: Maps a string key to a path within a volume.
10340 properties:
10341 key:
10342 type: string
10343 description: key is the key to project.
10344 mode:
10345 type: integer
10346 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
10347 format: int32
10348 path:
10349 type: string
10350 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
10351 required:
10352 - key
10353 - path
10354 optional:
10355 type: boolean
10356 description: optional field specify whether the Secret or its key must be defined
10357 x-kubernetes-map-type: atomic
10358 serviceAccountToken:
10359 type: object
10360 description: serviceAccountToken is information about the serviceAccountToken data to project
10361 properties:
10362 audience:
10363 type: string
10364 description: audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
10365 expirationSeconds:
10366 type: integer
10367 description: expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
10368 format: int64
10369 path:
10370 type: string
10371 description: path is the path relative to the mount point of the file to project the token into.
10372 required:
10373 - path
10374 quobyte:
10375 type: object
10376 description: quobyte represents a Quobyte mount on the host that shares a pod's lifetime
10377 properties:
10378 readOnly:
10379 type: boolean
10380 description: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
10381 group:
10382 type: string
10383 description: group to map volume access to Default is no group
10384 registry:
10385 type: string
10386 description: registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
10387 tenant:
10388 type: string
10389 description: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
10390 user:
10391 type: string
10392 description: user to map volume access to Defaults to serivceaccount user
10393 volume:
10394 type: string
10395 description: volume is a string that references an already created Quobyte volume by name.
10396 required:
10397 - registry
10398 - volume
10399 rbd:
10400 type: object
10401 description: 'rbd represents a Rados Block Device mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
10402 properties:
10403 image:
10404 type: string
10405 description: 'image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
10406 readOnly:
10407 type: boolean
10408 description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
10409 secretRef:
10410 type: object
10411 description: 'secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
10412 properties:
10413 name:
10414 type: string
10415 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
10416 x-kubernetes-map-type: atomic
10417 fsType:
10418 type: string
10419 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
10420 keyring:
10421 type: string
10422 description: 'keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
10423 monitors:
10424 type: array
10425 description: 'monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
10426 items:
10427 type: string
10428 pool:
10429 type: string
10430 description: 'pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
10431 user:
10432 type: string
10433 description: 'user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
10434 required:
10435 - image
10436 - monitors
10437 scaleIO:
10438 type: object
10439 description: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
10440 properties:
10441 readOnly:
10442 type: boolean
10443 description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
10444 secretRef:
10445 type: object
10446 description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
10447 properties:
10448 name:
10449 type: string
10450 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
10451 x-kubernetes-map-type: atomic
10452 fsType:
10453 type: string
10454 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
10455 gateway:
10456 type: string
10457 description: gateway is the host address of the ScaleIO API Gateway.
10458 protectionDomain:
10459 type: string
10460 description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
10461 sslEnabled:
10462 type: boolean
10463 description: sslEnabled Flag enable/disable SSL communication with Gateway, default false
10464 storageMode:
10465 type: string
10466 description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
10467 storagePool:
10468 type: string
10469 description: storagePool is the ScaleIO Storage Pool associated with the protection domain.
10470 system:
10471 type: string
10472 description: system is the name of the storage system as configured in ScaleIO.
10473 volumeName:
10474 type: string
10475 description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
10476 required:
10477 - gateway
10478 - secretRef
10479 - system
10480 secret:
10481 type: object
10482 description: 'secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
10483 properties:
10484 defaultMode:
10485 type: integer
10486 description: 'defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
10487 format: int32
10488 items:
10489 type: array
10490 description: items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
10491 items:
10492 type: object
10493 description: Maps a string key to a path within a volume.
10494 properties:
10495 key:
10496 type: string
10497 description: key is the key to project.
10498 mode:
10499 type: integer
10500 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
10501 format: int32
10502 path:
10503 type: string
10504 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
10505 required:
10506 - key
10507 - path
10508 optional:
10509 type: boolean
10510 description: optional field specify whether the Secret or its keys must be defined
10511 secretName:
10512 type: string
10513 description: 'secretName is the name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
10514 storageos:
10515 type: object
10516 description: storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
10517 properties:
10518 readOnly:
10519 type: boolean
10520 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
10521 secretRef:
10522 type: object
10523 description: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
10524 properties:
10525 name:
10526 type: string
10527 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
10528 x-kubernetes-map-type: atomic
10529 fsType:
10530 type: string
10531 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
10532 volumeName:
10533 type: string
10534 description: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
10535 volumeNamespace:
10536 type: string
10537 description: volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
10538 vsphereVolume:
10539 type: object
10540 description: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
10541 properties:
10542 fsType:
10543 type: string
10544 description: fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
10545 storagePolicyID:
10546 type: string
10547 description: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
10548 storagePolicyName:
10549 type: string
10550 description: storagePolicyName is the storage Policy Based Management (SPBM) profile name.
10551 volumePath:
10552 type: string
10553 description: volumePath is the path that identifies vSphere volume vmdk
10554 required:
10555 - volumePath
10556 required:
10557 - name
10558 imagePullSecrets:
10559 type: array
10560 description: Fluent Bit image pull secret
10561 items:
10562 type: object
10563 description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
10564 properties:
10565 name:
10566 type: string
10567 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
10568 x-kubernetes-map-type: atomic
10569 affinity:
10570 type: object
10571 description: Pod's scheduling constraints.
10572 properties:
10573 nodeAffinity:
10574 type: object
10575 description: Describes node affinity scheduling rules for the pod.
10576 properties:
10577 preferredDuringSchedulingIgnoredDuringExecution:
10578 type: array
10579 description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
10580 items:
10581 type: object
10582 description: An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
10583 properties:
10584 preference:
10585 type: object
10586 description: A node selector term, associated with the corresponding weight.
10587 properties:
10588 matchExpressions:
10589 type: array
10590 description: A list of node selector requirements by node's labels.
10591 items:
10592 type: object
10593 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10594 properties:
10595 key:
10596 type: string
10597 description: The label key that the selector applies to.
10598 operator:
10599 type: string
10600 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
10601 values:
10602 type: array
10603 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
10604 items:
10605 type: string
10606 required:
10607 - key
10608 - operator
10609 matchFields:
10610 type: array
10611 description: A list of node selector requirements by node's fields.
10612 items:
10613 type: object
10614 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10615 properties:
10616 key:
10617 type: string
10618 description: The label key that the selector applies to.
10619 operator:
10620 type: string
10621 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
10622 values:
10623 type: array
10624 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
10625 items:
10626 type: string
10627 required:
10628 - key
10629 - operator
10630 x-kubernetes-map-type: atomic
10631 weight:
10632 type: integer
10633 description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
10634 format: int32
10635 required:
10636 - preference
10637 - weight
10638 requiredDuringSchedulingIgnoredDuringExecution:
10639 type: object
10640 description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
10641 properties:
10642 nodeSelectorTerms:
10643 type: array
10644 description: Required. A list of node selector terms. The terms are ORed.
10645 items:
10646 type: object
10647 description: A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
10648 properties:
10649 matchExpressions:
10650 type: array
10651 description: A list of node selector requirements by node's labels.
10652 items:
10653 type: object
10654 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10655 properties:
10656 key:
10657 type: string
10658 description: The label key that the selector applies to.
10659 operator:
10660 type: string
10661 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
10662 values:
10663 type: array
10664 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
10665 items:
10666 type: string
10667 required:
10668 - key
10669 - operator
10670 matchFields:
10671 type: array
10672 description: A list of node selector requirements by node's fields.
10673 items:
10674 type: object
10675 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10676 properties:
10677 key:
10678 type: string
10679 description: The label key that the selector applies to.
10680 operator:
10681 type: string
10682 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
10683 values:
10684 type: array
10685 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
10686 items:
10687 type: string
10688 required:
10689 - key
10690 - operator
10691 x-kubernetes-map-type: atomic
10692 required:
10693 - nodeSelectorTerms
10694 x-kubernetes-map-type: atomic
10695 podAffinity:
10696 type: object
10697 description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
10698 properties:
10699 preferredDuringSchedulingIgnoredDuringExecution:
10700 type: array
10701 description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
10702 items:
10703 type: object
10704 description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
10705 properties:
10706 podAffinityTerm:
10707 type: object
10708 description: Required. A pod affinity term, associated with the corresponding weight.
10709 properties:
10710 labelSelector:
10711 type: object
10712 description: A label query over a set of resources, in this case pods.
10713 properties:
10714 matchExpressions:
10715 type: array
10716 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
10717 items:
10718 type: object
10719 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10720 properties:
10721 key:
10722 type: string
10723 description: key is the label key that the selector applies to.
10724 operator:
10725 type: string
10726 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
10727 values:
10728 type: array
10729 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.
10730 items:
10731 type: string
10732 required:
10733 - key
10734 - operator
10735 matchLabels:
10736 type: object
10737 additionalProperties:
10738 type: string
10739 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.
10740 x-kubernetes-map-type: atomic
10741 namespaceSelector:
10742 type: object
10743 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
10744 properties:
10745 matchExpressions:
10746 type: array
10747 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
10748 items:
10749 type: object
10750 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10751 properties:
10752 key:
10753 type: string
10754 description: key is the label key that the selector applies to.
10755 operator:
10756 type: string
10757 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
10758 values:
10759 type: array
10760 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.
10761 items:
10762 type: string
10763 required:
10764 - key
10765 - operator
10766 matchLabels:
10767 type: object
10768 additionalProperties:
10769 type: string
10770 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.
10771 x-kubernetes-map-type: atomic
10772 namespaces:
10773 type: array
10774 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
10775 items:
10776 type: string
10777 topologyKey:
10778 type: string
10779 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
10780 required:
10781 - topologyKey
10782 weight:
10783 type: integer
10784 description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
10785 format: int32
10786 required:
10787 - podAffinityTerm
10788 - weight
10789 requiredDuringSchedulingIgnoredDuringExecution:
10790 type: array
10791 description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
10792 items:
10793 type: object
10794 description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
10795 properties:
10796 labelSelector:
10797 type: object
10798 description: A label query over a set of resources, in this case pods.
10799 properties:
10800 matchExpressions:
10801 type: array
10802 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
10803 items:
10804 type: object
10805 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10806 properties:
10807 key:
10808 type: string
10809 description: key is the label key that the selector applies to.
10810 operator:
10811 type: string
10812 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
10813 values:
10814 type: array
10815 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.
10816 items:
10817 type: string
10818 required:
10819 - key
10820 - operator
10821 matchLabels:
10822 type: object
10823 additionalProperties:
10824 type: string
10825 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.
10826 x-kubernetes-map-type: atomic
10827 namespaceSelector:
10828 type: object
10829 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
10830 properties:
10831 matchExpressions:
10832 type: array
10833 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
10834 items:
10835 type: object
10836 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10837 properties:
10838 key:
10839 type: string
10840 description: key is the label key that the selector applies to.
10841 operator:
10842 type: string
10843 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
10844 values:
10845 type: array
10846 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.
10847 items:
10848 type: string
10849 required:
10850 - key
10851 - operator
10852 matchLabels:
10853 type: object
10854 additionalProperties:
10855 type: string
10856 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.
10857 x-kubernetes-map-type: atomic
10858 namespaces:
10859 type: array
10860 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
10861 items:
10862 type: string
10863 topologyKey:
10864 type: string
10865 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
10866 required:
10867 - topologyKey
10868 podAntiAffinity:
10869 type: object
10870 description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
10871 properties:
10872 preferredDuringSchedulingIgnoredDuringExecution:
10873 type: array
10874 description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
10875 items:
10876 type: object
10877 description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
10878 properties:
10879 podAffinityTerm:
10880 type: object
10881 description: Required. A pod affinity term, associated with the corresponding weight.
10882 properties:
10883 labelSelector:
10884 type: object
10885 description: A label query over a set of resources, in this case pods.
10886 properties:
10887 matchExpressions:
10888 type: array
10889 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
10890 items:
10891 type: object
10892 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10893 properties:
10894 key:
10895 type: string
10896 description: key is the label key that the selector applies to.
10897 operator:
10898 type: string
10899 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
10900 values:
10901 type: array
10902 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.
10903 items:
10904 type: string
10905 required:
10906 - key
10907 - operator
10908 matchLabels:
10909 type: object
10910 additionalProperties:
10911 type: string
10912 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.
10913 x-kubernetes-map-type: atomic
10914 namespaceSelector:
10915 type: object
10916 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
10917 properties:
10918 matchExpressions:
10919 type: array
10920 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
10921 items:
10922 type: object
10923 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10924 properties:
10925 key:
10926 type: string
10927 description: key is the label key that the selector applies to.
10928 operator:
10929 type: string
10930 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
10931 values:
10932 type: array
10933 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.
10934 items:
10935 type: string
10936 required:
10937 - key
10938 - operator
10939 matchLabels:
10940 type: object
10941 additionalProperties:
10942 type: string
10943 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.
10944 x-kubernetes-map-type: atomic
10945 namespaces:
10946 type: array
10947 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
10948 items:
10949 type: string
10950 topologyKey:
10951 type: string
10952 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
10953 required:
10954 - topologyKey
10955 weight:
10956 type: integer
10957 description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
10958 format: int32
10959 required:
10960 - podAffinityTerm
10961 - weight
10962 requiredDuringSchedulingIgnoredDuringExecution:
10963 type: array
10964 description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
10965 items:
10966 type: object
10967 description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
10968 properties:
10969 labelSelector:
10970 type: object
10971 description: A label query over a set of resources, in this case pods.
10972 properties:
10973 matchExpressions:
10974 type: array
10975 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
10976 items:
10977 type: object
10978 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
10979 properties:
10980 key:
10981 type: string
10982 description: key is the label key that the selector applies to.
10983 operator:
10984 type: string
10985 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
10986 values:
10987 type: array
10988 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.
10989 items:
10990 type: string
10991 required:
10992 - key
10993 - operator
10994 matchLabels:
10995 type: object
10996 additionalProperties:
10997 type: string
10998 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.
10999 x-kubernetes-map-type: atomic
11000 namespaceSelector:
11001 type: object
11002 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
11003 properties:
11004 matchExpressions:
11005 type: array
11006 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
11007 items:
11008 type: object
11009 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
11010 properties:
11011 key:
11012 type: string
11013 description: key is the label key that the selector applies to.
11014 operator:
11015 type: string
11016 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
11017 values:
11018 type: array
11019 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.
11020 items:
11021 type: string
11022 required:
11023 - key
11024 - operator
11025 matchLabels:
11026 type: object
11027 additionalProperties:
11028 type: string
11029 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.
11030 x-kubernetes-map-type: atomic
11031 namespaces:
11032 type: array
11033 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
11034 items:
11035 type: string
11036 topologyKey:
11037 type: string
11038 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
11039 required:
11040 - topologyKey
11041 tolerations:
11042 type: array
11043 description: Tolerations
11044 items:
11045 type: object
11046 description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
11047 properties:
11048 value:
11049 type: string
11050 description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
11051 effect:
11052 type: string
11053 description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
11054 key:
11055 type: string
11056 description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
11057 operator:
11058 type: string
11059 description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
11060 tolerationSeconds:
11061 type: integer
11062 description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
11063 format: int64
11064 image:
11065 type: string
11066 description: Fluent Bit image.
11067 command:
11068 type: array
11069 description: Fluent Bit Watcher command.
11070 items:
11071 type: string
11072 args:
11073 type: array
11074 description: Fluent Bit Watcher command line arguments.
11075 items:
11076 type: string
11077 ports:
11078 type: array
11079 description: Ports represents the pod's ports.
11080 items:
11081 type: object
11082 description: ContainerPort represents a network port in a single container.
11083 properties:
11084 name:
11085 type: string
11086 description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
11087 protocol:
11088 type: string
11089 default: TCP
11090 description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
11091 hostPort:
11092 type: integer
11093 description: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
11094 format: int32
11095 containerPort:
11096 type: integer
11097 description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
11098 format: int32
11099 hostIP:
11100 type: string
11101 description: What host IP to bind the external port to.
11102 required:
11103 - containerPort
11104 resources:
11105 type: object
11106 description: Compute Resources required by container.
11107 properties:
11108 claims:
11109 type: array
11110 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
11111 items:
11112 type: object
11113 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
11114 properties:
11115 name:
11116 type: string
11117 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.
11118 required:
11119 - name
11120 x-kubernetes-list-map-keys:
11121 - name
11122 x-kubernetes-list-type: map
11123 limits:
11124 type: object
11125 additionalProperties:
11126 anyOf:
11127 - type: integer
11128 - type: string
11129 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
11130 x-kubernetes-int-or-string: true
11131 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
11132 requests:
11133 type: object
11134 additionalProperties:
11135 anyOf:
11136 - type: integer
11137 - type: string
11138 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
11139 x-kubernetes-int-or-string: true
11140 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
11141 livenessProbe:
11142 type: object
11143 description: LivenessProbe represents the pod's liveness probe.
11144 properties:
11145 terminationGracePeriodSeconds:
11146 type: integer
11147 description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
11148 format: int64
11149 exec:
11150 type: object
11151 description: Exec specifies the action to take.
11152 properties:
11153 command:
11154 type: array
11155 description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
11156 items:
11157 type: string
11158 failureThreshold:
11159 type: integer
11160 description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
11161 format: int32
11162 grpc:
11163 type: object
11164 description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
11165 properties:
11166 service:
11167 type: string
11168 description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
11169 port:
11170 type: integer
11171 description: Port number of the gRPC service. Number must be in the range 1 to 65535.
11172 format: int32
11173 required:
11174 - port
11175 httpGet:
11176 type: object
11177 description: HTTPGet specifies the http request to perform.
11178 properties:
11179 port:
11180 anyOf:
11181 - type: integer
11182 - type: string
11183 description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
11184 x-kubernetes-int-or-string: true
11185 host:
11186 type: string
11187 description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
11188 httpHeaders:
11189 type: array
11190 description: Custom headers to set in the request. HTTP allows repeated headers.
11191 items:
11192 type: object
11193 description: HTTPHeader describes a custom header to be used in HTTP probes
11194 properties:
11195 name:
11196 type: string
11197 description: The header field name
11198 value:
11199 type: string
11200 description: The header field value
11201 required:
11202 - name
11203 - value
11204 path:
11205 type: string
11206 description: Path to access on the HTTP server.
11207 scheme:
11208 type: string
11209 description: Scheme to use for connecting to the host. Defaults to HTTP.
11210 required:
11211 - port
11212 initialDelaySeconds:
11213 type: integer
11214 description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
11215 format: int32
11216 periodSeconds:
11217 type: integer
11218 description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
11219 format: int32
11220 successThreshold:
11221 type: integer
11222 description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
11223 format: int32
11224 tcpSocket:
11225 type: object
11226 description: TCPSocket specifies an action involving a TCP port.
11227 properties:
11228 port:
11229 anyOf:
11230 - type: integer
11231 - type: string
11232 description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
11233 x-kubernetes-int-or-string: true
11234 host:
11235 type: string
11236 description: 'Optional: Host name to connect to, defaults to the pod IP.'
11237 required:
11238 - port
11239 timeoutSeconds:
11240 type: integer
11241 description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
11242 format: int32
11243 readinessProbe:
11244 type: object
11245 description: ReadinessProbe represents the pod's readiness probe.
11246 properties:
11247 terminationGracePeriodSeconds:
11248 type: integer
11249 description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
11250 format: int64
11251 exec:
11252 type: object
11253 description: Exec specifies the action to take.
11254 properties:
11255 command:
11256 type: array
11257 description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
11258 items:
11259 type: string
11260 failureThreshold:
11261 type: integer
11262 description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
11263 format: int32
11264 grpc:
11265 type: object
11266 description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
11267 properties:
11268 service:
11269 type: string
11270 description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
11271 port:
11272 type: integer
11273 description: Port number of the gRPC service. Number must be in the range 1 to 65535.
11274 format: int32
11275 required:
11276 - port
11277 httpGet:
11278 type: object
11279 description: HTTPGet specifies the http request to perform.
11280 properties:
11281 port:
11282 anyOf:
11283 - type: integer
11284 - type: string
11285 description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
11286 x-kubernetes-int-or-string: true
11287 host:
11288 type: string
11289 description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
11290 httpHeaders:
11291 type: array
11292 description: Custom headers to set in the request. HTTP allows repeated headers.
11293 items:
11294 type: object
11295 description: HTTPHeader describes a custom header to be used in HTTP probes
11296 properties:
11297 name:
11298 type: string
11299 description: The header field name
11300 value:
11301 type: string
11302 description: The header field value
11303 required:
11304 - name
11305 - value
11306 path:
11307 type: string
11308 description: Path to access on the HTTP server.
11309 scheme:
11310 type: string
11311 description: Scheme to use for connecting to the host. Defaults to HTTP.
11312 required:
11313 - port
11314 initialDelaySeconds:
11315 type: integer
11316 description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
11317 format: int32
11318 periodSeconds:
11319 type: integer
11320 description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
11321 format: int32
11322 successThreshold:
11323 type: integer
11324 description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
11325 format: int32
11326 tcpSocket:
11327 type: object
11328 description: TCPSocket specifies an action involving a TCP port.
11329 properties:
11330 port:
11331 anyOf:
11332 - type: integer
11333 - type: string
11334 description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
11335 x-kubernetes-int-or-string: true
11336 host:
11337 type: string
11338 description: 'Optional: Host name to connect to, defaults to the pod IP.'
11339 required:
11340 - port
11341 timeoutSeconds:
11342 type: integer
11343 description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
11344 format: int32
11345 imagePullPolicy:
11346 type: string
11347 description: Fluent Bit image pull policy.
11348 securityContext:
11349 type: object
11350 description: SecurityContext holds pod-level security attributes and common container settings.
11351 properties:
11352 fsGroup:
11353 type: integer
11354 description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows."
11355 format: int64
11356 fsGroupChangePolicy:
11357 type: string
11358 description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.'
11359 runAsGroup:
11360 type: integer
11361 description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
11362 format: int64
11363 runAsNonRoot:
11364 type: boolean
11365 description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
11366 runAsUser:
11367 type: integer
11368 description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
11369 format: int64
11370 seLinuxOptions:
11371 type: object
11372 description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
11373 properties:
11374 type:
11375 type: string
11376 description: Type is a SELinux type label that applies to the container.
11377 level:
11378 type: string
11379 description: Level is SELinux level label that applies to the container.
11380 role:
11381 type: string
11382 description: Role is a SELinux role label that applies to the container.
11383 user:
11384 type: string
11385 description: User is a SELinux user label that applies to the container.
11386 seccompProfile:
11387 type: object
11388 description: The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
11389 properties:
11390 type:
11391 type: string
11392 description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
11393 localhostProfile:
11394 type: string
11395 description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
11396 required:
11397 - type
11398 supplementalGroups:
11399 type: array
11400 description: A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
11401 items:
11402 type: integer
11403 format: int64
11404 sysctls:
11405 type: array
11406 description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
11407 items:
11408 type: object
11409 description: Sysctl defines a kernel parameter to be set
11410 properties:
11411 name:
11412 type: string
11413 description: Name of a property to set
11414 value:
11415 type: string
11416 description: Value of a property to set
11417 required:
11418 - name
11419 - value
11420 windowsOptions:
11421 type: object
11422 description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
11423 properties:
11424 gmsaCredentialSpec:
11425 type: string
11426 description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
11427 gmsaCredentialSpecName:
11428 type: string
11429 description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
11430 hostProcess:
11431 type: boolean
11432 description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
11433 runAsUserName:
11434 type: string
11435 description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
11436 containerLogRealPath:
11437 type: string
11438 description: Container log path
11439 containerSecurityContext:
11440 type: object
11441 description: ContainerSecurityContext holds container-level security attributes.
11442 properties:
11443 allowPrivilegeEscalation:
11444 type: boolean
11445 description: 'AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.'
11446 capabilities:
11447 type: object
11448 description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
11449 properties:
11450 add:
11451 type: array
11452 description: Added capabilities
11453 items:
11454 type: string
11455 description: Capability represent POSIX capabilities type
11456 drop:
11457 type: array
11458 description: Removed capabilities
11459 items:
11460 type: string
11461 description: Capability represent POSIX capabilities type
11462 privileged:
11463 type: boolean
11464 description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
11465 procMount:
11466 type: string
11467 description: procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
11468 readOnlyRootFilesystem:
11469 type: boolean
11470 description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
11471 runAsGroup:
11472 type: integer
11473 description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
11474 format: int64
11475 runAsNonRoot:
11476 type: boolean
11477 description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
11478 runAsUser:
11479 type: integer
11480 description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
11481 format: int64
11482 seLinuxOptions:
11483 type: object
11484 description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
11485 properties:
11486 type:
11487 type: string
11488 description: Type is a SELinux type label that applies to the container.
11489 level:
11490 type: string
11491 description: Level is SELinux level label that applies to the container.
11492 role:
11493 type: string
11494 description: Role is a SELinux role label that applies to the container.
11495 user:
11496 type: string
11497 description: User is a SELinux user label that applies to the container.
11498 seccompProfile:
11499 type: object
11500 description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
11501 properties:
11502 type:
11503 type: string
11504 description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
11505 localhostProfile:
11506 type: string
11507 description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
11508 required:
11509 - type
11510 windowsOptions:
11511 type: object
11512 description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
11513 properties:
11514 gmsaCredentialSpec:
11515 type: string
11516 description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
11517 gmsaCredentialSpecName:
11518 type: string
11519 description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
11520 hostProcess:
11521 type: boolean
11522 description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
11523 runAsUserName:
11524 type: string
11525 description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
11526 disableService:
11527 type: boolean
11528 description: DisableService tells if the fluentbit service should be deployed.
11529 envVars:
11530 type: array
11531 description: EnvVars represent environment variables that can be passed to fluentbit pods.
11532 items:
11533 type: object
11534 description: EnvVar represents an environment variable present in a Container.
11535 properties:
11536 name:
11537 type: string
11538 description: Name of the environment variable. Must be a C_IDENTIFIER.
11539 value:
11540 type: string
11541 description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
11542 valueFrom:
11543 type: object
11544 description: Source for the environment variable's value. Cannot be used if value is not empty.
11545 properties:
11546 fieldRef:
11547 type: object
11548 description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.'
11549 properties:
11550 apiVersion:
11551 type: string
11552 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
11553 fieldPath:
11554 type: string
11555 description: Path of the field to select in the specified API version.
11556 required:
11557 - fieldPath
11558 x-kubernetes-map-type: atomic
11559 resourceFieldRef:
11560 type: object
11561 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.'
11562 properties:
11563 containerName:
11564 type: string
11565 description: 'Container name: required for volumes, optional for env vars'
11566 divisor:
11567 anyOf:
11568 - type: integer
11569 - type: string
11570 description: Specifies the output format of the exposed resources, defaults to "1"
11571 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
11572 x-kubernetes-int-or-string: true
11573 resource:
11574 type: string
11575 description: 'Required: resource to select'
11576 required:
11577 - resource
11578 x-kubernetes-map-type: atomic
11579 configMapKeyRef:
11580 type: object
11581 description: Selects a key of a ConfigMap.
11582 properties:
11583 name:
11584 type: string
11585 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
11586 key:
11587 type: string
11588 description: The key to select.
11589 optional:
11590 type: boolean
11591 description: Specify whether the ConfigMap or its key must be defined
11592 required:
11593 - key
11594 x-kubernetes-map-type: atomic
11595 secretKeyRef:
11596 type: object
11597 description: Selects a key of a secret in the pod's namespace
11598 properties:
11599 name:
11600 type: string
11601 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
11602 key:
11603 type: string
11604 description: The key of the secret to select from. Must be a valid secret key.
11605 optional:
11606 type: boolean
11607 description: Specify whether the Secret or its key must be defined
11608 required:
11609 - key
11610 x-kubernetes-map-type: atomic
11611 required:
11612 - name
11613 fluentBitConfigName:
11614 type: string
11615 description: Fluentbitconfig object associated with this Fluentbit
11616 internalMountPropagation:
11617 type: string
11618 description: MountPropagation option for internal mounts
11619 enum:
11620 - None
11621 - HostToContainer
11622 - Bidirectional
11623 metricsPort:
11624 type: integer
11625 description: MetricsPort is the port used by the metrics server. If this option is set, HttpPort from ClusterFluentBitConfig needs to match this value. Default is 2020.
11626 format: int32
11627 namespaceFluentBitCfgSelector:
11628 type: object
11629 description: NamespacedFluentBitCfgSelector selects the namespace FluentBitConfig associated with this FluentBit
11630 properties:
11631 matchExpressions:
11632 type: array
11633 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
11634 items:
11635 type: object
11636 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
11637 properties:
11638 key:
11639 type: string
11640 description: key is the label key that the selector applies to.
11641 operator:
11642 type: string
11643 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
11644 values:
11645 type: array
11646 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.
11647 items:
11648 type: string
11649 required:
11650 - key
11651 - operator
11652 matchLabels:
11653 type: object
11654 additionalProperties:
11655 type: string
11656 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.
11657 x-kubernetes-map-type: atomic
11658 positionDB:
11659 type: object
11660 description: Storage for position db. You will use it if tail input is enabled.
11661 properties:
11662 awsElasticBlockStore:
11663 type: object
11664 description: 'awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
11665 properties:
11666 readOnly:
11667 type: boolean
11668 description: 'readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
11669 fsType:
11670 type: string
11671 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine'
11672 partition:
11673 type: integer
11674 description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).'
11675 format: int32
11676 volumeID:
11677 type: string
11678 description: 'volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
11679 required:
11680 - volumeID
11681 azureDisk:
11682 type: object
11683 description: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
11684 properties:
11685 kind:
11686 type: string
11687 description: 'kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared'
11688 readOnly:
11689 type: boolean
11690 description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
11691 cachingMode:
11692 type: string
11693 description: 'cachingMode is the Host Caching mode: None, Read Only, Read Write.'
11694 diskName:
11695 type: string
11696 description: diskName is the Name of the data disk in the blob storage
11697 diskURI:
11698 type: string
11699 description: diskURI is the URI of data disk in the blob storage
11700 fsType:
11701 type: string
11702 description: fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
11703 required:
11704 - diskName
11705 - diskURI
11706 azureFile:
11707 type: object
11708 description: azureFile represents an Azure File Service mount on the host and bind mount to the pod.
11709 properties:
11710 readOnly:
11711 type: boolean
11712 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
11713 secretName:
11714 type: string
11715 description: secretName is the name of secret that contains Azure Storage Account Name and Key
11716 shareName:
11717 type: string
11718 description: shareName is the azure share Name
11719 required:
11720 - secretName
11721 - shareName
11722 cephfs:
11723 type: object
11724 description: cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
11725 properties:
11726 readOnly:
11727 type: boolean
11728 description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
11729 secretRef:
11730 type: object
11731 description: 'secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
11732 properties:
11733 name:
11734 type: string
11735 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
11736 x-kubernetes-map-type: atomic
11737 monitors:
11738 type: array
11739 description: 'monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
11740 items:
11741 type: string
11742 path:
11743 type: string
11744 description: 'path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
11745 secretFile:
11746 type: string
11747 description: 'secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
11748 user:
11749 type: string
11750 description: 'user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
11751 required:
11752 - monitors
11753 cinder:
11754 type: object
11755 description: 'cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
11756 properties:
11757 readOnly:
11758 type: boolean
11759 description: 'readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
11760 secretRef:
11761 type: object
11762 description: 'secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.'
11763 properties:
11764 name:
11765 type: string
11766 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
11767 x-kubernetes-map-type: atomic
11768 fsType:
11769 type: string
11770 description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
11771 volumeID:
11772 type: string
11773 description: 'volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
11774 required:
11775 - volumeID
11776 configMap:
11777 type: object
11778 description: configMap represents a configMap that should populate this volume
11779 properties:
11780 name:
11781 type: string
11782 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
11783 defaultMode:
11784 type: integer
11785 description: 'defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
11786 format: int32
11787 items:
11788 type: array
11789 description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
11790 items:
11791 type: object
11792 description: Maps a string key to a path within a volume.
11793 properties:
11794 key:
11795 type: string
11796 description: key is the key to project.
11797 mode:
11798 type: integer
11799 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
11800 format: int32
11801 path:
11802 type: string
11803 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
11804 required:
11805 - key
11806 - path
11807 optional:
11808 type: boolean
11809 description: optional specify whether the ConfigMap or its keys must be defined
11810 x-kubernetes-map-type: atomic
11811 csi:
11812 type: object
11813 description: csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
11814 properties:
11815 readOnly:
11816 type: boolean
11817 description: readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
11818 driver:
11819 type: string
11820 description: driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
11821 fsType:
11822 type: string
11823 description: fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
11824 nodePublishSecretRef:
11825 type: object
11826 description: nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
11827 properties:
11828 name:
11829 type: string
11830 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
11831 x-kubernetes-map-type: atomic
11832 volumeAttributes:
11833 type: object
11834 additionalProperties:
11835 type: string
11836 description: volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
11837 required:
11838 - driver
11839 downwardAPI:
11840 type: object
11841 description: downwardAPI represents downward API about the pod that should populate this volume
11842 properties:
11843 defaultMode:
11844 type: integer
11845 description: 'Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
11846 format: int32
11847 items:
11848 type: array
11849 description: Items is a list of downward API volume file
11850 items:
11851 type: object
11852 description: DownwardAPIVolumeFile represents information to create the file containing the pod field
11853 properties:
11854 fieldRef:
11855 type: object
11856 description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
11857 properties:
11858 apiVersion:
11859 type: string
11860 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
11861 fieldPath:
11862 type: string
11863 description: Path of the field to select in the specified API version.
11864 required:
11865 - fieldPath
11866 x-kubernetes-map-type: atomic
11867 resourceFieldRef:
11868 type: object
11869 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
11870 properties:
11871 containerName:
11872 type: string
11873 description: 'Container name: required for volumes, optional for env vars'
11874 divisor:
11875 anyOf:
11876 - type: integer
11877 - type: string
11878 description: Specifies the output format of the exposed resources, defaults to "1"
11879 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
11880 x-kubernetes-int-or-string: true
11881 resource:
11882 type: string
11883 description: 'Required: resource to select'
11884 required:
11885 - resource
11886 x-kubernetes-map-type: atomic
11887 mode:
11888 type: integer
11889 description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
11890 format: int32
11891 path:
11892 type: string
11893 description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
11894 required:
11895 - path
11896 emptyDir:
11897 type: object
11898 description: 'emptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
11899 properties:
11900 medium:
11901 type: string
11902 description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
11903 sizeLimit:
11904 anyOf:
11905 - type: integer
11906 - type: string
11907 description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
11908 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
11909 x-kubernetes-int-or-string: true
11910 ephemeral:
11911 type: object
11912 description: "ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."
11913 properties:
11914 volumeClaimTemplate:
11915 type: object
11916 description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
11917 properties:
11918 metadata:
11919 type: object
11920 description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
11921 properties:
11922 name:
11923 type: string
11924 namespace:
11925 type: string
11926 labels:
11927 type: object
11928 additionalProperties:
11929 type: string
11930 annotations:
11931 type: object
11932 additionalProperties:
11933 type: string
11934 finalizers:
11935 type: array
11936 items:
11937 type: string
11938 spec:
11939 type: object
11940 description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
11941 properties:
11942 selector:
11943 type: object
11944 description: selector is a label query over volumes to consider for binding.
11945 properties:
11946 matchExpressions:
11947 type: array
11948 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
11949 items:
11950 type: object
11951 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
11952 properties:
11953 key:
11954 type: string
11955 description: key is the label key that the selector applies to.
11956 operator:
11957 type: string
11958 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
11959 values:
11960 type: array
11961 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.
11962 items:
11963 type: string
11964 required:
11965 - key
11966 - operator
11967 matchLabels:
11968 type: object
11969 additionalProperties:
11970 type: string
11971 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.
11972 x-kubernetes-map-type: atomic
11973 resources:
11974 type: object
11975 description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
11976 properties:
11977 claims:
11978 type: array
11979 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
11980 items:
11981 type: object
11982 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
11983 properties:
11984 name:
11985 type: string
11986 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.
11987 required:
11988 - name
11989 x-kubernetes-list-map-keys:
11990 - name
11991 x-kubernetes-list-type: map
11992 limits:
11993 type: object
11994 additionalProperties:
11995 anyOf:
11996 - type: integer
11997 - type: string
11998 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
11999 x-kubernetes-int-or-string: true
12000 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
12001 requests:
12002 type: object
12003 additionalProperties:
12004 anyOf:
12005 - type: integer
12006 - type: string
12007 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
12008 x-kubernetes-int-or-string: true
12009 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
12010 accessModes:
12011 type: array
12012 description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
12013 items:
12014 type: string
12015 dataSource:
12016 type: object
12017 description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
12018 properties:
12019 name:
12020 type: string
12021 description: Name is the name of resource being referenced
12022 kind:
12023 type: string
12024 description: Kind is the type of resource being referenced
12025 apiGroup:
12026 type: string
12027 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
12028 required:
12029 - kind
12030 - name
12031 x-kubernetes-map-type: atomic
12032 dataSourceRef:
12033 type: object
12034 description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
12035 properties:
12036 name:
12037 type: string
12038 description: Name is the name of resource being referenced
12039 namespace:
12040 type: string
12041 description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
12042 kind:
12043 type: string
12044 description: Kind is the type of resource being referenced
12045 apiGroup:
12046 type: string
12047 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
12048 required:
12049 - kind
12050 - name
12051 storageClassName:
12052 type: string
12053 description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
12054 volumeMode:
12055 type: string
12056 description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
12057 volumeName:
12058 type: string
12059 description: volumeName is the binding reference to the PersistentVolume backing this claim.
12060 required:
12061 - spec
12062 fc:
12063 type: object
12064 description: fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
12065 properties:
12066 readOnly:
12067 type: boolean
12068 description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
12069 fsType:
12070 type: string
12071 description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
12072 lun:
12073 type: integer
12074 description: 'lun is Optional: FC target lun number'
12075 format: int32
12076 targetWWNs:
12077 type: array
12078 description: 'targetWWNs is Optional: FC target worldwide names (WWNs)'
12079 items:
12080 type: string
12081 wwids:
12082 type: array
12083 description: 'wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
12084 items:
12085 type: string
12086 flexVolume:
12087 type: object
12088 description: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
12089 properties:
12090 readOnly:
12091 type: boolean
12092 description: 'readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
12093 secretRef:
12094 type: object
12095 description: 'secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.'
12096 properties:
12097 name:
12098 type: string
12099 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
12100 x-kubernetes-map-type: atomic
12101 driver:
12102 type: string
12103 description: driver is the name of the driver to use for this volume.
12104 fsType:
12105 type: string
12106 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
12107 options:
12108 type: object
12109 additionalProperties:
12110 type: string
12111 description: 'options is Optional: this field holds extra command options if any.'
12112 required:
12113 - driver
12114 flocker:
12115 type: object
12116 description: flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
12117 properties:
12118 datasetName:
12119 type: string
12120 description: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
12121 datasetUUID:
12122 type: string
12123 description: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
12124 gcePersistentDisk:
12125 type: object
12126 description: 'gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
12127 properties:
12128 readOnly:
12129 type: boolean
12130 description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
12131 fsType:
12132 type: string
12133 description: 'fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine'
12134 partition:
12135 type: integer
12136 description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
12137 format: int32
12138 pdName:
12139 type: string
12140 description: 'pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
12141 required:
12142 - pdName
12143 gitRepo:
12144 type: object
12145 description: 'gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod''s container.'
12146 properties:
12147 revision:
12148 type: string
12149 description: revision is the commit hash for the specified revision.
12150 directory:
12151 type: string
12152 description: directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
12153 repository:
12154 type: string
12155 description: repository is the URL
12156 required:
12157 - repository
12158 glusterfs:
12159 type: object
12160 description: 'glusterfs represents a Glusterfs mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
12161 properties:
12162 readOnly:
12163 type: boolean
12164 description: 'readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
12165 endpoints:
12166 type: string
12167 description: 'endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
12168 path:
12169 type: string
12170 description: 'path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
12171 required:
12172 - endpoints
12173 - path
12174 hostPath:
12175 type: object
12176 description: 'hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.'
12177 properties:
12178 type:
12179 type: string
12180 description: 'type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
12181 path:
12182 type: string
12183 description: 'path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
12184 required:
12185 - path
12186 iscsi:
12187 type: object
12188 description: 'iscsi represents an ISCSI Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
12189 properties:
12190 readOnly:
12191 type: boolean
12192 description: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
12193 secretRef:
12194 type: object
12195 description: secretRef is the CHAP Secret for iSCSI target and initiator authentication
12196 properties:
12197 name:
12198 type: string
12199 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
12200 x-kubernetes-map-type: atomic
12201 chapAuthDiscovery:
12202 type: boolean
12203 description: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
12204 chapAuthSession:
12205 type: boolean
12206 description: chapAuthSession defines whether support iSCSI Session CHAP authentication
12207 fsType:
12208 type: string
12209 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
12210 initiatorName:
12211 type: string
12212 description: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
12213 iqn:
12214 type: string
12215 description: iqn is the target iSCSI Qualified Name.
12216 iscsiInterface:
12217 type: string
12218 description: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
12219 lun:
12220 type: integer
12221 description: lun represents iSCSI Target Lun number.
12222 format: int32
12223 portals:
12224 type: array
12225 description: portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
12226 items:
12227 type: string
12228 targetPortal:
12229 type: string
12230 description: targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
12231 required:
12232 - iqn
12233 - lun
12234 - targetPortal
12235 nfs:
12236 type: object
12237 description: 'nfs represents an NFS mount on the host that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
12238 properties:
12239 readOnly:
12240 type: boolean
12241 description: 'readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
12242 path:
12243 type: string
12244 description: 'path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
12245 server:
12246 type: string
12247 description: 'server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
12248 required:
12249 - path
12250 - server
12251 persistentVolumeClaim:
12252 type: object
12253 description: 'persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
12254 properties:
12255 readOnly:
12256 type: boolean
12257 description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
12258 claimName:
12259 type: string
12260 description: 'claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
12261 required:
12262 - claimName
12263 photonPersistentDisk:
12264 type: object
12265 description: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
12266 properties:
12267 fsType:
12268 type: string
12269 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
12270 pdID:
12271 type: string
12272 description: pdID is the ID that identifies Photon Controller persistent disk
12273 required:
12274 - pdID
12275 portworxVolume:
12276 type: object
12277 description: portworxVolume represents a portworx volume attached and mounted on kubelets host machine
12278 properties:
12279 readOnly:
12280 type: boolean
12281 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
12282 fsType:
12283 type: string
12284 description: fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
12285 volumeID:
12286 type: string
12287 description: volumeID uniquely identifies a Portworx volume
12288 required:
12289 - volumeID
12290 projected:
12291 type: object
12292 description: projected items for all in one resources secrets, configmaps, and downward API
12293 properties:
12294 defaultMode:
12295 type: integer
12296 description: defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
12297 format: int32
12298 sources:
12299 type: array
12300 description: sources is the list of volume projections
12301 items:
12302 type: object
12303 description: Projection that may be projected along with other supported volume types
12304 properties:
12305 configMap:
12306 type: object
12307 description: configMap information about the configMap data to project
12308 properties:
12309 name:
12310 type: string
12311 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
12312 items:
12313 type: array
12314 description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
12315 items:
12316 type: object
12317 description: Maps a string key to a path within a volume.
12318 properties:
12319 key:
12320 type: string
12321 description: key is the key to project.
12322 mode:
12323 type: integer
12324 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
12325 format: int32
12326 path:
12327 type: string
12328 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
12329 required:
12330 - key
12331 - path
12332 optional:
12333 type: boolean
12334 description: optional specify whether the ConfigMap or its keys must be defined
12335 x-kubernetes-map-type: atomic
12336 downwardAPI:
12337 type: object
12338 description: downwardAPI information about the downwardAPI data to project
12339 properties:
12340 items:
12341 type: array
12342 description: Items is a list of DownwardAPIVolume file
12343 items:
12344 type: object
12345 description: DownwardAPIVolumeFile represents information to create the file containing the pod field
12346 properties:
12347 fieldRef:
12348 type: object
12349 description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
12350 properties:
12351 apiVersion:
12352 type: string
12353 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
12354 fieldPath:
12355 type: string
12356 description: Path of the field to select in the specified API version.
12357 required:
12358 - fieldPath
12359 x-kubernetes-map-type: atomic
12360 resourceFieldRef:
12361 type: object
12362 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
12363 properties:
12364 containerName:
12365 type: string
12366 description: 'Container name: required for volumes, optional for env vars'
12367 divisor:
12368 anyOf:
12369 - type: integer
12370 - type: string
12371 description: Specifies the output format of the exposed resources, defaults to "1"
12372 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
12373 x-kubernetes-int-or-string: true
12374 resource:
12375 type: string
12376 description: 'Required: resource to select'
12377 required:
12378 - resource
12379 x-kubernetes-map-type: atomic
12380 mode:
12381 type: integer
12382 description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
12383 format: int32
12384 path:
12385 type: string
12386 description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
12387 required:
12388 - path
12389 secret:
12390 type: object
12391 description: secret information about the secret data to project
12392 properties:
12393 name:
12394 type: string
12395 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
12396 items:
12397 type: array
12398 description: items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
12399 items:
12400 type: object
12401 description: Maps a string key to a path within a volume.
12402 properties:
12403 key:
12404 type: string
12405 description: key is the key to project.
12406 mode:
12407 type: integer
12408 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
12409 format: int32
12410 path:
12411 type: string
12412 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
12413 required:
12414 - key
12415 - path
12416 optional:
12417 type: boolean
12418 description: optional field specify whether the Secret or its key must be defined
12419 x-kubernetes-map-type: atomic
12420 serviceAccountToken:
12421 type: object
12422 description: serviceAccountToken is information about the serviceAccountToken data to project
12423 properties:
12424 audience:
12425 type: string
12426 description: audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
12427 expirationSeconds:
12428 type: integer
12429 description: expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
12430 format: int64
12431 path:
12432 type: string
12433 description: path is the path relative to the mount point of the file to project the token into.
12434 required:
12435 - path
12436 quobyte:
12437 type: object
12438 description: quobyte represents a Quobyte mount on the host that shares a pod's lifetime
12439 properties:
12440 readOnly:
12441 type: boolean
12442 description: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
12443 group:
12444 type: string
12445 description: group to map volume access to Default is no group
12446 registry:
12447 type: string
12448 description: registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
12449 tenant:
12450 type: string
12451 description: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
12452 user:
12453 type: string
12454 description: user to map volume access to Defaults to serivceaccount user
12455 volume:
12456 type: string
12457 description: volume is a string that references an already created Quobyte volume by name.
12458 required:
12459 - registry
12460 - volume
12461 rbd:
12462 type: object
12463 description: 'rbd represents a Rados Block Device mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
12464 properties:
12465 image:
12466 type: string
12467 description: 'image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
12468 readOnly:
12469 type: boolean
12470 description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
12471 secretRef:
12472 type: object
12473 description: 'secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
12474 properties:
12475 name:
12476 type: string
12477 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
12478 x-kubernetes-map-type: atomic
12479 fsType:
12480 type: string
12481 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
12482 keyring:
12483 type: string
12484 description: 'keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
12485 monitors:
12486 type: array
12487 description: 'monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
12488 items:
12489 type: string
12490 pool:
12491 type: string
12492 description: 'pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
12493 user:
12494 type: string
12495 description: 'user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
12496 required:
12497 - image
12498 - monitors
12499 scaleIO:
12500 type: object
12501 description: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
12502 properties:
12503 readOnly:
12504 type: boolean
12505 description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
12506 secretRef:
12507 type: object
12508 description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
12509 properties:
12510 name:
12511 type: string
12512 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
12513 x-kubernetes-map-type: atomic
12514 fsType:
12515 type: string
12516 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
12517 gateway:
12518 type: string
12519 description: gateway is the host address of the ScaleIO API Gateway.
12520 protectionDomain:
12521 type: string
12522 description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
12523 sslEnabled:
12524 type: boolean
12525 description: sslEnabled Flag enable/disable SSL communication with Gateway, default false
12526 storageMode:
12527 type: string
12528 description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
12529 storagePool:
12530 type: string
12531 description: storagePool is the ScaleIO Storage Pool associated with the protection domain.
12532 system:
12533 type: string
12534 description: system is the name of the storage system as configured in ScaleIO.
12535 volumeName:
12536 type: string
12537 description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
12538 required:
12539 - gateway
12540 - secretRef
12541 - system
12542 secret:
12543 type: object
12544 description: 'secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
12545 properties:
12546 defaultMode:
12547 type: integer
12548 description: 'defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
12549 format: int32
12550 items:
12551 type: array
12552 description: items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
12553 items:
12554 type: object
12555 description: Maps a string key to a path within a volume.
12556 properties:
12557 key:
12558 type: string
12559 description: key is the key to project.
12560 mode:
12561 type: integer
12562 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
12563 format: int32
12564 path:
12565 type: string
12566 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
12567 required:
12568 - key
12569 - path
12570 optional:
12571 type: boolean
12572 description: optional field specify whether the Secret or its keys must be defined
12573 secretName:
12574 type: string
12575 description: 'secretName is the name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
12576 storageos:
12577 type: object
12578 description: storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
12579 properties:
12580 readOnly:
12581 type: boolean
12582 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
12583 secretRef:
12584 type: object
12585 description: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
12586 properties:
12587 name:
12588 type: string
12589 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
12590 x-kubernetes-map-type: atomic
12591 fsType:
12592 type: string
12593 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
12594 volumeName:
12595 type: string
12596 description: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
12597 volumeNamespace:
12598 type: string
12599 description: volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
12600 vsphereVolume:
12601 type: object
12602 description: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
12603 properties:
12604 fsType:
12605 type: string
12606 description: fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
12607 storagePolicyID:
12608 type: string
12609 description: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
12610 storagePolicyName:
12611 type: string
12612 description: storagePolicyName is the storage Policy Based Management (SPBM) profile name.
12613 volumePath:
12614 type: string
12615 description: volumePath is the path that identifies vSphere volume vmdk
12616 required:
12617 - volumePath
12618 rbacRules:
12619 type: array
12620 description: RBACRules represents additional rbac rules which will be applied to the fluent-bit clusterrole.
12621 items:
12622 type: object
12623 description: PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
12624 properties:
12625 resources:
12626 type: array
12627 description: Resources is a list of resources this rule applies to. '*' represents all resources.
12628 items:
12629 type: string
12630 apiGroups:
12631 type: array
12632 description: APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
12633 items:
12634 type: string
12635 nonResourceURLs:
12636 type: array
12637 description: NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
12638 items:
12639 type: string
12640 resourceNames:
12641 type: array
12642 description: ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
12643 items:
12644 type: string
12645 verbs:
12646 type: array
12647 description: Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.
12648 items:
12649 type: string
12650 required:
12651 - verbs
12652 secrets:
12653 type: array
12654 description: The Secrets are mounted into /fluent-bit/secrets/<secret-name>.
12655 items:
12656 type: string
12657 serviceAccountAnnotations:
12658 type: object
12659 additionalProperties:
12660 type: string
12661 description: Annotations to add to the Fluentbit service account
12662 volumesMounts:
12663 type: array
12664 description: Pod volumes to mount into the container's filesystem.
12665 items:
12666 type: object
12667 description: VolumeMount describes a mounting of a Volume within a container.
12668 properties:
12669 name:
12670 type: string
12671 description: This must match the Name of a Volume.
12672 readOnly:
12673 type: boolean
12674 description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
12675 mountPath:
12676 type: string
12677 description: Path within the container at which the volume should be mounted. Must not contain ':'.
12678 subPath:
12679 type: string
12680 description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
12681 subPathExpr:
12682 type: string
12683 description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
12684 mountPropagation:
12685 type: string
12686 description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
12687 required:
12688 - mountPath
12689 - name
12690 status:
12691 type: object
12692 description: FluentBitStatus defines the observed state of FluentBit
12693 served: true
12694 storage: true
12695---
12696apiVersion: apiextensions.k8s.io/v1
12697kind: CustomResourceDefinition
12698metadata:
12699 name: fluentdconfigs.fluentd.fluent.io
12700 annotations:
12701 controller-gen.kubebuilder.io/version: v0.11.3
12702 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
12703 pallet.edge.ncr.com/name: fluent-operator
12704 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
12705 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
12706 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
12707 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
12708spec:
12709 group: fluentd.fluent.io
12710 names:
12711 kind: FluentdConfig
12712 listKind: FluentdConfigList
12713 plural: fluentdconfigs
12714 shortNames:
12715 - fdc
12716 singular: fluentdconfig
12717 scope: Namespaced
12718 versions:
12719 - name: v1alpha1
12720 schema:
12721 openAPIV3Schema:
12722 type: object
12723 description: FluentdConfig is the Schema for the fluentdconfigs API
12724 properties:
12725 apiVersion:
12726 type: string
12727 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'
12728 kind:
12729 type: string
12730 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'
12731 metadata:
12732 type: object
12733 spec:
12734 type: object
12735 description: FluentdConfigSpec defines the desired state of FluentdConfig
12736 properties:
12737 clusterFilterSelector:
12738 type: object
12739 description: Select cluster filter plugins
12740 properties:
12741 matchExpressions:
12742 type: array
12743 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
12744 items:
12745 type: object
12746 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
12747 properties:
12748 key:
12749 type: string
12750 description: key is the label key that the selector applies to.
12751 operator:
12752 type: string
12753 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
12754 values:
12755 type: array
12756 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.
12757 items:
12758 type: string
12759 required:
12760 - key
12761 - operator
12762 matchLabels:
12763 type: object
12764 additionalProperties:
12765 type: string
12766 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.
12767 x-kubernetes-map-type: atomic
12768 clusterOutputSelector:
12769 type: object
12770 description: Select cluster output plugins
12771 properties:
12772 matchExpressions:
12773 type: array
12774 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
12775 items:
12776 type: object
12777 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
12778 properties:
12779 key:
12780 type: string
12781 description: key is the label key that the selector applies to.
12782 operator:
12783 type: string
12784 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
12785 values:
12786 type: array
12787 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.
12788 items:
12789 type: string
12790 required:
12791 - key
12792 - operator
12793 matchLabels:
12794 type: object
12795 additionalProperties:
12796 type: string
12797 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.
12798 x-kubernetes-map-type: atomic
12799 emit_mode:
12800 type: string
12801 description: 'Emit mode. If batch, the plugin will emit events per labels matched. Enum: record, batch. will make no effect if EnableFilterKubernetes is set false.'
12802 enum:
12803 - record
12804 - batch
12805 filterSelector:
12806 type: object
12807 description: Select namespaced filter plugins
12808 properties:
12809 matchExpressions:
12810 type: array
12811 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
12812 items:
12813 type: object
12814 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
12815 properties:
12816 key:
12817 type: string
12818 description: key is the label key that the selector applies to.
12819 operator:
12820 type: string
12821 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
12822 values:
12823 type: array
12824 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.
12825 items:
12826 type: string
12827 required:
12828 - key
12829 - operator
12830 matchLabels:
12831 type: object
12832 additionalProperties:
12833 type: string
12834 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.
12835 x-kubernetes-map-type: atomic
12836 outputSelector:
12837 type: object
12838 description: Select namespaced output plugins
12839 properties:
12840 matchExpressions:
12841 type: array
12842 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
12843 items:
12844 type: object
12845 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
12846 properties:
12847 key:
12848 type: string
12849 description: key is the label key that the selector applies to.
12850 operator:
12851 type: string
12852 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
12853 values:
12854 type: array
12855 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.
12856 items:
12857 type: string
12858 required:
12859 - key
12860 - operator
12861 matchLabels:
12862 type: object
12863 additionalProperties:
12864 type: string
12865 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.
12866 x-kubernetes-map-type: atomic
12867 stickyTags:
12868 type: string
12869 description: Sticky tags will match only one record from an event stream. The same tag will be treated the same way. will make no effect if EnableFilterKubernetes is set false.
12870 watchedConstainers:
12871 type: array
12872 description: A set of container names. Ignored if left empty.
12873 items:
12874 type: string
12875 watchedHosts:
12876 type: array
12877 description: A set of hosts. Ignored if left empty.
12878 items:
12879 type: string
12880 watchedLabels:
12881 type: object
12882 additionalProperties:
12883 type: string
12884 description: Use this field to filter the logs, will make no effect if EnableFilterKubernetes is set false.
12885 status:
12886 type: object
12887 description: FluentdConfigStatus defines the observed state of FluentdConfig
12888 properties:
12889 messages:
12890 type: string
12891 description: Messages defines the plugin errors which is selected by this fluentdconfig
12892 state:
12893 type: string
12894 description: The state of this fluentd config
12895 served: true
12896 storage: true
12897 subresources:
12898 status: {}
12899---
12900apiVersion: apiextensions.k8s.io/v1
12901kind: CustomResourceDefinition
12902metadata:
12903 name: fluentds.fluentd.fluent.io
12904 annotations:
12905 controller-gen.kubebuilder.io/version: v0.11.3
12906 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
12907 pallet.edge.ncr.com/name: fluent-operator
12908 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
12909 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
12910 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
12911 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
12912spec:
12913 group: fluentd.fluent.io
12914 names:
12915 kind: Fluentd
12916 listKind: FluentdList
12917 plural: fluentds
12918 shortNames:
12919 - fd
12920 singular: fluentd
12921 scope: Namespaced
12922 versions:
12923 - name: v1alpha1
12924 schema:
12925 openAPIV3Schema:
12926 type: object
12927 description: Fluentd is the Schema for the fluentds API
12928 properties:
12929 apiVersion:
12930 type: string
12931 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'
12932 kind:
12933 type: string
12934 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'
12935 metadata:
12936 type: object
12937 spec:
12938 type: object
12939 description: FluentdSpec defines the desired state of Fluentd
12940 properties:
12941 annotations:
12942 type: object
12943 additionalProperties:
12944 type: string
12945 description: Annotations to add to each Fluentd pod.
12946 replicas:
12947 type: integer
12948 description: Numbers of the Fluentd instance
12949 format: int32
12950 volumeClaimTemplates:
12951 type: array
12952 description: volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template.
12953 items:
12954 type: object
12955 description: PersistentVolumeClaim is a user's request for and claim to a persistent volume
12956 properties:
12957 apiVersion:
12958 type: string
12959 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'
12960 kind:
12961 type: string
12962 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'
12963 metadata:
12964 type: object
12965 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata'
12966 properties:
12967 name:
12968 type: string
12969 namespace:
12970 type: string
12971 labels:
12972 type: object
12973 additionalProperties:
12974 type: string
12975 annotations:
12976 type: object
12977 additionalProperties:
12978 type: string
12979 finalizers:
12980 type: array
12981 items:
12982 type: string
12983 spec:
12984 type: object
12985 description: 'spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
12986 properties:
12987 selector:
12988 type: object
12989 description: selector is a label query over volumes to consider for binding.
12990 properties:
12991 matchExpressions:
12992 type: array
12993 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
12994 items:
12995 type: object
12996 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
12997 properties:
12998 key:
12999 type: string
13000 description: key is the label key that the selector applies to.
13001 operator:
13002 type: string
13003 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
13004 values:
13005 type: array
13006 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.
13007 items:
13008 type: string
13009 required:
13010 - key
13011 - operator
13012 matchLabels:
13013 type: object
13014 additionalProperties:
13015 type: string
13016 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.
13017 x-kubernetes-map-type: atomic
13018 resources:
13019 type: object
13020 description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
13021 properties:
13022 claims:
13023 type: array
13024 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
13025 items:
13026 type: object
13027 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
13028 properties:
13029 name:
13030 type: string
13031 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.
13032 required:
13033 - name
13034 x-kubernetes-list-map-keys:
13035 - name
13036 x-kubernetes-list-type: map
13037 limits:
13038 type: object
13039 additionalProperties:
13040 anyOf:
13041 - type: integer
13042 - type: string
13043 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
13044 x-kubernetes-int-or-string: true
13045 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
13046 requests:
13047 type: object
13048 additionalProperties:
13049 anyOf:
13050 - type: integer
13051 - type: string
13052 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
13053 x-kubernetes-int-or-string: true
13054 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
13055 accessModes:
13056 type: array
13057 description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
13058 items:
13059 type: string
13060 dataSource:
13061 type: object
13062 description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
13063 properties:
13064 name:
13065 type: string
13066 description: Name is the name of resource being referenced
13067 kind:
13068 type: string
13069 description: Kind is the type of resource being referenced
13070 apiGroup:
13071 type: string
13072 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
13073 required:
13074 - kind
13075 - name
13076 x-kubernetes-map-type: atomic
13077 dataSourceRef:
13078 type: object
13079 description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
13080 properties:
13081 name:
13082 type: string
13083 description: Name is the name of resource being referenced
13084 namespace:
13085 type: string
13086 description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
13087 kind:
13088 type: string
13089 description: Kind is the type of resource being referenced
13090 apiGroup:
13091 type: string
13092 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
13093 required:
13094 - kind
13095 - name
13096 storageClassName:
13097 type: string
13098 description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
13099 volumeMode:
13100 type: string
13101 description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
13102 volumeName:
13103 type: string
13104 description: volumeName is the binding reference to the PersistentVolume backing this claim.
13105 status:
13106 type: object
13107 description: 'status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
13108 properties:
13109 accessModes:
13110 type: array
13111 description: 'accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
13112 items:
13113 type: string
13114 allocatedResources:
13115 type: object
13116 additionalProperties:
13117 anyOf:
13118 - type: integer
13119 - type: string
13120 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
13121 x-kubernetes-int-or-string: true
13122 description: allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
13123 capacity:
13124 type: object
13125 additionalProperties:
13126 anyOf:
13127 - type: integer
13128 - type: string
13129 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
13130 x-kubernetes-int-or-string: true
13131 description: capacity represents the actual resources of the underlying volume.
13132 conditions:
13133 type: array
13134 description: conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
13135 items:
13136 type: object
13137 description: PersistentVolumeClaimCondition contails details about state of pvc
13138 properties:
13139 type:
13140 type: string
13141 description: PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
13142 status:
13143 type: string
13144 lastProbeTime:
13145 type: string
13146 description: lastProbeTime is the time we probed the condition.
13147 format: date-time
13148 lastTransitionTime:
13149 type: string
13150 description: lastTransitionTime is the time the condition transitioned from one status to another.
13151 format: date-time
13152 message:
13153 type: string
13154 description: message is the human-readable message indicating details about last transition.
13155 reason:
13156 type: string
13157 description: reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
13158 required:
13159 - status
13160 - type
13161 phase:
13162 type: string
13163 description: phase represents the current phase of PersistentVolumeClaim.
13164 resizeStatus:
13165 type: string
13166 description: resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
13167 service:
13168 type: object
13169 description: Service represents configurations on the fluentd service.
13170 properties:
13171 name:
13172 type: string
13173 description: Name is the name of the FluentD service.
13174 labels:
13175 type: object
13176 additionalProperties:
13177 type: string
13178 description: Labels to add to each FluentD service
13179 annotations:
13180 type: object
13181 additionalProperties:
13182 type: string
13183 description: Annotations to add to each FluentD service.
13184 schedulerName:
13185 type: string
13186 description: SchedulerName represents the desired scheduler for fluentd pods.
13187 priorityClassName:
13188 type: string
13189 description: PriorityClassName represents the pod's priority class.
13190 runtimeClassName:
13191 type: string
13192 description: RuntimeClassName represents the container runtime configuration.
13193 nodeSelector:
13194 type: object
13195 additionalProperties:
13196 type: string
13197 description: NodeSelector
13198 volumes:
13199 type: array
13200 description: List of volumes that can be mounted by containers belonging to the pod.
13201 items:
13202 type: object
13203 description: Volume represents a named volume in a pod that may be accessed by any container in the pod.
13204 properties:
13205 name:
13206 type: string
13207 description: 'name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
13208 awsElasticBlockStore:
13209 type: object
13210 description: 'awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
13211 properties:
13212 readOnly:
13213 type: boolean
13214 description: 'readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
13215 fsType:
13216 type: string
13217 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine'
13218 partition:
13219 type: integer
13220 description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).'
13221 format: int32
13222 volumeID:
13223 type: string
13224 description: 'volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
13225 required:
13226 - volumeID
13227 azureDisk:
13228 type: object
13229 description: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
13230 properties:
13231 kind:
13232 type: string
13233 description: 'kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared'
13234 readOnly:
13235 type: boolean
13236 description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
13237 cachingMode:
13238 type: string
13239 description: 'cachingMode is the Host Caching mode: None, Read Only, Read Write.'
13240 diskName:
13241 type: string
13242 description: diskName is the Name of the data disk in the blob storage
13243 diskURI:
13244 type: string
13245 description: diskURI is the URI of data disk in the blob storage
13246 fsType:
13247 type: string
13248 description: fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
13249 required:
13250 - diskName
13251 - diskURI
13252 azureFile:
13253 type: object
13254 description: azureFile represents an Azure File Service mount on the host and bind mount to the pod.
13255 properties:
13256 readOnly:
13257 type: boolean
13258 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
13259 secretName:
13260 type: string
13261 description: secretName is the name of secret that contains Azure Storage Account Name and Key
13262 shareName:
13263 type: string
13264 description: shareName is the azure share Name
13265 required:
13266 - secretName
13267 - shareName
13268 cephfs:
13269 type: object
13270 description: cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
13271 properties:
13272 readOnly:
13273 type: boolean
13274 description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
13275 secretRef:
13276 type: object
13277 description: 'secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
13278 properties:
13279 name:
13280 type: string
13281 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
13282 x-kubernetes-map-type: atomic
13283 monitors:
13284 type: array
13285 description: 'monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
13286 items:
13287 type: string
13288 path:
13289 type: string
13290 description: 'path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
13291 secretFile:
13292 type: string
13293 description: 'secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
13294 user:
13295 type: string
13296 description: 'user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
13297 required:
13298 - monitors
13299 cinder:
13300 type: object
13301 description: 'cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
13302 properties:
13303 readOnly:
13304 type: boolean
13305 description: 'readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
13306 secretRef:
13307 type: object
13308 description: 'secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.'
13309 properties:
13310 name:
13311 type: string
13312 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
13313 x-kubernetes-map-type: atomic
13314 fsType:
13315 type: string
13316 description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
13317 volumeID:
13318 type: string
13319 description: 'volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
13320 required:
13321 - volumeID
13322 configMap:
13323 type: object
13324 description: configMap represents a configMap that should populate this volume
13325 properties:
13326 name:
13327 type: string
13328 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
13329 defaultMode:
13330 type: integer
13331 description: 'defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
13332 format: int32
13333 items:
13334 type: array
13335 description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
13336 items:
13337 type: object
13338 description: Maps a string key to a path within a volume.
13339 properties:
13340 key:
13341 type: string
13342 description: key is the key to project.
13343 mode:
13344 type: integer
13345 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
13346 format: int32
13347 path:
13348 type: string
13349 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
13350 required:
13351 - key
13352 - path
13353 optional:
13354 type: boolean
13355 description: optional specify whether the ConfigMap or its keys must be defined
13356 x-kubernetes-map-type: atomic
13357 csi:
13358 type: object
13359 description: csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
13360 properties:
13361 readOnly:
13362 type: boolean
13363 description: readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
13364 driver:
13365 type: string
13366 description: driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
13367 fsType:
13368 type: string
13369 description: fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
13370 nodePublishSecretRef:
13371 type: object
13372 description: nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
13373 properties:
13374 name:
13375 type: string
13376 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
13377 x-kubernetes-map-type: atomic
13378 volumeAttributes:
13379 type: object
13380 additionalProperties:
13381 type: string
13382 description: volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
13383 required:
13384 - driver
13385 downwardAPI:
13386 type: object
13387 description: downwardAPI represents downward API about the pod that should populate this volume
13388 properties:
13389 defaultMode:
13390 type: integer
13391 description: 'Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
13392 format: int32
13393 items:
13394 type: array
13395 description: Items is a list of downward API volume file
13396 items:
13397 type: object
13398 description: DownwardAPIVolumeFile represents information to create the file containing the pod field
13399 properties:
13400 fieldRef:
13401 type: object
13402 description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
13403 properties:
13404 apiVersion:
13405 type: string
13406 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
13407 fieldPath:
13408 type: string
13409 description: Path of the field to select in the specified API version.
13410 required:
13411 - fieldPath
13412 x-kubernetes-map-type: atomic
13413 resourceFieldRef:
13414 type: object
13415 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
13416 properties:
13417 containerName:
13418 type: string
13419 description: 'Container name: required for volumes, optional for env vars'
13420 divisor:
13421 anyOf:
13422 - type: integer
13423 - type: string
13424 description: Specifies the output format of the exposed resources, defaults to "1"
13425 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
13426 x-kubernetes-int-or-string: true
13427 resource:
13428 type: string
13429 description: 'Required: resource to select'
13430 required:
13431 - resource
13432 x-kubernetes-map-type: atomic
13433 mode:
13434 type: integer
13435 description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
13436 format: int32
13437 path:
13438 type: string
13439 description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
13440 required:
13441 - path
13442 emptyDir:
13443 type: object
13444 description: 'emptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
13445 properties:
13446 medium:
13447 type: string
13448 description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
13449 sizeLimit:
13450 anyOf:
13451 - type: integer
13452 - type: string
13453 description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
13454 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
13455 x-kubernetes-int-or-string: true
13456 ephemeral:
13457 type: object
13458 description: "ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."
13459 properties:
13460 volumeClaimTemplate:
13461 type: object
13462 description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
13463 properties:
13464 metadata:
13465 type: object
13466 description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
13467 properties:
13468 name:
13469 type: string
13470 namespace:
13471 type: string
13472 labels:
13473 type: object
13474 additionalProperties:
13475 type: string
13476 annotations:
13477 type: object
13478 additionalProperties:
13479 type: string
13480 finalizers:
13481 type: array
13482 items:
13483 type: string
13484 spec:
13485 type: object
13486 description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
13487 properties:
13488 selector:
13489 type: object
13490 description: selector is a label query over volumes to consider for binding.
13491 properties:
13492 matchExpressions:
13493 type: array
13494 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
13495 items:
13496 type: object
13497 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
13498 properties:
13499 key:
13500 type: string
13501 description: key is the label key that the selector applies to.
13502 operator:
13503 type: string
13504 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
13505 values:
13506 type: array
13507 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.
13508 items:
13509 type: string
13510 required:
13511 - key
13512 - operator
13513 matchLabels:
13514 type: object
13515 additionalProperties:
13516 type: string
13517 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.
13518 x-kubernetes-map-type: atomic
13519 resources:
13520 type: object
13521 description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
13522 properties:
13523 claims:
13524 type: array
13525 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
13526 items:
13527 type: object
13528 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
13529 properties:
13530 name:
13531 type: string
13532 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.
13533 required:
13534 - name
13535 x-kubernetes-list-map-keys:
13536 - name
13537 x-kubernetes-list-type: map
13538 limits:
13539 type: object
13540 additionalProperties:
13541 anyOf:
13542 - type: integer
13543 - type: string
13544 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
13545 x-kubernetes-int-or-string: true
13546 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
13547 requests:
13548 type: object
13549 additionalProperties:
13550 anyOf:
13551 - type: integer
13552 - type: string
13553 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
13554 x-kubernetes-int-or-string: true
13555 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
13556 accessModes:
13557 type: array
13558 description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
13559 items:
13560 type: string
13561 dataSource:
13562 type: object
13563 description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
13564 properties:
13565 name:
13566 type: string
13567 description: Name is the name of resource being referenced
13568 kind:
13569 type: string
13570 description: Kind is the type of resource being referenced
13571 apiGroup:
13572 type: string
13573 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
13574 required:
13575 - kind
13576 - name
13577 x-kubernetes-map-type: atomic
13578 dataSourceRef:
13579 type: object
13580 description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
13581 properties:
13582 name:
13583 type: string
13584 description: Name is the name of resource being referenced
13585 namespace:
13586 type: string
13587 description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
13588 kind:
13589 type: string
13590 description: Kind is the type of resource being referenced
13591 apiGroup:
13592 type: string
13593 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
13594 required:
13595 - kind
13596 - name
13597 storageClassName:
13598 type: string
13599 description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
13600 volumeMode:
13601 type: string
13602 description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
13603 volumeName:
13604 type: string
13605 description: volumeName is the binding reference to the PersistentVolume backing this claim.
13606 required:
13607 - spec
13608 fc:
13609 type: object
13610 description: fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
13611 properties:
13612 readOnly:
13613 type: boolean
13614 description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
13615 fsType:
13616 type: string
13617 description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
13618 lun:
13619 type: integer
13620 description: 'lun is Optional: FC target lun number'
13621 format: int32
13622 targetWWNs:
13623 type: array
13624 description: 'targetWWNs is Optional: FC target worldwide names (WWNs)'
13625 items:
13626 type: string
13627 wwids:
13628 type: array
13629 description: 'wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
13630 items:
13631 type: string
13632 flexVolume:
13633 type: object
13634 description: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
13635 properties:
13636 readOnly:
13637 type: boolean
13638 description: 'readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
13639 secretRef:
13640 type: object
13641 description: 'secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.'
13642 properties:
13643 name:
13644 type: string
13645 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
13646 x-kubernetes-map-type: atomic
13647 driver:
13648 type: string
13649 description: driver is the name of the driver to use for this volume.
13650 fsType:
13651 type: string
13652 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
13653 options:
13654 type: object
13655 additionalProperties:
13656 type: string
13657 description: 'options is Optional: this field holds extra command options if any.'
13658 required:
13659 - driver
13660 flocker:
13661 type: object
13662 description: flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
13663 properties:
13664 datasetName:
13665 type: string
13666 description: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
13667 datasetUUID:
13668 type: string
13669 description: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
13670 gcePersistentDisk:
13671 type: object
13672 description: 'gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
13673 properties:
13674 readOnly:
13675 type: boolean
13676 description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
13677 fsType:
13678 type: string
13679 description: 'fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine'
13680 partition:
13681 type: integer
13682 description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
13683 format: int32
13684 pdName:
13685 type: string
13686 description: 'pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
13687 required:
13688 - pdName
13689 gitRepo:
13690 type: object
13691 description: 'gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod''s container.'
13692 properties:
13693 revision:
13694 type: string
13695 description: revision is the commit hash for the specified revision.
13696 directory:
13697 type: string
13698 description: directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
13699 repository:
13700 type: string
13701 description: repository is the URL
13702 required:
13703 - repository
13704 glusterfs:
13705 type: object
13706 description: 'glusterfs represents a Glusterfs mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
13707 properties:
13708 readOnly:
13709 type: boolean
13710 description: 'readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
13711 endpoints:
13712 type: string
13713 description: 'endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
13714 path:
13715 type: string
13716 description: 'path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
13717 required:
13718 - endpoints
13719 - path
13720 hostPath:
13721 type: object
13722 description: 'hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.'
13723 properties:
13724 type:
13725 type: string
13726 description: 'type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
13727 path:
13728 type: string
13729 description: 'path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
13730 required:
13731 - path
13732 iscsi:
13733 type: object
13734 description: 'iscsi represents an ISCSI Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
13735 properties:
13736 readOnly:
13737 type: boolean
13738 description: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
13739 secretRef:
13740 type: object
13741 description: secretRef is the CHAP Secret for iSCSI target and initiator authentication
13742 properties:
13743 name:
13744 type: string
13745 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
13746 x-kubernetes-map-type: atomic
13747 chapAuthDiscovery:
13748 type: boolean
13749 description: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
13750 chapAuthSession:
13751 type: boolean
13752 description: chapAuthSession defines whether support iSCSI Session CHAP authentication
13753 fsType:
13754 type: string
13755 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
13756 initiatorName:
13757 type: string
13758 description: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
13759 iqn:
13760 type: string
13761 description: iqn is the target iSCSI Qualified Name.
13762 iscsiInterface:
13763 type: string
13764 description: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
13765 lun:
13766 type: integer
13767 description: lun represents iSCSI Target Lun number.
13768 format: int32
13769 portals:
13770 type: array
13771 description: portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
13772 items:
13773 type: string
13774 targetPortal:
13775 type: string
13776 description: targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
13777 required:
13778 - iqn
13779 - lun
13780 - targetPortal
13781 nfs:
13782 type: object
13783 description: 'nfs represents an NFS mount on the host that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
13784 properties:
13785 readOnly:
13786 type: boolean
13787 description: 'readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
13788 path:
13789 type: string
13790 description: 'path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
13791 server:
13792 type: string
13793 description: 'server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
13794 required:
13795 - path
13796 - server
13797 persistentVolumeClaim:
13798 type: object
13799 description: 'persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
13800 properties:
13801 readOnly:
13802 type: boolean
13803 description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
13804 claimName:
13805 type: string
13806 description: 'claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
13807 required:
13808 - claimName
13809 photonPersistentDisk:
13810 type: object
13811 description: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
13812 properties:
13813 fsType:
13814 type: string
13815 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
13816 pdID:
13817 type: string
13818 description: pdID is the ID that identifies Photon Controller persistent disk
13819 required:
13820 - pdID
13821 portworxVolume:
13822 type: object
13823 description: portworxVolume represents a portworx volume attached and mounted on kubelets host machine
13824 properties:
13825 readOnly:
13826 type: boolean
13827 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
13828 fsType:
13829 type: string
13830 description: fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
13831 volumeID:
13832 type: string
13833 description: volumeID uniquely identifies a Portworx volume
13834 required:
13835 - volumeID
13836 projected:
13837 type: object
13838 description: projected items for all in one resources secrets, configmaps, and downward API
13839 properties:
13840 defaultMode:
13841 type: integer
13842 description: defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
13843 format: int32
13844 sources:
13845 type: array
13846 description: sources is the list of volume projections
13847 items:
13848 type: object
13849 description: Projection that may be projected along with other supported volume types
13850 properties:
13851 configMap:
13852 type: object
13853 description: configMap information about the configMap data to project
13854 properties:
13855 name:
13856 type: string
13857 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
13858 items:
13859 type: array
13860 description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
13861 items:
13862 type: object
13863 description: Maps a string key to a path within a volume.
13864 properties:
13865 key:
13866 type: string
13867 description: key is the key to project.
13868 mode:
13869 type: integer
13870 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
13871 format: int32
13872 path:
13873 type: string
13874 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
13875 required:
13876 - key
13877 - path
13878 optional:
13879 type: boolean
13880 description: optional specify whether the ConfigMap or its keys must be defined
13881 x-kubernetes-map-type: atomic
13882 downwardAPI:
13883 type: object
13884 description: downwardAPI information about the downwardAPI data to project
13885 properties:
13886 items:
13887 type: array
13888 description: Items is a list of DownwardAPIVolume file
13889 items:
13890 type: object
13891 description: DownwardAPIVolumeFile represents information to create the file containing the pod field
13892 properties:
13893 fieldRef:
13894 type: object
13895 description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
13896 properties:
13897 apiVersion:
13898 type: string
13899 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
13900 fieldPath:
13901 type: string
13902 description: Path of the field to select in the specified API version.
13903 required:
13904 - fieldPath
13905 x-kubernetes-map-type: atomic
13906 resourceFieldRef:
13907 type: object
13908 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
13909 properties:
13910 containerName:
13911 type: string
13912 description: 'Container name: required for volumes, optional for env vars'
13913 divisor:
13914 anyOf:
13915 - type: integer
13916 - type: string
13917 description: Specifies the output format of the exposed resources, defaults to "1"
13918 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
13919 x-kubernetes-int-or-string: true
13920 resource:
13921 type: string
13922 description: 'Required: resource to select'
13923 required:
13924 - resource
13925 x-kubernetes-map-type: atomic
13926 mode:
13927 type: integer
13928 description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
13929 format: int32
13930 path:
13931 type: string
13932 description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
13933 required:
13934 - path
13935 secret:
13936 type: object
13937 description: secret information about the secret data to project
13938 properties:
13939 name:
13940 type: string
13941 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
13942 items:
13943 type: array
13944 description: items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
13945 items:
13946 type: object
13947 description: Maps a string key to a path within a volume.
13948 properties:
13949 key:
13950 type: string
13951 description: key is the key to project.
13952 mode:
13953 type: integer
13954 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
13955 format: int32
13956 path:
13957 type: string
13958 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
13959 required:
13960 - key
13961 - path
13962 optional:
13963 type: boolean
13964 description: optional field specify whether the Secret or its key must be defined
13965 x-kubernetes-map-type: atomic
13966 serviceAccountToken:
13967 type: object
13968 description: serviceAccountToken is information about the serviceAccountToken data to project
13969 properties:
13970 audience:
13971 type: string
13972 description: audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
13973 expirationSeconds:
13974 type: integer
13975 description: expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
13976 format: int64
13977 path:
13978 type: string
13979 description: path is the path relative to the mount point of the file to project the token into.
13980 required:
13981 - path
13982 quobyte:
13983 type: object
13984 description: quobyte represents a Quobyte mount on the host that shares a pod's lifetime
13985 properties:
13986 readOnly:
13987 type: boolean
13988 description: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
13989 group:
13990 type: string
13991 description: group to map volume access to Default is no group
13992 registry:
13993 type: string
13994 description: registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
13995 tenant:
13996 type: string
13997 description: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
13998 user:
13999 type: string
14000 description: user to map volume access to Defaults to serivceaccount user
14001 volume:
14002 type: string
14003 description: volume is a string that references an already created Quobyte volume by name.
14004 required:
14005 - registry
14006 - volume
14007 rbd:
14008 type: object
14009 description: 'rbd represents a Rados Block Device mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
14010 properties:
14011 image:
14012 type: string
14013 description: 'image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
14014 readOnly:
14015 type: boolean
14016 description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
14017 secretRef:
14018 type: object
14019 description: 'secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
14020 properties:
14021 name:
14022 type: string
14023 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
14024 x-kubernetes-map-type: atomic
14025 fsType:
14026 type: string
14027 description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
14028 keyring:
14029 type: string
14030 description: 'keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
14031 monitors:
14032 type: array
14033 description: 'monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
14034 items:
14035 type: string
14036 pool:
14037 type: string
14038 description: 'pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
14039 user:
14040 type: string
14041 description: 'user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
14042 required:
14043 - image
14044 - monitors
14045 scaleIO:
14046 type: object
14047 description: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
14048 properties:
14049 readOnly:
14050 type: boolean
14051 description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
14052 secretRef:
14053 type: object
14054 description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
14055 properties:
14056 name:
14057 type: string
14058 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
14059 x-kubernetes-map-type: atomic
14060 fsType:
14061 type: string
14062 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
14063 gateway:
14064 type: string
14065 description: gateway is the host address of the ScaleIO API Gateway.
14066 protectionDomain:
14067 type: string
14068 description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
14069 sslEnabled:
14070 type: boolean
14071 description: sslEnabled Flag enable/disable SSL communication with Gateway, default false
14072 storageMode:
14073 type: string
14074 description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
14075 storagePool:
14076 type: string
14077 description: storagePool is the ScaleIO Storage Pool associated with the protection domain.
14078 system:
14079 type: string
14080 description: system is the name of the storage system as configured in ScaleIO.
14081 volumeName:
14082 type: string
14083 description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
14084 required:
14085 - gateway
14086 - secretRef
14087 - system
14088 secret:
14089 type: object
14090 description: 'secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
14091 properties:
14092 defaultMode:
14093 type: integer
14094 description: 'defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
14095 format: int32
14096 items:
14097 type: array
14098 description: items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
14099 items:
14100 type: object
14101 description: Maps a string key to a path within a volume.
14102 properties:
14103 key:
14104 type: string
14105 description: key is the key to project.
14106 mode:
14107 type: integer
14108 description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
14109 format: int32
14110 path:
14111 type: string
14112 description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
14113 required:
14114 - key
14115 - path
14116 optional:
14117 type: boolean
14118 description: optional field specify whether the Secret or its keys must be defined
14119 secretName:
14120 type: string
14121 description: 'secretName is the name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
14122 storageos:
14123 type: object
14124 description: storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
14125 properties:
14126 readOnly:
14127 type: boolean
14128 description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
14129 secretRef:
14130 type: object
14131 description: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
14132 properties:
14133 name:
14134 type: string
14135 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
14136 x-kubernetes-map-type: atomic
14137 fsType:
14138 type: string
14139 description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
14140 volumeName:
14141 type: string
14142 description: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
14143 volumeNamespace:
14144 type: string
14145 description: volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
14146 vsphereVolume:
14147 type: object
14148 description: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
14149 properties:
14150 fsType:
14151 type: string
14152 description: fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
14153 storagePolicyID:
14154 type: string
14155 description: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
14156 storagePolicyName:
14157 type: string
14158 description: storagePolicyName is the storage Policy Based Management (SPBM) profile name.
14159 volumePath:
14160 type: string
14161 description: volumePath is the path that identifies vSphere volume vmdk
14162 required:
14163 - volumePath
14164 required:
14165 - name
14166 imagePullSecrets:
14167 type: array
14168 description: Fluentd image pull secret
14169 items:
14170 type: object
14171 description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
14172 properties:
14173 name:
14174 type: string
14175 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
14176 x-kubernetes-map-type: atomic
14177 affinity:
14178 type: object
14179 description: Pod's scheduling constraints.
14180 properties:
14181 nodeAffinity:
14182 type: object
14183 description: Describes node affinity scheduling rules for the pod.
14184 properties:
14185 preferredDuringSchedulingIgnoredDuringExecution:
14186 type: array
14187 description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
14188 items:
14189 type: object
14190 description: An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
14191 properties:
14192 preference:
14193 type: object
14194 description: A node selector term, associated with the corresponding weight.
14195 properties:
14196 matchExpressions:
14197 type: array
14198 description: A list of node selector requirements by node's labels.
14199 items:
14200 type: object
14201 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14202 properties:
14203 key:
14204 type: string
14205 description: The label key that the selector applies to.
14206 operator:
14207 type: string
14208 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
14209 values:
14210 type: array
14211 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
14212 items:
14213 type: string
14214 required:
14215 - key
14216 - operator
14217 matchFields:
14218 type: array
14219 description: A list of node selector requirements by node's fields.
14220 items:
14221 type: object
14222 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14223 properties:
14224 key:
14225 type: string
14226 description: The label key that the selector applies to.
14227 operator:
14228 type: string
14229 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
14230 values:
14231 type: array
14232 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
14233 items:
14234 type: string
14235 required:
14236 - key
14237 - operator
14238 x-kubernetes-map-type: atomic
14239 weight:
14240 type: integer
14241 description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
14242 format: int32
14243 required:
14244 - preference
14245 - weight
14246 requiredDuringSchedulingIgnoredDuringExecution:
14247 type: object
14248 description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
14249 properties:
14250 nodeSelectorTerms:
14251 type: array
14252 description: Required. A list of node selector terms. The terms are ORed.
14253 items:
14254 type: object
14255 description: A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
14256 properties:
14257 matchExpressions:
14258 type: array
14259 description: A list of node selector requirements by node's labels.
14260 items:
14261 type: object
14262 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14263 properties:
14264 key:
14265 type: string
14266 description: The label key that the selector applies to.
14267 operator:
14268 type: string
14269 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
14270 values:
14271 type: array
14272 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
14273 items:
14274 type: string
14275 required:
14276 - key
14277 - operator
14278 matchFields:
14279 type: array
14280 description: A list of node selector requirements by node's fields.
14281 items:
14282 type: object
14283 description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14284 properties:
14285 key:
14286 type: string
14287 description: The label key that the selector applies to.
14288 operator:
14289 type: string
14290 description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
14291 values:
14292 type: array
14293 description: 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
14294 items:
14295 type: string
14296 required:
14297 - key
14298 - operator
14299 x-kubernetes-map-type: atomic
14300 required:
14301 - nodeSelectorTerms
14302 x-kubernetes-map-type: atomic
14303 podAffinity:
14304 type: object
14305 description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
14306 properties:
14307 preferredDuringSchedulingIgnoredDuringExecution:
14308 type: array
14309 description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
14310 items:
14311 type: object
14312 description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
14313 properties:
14314 podAffinityTerm:
14315 type: object
14316 description: Required. A pod affinity term, associated with the corresponding weight.
14317 properties:
14318 labelSelector:
14319 type: object
14320 description: A label query over a set of resources, in this case pods.
14321 properties:
14322 matchExpressions:
14323 type: array
14324 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
14325 items:
14326 type: object
14327 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14328 properties:
14329 key:
14330 type: string
14331 description: key is the label key that the selector applies to.
14332 operator:
14333 type: string
14334 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
14335 values:
14336 type: array
14337 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.
14338 items:
14339 type: string
14340 required:
14341 - key
14342 - operator
14343 matchLabels:
14344 type: object
14345 additionalProperties:
14346 type: string
14347 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.
14348 x-kubernetes-map-type: atomic
14349 namespaceSelector:
14350 type: object
14351 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
14352 properties:
14353 matchExpressions:
14354 type: array
14355 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
14356 items:
14357 type: object
14358 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14359 properties:
14360 key:
14361 type: string
14362 description: key is the label key that the selector applies to.
14363 operator:
14364 type: string
14365 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
14366 values:
14367 type: array
14368 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.
14369 items:
14370 type: string
14371 required:
14372 - key
14373 - operator
14374 matchLabels:
14375 type: object
14376 additionalProperties:
14377 type: string
14378 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.
14379 x-kubernetes-map-type: atomic
14380 namespaces:
14381 type: array
14382 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
14383 items:
14384 type: string
14385 topologyKey:
14386 type: string
14387 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
14388 required:
14389 - topologyKey
14390 weight:
14391 type: integer
14392 description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
14393 format: int32
14394 required:
14395 - podAffinityTerm
14396 - weight
14397 requiredDuringSchedulingIgnoredDuringExecution:
14398 type: array
14399 description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
14400 items:
14401 type: object
14402 description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
14403 properties:
14404 labelSelector:
14405 type: object
14406 description: A label query over a set of resources, in this case pods.
14407 properties:
14408 matchExpressions:
14409 type: array
14410 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
14411 items:
14412 type: object
14413 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14414 properties:
14415 key:
14416 type: string
14417 description: key is the label key that the selector applies to.
14418 operator:
14419 type: string
14420 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
14421 values:
14422 type: array
14423 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.
14424 items:
14425 type: string
14426 required:
14427 - key
14428 - operator
14429 matchLabels:
14430 type: object
14431 additionalProperties:
14432 type: string
14433 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.
14434 x-kubernetes-map-type: atomic
14435 namespaceSelector:
14436 type: object
14437 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
14438 properties:
14439 matchExpressions:
14440 type: array
14441 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
14442 items:
14443 type: object
14444 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14445 properties:
14446 key:
14447 type: string
14448 description: key is the label key that the selector applies to.
14449 operator:
14450 type: string
14451 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
14452 values:
14453 type: array
14454 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.
14455 items:
14456 type: string
14457 required:
14458 - key
14459 - operator
14460 matchLabels:
14461 type: object
14462 additionalProperties:
14463 type: string
14464 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.
14465 x-kubernetes-map-type: atomic
14466 namespaces:
14467 type: array
14468 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
14469 items:
14470 type: string
14471 topologyKey:
14472 type: string
14473 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
14474 required:
14475 - topologyKey
14476 podAntiAffinity:
14477 type: object
14478 description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
14479 properties:
14480 preferredDuringSchedulingIgnoredDuringExecution:
14481 type: array
14482 description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
14483 items:
14484 type: object
14485 description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
14486 properties:
14487 podAffinityTerm:
14488 type: object
14489 description: Required. A pod affinity term, associated with the corresponding weight.
14490 properties:
14491 labelSelector:
14492 type: object
14493 description: A label query over a set of resources, in this case pods.
14494 properties:
14495 matchExpressions:
14496 type: array
14497 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
14498 items:
14499 type: object
14500 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14501 properties:
14502 key:
14503 type: string
14504 description: key is the label key that the selector applies to.
14505 operator:
14506 type: string
14507 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
14508 values:
14509 type: array
14510 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.
14511 items:
14512 type: string
14513 required:
14514 - key
14515 - operator
14516 matchLabels:
14517 type: object
14518 additionalProperties:
14519 type: string
14520 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.
14521 x-kubernetes-map-type: atomic
14522 namespaceSelector:
14523 type: object
14524 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
14525 properties:
14526 matchExpressions:
14527 type: array
14528 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
14529 items:
14530 type: object
14531 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14532 properties:
14533 key:
14534 type: string
14535 description: key is the label key that the selector applies to.
14536 operator:
14537 type: string
14538 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
14539 values:
14540 type: array
14541 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.
14542 items:
14543 type: string
14544 required:
14545 - key
14546 - operator
14547 matchLabels:
14548 type: object
14549 additionalProperties:
14550 type: string
14551 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.
14552 x-kubernetes-map-type: atomic
14553 namespaces:
14554 type: array
14555 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
14556 items:
14557 type: string
14558 topologyKey:
14559 type: string
14560 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
14561 required:
14562 - topologyKey
14563 weight:
14564 type: integer
14565 description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
14566 format: int32
14567 required:
14568 - podAffinityTerm
14569 - weight
14570 requiredDuringSchedulingIgnoredDuringExecution:
14571 type: array
14572 description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
14573 items:
14574 type: object
14575 description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
14576 properties:
14577 labelSelector:
14578 type: object
14579 description: A label query over a set of resources, in this case pods.
14580 properties:
14581 matchExpressions:
14582 type: array
14583 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
14584 items:
14585 type: object
14586 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14587 properties:
14588 key:
14589 type: string
14590 description: key is the label key that the selector applies to.
14591 operator:
14592 type: string
14593 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
14594 values:
14595 type: array
14596 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.
14597 items:
14598 type: string
14599 required:
14600 - key
14601 - operator
14602 matchLabels:
14603 type: object
14604 additionalProperties:
14605 type: string
14606 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.
14607 x-kubernetes-map-type: atomic
14608 namespaceSelector:
14609 type: object
14610 description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
14611 properties:
14612 matchExpressions:
14613 type: array
14614 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
14615 items:
14616 type: object
14617 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14618 properties:
14619 key:
14620 type: string
14621 description: key is the label key that the selector applies to.
14622 operator:
14623 type: string
14624 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
14625 values:
14626 type: array
14627 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.
14628 items:
14629 type: string
14630 required:
14631 - key
14632 - operator
14633 matchLabels:
14634 type: object
14635 additionalProperties:
14636 type: string
14637 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.
14638 x-kubernetes-map-type: atomic
14639 namespaces:
14640 type: array
14641 description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
14642 items:
14643 type: string
14644 topologyKey:
14645 type: string
14646 description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
14647 required:
14648 - topologyKey
14649 tolerations:
14650 type: array
14651 description: Tolerations
14652 items:
14653 type: object
14654 description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
14655 properties:
14656 value:
14657 type: string
14658 description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
14659 effect:
14660 type: string
14661 description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
14662 key:
14663 type: string
14664 description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
14665 operator:
14666 type: string
14667 description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
14668 tolerationSeconds:
14669 type: integer
14670 description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
14671 format: int64
14672 image:
14673 type: string
14674 description: Fluentd image.
14675 args:
14676 type: array
14677 description: Fluentd Watcher command line arguments.
14678 items:
14679 type: string
14680 resources:
14681 type: object
14682 description: Compute Resources required by container.
14683 properties:
14684 claims:
14685 type: array
14686 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
14687 items:
14688 type: object
14689 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
14690 properties:
14691 name:
14692 type: string
14693 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.
14694 required:
14695 - name
14696 x-kubernetes-list-map-keys:
14697 - name
14698 x-kubernetes-list-type: map
14699 limits:
14700 type: object
14701 additionalProperties:
14702 anyOf:
14703 - type: integer
14704 - type: string
14705 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
14706 x-kubernetes-int-or-string: true
14707 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
14708 requests:
14709 type: object
14710 additionalProperties:
14711 anyOf:
14712 - type: integer
14713 - type: string
14714 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
14715 x-kubernetes-int-or-string: true
14716 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
14717 volumeMounts:
14718 type: array
14719 description: Pod volumes to mount into the container's filesystem. Cannot be updated.
14720 items:
14721 type: object
14722 description: VolumeMount describes a mounting of a Volume within a container.
14723 properties:
14724 name:
14725 type: string
14726 description: This must match the Name of a Volume.
14727 readOnly:
14728 type: boolean
14729 description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
14730 mountPath:
14731 type: string
14732 description: Path within the container at which the volume should be mounted. Must not contain ':'.
14733 subPath:
14734 type: string
14735 description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
14736 subPathExpr:
14737 type: string
14738 description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
14739 mountPropagation:
14740 type: string
14741 description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
14742 required:
14743 - mountPath
14744 - name
14745 imagePullPolicy:
14746 type: string
14747 description: Fluentd image pull policy.
14748 securityContext:
14749 type: object
14750 description: PodSecurityContext represents the security context for the fluentd pods.
14751 properties:
14752 fsGroup:
14753 type: integer
14754 description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows."
14755 format: int64
14756 fsGroupChangePolicy:
14757 type: string
14758 description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.'
14759 runAsGroup:
14760 type: integer
14761 description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
14762 format: int64
14763 runAsNonRoot:
14764 type: boolean
14765 description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
14766 runAsUser:
14767 type: integer
14768 description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
14769 format: int64
14770 seLinuxOptions:
14771 type: object
14772 description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
14773 properties:
14774 type:
14775 type: string
14776 description: Type is a SELinux type label that applies to the container.
14777 level:
14778 type: string
14779 description: Level is SELinux level label that applies to the container.
14780 role:
14781 type: string
14782 description: Role is a SELinux role label that applies to the container.
14783 user:
14784 type: string
14785 description: User is a SELinux user label that applies to the container.
14786 seccompProfile:
14787 type: object
14788 description: The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
14789 properties:
14790 type:
14791 type: string
14792 description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
14793 localhostProfile:
14794 type: string
14795 description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
14796 required:
14797 - type
14798 supplementalGroups:
14799 type: array
14800 description: A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
14801 items:
14802 type: integer
14803 format: int64
14804 sysctls:
14805 type: array
14806 description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
14807 items:
14808 type: object
14809 description: Sysctl defines a kernel parameter to be set
14810 properties:
14811 name:
14812 type: string
14813 description: Name of a property to set
14814 value:
14815 type: string
14816 description: Value of a property to set
14817 required:
14818 - name
14819 - value
14820 windowsOptions:
14821 type: object
14822 description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
14823 properties:
14824 gmsaCredentialSpec:
14825 type: string
14826 description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
14827 gmsaCredentialSpecName:
14828 type: string
14829 description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
14830 hostProcess:
14831 type: boolean
14832 description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
14833 runAsUserName:
14834 type: string
14835 description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
14836 buffer:
14837 type: object
14838 description: Buffer definition
14839 properties:
14840 disableBufferVolume:
14841 type: boolean
14842 description: Enabled buffer pvc by default.
14843 emptyDir:
14844 type: object
14845 description: Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
14846 properties:
14847 medium:
14848 type: string
14849 description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
14850 sizeLimit:
14851 anyOf:
14852 - type: integer
14853 - type: string
14854 description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
14855 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
14856 x-kubernetes-int-or-string: true
14857 hostPath:
14858 type: object
14859 description: Volume definition.
14860 properties:
14861 type:
14862 type: string
14863 description: 'type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
14864 path:
14865 type: string
14866 description: 'path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
14867 required:
14868 - path
14869 pvc:
14870 type: object
14871 description: PVC definition
14872 properties:
14873 apiVersion:
14874 type: string
14875 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'
14876 kind:
14877 type: string
14878 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'
14879 metadata:
14880 type: object
14881 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata'
14882 properties:
14883 name:
14884 type: string
14885 namespace:
14886 type: string
14887 labels:
14888 type: object
14889 additionalProperties:
14890 type: string
14891 annotations:
14892 type: object
14893 additionalProperties:
14894 type: string
14895 finalizers:
14896 type: array
14897 items:
14898 type: string
14899 spec:
14900 type: object
14901 description: 'spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
14902 properties:
14903 selector:
14904 type: object
14905 description: selector is a label query over volumes to consider for binding.
14906 properties:
14907 matchExpressions:
14908 type: array
14909 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
14910 items:
14911 type: object
14912 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
14913 properties:
14914 key:
14915 type: string
14916 description: key is the label key that the selector applies to.
14917 operator:
14918 type: string
14919 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
14920 values:
14921 type: array
14922 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.
14923 items:
14924 type: string
14925 required:
14926 - key
14927 - operator
14928 matchLabels:
14929 type: object
14930 additionalProperties:
14931 type: string
14932 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.
14933 x-kubernetes-map-type: atomic
14934 resources:
14935 type: object
14936 description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
14937 properties:
14938 claims:
14939 type: array
14940 description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
14941 items:
14942 type: object
14943 description: ResourceClaim references one entry in PodSpec.ResourceClaims.
14944 properties:
14945 name:
14946 type: string
14947 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.
14948 required:
14949 - name
14950 x-kubernetes-list-map-keys:
14951 - name
14952 x-kubernetes-list-type: map
14953 limits:
14954 type: object
14955 additionalProperties:
14956 anyOf:
14957 - type: integer
14958 - type: string
14959 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
14960 x-kubernetes-int-or-string: true
14961 description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
14962 requests:
14963 type: object
14964 additionalProperties:
14965 anyOf:
14966 - type: integer
14967 - type: string
14968 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
14969 x-kubernetes-int-or-string: true
14970 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
14971 accessModes:
14972 type: array
14973 description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
14974 items:
14975 type: string
14976 dataSource:
14977 type: object
14978 description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
14979 properties:
14980 name:
14981 type: string
14982 description: Name is the name of resource being referenced
14983 kind:
14984 type: string
14985 description: Kind is the type of resource being referenced
14986 apiGroup:
14987 type: string
14988 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
14989 required:
14990 - kind
14991 - name
14992 x-kubernetes-map-type: atomic
14993 dataSourceRef:
14994 type: object
14995 description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
14996 properties:
14997 name:
14998 type: string
14999 description: Name is the name of resource being referenced
15000 namespace:
15001 type: string
15002 description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
15003 kind:
15004 type: string
15005 description: Kind is the type of resource being referenced
15006 apiGroup:
15007 type: string
15008 description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
15009 required:
15010 - kind
15011 - name
15012 storageClassName:
15013 type: string
15014 description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
15015 volumeMode:
15016 type: string
15017 description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
15018 volumeName:
15019 type: string
15020 description: volumeName is the binding reference to the PersistentVolume backing this claim.
15021 status:
15022 type: object
15023 description: 'status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
15024 properties:
15025 accessModes:
15026 type: array
15027 description: 'accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
15028 items:
15029 type: string
15030 allocatedResources:
15031 type: object
15032 additionalProperties:
15033 anyOf:
15034 - type: integer
15035 - type: string
15036 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
15037 x-kubernetes-int-or-string: true
15038 description: allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
15039 capacity:
15040 type: object
15041 additionalProperties:
15042 anyOf:
15043 - type: integer
15044 - type: string
15045 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
15046 x-kubernetes-int-or-string: true
15047 description: capacity represents the actual resources of the underlying volume.
15048 conditions:
15049 type: array
15050 description: conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
15051 items:
15052 type: object
15053 description: PersistentVolumeClaimCondition contails details about state of pvc
15054 properties:
15055 type:
15056 type: string
15057 description: PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
15058 status:
15059 type: string
15060 lastProbeTime:
15061 type: string
15062 description: lastProbeTime is the time we probed the condition.
15063 format: date-time
15064 lastTransitionTime:
15065 type: string
15066 description: lastTransitionTime is the time the condition transitioned from one status to another.
15067 format: date-time
15068 message:
15069 type: string
15070 description: message is the human-readable message indicating details about last transition.
15071 reason:
15072 type: string
15073 description: reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
15074 required:
15075 - status
15076 - type
15077 phase:
15078 type: string
15079 description: phase represents the current phase of PersistentVolumeClaim.
15080 resizeStatus:
15081 type: string
15082 description: resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
15083 defaultFilterSelector:
15084 type: object
15085 description: Select cluster filter plugins used to filter for the default cluster output
15086 properties:
15087 matchExpressions:
15088 type: array
15089 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
15090 items:
15091 type: object
15092 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
15093 properties:
15094 key:
15095 type: string
15096 description: key is the label key that the selector applies to.
15097 operator:
15098 type: string
15099 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
15100 values:
15101 type: array
15102 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.
15103 items:
15104 type: string
15105 required:
15106 - key
15107 - operator
15108 matchLabels:
15109 type: object
15110 additionalProperties:
15111 type: string
15112 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.
15113 x-kubernetes-map-type: atomic
15114 defaultOutputSelector:
15115 type: object
15116 description: Select cluster output plugins used to send all logs that did not match any route to the matching outputs
15117 properties:
15118 matchExpressions:
15119 type: array
15120 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
15121 items:
15122 type: object
15123 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
15124 properties:
15125 key:
15126 type: string
15127 description: key is the label key that the selector applies to.
15128 operator:
15129 type: string
15130 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
15131 values:
15132 type: array
15133 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.
15134 items:
15135 type: string
15136 required:
15137 - key
15138 - operator
15139 matchLabels:
15140 type: object
15141 additionalProperties:
15142 type: string
15143 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.
15144 x-kubernetes-map-type: atomic
15145 disableService:
15146 type: boolean
15147 description: By default will build the related service according to the globalinputs definition.
15148 envVars:
15149 type: array
15150 description: EnvVars represent environment variables that can be passed to fluentd pods.
15151 items:
15152 type: object
15153 description: EnvVar represents an environment variable present in a Container.
15154 properties:
15155 name:
15156 type: string
15157 description: Name of the environment variable. Must be a C_IDENTIFIER.
15158 value:
15159 type: string
15160 description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
15161 valueFrom:
15162 type: object
15163 description: Source for the environment variable's value. Cannot be used if value is not empty.
15164 properties:
15165 fieldRef:
15166 type: object
15167 description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.'
15168 properties:
15169 apiVersion:
15170 type: string
15171 description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
15172 fieldPath:
15173 type: string
15174 description: Path of the field to select in the specified API version.
15175 required:
15176 - fieldPath
15177 x-kubernetes-map-type: atomic
15178 resourceFieldRef:
15179 type: object
15180 description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.'
15181 properties:
15182 containerName:
15183 type: string
15184 description: 'Container name: required for volumes, optional for env vars'
15185 divisor:
15186 anyOf:
15187 - type: integer
15188 - type: string
15189 description: Specifies the output format of the exposed resources, defaults to "1"
15190 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
15191 x-kubernetes-int-or-string: true
15192 resource:
15193 type: string
15194 description: 'Required: resource to select'
15195 required:
15196 - resource
15197 x-kubernetes-map-type: atomic
15198 configMapKeyRef:
15199 type: object
15200 description: Selects a key of a ConfigMap.
15201 properties:
15202 name:
15203 type: string
15204 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
15205 key:
15206 type: string
15207 description: The key to select.
15208 optional:
15209 type: boolean
15210 description: Specify whether the ConfigMap or its key must be defined
15211 required:
15212 - key
15213 x-kubernetes-map-type: atomic
15214 secretKeyRef:
15215 type: object
15216 description: Selects a key of a secret in the pod's namespace
15217 properties:
15218 name:
15219 type: string
15220 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
15221 key:
15222 type: string
15223 description: The key of the secret to select from. Must be a valid secret key.
15224 optional:
15225 type: boolean
15226 description: Specify whether the Secret or its key must be defined
15227 required:
15228 - key
15229 x-kubernetes-map-type: atomic
15230 required:
15231 - name
15232 fluentdCfgSelector:
15233 type: object
15234 description: FluentdCfgSelector defines the selectors to select the fluentd config CRs.
15235 properties:
15236 matchExpressions:
15237 type: array
15238 description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
15239 items:
15240 type: object
15241 description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
15242 properties:
15243 key:
15244 type: string
15245 description: key is the label key that the selector applies to.
15246 operator:
15247 type: string
15248 description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
15249 values:
15250 type: array
15251 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.
15252 items:
15253 type: string
15254 required:
15255 - key
15256 - operator
15257 matchLabels:
15258 type: object
15259 additionalProperties:
15260 type: string
15261 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.
15262 x-kubernetes-map-type: atomic
15263 globalInputs:
15264 type: array
15265 description: Fluentd global inputs.
15266 items:
15267 type: object
15268 description: Input defines all available input plugins and their parameters
15269 properties:
15270 forward:
15271 type: object
15272 description: in_forward plugin
15273 properties:
15274 port:
15275 type: integer
15276 description: The port to listen to, default is 24224.
15277 format: int32
15278 maximum: 65535
15279 minimum: 1
15280 addTagPrefix:
15281 type: string
15282 description: Adds the prefix to the incoming event's tag.
15283 bind:
15284 type: string
15285 description: The port to listen to, default is "0.0.0.0"
15286 chunkSizeLimit:
15287 type: string
15288 description: The size limit of the received chunk. If the chunk size is larger than this value, the received chunk is dropped.
15289 pattern: ^\d+(KB|MB|GB|TB)$
15290 chunkSizeWarnLimit:
15291 type: string
15292 description: The warning size limit of the received chunk. If the chunk size is larger than this value, a warning message will be sent.
15293 pattern: ^\d+(KB|MB|GB|TB)$
15294 client:
15295 type: object
15296 description: The security section of client plugin
15297 properties:
15298 host:
15299 type: string
15300 description: The IP address or hostname of the client. This is exclusive with Network.
15301 network:
15302 type: string
15303 description: The network address specification. This is exclusive with Host.
15304 sharedKey:
15305 type: string
15306 description: The shared key per client.
15307 users:
15308 type: string
15309 description: The array of usernames.
15310 denyKeepalive:
15311 type: boolean
15312 description: The connections will be disconnected right after receiving a message, if true.
15313 lingerTimeout:
15314 type: integer
15315 description: The timeout used to set the linger option.
15316 resolveHostname:
15317 type: boolean
15318 description: Tries to resolve hostname from IP addresses or not.
15319 security:
15320 type: object
15321 description: The security section of forward plugin
15322 properties:
15323 allowAnonymousSource:
15324 type: string
15325 description: Allows the anonymous source. <client> sections are required, if disabled.
15326 selfHostname:
15327 type: string
15328 description: The hostname.
15329 sharedKey:
15330 type: string
15331 description: The shared key for authentication.
15332 user:
15333 type: object
15334 description: Defines user section directly.
15335 properties:
15336 password:
15337 type: object
15338 description: Secret defines the key of a value.
15339 properties:
15340 valueFrom:
15341 type: object
15342 description: ValueSource defines how to find a value's key.
15343 properties:
15344 secretKeyRef:
15345 type: object
15346 description: Selects a key of a secret in the pod's namespace
15347 properties:
15348 name:
15349 type: string
15350 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
15351 key:
15352 type: string
15353 description: The key of the secret to select from. Must be a valid secret key.
15354 optional:
15355 type: boolean
15356 description: Specify whether the Secret or its key must be defined
15357 required:
15358 - key
15359 x-kubernetes-map-type: atomic
15360 username:
15361 type: object
15362 description: Secret defines the key of a value.
15363 properties:
15364 valueFrom:
15365 type: object
15366 description: ValueSource defines how to find a value's key.
15367 properties:
15368 secretKeyRef:
15369 type: object
15370 description: Selects a key of a secret in the pod's namespace
15371 properties:
15372 name:
15373 type: string
15374 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
15375 key:
15376 type: string
15377 description: The key of the secret to select from. Must be a valid secret key.
15378 optional:
15379 type: boolean
15380 description: Specify whether the Secret or its key must be defined
15381 required:
15382 - key
15383 x-kubernetes-map-type: atomic
15384 userAuth:
15385 type: string
15386 description: If true, user-based authentication is used.
15387 sendKeepalivePacket:
15388 type: boolean
15389 description: Enables the TCP keepalive for sockets.
15390 skipInvalidEvent:
15391 type: boolean
15392 description: Skips the invalid incoming event.
15393 sourceAddressKey:
15394 type: string
15395 description: The field name of the client's source address. If set, the client's address will be set to its key.
15396 sourceHostnameKey:
15397 type: string
15398 description: The field name of the client's hostname. If set, the client's hostname will be set to its key.
15399 tag:
15400 type: string
15401 description: in_forward uses incoming event's tag by default (See Protocol Section). If the tag parameter is set, its value is used instead.
15402 transport:
15403 type: object
15404 description: The transport section of forward plugin
15405 properties:
15406 protocol:
15407 type: string
15408 description: 'The protocal name of this plugin, i.e: tls'
15409 caCertPath:
15410 type: string
15411 description: for Cert generated
15412 caPath:
15413 type: string
15414 description: for Cert signed by public CA
15415 caPrivateKeyPassphrase:
15416 type: string
15417 caPrivateKeyPath:
15418 type: string
15419 certPath:
15420 type: string
15421 certVerifier:
15422 type: string
15423 description: other parameters
15424 ciphers:
15425 type: string
15426 clientCertAuth:
15427 type: boolean
15428 insecure:
15429 type: boolean
15430 privateKeyPassphrase:
15431 type: string
15432 privateKeyPath:
15433 type: string
15434 version:
15435 type: string
15436 user:
15437 type: object
15438 description: The security section of user plugin
15439 properties:
15440 password:
15441 type: object
15442 description: Secret defines the key of a value.
15443 properties:
15444 valueFrom:
15445 type: object
15446 description: ValueSource defines how to find a value's key.
15447 properties:
15448 secretKeyRef:
15449 type: object
15450 description: Selects a key of a secret in the pod's namespace
15451 properties:
15452 name:
15453 type: string
15454 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
15455 key:
15456 type: string
15457 description: The key of the secret to select from. Must be a valid secret key.
15458 optional:
15459 type: boolean
15460 description: Specify whether the Secret or its key must be defined
15461 required:
15462 - key
15463 x-kubernetes-map-type: atomic
15464 username:
15465 type: object
15466 description: Secret defines the key of a value.
15467 properties:
15468 valueFrom:
15469 type: object
15470 description: ValueSource defines how to find a value's key.
15471 properties:
15472 secretKeyRef:
15473 type: object
15474 description: Selects a key of a secret in the pod's namespace
15475 properties:
15476 name:
15477 type: string
15478 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
15479 key:
15480 type: string
15481 description: The key of the secret to select from. Must be a valid secret key.
15482 optional:
15483 type: boolean
15484 description: Specify whether the Secret or its key must be defined
15485 required:
15486 - key
15487 x-kubernetes-map-type: atomic
15488 http:
15489 type: object
15490 description: in_http plugin
15491 properties:
15492 port:
15493 type: integer
15494 description: The port to listen to, default is 9880.
15495 format: int32
15496 maximum: 65535
15497 minimum: 1
15498 addHttpHeaders:
15499 type: boolean
15500 description: Adds HTTP_ prefix headers to the record.
15501 addRemoteAddr:
15502 type: string
15503 description: 'Adds REMOTE_ADDR field to the record. The value of REMOTE_ADDR is the client''s address. i.e: X-Forwarded-For: host1, host2'
15504 bind:
15505 type: string
15506 description: The port to listen to, default is "0.0.0.0"
15507 bodySizeLimit:
15508 type: string
15509 description: The size limit of the POSTed element.
15510 pattern: ^\d+(KB|MB|GB|TB)$
15511 corsAllOrigins:
15512 type: string
15513 description: Whitelist domains for CORS.
15514 corsAllowCredentials:
15515 type: string
15516 description: Add Access-Control-Allow-Credentials header. It's needed when a request's credentials mode is include
15517 keepaliveTimeout:
15518 type: string
15519 description: The timeout limit for keeping the connection alive.
15520 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
15521 parse:
15522 type: object
15523 description: The parse section of http plugin
15524 properties:
15525 type:
15526 type: string
15527 description: The @type parameter specifies the type of the plugin.
15528 enum:
15529 - regexp
15530 - apache2
15531 - apache_error
15532 - nginx
15533 - syslog
15534 - csv
15535 - tsv
15536 - ltsv
15537 - json
15538 - multiline
15539 - none
15540 estimateCurrentEvent:
15541 type: boolean
15542 description: If true, use Fluent::Eventnow(current time) as a timestamp when time_key is specified.
15543 expression:
15544 type: string
15545 description: Specifies the regular expression for matching logs. Regular expression also supports i and m suffix.
15546 id:
15547 type: string
15548 description: The @id parameter specifies a unique name for the configuration.
15549 keepTimeKey:
15550 type: boolean
15551 description: If true, keep time field in th record.
15552 localtime:
15553 type: boolean
15554 description: If true, uses local time.
15555 logLevel:
15556 type: string
15557 description: The @log_level parameter specifies the plugin-specific logging level
15558 timeFormat:
15559 type: string
15560 description: Process value according to the specified format. This is available only when time_type is string
15561 timeFormatFallbacks:
15562 type: string
15563 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
15564 timeKey:
15565 type: string
15566 description: Specify time field for event time. If the event doesn't have this field, current time is used.
15567 timeType:
15568 type: string
15569 description: parses/formats value according to this type, default is string
15570 enum:
15571 - float
15572 - unixtime
15573 - string
15574 - mixed
15575 timeout:
15576 type: string
15577 description: Specify timeout for parse processing.
15578 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
15579 timezone:
15580 type: string
15581 description: Uses the specified timezone.
15582 types:
15583 type: string
15584 description: 'Specify types for converting field into another, i.e: types user_id:integer,paid:bool,paid_usd_amount:float'
15585 utc:
15586 type: boolean
15587 description: If true, uses UTC.
15588 required:
15589 - type
15590 respondsWithEmptyImg:
15591 type: boolean
15592 description: Responds with an empty GIF image of 1x1 pixel (rather than an empty string).
15593 transport:
15594 type: object
15595 description: The transport section of http plugin
15596 properties:
15597 protocol:
15598 type: string
15599 description: 'The protocal name of this plugin, i.e: tls'
15600 caCertPath:
15601 type: string
15602 description: for Cert generated
15603 caPath:
15604 type: string
15605 description: for Cert signed by public CA
15606 caPrivateKeyPassphrase:
15607 type: string
15608 caPrivateKeyPath:
15609 type: string
15610 certPath:
15611 type: string
15612 certVerifier:
15613 type: string
15614 description: other parameters
15615 ciphers:
15616 type: string
15617 clientCertAuth:
15618 type: boolean
15619 insecure:
15620 type: boolean
15621 privateKeyPassphrase:
15622 type: string
15623 privateKeyPath:
15624 type: string
15625 version:
15626 type: string
15627 id:
15628 type: string
15629 description: The @id parameter specifies a unique name for the configuration.
15630 label:
15631 type: string
15632 description: The @label parameter is to route the input events to <label> sections.
15633 logLevel:
15634 type: string
15635 description: The @log_level parameter specifies the plugin-specific logging level
15636 tail:
15637 type: object
15638 description: in_tail plugin
15639 properties:
15640 emitUnmatchedLines:
15641 type: boolean
15642 description: Emits unmatched lines when <parse> format is not matched for incoming logs.
15643 enableStatWatcher:
15644 type: boolean
15645 description: Enables the additional inotify-based watcher. Setting this parameter to false will disable the inotify events and use only timer watcher for file tailing. This option is mainly for avoiding the stuck issue with inotify.
15646 enableWatchTimer:
15647 type: boolean
15648 description: Enables the additional watch timer. Setting this parameter to false will significantly reduce CPU and I/O consumption when tailing a large number of files on systems with inotify support. The default is true which results in an additional 1 second timer being used.
15649 encoding:
15650 type: string
15651 description: Specifies the encoding of reading lines. By default, in_tail emits string value as ASCII-8BIT encoding. If encoding is specified, in_tail changes string to encoding. If encoding and fromEncoding both are specified, in_tail tries to encode string from fromEncoding to encoding.
15652 excludePath:
15653 type: array
15654 description: The paths excluded from the watcher list.
15655 items:
15656 type: string
15657 followInodes:
15658 type: boolean
15659 description: Avoid to read rotated files duplicately. You should set true when you use * or strftime format in path.
15660 fromEncoding:
15661 type: string
15662 description: Specifies the encoding of reading lines. By default, in_tail emits string value as ASCII-8BIT encoding. If encoding is specified, in_tail changes string to encoding. If encoding and fromEncoding both are specified, in_tail tries to encode string from fromEncoding to encoding.
15663 group:
15664 type: object
15665 description: The in_tail plugin can assign each log file to a group, based on user defined rules. The limit parameter controls the total number of lines collected for a group within a rate_period time interval.
15666 properties:
15667 pattern:
15668 type: string
15669 description: Specifies the regular expression for extracting metadata (namespace, podname) from log file path. Default value of the pattern regexp extracts information about namespace, podname, docker_id, container of the log (K8s specific).
15670 ratePeriod:
15671 type: integer
15672 description: Time period in which the group line limit is applied. in_tail resets the counter after every rate_period interval.
15673 format: int32
15674 rule:
15675 type: object
15676 description: Grouping rules for log files.
15677 properties:
15678 limit:
15679 type: integer
15680 description: Maximum number of lines allowed from a group in rate_period time interval. The default value of -1 doesn't throttle log files of that group.
15681 format: int32
15682 match:
15683 type: object
15684 additionalProperties:
15685 type: string
15686 description: match parameter is used to check if a file belongs to a particular group based on hash keys (named captures from pattern) and hash values (regexp in string)
15687 required:
15688 - rule
15689 ignoreRepeatedPermissionError:
15690 type: boolean
15691 description: If you have to exclude the non-permission files from the watch list, set this parameter to true. It suppresses the repeated permission error logs.
15692 limitRecentlyModified:
15693 type: integer
15694 description: Limits the watching files that the modification time is within the specified time range when using * in path.
15695 format: int32
15696 maxLineSize:
15697 type: integer
15698 description: The maximum length of a line. Longer lines than it will be just skipped.
15699 format: int32
15700 multilineFlushInterval:
15701 type: integer
15702 description: The interval of flushing the buffer for multiline format.
15703 format: int32
15704 openOnEveryUpdate:
15705 type: boolean
15706 description: Opens and closes the file on every update instead of leaving it open until it gets rotated.
15707 parse:
15708 type: object
15709 description: Parse defines various parameters for the parse plugin
15710 properties:
15711 type:
15712 type: string
15713 description: The @type parameter specifies the type of the plugin.
15714 enum:
15715 - regexp
15716 - apache2
15717 - apache_error
15718 - nginx
15719 - syslog
15720 - csv
15721 - tsv
15722 - ltsv
15723 - json
15724 - multiline
15725 - none
15726 estimateCurrentEvent:
15727 type: boolean
15728 description: If true, use Fluent::Eventnow(current time) as a timestamp when time_key is specified.
15729 expression:
15730 type: string
15731 description: Specifies the regular expression for matching logs. Regular expression also supports i and m suffix.
15732 id:
15733 type: string
15734 description: The @id parameter specifies a unique name for the configuration.
15735 keepTimeKey:
15736 type: boolean
15737 description: If true, keep time field in th record.
15738 localtime:
15739 type: boolean
15740 description: If true, uses local time.
15741 logLevel:
15742 type: string
15743 description: The @log_level parameter specifies the plugin-specific logging level
15744 timeFormat:
15745 type: string
15746 description: Process value according to the specified format. This is available only when time_type is string
15747 timeFormatFallbacks:
15748 type: string
15749 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
15750 timeKey:
15751 type: string
15752 description: Specify time field for event time. If the event doesn't have this field, current time is used.
15753 timeType:
15754 type: string
15755 description: parses/formats value according to this type, default is string
15756 enum:
15757 - float
15758 - unixtime
15759 - string
15760 - mixed
15761 timeout:
15762 type: string
15763 description: Specify timeout for parse processing.
15764 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
15765 timezone:
15766 type: string
15767 description: Uses the specified timezone.
15768 types:
15769 type: string
15770 description: 'Specify types for converting field into another, i.e: types user_id:integer,paid:bool,paid_usd_amount:float'
15771 utc:
15772 type: boolean
15773 description: If true, uses UTC.
15774 required:
15775 - type
15776 path:
15777 type: string
15778 description: The path(s) to read. Multiple paths can be specified, separated by comma ','.
15779 pathKey:
15780 type: string
15781 description: Adds the watching file path to the path_key field.
15782 pathTimezone:
15783 type: string
15784 description: This parameter is for strftime formatted path like /path/to/%Y/%m/%d/.
15785 posFile:
15786 type: string
15787 description: (recommended) Fluentd will record the position it last read from this file. pos_file handles multiple positions in one file so no need to have multiple pos_file parameters per source. Don't share pos_file between in_tail configurations. It causes unexpected behavior e.g. corrupt pos_file content.
15788 posFileCompactionInterval:
15789 type: integer
15790 description: The interval of doing compaction of pos file.
15791 format: int32
15792 readBytesLimitPerSecond:
15793 type: integer
15794 description: The number of reading bytes per second to read with I/O operation. This value should be equal or greater than 8192.
15795 format: int32
15796 readFromHead:
15797 type: boolean
15798 description: Starts to read the logs from the head of the file or the last read position recorded in pos_file, not tail.
15799 readLinesLimit:
15800 type: integer
15801 description: The number of lines to read with each I/O operation.
15802 format: int32
15803 refreshInterval:
15804 type: integer
15805 description: The interval to refresh the list of watch files. This is used when the path includes *.
15806 format: int32
15807 rotateWait:
15808 type: integer
15809 description: in_tail actually does a bit more than tail -F itself. When rotating a file, some data may still need to be written to the old file as opposed to the new one. in_tail takes care of this by keeping a reference to the old file (even after it has been rotated) for some time before transitioning completely to the new file. This helps prevent data designated for the old file from getting lost. By default, this time interval is 5 seconds. The rotate_wait parameter accepts a single integer representing the number of seconds you want this time interval to be.
15810 format: int32
15811 skipRefreshOnStartup:
15812 type: boolean
15813 description: Skips the refresh of the watch list on startup. This reduces the startup time when * is used in path.
15814 tag:
15815 type: string
15816 description: The tag of the event.
15817 required:
15818 - parse
15819 - path
15820 - tag
15821 logLevel:
15822 type: string
15823 default: info
15824 description: Global logging verbosity
15825 enum:
15826 - fatal
15827 - error
15828 - warn
15829 - info
15830 - debug
15831 - trace
15832 rbacRules:
15833 type: array
15834 description: RBACRules represents additional rbac rules which will be applied to the fluentd clusterrole.
15835 items:
15836 type: object
15837 description: PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
15838 properties:
15839 resources:
15840 type: array
15841 description: Resources is a list of resources this rule applies to. '*' represents all resources.
15842 items:
15843 type: string
15844 apiGroups:
15845 type: array
15846 description: APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
15847 items:
15848 type: string
15849 nonResourceURLs:
15850 type: array
15851 description: NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
15852 items:
15853 type: string
15854 resourceNames:
15855 type: array
15856 description: ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
15857 items:
15858 type: string
15859 verbs:
15860 type: array
15861 description: Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.
15862 items:
15863 type: string
15864 required:
15865 - verbs
15866 serviceAccountAnnotations:
15867 type: object
15868 additionalProperties:
15869 type: string
15870 description: Annotations to add to the Fluentd service account
15871 workers:
15872 type: integer
15873 description: Numbers of the workers in Fluentd instance
15874 format: int32
15875 status:
15876 type: object
15877 description: FluentdStatus defines the observed state of Fluentd
15878 properties:
15879 messages:
15880 type: string
15881 description: Messages defines the plugin errors which is selected by this fluentdconfig
15882 state:
15883 type: string
15884 description: The state of this fluentd
15885 served: true
15886 storage: true
15887 subresources:
15888 status: {}
15889---
15890apiVersion: apiextensions.k8s.io/v1
15891kind: CustomResourceDefinition
15892metadata:
15893 name: outputs.fluentbit.fluent.io
15894 annotations:
15895 controller-gen.kubebuilder.io/version: v0.11.3
15896 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
15897 pallet.edge.ncr.com/name: fluent-operator
15898 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
15899 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
15900 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
15901 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
15902spec:
15903 group: fluentbit.fluent.io
15904 names:
15905 kind: Output
15906 listKind: OutputList
15907 plural: outputs
15908 shortNames:
15909 - fbo
15910 singular: output
15911 scope: Namespaced
15912 versions:
15913 - name: v1alpha2
15914 schema:
15915 openAPIV3Schema:
15916 type: object
15917 description: Output is the schema for namespace level output API
15918 properties:
15919 apiVersion:
15920 type: string
15921 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'
15922 kind:
15923 type: string
15924 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'
15925 metadata:
15926 type: object
15927 spec:
15928 type: object
15929 description: OutputSpec defines the desired state of ClusterOutput
15930 properties:
15931 alias:
15932 type: string
15933 description: A user friendly alias name for this output plugin. Used in metrics for distinction of each configured output.
15934 azureBlob:
15935 type: object
15936 description: AzureBlob defines AzureBlob Output Configuration
15937 properties:
15938 accountName:
15939 type: string
15940 description: Azure Storage account name
15941 autoCreateContainer:
15942 type: boolean
15943 description: Creates container if ContainerName is not set.
15944 blobType:
15945 type: string
15946 description: Specify the desired blob type. Must be `appendblob` or `blockblob`
15947 containerName:
15948 type: string
15949 description: Name of the container that will contain the blobs
15950 emulatorMode:
15951 type: boolean
15952 description: Optional toggle to use an Azure emulator
15953 endpoint:
15954 type: string
15955 description: HTTP Service of the endpoint (if using EmulatorMode)
15956 path:
15957 type: string
15958 description: Optional path to store the blobs.
15959 sharedKey:
15960 type: object
15961 description: Specify the Azure Storage Shared Key to authenticate against the storage account
15962 properties:
15963 valueFrom:
15964 type: object
15965 description: ValueSource defines how to find a value's key.
15966 properties:
15967 secretKeyRef:
15968 type: object
15969 description: Selects a key of a secret in the pod's namespace
15970 properties:
15971 name:
15972 type: string
15973 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
15974 key:
15975 type: string
15976 description: The key of the secret to select from. Must be a valid secret key.
15977 optional:
15978 type: boolean
15979 description: Specify whether the Secret or its key must be defined
15980 required:
15981 - key
15982 x-kubernetes-map-type: atomic
15983 tls:
15984 type: boolean
15985 description: Enable/Disable TLS Encryption. Azure services require TLS to be enabled.
15986 required:
15987 - accountName
15988 - containerName
15989 - sharedKey
15990 azureLogAnalytics:
15991 type: object
15992 description: AzureLogAnalytics defines AzureLogAnalytics Output Configuration
15993 properties:
15994 customerID:
15995 type: object
15996 description: Customer ID or Workspace ID
15997 properties:
15998 valueFrom:
15999 type: object
16000 description: ValueSource defines how to find a value's key.
16001 properties:
16002 secretKeyRef:
16003 type: object
16004 description: Selects a key of a secret in the pod's namespace
16005 properties:
16006 name:
16007 type: string
16008 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16009 key:
16010 type: string
16011 description: The key of the secret to select from. Must be a valid secret key.
16012 optional:
16013 type: boolean
16014 description: Specify whether the Secret or its key must be defined
16015 required:
16016 - key
16017 x-kubernetes-map-type: atomic
16018 logType:
16019 type: string
16020 description: Name of the event type.
16021 sharedKey:
16022 type: object
16023 description: Specify the primary or the secondary client authentication key
16024 properties:
16025 valueFrom:
16026 type: object
16027 description: ValueSource defines how to find a value's key.
16028 properties:
16029 secretKeyRef:
16030 type: object
16031 description: Selects a key of a secret in the pod's namespace
16032 properties:
16033 name:
16034 type: string
16035 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16036 key:
16037 type: string
16038 description: The key of the secret to select from. Must be a valid secret key.
16039 optional:
16040 type: boolean
16041 description: Specify whether the Secret or its key must be defined
16042 required:
16043 - key
16044 x-kubernetes-map-type: atomic
16045 timeGenerated:
16046 type: boolean
16047 description: If set, overrides the timeKey value with the `time-generated-field` HTTP header value.
16048 timeKey:
16049 type: string
16050 description: Specify the name of the key where the timestamp is stored.
16051 required:
16052 - customerID
16053 - sharedKey
16054 cloudWatch:
16055 type: object
16056 description: CloudWatch defines CloudWatch Output Configuration
16057 properties:
16058 autoCreateGroup:
16059 type: boolean
16060 description: Automatically create the log group. Defaults to False.
16061 autoRetryRequests:
16062 type: boolean
16063 description: Automatically retry failed requests to CloudWatch once. Defaults to True.
16064 endpoint:
16065 type: string
16066 description: Custom endpoint for CloudWatch logs API
16067 externalID:
16068 type: string
16069 description: Specify an external ID for the STS API.
16070 logFormat:
16071 type: string
16072 description: Optional parameter to tell CloudWatch the format of the data
16073 logGroupName:
16074 type: string
16075 description: Name of Cloudwatch Log Group to send log records to
16076 logGroupTemplate:
16077 type: string
16078 description: Template for Log Group name, overrides LogGroupName if set.
16079 logKey:
16080 type: string
16081 description: If set, only the value of the key will be sent to CloudWatch
16082 logRetentionDays:
16083 type: integer
16084 description: Number of days logs are retained for
16085 enum:
16086 - 1
16087 - 3
16088 - 5
16089 - 7
16090 - 14
16091 - 30
16092 - 60
16093 - 90
16094 - 120
16095 - 150
16096 - 180
16097 - 365
16098 - 400
16099 - 545
16100 - 731
16101 - 1827
16102 - 3653
16103 format: int32
16104 logStreamName:
16105 type: string
16106 description: The name of the CloudWatch Log Stream to send log records to
16107 logStreamPrefix:
16108 type: string
16109 description: Prefix for the Log Stream name. Not compatible with LogStreamName setting
16110 logStreamTemplate:
16111 type: string
16112 description: Template for Log Stream name. Overrides LogStreamPrefix and LogStreamName if set.
16113 metricDimensions:
16114 type: string
16115 description: Optional lists of lists for dimension keys to be added to all metrics. Use comma separated strings for one list of dimensions and semicolon separated strings for list of lists dimensions.
16116 metricNamespace:
16117 type: string
16118 description: Optional string to represent the CloudWatch namespace.
16119 region:
16120 type: string
16121 description: AWS Region
16122 roleArn:
16123 type: string
16124 description: Role ARN to use for cross-account access
16125 stsEndpoint:
16126 type: string
16127 description: Specify a custom STS endpoint for the AWS STS API
16128 required:
16129 - region
16130 customPlugin:
16131 type: object
16132 description: CustomPlugin defines Custom Output configuration.
16133 properties:
16134 config:
16135 type: string
16136 datadog:
16137 type: object
16138 description: DataDog defines DataDog Output configuration.
16139 properties:
16140 apikey:
16141 type: string
16142 description: Your Datadog API key.
16143 compress:
16144 type: string
16145 description: Compress the payload in GZIP format. Datadog supports and recommends setting this to gzip.
16146 dd_message_key:
16147 type: string
16148 description: By default, the plugin searches for the key 'log' and remap the value to the key 'message'. If the property is set, the plugin will search the property name key.
16149 dd_service:
16150 type: string
16151 description: The human readable name for your service generating the logs.
16152 dd_source:
16153 type: string
16154 description: A human readable name for the underlying technology of your service.
16155 dd_tags:
16156 type: string
16157 description: The tags you want to assign to your logs in Datadog.
16158 host:
16159 type: string
16160 description: Host is the Datadog server where you are sending your logs.
16161 include_tag_key:
16162 type: boolean
16163 description: If enabled, a tag is appended to output. The key name is used tag_key property.
16164 json_date_key:
16165 type: string
16166 description: Date key name for output.
16167 provider:
16168 type: string
16169 description: To activate the remapping, specify configuration flag provider.
16170 proxy:
16171 type: string
16172 description: Specify an HTTP Proxy.
16173 tag_key:
16174 type: string
16175 description: The key name of tag. If include_tag_key is false, This property is ignored.
16176 tls:
16177 type: boolean
16178 description: TLS controls whether to use end-to-end security communications security protocol. Datadog recommends setting this to on.
16179 es:
16180 type: object
16181 description: Elasticsearch defines Elasticsearch Output configuration.
16182 properties:
16183 type:
16184 type: string
16185 description: Type name
16186 port:
16187 type: integer
16188 description: TCP port of the target Elasticsearch instance
16189 format: int32
16190 maximum: 65535
16191 minimum: 1
16192 awsAuth:
16193 type: string
16194 description: Enable AWS Sigv4 Authentication for Amazon ElasticSearch Service.
16195 awsExternalID:
16196 type: string
16197 description: External ID for the AWS IAM Role specified with aws_role_arn.
16198 awsRegion:
16199 type: string
16200 description: Specify the AWS region for Amazon ElasticSearch Service.
16201 awsRoleARN:
16202 type: string
16203 description: AWS IAM Role to assume to put records to your Amazon ES cluster.
16204 awsSTSEndpoint:
16205 type: string
16206 description: Specify the custom sts endpoint to be used with STS API for Amazon ElasticSearch Service.
16207 bufferSize:
16208 type: string
16209 description: Specify the buffer size used to read the response from the Elasticsearch HTTP service. This option is useful for debugging purposes where is required to read full responses, note that response size grows depending of the number of records inserted. To set an unlimited amount of memory set this value to False, otherwise the value must be according to the Unit Size specification.
16210 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
16211 cloudAuth:
16212 type: string
16213 description: Specify the credentials to use to connect to Elastic's Elasticsearch Service running on Elastic Cloud.
16214 cloudID:
16215 type: string
16216 description: If you are using Elastic's Elasticsearch Service you can specify the cloud_id of the cluster running.
16217 currentTimeIndex:
16218 type: boolean
16219 description: Use current time for index generation instead of message record
16220 generateID:
16221 type: boolean
16222 description: When enabled, generate _id for outgoing records. This prevents duplicate records when retrying ES.
16223 host:
16224 type: string
16225 description: IP address or hostname of the target Elasticsearch instance
16226 httpPassword:
16227 type: object
16228 description: Password for user defined in HTTP_User
16229 properties:
16230 valueFrom:
16231 type: object
16232 description: ValueSource defines how to find a value's key.
16233 properties:
16234 secretKeyRef:
16235 type: object
16236 description: Selects a key of a secret in the pod's namespace
16237 properties:
16238 name:
16239 type: string
16240 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16241 key:
16242 type: string
16243 description: The key of the secret to select from. Must be a valid secret key.
16244 optional:
16245 type: boolean
16246 description: Specify whether the Secret or its key must be defined
16247 required:
16248 - key
16249 x-kubernetes-map-type: atomic
16250 httpUser:
16251 type: object
16252 description: Optional username credential for Elastic X-Pack access
16253 properties:
16254 valueFrom:
16255 type: object
16256 description: ValueSource defines how to find a value's key.
16257 properties:
16258 secretKeyRef:
16259 type: object
16260 description: Selects a key of a secret in the pod's namespace
16261 properties:
16262 name:
16263 type: string
16264 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16265 key:
16266 type: string
16267 description: The key of the secret to select from. Must be a valid secret key.
16268 optional:
16269 type: boolean
16270 description: Specify whether the Secret or its key must be defined
16271 required:
16272 - key
16273 x-kubernetes-map-type: atomic
16274 idKey:
16275 type: string
16276 description: If set, _id will be the value of the key from incoming record and Generate_ID option is ignored.
16277 includeTagKey:
16278 type: boolean
16279 description: When enabled, it append the Tag name to the record.
16280 index:
16281 type: string
16282 description: Index name
16283 logstashDateFormat:
16284 type: string
16285 description: Time format (based on strftime) to generate the second part of the Index name.
16286 logstashFormat:
16287 type: boolean
16288 description: 'Enable Logstash format compatibility. This option takes a boolean value: True/False, On/Off'
16289 logstashPrefix:
16290 type: string
16291 description: 'When Logstash_Format is enabled, the Index name is composed using a prefix and the date, e.g: If Logstash_Prefix is equals to ''mydata'' your index will become ''mydata-YYYY.MM.DD''. The last string appended belongs to the date when the data is being generated.'
16292 logstashPrefixKey:
16293 type: string
16294 description: Prefix keys with this string
16295 path:
16296 type: string
16297 description: Elasticsearch accepts new data on HTTP query path "/_bulk". But it is also possible to serve Elasticsearch behind a reverse proxy on a subpath. This option defines such path on the fluent-bit side. It simply adds a path prefix in the indexing HTTP POST URI.
16298 pipeline:
16299 type: string
16300 description: Newer versions of Elasticsearch allows setting up filters called pipelines. This option allows defining which pipeline the database should use. For performance reasons is strongly suggested parsing and filtering on Fluent Bit side, avoid pipelines.
16301 replaceDots:
16302 type: boolean
16303 description: When enabled, replace field name dots with underscore, required by Elasticsearch 2.0-2.3.
16304 suppressTypeName:
16305 type: string
16306 description: When enabled, mapping types is removed and Type option is ignored. Types are deprecated in APIs in v7.0. This options is for v7.0 or later.
16307 tagKey:
16308 type: string
16309 description: When Include_Tag_Key is enabled, this property defines the key name for the tag.
16310 timeKey:
16311 type: string
16312 description: When Logstash_Format is enabled, each record will get a new timestamp field. The Time_Key property defines the name of that field.
16313 timeKeyFormat:
16314 type: string
16315 description: When Logstash_Format is enabled, this property defines the format of the timestamp.
16316 timeKeyNanos:
16317 type: boolean
16318 description: When Logstash_Format is enabled, enabling this property sends nanosecond precision timestamps.
16319 tls:
16320 type: object
16321 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
16322 properties:
16323 caFile:
16324 type: string
16325 description: Absolute path to CA certificate file
16326 caPath:
16327 type: string
16328 description: Absolute path to scan for certificate files
16329 crtFile:
16330 type: string
16331 description: Absolute path to Certificate file
16332 debug:
16333 type: integer
16334 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
16335 enum:
16336 - 0
16337 - 1
16338 - 2
16339 - 3
16340 - 4
16341 format: int32
16342 keyFile:
16343 type: string
16344 description: Absolute path to private Key file
16345 keyPassword:
16346 type: object
16347 description: Optional password for tls.key_file file
16348 properties:
16349 valueFrom:
16350 type: object
16351 description: ValueSource defines how to find a value's key.
16352 properties:
16353 secretKeyRef:
16354 type: object
16355 description: Selects a key of a secret in the pod's namespace
16356 properties:
16357 name:
16358 type: string
16359 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16360 key:
16361 type: string
16362 description: The key of the secret to select from. Must be a valid secret key.
16363 optional:
16364 type: boolean
16365 description: Specify whether the Secret or its key must be defined
16366 required:
16367 - key
16368 x-kubernetes-map-type: atomic
16369 verify:
16370 type: boolean
16371 description: Force certificate validation
16372 vhost:
16373 type: string
16374 description: Hostname to be used for TLS SNI extension
16375 traceError:
16376 type: boolean
16377 description: When enabled print the elasticsearch API calls to stdout when elasticsearch returns an error
16378 traceOutput:
16379 type: boolean
16380 description: When enabled print the elasticsearch API calls to stdout (for diag only)
16381 file:
16382 type: object
16383 description: File defines File Output configuration.
16384 properties:
16385 template:
16386 type: string
16387 description: The format string. Applicable only if format is template.
16388 delimiter:
16389 type: string
16390 description: The character to separate each pair. Applicable only if format is csv or ltsv.
16391 file:
16392 type: string
16393 description: Set file name to store the records. If not set, the file name will be the tag associated with the records.
16394 format:
16395 type: string
16396 description: 'The format of the file content. See also Format section. Default: out_file.'
16397 enum:
16398 - out_file
16399 - plain
16400 - csv
16401 - ltsv
16402 - template
16403 labelDelimiter:
16404 type: string
16405 description: The character to separate each pair. Applicable only if format is ltsv.
16406 path:
16407 type: string
16408 description: Absolute directory path to store files. If not set, Fluent Bit will write the files on it's own positioned directory.
16409 firehose:
16410 type: object
16411 description: Firehose defines Firehose Output configuration.
16412 properties:
16413 autoRetryRequests:
16414 type: boolean
16415 description: Immediately retry failed requests to AWS services once. This option does not affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which may help improve throughput when there are transient/random networking issues.
16416 dataKeys:
16417 type: string
16418 description: By default, the whole log record will be sent to Kinesis. If you specify a key name(s) with this option, then only those keys and values will be sent to Kinesis. For example, if you are using the Fluentd Docker log driver, you can specify data_keys log and only the log message will be sent to Kinesis. If you specify multiple keys, they should be comma delimited.
16419 deliveryStream:
16420 type: string
16421 description: The name of the Kinesis Firehose Delivery stream that you want log records sent to.
16422 endpoint:
16423 type: string
16424 description: Specify a custom endpoint for the Kinesis Firehose API.
16425 logKey:
16426 type: string
16427 description: By default, the whole log record will be sent to Firehose. If you specify a key name with this option, then only the value of that key will be sent to Firehose. For example, if you are using the Fluentd Docker log driver, you can specify log_key log and only the log message will be sent to Firehose.
16428 region:
16429 type: string
16430 description: The AWS region.
16431 roleARN:
16432 type: string
16433 description: ARN of an IAM role to assume (for cross account access).
16434 stsEndpoint:
16435 type: string
16436 description: Specify a custom endpoint for the STS API; used to assume your custom role provided with role_arn.
16437 timeKey:
16438 type: string
16439 description: Add the timestamp to the record under this key. By default, the timestamp from Fluent Bit will not be added to records sent to Kinesis.
16440 timeKeyFormat:
16441 type: string
16442 description: strftime compliant format string for the timestamp; for example, %Y-%m-%dT%H *string This option is used with time_key. You can also use %L for milliseconds and %f for microseconds. If you are using ECS FireLens, make sure you are running Amazon ECS Container Agent v1.42.0 or later, otherwise the timestamps associated with your container logs will only have second precision.
16443 required:
16444 - deliveryStream
16445 - region
16446 forward:
16447 type: object
16448 description: Forward defines Forward Output configuration.
16449 properties:
16450 port:
16451 type: integer
16452 description: TCP Port of the target service.
16453 format: int32
16454 maximum: 65535
16455 minimum: 1
16456 emptySharedKey:
16457 type: boolean
16458 description: Use this option to connect to Fluentd with a zero-length secret.
16459 host:
16460 type: string
16461 description: Target host where Fluent-Bit or Fluentd are listening for Forward messages.
16462 password:
16463 type: object
16464 description: Specify the password corresponding to the username.
16465 properties:
16466 valueFrom:
16467 type: object
16468 description: ValueSource defines how to find a value's key.
16469 properties:
16470 secretKeyRef:
16471 type: object
16472 description: Selects a key of a secret in the pod's namespace
16473 properties:
16474 name:
16475 type: string
16476 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16477 key:
16478 type: string
16479 description: The key of the secret to select from. Must be a valid secret key.
16480 optional:
16481 type: boolean
16482 description: Specify whether the Secret or its key must be defined
16483 required:
16484 - key
16485 x-kubernetes-map-type: atomic
16486 requireAckResponse:
16487 type: boolean
16488 description: Send "chunk"-option and wait for "ack" response from server. Enables at-least-once and receiving server can control rate of traffic. (Requires Fluentd v0.14.0+ server)
16489 selfHostname:
16490 type: string
16491 description: Default value of the auto-generated certificate common name (CN).
16492 sendOptions:
16493 type: boolean
16494 description: Always send options (with "size"=count of messages)
16495 sharedKey:
16496 type: string
16497 description: A key string known by the remote Fluentd used for authorization.
16498 timeAsInteger:
16499 type: boolean
16500 description: Set timestamps in integer format, it enable compatibility mode for Fluentd v0.12 series.
16501 tls:
16502 type: object
16503 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
16504 properties:
16505 caFile:
16506 type: string
16507 description: Absolute path to CA certificate file
16508 caPath:
16509 type: string
16510 description: Absolute path to scan for certificate files
16511 crtFile:
16512 type: string
16513 description: Absolute path to Certificate file
16514 debug:
16515 type: integer
16516 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
16517 enum:
16518 - 0
16519 - 1
16520 - 2
16521 - 3
16522 - 4
16523 format: int32
16524 keyFile:
16525 type: string
16526 description: Absolute path to private Key file
16527 keyPassword:
16528 type: object
16529 description: Optional password for tls.key_file file
16530 properties:
16531 valueFrom:
16532 type: object
16533 description: ValueSource defines how to find a value's key.
16534 properties:
16535 secretKeyRef:
16536 type: object
16537 description: Selects a key of a secret in the pod's namespace
16538 properties:
16539 name:
16540 type: string
16541 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16542 key:
16543 type: string
16544 description: The key of the secret to select from. Must be a valid secret key.
16545 optional:
16546 type: boolean
16547 description: Specify whether the Secret or its key must be defined
16548 required:
16549 - key
16550 x-kubernetes-map-type: atomic
16551 verify:
16552 type: boolean
16553 description: Force certificate validation
16554 vhost:
16555 type: string
16556 description: Hostname to be used for TLS SNI extension
16557 username:
16558 type: object
16559 description: Specify the username to present to a Fluentd server that enables user_auth.
16560 properties:
16561 valueFrom:
16562 type: object
16563 description: ValueSource defines how to find a value's key.
16564 properties:
16565 secretKeyRef:
16566 type: object
16567 description: Selects a key of a secret in the pod's namespace
16568 properties:
16569 name:
16570 type: string
16571 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16572 key:
16573 type: string
16574 description: The key of the secret to select from. Must be a valid secret key.
16575 optional:
16576 type: boolean
16577 description: Specify whether the Secret or its key must be defined
16578 required:
16579 - key
16580 x-kubernetes-map-type: atomic
16581 http:
16582 type: object
16583 description: HTTP defines HTTP Output configuration.
16584 properties:
16585 port:
16586 type: integer
16587 description: TCP port of the target HTTP Server
16588 format: int32
16589 maximum: 65535
16590 minimum: 1
16591 allowDuplicatedHeaders:
16592 type: boolean
16593 description: Specify if duplicated headers are allowed. If a duplicated header is found, the latest key/value set is preserved.
16594 compress:
16595 type: string
16596 description: Set payload compression mechanism. Option available is 'gzip'
16597 format:
16598 type: string
16599 description: Specify the data format to be used in the HTTP request body, by default it uses msgpack. Other supported formats are json, json_stream and json_lines and gelf.
16600 enum:
16601 - msgpack
16602 - json
16603 - json_stream
16604 - json_lines
16605 - gelf
16606 gelfFullMessageKey:
16607 type: string
16608 description: Specify the key to use for the full message in gelf format
16609 gelfHostKey:
16610 type: string
16611 description: Specify the key to use for the host in gelf format
16612 gelfLevelKey:
16613 type: string
16614 description: Specify the key to use for the level in gelf format
16615 gelfShortMessageKey:
16616 type: string
16617 description: Specify the key to use as the short message in gelf format
16618 gelfTimestampKey:
16619 type: string
16620 description: Specify the key to use for timestamp in gelf format
16621 headerTag:
16622 type: string
16623 description: Specify an optional HTTP header field for the original message tag.
16624 headers:
16625 type: object
16626 additionalProperties:
16627 type: string
16628 description: Add a HTTP header key/value pair. Multiple headers can be set.
16629 host:
16630 type: string
16631 description: IP address or hostname of the target HTTP Server
16632 httpPassword:
16633 type: object
16634 description: Basic Auth Password. Requires HTTP_User to be set
16635 properties:
16636 valueFrom:
16637 type: object
16638 description: ValueSource defines how to find a value's key.
16639 properties:
16640 secretKeyRef:
16641 type: object
16642 description: Selects a key of a secret in the pod's namespace
16643 properties:
16644 name:
16645 type: string
16646 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16647 key:
16648 type: string
16649 description: The key of the secret to select from. Must be a valid secret key.
16650 optional:
16651 type: boolean
16652 description: Specify whether the Secret or its key must be defined
16653 required:
16654 - key
16655 x-kubernetes-map-type: atomic
16656 httpUser:
16657 type: object
16658 description: Basic Auth Username
16659 properties:
16660 valueFrom:
16661 type: object
16662 description: ValueSource defines how to find a value's key.
16663 properties:
16664 secretKeyRef:
16665 type: object
16666 description: Selects a key of a secret in the pod's namespace
16667 properties:
16668 name:
16669 type: string
16670 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16671 key:
16672 type: string
16673 description: The key of the secret to select from. Must be a valid secret key.
16674 optional:
16675 type: boolean
16676 description: Specify whether the Secret or its key must be defined
16677 required:
16678 - key
16679 x-kubernetes-map-type: atomic
16680 jsonDateFormat:
16681 type: string
16682 description: 'Specify the format of the date. Supported formats are double, epoch and iso8601 (eg: 2018-05-30T09:39:52.000681Z)'
16683 jsonDateKey:
16684 type: string
16685 description: Specify the name of the time key in the output record. To disable the time key just set the value to false.
16686 proxy:
16687 type: string
16688 description: Specify an HTTP Proxy. The expected format of this value is http://host:port. Note that https is not supported yet.
16689 tls:
16690 type: object
16691 description: HTTP output plugin supports TTL/SSL, for more details about the properties available and general configuration, please refer to the TLS/SSL section.
16692 properties:
16693 caFile:
16694 type: string
16695 description: Absolute path to CA certificate file
16696 caPath:
16697 type: string
16698 description: Absolute path to scan for certificate files
16699 crtFile:
16700 type: string
16701 description: Absolute path to Certificate file
16702 debug:
16703 type: integer
16704 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
16705 enum:
16706 - 0
16707 - 1
16708 - 2
16709 - 3
16710 - 4
16711 format: int32
16712 keyFile:
16713 type: string
16714 description: Absolute path to private Key file
16715 keyPassword:
16716 type: object
16717 description: Optional password for tls.key_file file
16718 properties:
16719 valueFrom:
16720 type: object
16721 description: ValueSource defines how to find a value's key.
16722 properties:
16723 secretKeyRef:
16724 type: object
16725 description: Selects a key of a secret in the pod's namespace
16726 properties:
16727 name:
16728 type: string
16729 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16730 key:
16731 type: string
16732 description: The key of the secret to select from. Must be a valid secret key.
16733 optional:
16734 type: boolean
16735 description: Specify whether the Secret or its key must be defined
16736 required:
16737 - key
16738 x-kubernetes-map-type: atomic
16739 verify:
16740 type: boolean
16741 description: Force certificate validation
16742 vhost:
16743 type: string
16744 description: Hostname to be used for TLS SNI extension
16745 uri:
16746 type: string
16747 description: 'Specify an optional HTTP URI for the target web server, e.g: /something'
16748 influxDB:
16749 type: object
16750 description: InfluxDB defines InfluxDB Output configuration.
16751 properties:
16752 port:
16753 type: integer
16754 description: TCP port of the target InfluxDB service.
16755 format: int32
16756 maximum: 65536
16757 minimum: 0
16758 autoTags:
16759 type: boolean
16760 description: Automatically tag keys where value is string.
16761 bucket:
16762 type: string
16763 description: InfluxDB bucket name where records will be inserted - if specified, database is ignored and v2 of API is used
16764 database:
16765 type: string
16766 description: InfluxDB database name where records will be inserted.
16767 host:
16768 type: string
16769 description: IP address or hostname of the target InfluxDB service.
16770 format: ipv6
16771 httpPassword:
16772 type: object
16773 description: Password for user defined in HTTP_User
16774 properties:
16775 valueFrom:
16776 type: object
16777 description: ValueSource defines how to find a value's key.
16778 properties:
16779 secretKeyRef:
16780 type: object
16781 description: Selects a key of a secret in the pod's namespace
16782 properties:
16783 name:
16784 type: string
16785 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16786 key:
16787 type: string
16788 description: The key of the secret to select from. Must be a valid secret key.
16789 optional:
16790 type: boolean
16791 description: Specify whether the Secret or its key must be defined
16792 required:
16793 - key
16794 x-kubernetes-map-type: atomic
16795 httpToken:
16796 type: object
16797 description: Authentication token used with InfluxDB v2 - if specified, both HTTPUser and HTTPPasswd are ignored
16798 properties:
16799 valueFrom:
16800 type: object
16801 description: ValueSource defines how to find a value's key.
16802 properties:
16803 secretKeyRef:
16804 type: object
16805 description: Selects a key of a secret in the pod's namespace
16806 properties:
16807 name:
16808 type: string
16809 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16810 key:
16811 type: string
16812 description: The key of the secret to select from. Must be a valid secret key.
16813 optional:
16814 type: boolean
16815 description: Specify whether the Secret or its key must be defined
16816 required:
16817 - key
16818 x-kubernetes-map-type: atomic
16819 httpUser:
16820 type: object
16821 description: Optional username for HTTP Basic Authentication
16822 properties:
16823 valueFrom:
16824 type: object
16825 description: ValueSource defines how to find a value's key.
16826 properties:
16827 secretKeyRef:
16828 type: object
16829 description: Selects a key of a secret in the pod's namespace
16830 properties:
16831 name:
16832 type: string
16833 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16834 key:
16835 type: string
16836 description: The key of the secret to select from. Must be a valid secret key.
16837 optional:
16838 type: boolean
16839 description: Specify whether the Secret or its key must be defined
16840 required:
16841 - key
16842 x-kubernetes-map-type: atomic
16843 org:
16844 type: string
16845 description: InfluxDB organization name where the bucket is (v2 only)
16846 sequenceTag:
16847 type: string
16848 description: The name of the tag whose value is incremented for the consecutive simultaneous events.
16849 tagKeys:
16850 type: array
16851 description: List of keys that needs to be tagged
16852 items:
16853 type: string
16854 tagListKey:
16855 type: string
16856 description: Key of the string array optionally contained within each log record that contains tag keys for that record
16857 tagsListEnabled:
16858 type: boolean
16859 description: Dynamically tag keys which are in the string array at Tags_List_Key key.
16860 tls:
16861 type: object
16862 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
16863 properties:
16864 caFile:
16865 type: string
16866 description: Absolute path to CA certificate file
16867 caPath:
16868 type: string
16869 description: Absolute path to scan for certificate files
16870 crtFile:
16871 type: string
16872 description: Absolute path to Certificate file
16873 debug:
16874 type: integer
16875 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
16876 enum:
16877 - 0
16878 - 1
16879 - 2
16880 - 3
16881 - 4
16882 format: int32
16883 keyFile:
16884 type: string
16885 description: Absolute path to private Key file
16886 keyPassword:
16887 type: object
16888 description: Optional password for tls.key_file file
16889 properties:
16890 valueFrom:
16891 type: object
16892 description: ValueSource defines how to find a value's key.
16893 properties:
16894 secretKeyRef:
16895 type: object
16896 description: Selects a key of a secret in the pod's namespace
16897 properties:
16898 name:
16899 type: string
16900 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
16901 key:
16902 type: string
16903 description: The key of the secret to select from. Must be a valid secret key.
16904 optional:
16905 type: boolean
16906 description: Specify whether the Secret or its key must be defined
16907 required:
16908 - key
16909 x-kubernetes-map-type: atomic
16910 verify:
16911 type: boolean
16912 description: Force certificate validation
16913 vhost:
16914 type: string
16915 description: Hostname to be used for TLS SNI extension
16916 required:
16917 - host
16918 kafka:
16919 type: object
16920 description: Kafka defines Kafka Output configuration.
16921 properties:
16922 brokers:
16923 type: string
16924 description: 'Single of multiple list of Kafka Brokers, e.g: 192.168.1.3:9092, 192.168.1.4:9092.'
16925 dynamicTopic:
16926 type: boolean
16927 description: adds unknown topics (found in Topic_Key) to Topics. So in Topics only a default topic needs to be configured
16928 format:
16929 type: string
16930 description: 'Specify data format, options available: json, msgpack.'
16931 messageKey:
16932 type: string
16933 description: Optional key to store the message
16934 messageKeyField:
16935 type: string
16936 description: If set, the value of Message_Key_Field in the record will indicate the message key. If not set nor found in the record, Message_Key will be used (if set).
16937 queueFullRetries:
16938 type: integer
16939 description: Fluent Bit queues data into rdkafka library, if for some reason the underlying library cannot flush the records the queue might fills up blocking new addition of records. The queue_full_retries option set the number of local retries to enqueue the data. The default value is 10 times, the interval between each retry is 1 second. Setting the queue_full_retries value to 0 set's an unlimited number of retries.
16940 format: int64
16941 rdkafka:
16942 type: object
16943 additionalProperties:
16944 type: string
16945 description: '{property} can be any librdkafka properties'
16946 timestampFormat:
16947 type: string
16948 description: iso8601 or double
16949 timestampKey:
16950 type: string
16951 description: Set the key to store the record timestamp
16952 topicKey:
16953 type: string
16954 description: 'If multiple Topics exists, the value of Topic_Key in the record will indicate the topic to use. E.g: if Topic_Key is router and the record is {"key1": 123, "router": "route_2"}, Fluent Bit will use topic route_2. Note that if the value of Topic_Key is not present in Topics, then by default the first topic in the Topics list will indicate the topic to be used.'
16955 topics:
16956 type: string
16957 description: Single entry or list of topics separated by comma (,) that Fluent Bit will use to send messages to Kafka. If only one topic is set, that one will be used for all records. Instead if multiple topics exists, the one set in the record by Topic_Key will be used.
16958 kinesis:
16959 type: object
16960 description: Kinesis defines Kinesis Output configuration.
16961 properties:
16962 autoRetryRequests:
16963 type: boolean
16964 description: Immediately retry failed requests to AWS services once. This option does not affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which may help improve throughput when there are transient/random networking issues. This option defaults to true.
16965 endpoint:
16966 type: string
16967 description: Specify a custom endpoint for the Kinesis API.
16968 externalID:
16969 type: string
16970 description: Specify an external ID for the STS API, can be used with the role_arn parameter if your role requires an external ID.
16971 logKey:
16972 type: string
16973 description: By default, the whole log record will be sent to Kinesis. If you specify a key name with this option, then only the value of that key will be sent to Kinesis. For example, if you are using the Fluentd Docker log driver, you can specify log_key log and only the log message will be sent to Kinesis.
16974 region:
16975 type: string
16976 description: The AWS region.
16977 roleARN:
16978 type: string
16979 description: ARN of an IAM role to assume (for cross account access).
16980 stream:
16981 type: string
16982 description: The name of the Kinesis Streams Delivery stream that you want log records sent to.
16983 stsEndpoint:
16984 type: string
16985 description: Custom endpoint for the STS API.
16986 timeKey:
16987 type: string
16988 description: Add the timestamp to the record under this key. By default the timestamp from Fluent Bit will not be added to records sent to Kinesis.
16989 timeKeyFormat:
16990 type: string
16991 description: strftime compliant format string for the timestamp; for example, the default is '%Y-%m-%dT%H:%M:%S'. Supports millisecond precision with '%3N' and supports nanosecond precision with '%9N' and '%L'; for example, adding '%3N' to support millisecond '%Y-%m-%dT%H:%M:%S.%3N'. This option is used with time_key.
16992 required:
16993 - region
16994 - stream
16995 logLevel:
16996 type: string
16997 description: 'Set the plugin''s logging verbosity level. Allowed values are: off, error, warn, info, debug and trace, Defaults to the SERVICE section''s Log_Level'
16998 enum:
16999 - "off"
17000 - error
17001 - warning
17002 - info
17003 - debug
17004 - trace
17005 loki:
17006 type: object
17007 description: Loki defines Loki Output configuration.
17008 properties:
17009 labels:
17010 type: array
17011 description: Stream labels for API request. It can be multiple comma separated of strings specifying key=value pairs. In addition to fixed parameters, it also allows to add custom record keys (similar to label_keys property).
17012 items:
17013 type: string
17014 port:
17015 type: integer
17016 description: Loki TCP port
17017 format: int32
17018 maximum: 65535
17019 minimum: 1
17020 autoKubernetesLabels:
17021 type: string
17022 description: If set to true, it will add all Kubernetes labels to the Stream labels.
17023 enum:
17024 - "on"
17025 - "off"
17026 dropSingleKey:
17027 type: string
17028 description: If set to true and after extracting labels only a single key remains, the log line sent to Loki will be the value of that key in line_format.
17029 enum:
17030 - "on"
17031 - "off"
17032 host:
17033 type: string
17034 description: Loki hostname or IP address.
17035 httpPassword:
17036 type: object
17037 description: Password for user defined in HTTP_User Set HTTP basic authentication password
17038 properties:
17039 valueFrom:
17040 type: object
17041 description: ValueSource defines how to find a value's key.
17042 properties:
17043 secretKeyRef:
17044 type: object
17045 description: Selects a key of a secret in the pod's namespace
17046 properties:
17047 name:
17048 type: string
17049 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17050 key:
17051 type: string
17052 description: The key of the secret to select from. Must be a valid secret key.
17053 optional:
17054 type: boolean
17055 description: Specify whether the Secret or its key must be defined
17056 required:
17057 - key
17058 x-kubernetes-map-type: atomic
17059 httpUser:
17060 type: object
17061 description: Set HTTP basic authentication user name.
17062 properties:
17063 valueFrom:
17064 type: object
17065 description: ValueSource defines how to find a value's key.
17066 properties:
17067 secretKeyRef:
17068 type: object
17069 description: Selects a key of a secret in the pod's namespace
17070 properties:
17071 name:
17072 type: string
17073 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17074 key:
17075 type: string
17076 description: The key of the secret to select from. Must be a valid secret key.
17077 optional:
17078 type: boolean
17079 description: Specify whether the Secret or its key must be defined
17080 required:
17081 - key
17082 x-kubernetes-map-type: atomic
17083 labelKeys:
17084 type: array
17085 description: Optional list of record keys that will be placed as stream labels. This configuration property is for records key only.
17086 items:
17087 type: string
17088 labelMapPath:
17089 type: string
17090 description: Specify the label map file path. The file defines how to extract labels from each record.
17091 lineFormat:
17092 type: string
17093 description: Format to use when flattening the record to a log line. Valid values are json or key_value. If set to json, the log line sent to Loki will be the Fluent Bit record dumped as JSON. If set to key_value, the log line will be each item in the record concatenated together (separated by a single space) in the format.
17094 enum:
17095 - json
17096 - key_value
17097 removeKeys:
17098 type: array
17099 description: Optional list of keys to remove.
17100 items:
17101 type: string
17102 tenantID:
17103 type: object
17104 description: Tenant ID used by default to push logs to Loki. If omitted or empty it assumes Loki is running in single-tenant mode and no X-Scope-OrgID header is sent.
17105 properties:
17106 valueFrom:
17107 type: object
17108 description: ValueSource defines how to find a value's key.
17109 properties:
17110 secretKeyRef:
17111 type: object
17112 description: Selects a key of a secret in the pod's namespace
17113 properties:
17114 name:
17115 type: string
17116 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17117 key:
17118 type: string
17119 description: The key of the secret to select from. Must be a valid secret key.
17120 optional:
17121 type: boolean
17122 description: Specify whether the Secret or its key must be defined
17123 required:
17124 - key
17125 x-kubernetes-map-type: atomic
17126 tenantIDKey:
17127 type: string
17128 description: Specify the name of the key from the original record that contains the Tenant ID. The value of the key is set as X-Scope-OrgID of HTTP header. It is useful to set Tenant ID dynamically.
17129 tls:
17130 type: object
17131 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
17132 properties:
17133 caFile:
17134 type: string
17135 description: Absolute path to CA certificate file
17136 caPath:
17137 type: string
17138 description: Absolute path to scan for certificate files
17139 crtFile:
17140 type: string
17141 description: Absolute path to Certificate file
17142 debug:
17143 type: integer
17144 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
17145 enum:
17146 - 0
17147 - 1
17148 - 2
17149 - 3
17150 - 4
17151 format: int32
17152 keyFile:
17153 type: string
17154 description: Absolute path to private Key file
17155 keyPassword:
17156 type: object
17157 description: Optional password for tls.key_file file
17158 properties:
17159 valueFrom:
17160 type: object
17161 description: ValueSource defines how to find a value's key.
17162 properties:
17163 secretKeyRef:
17164 type: object
17165 description: Selects a key of a secret in the pod's namespace
17166 properties:
17167 name:
17168 type: string
17169 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17170 key:
17171 type: string
17172 description: The key of the secret to select from. Must be a valid secret key.
17173 optional:
17174 type: boolean
17175 description: Specify whether the Secret or its key must be defined
17176 required:
17177 - key
17178 x-kubernetes-map-type: atomic
17179 verify:
17180 type: boolean
17181 description: Force certificate validation
17182 vhost:
17183 type: string
17184 description: Hostname to be used for TLS SNI extension
17185 required:
17186 - host
17187 match:
17188 type: string
17189 description: A pattern to match against the tags of incoming records. It's case sensitive and support the star (*) character as a wildcard.
17190 matchRegex:
17191 type: string
17192 description: A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax.
17193 "null":
17194 type: object
17195 description: Null defines Null Output configuration.
17196 opensearch:
17197 type: object
17198 description: OpenSearch defines OpenSearch Output configuration.
17199 properties:
17200 type:
17201 type: string
17202 description: Type name
17203 port:
17204 type: integer
17205 description: TCP port of the target OpenSearch instance, default `9200`
17206 format: int32
17207 maximum: 65535
17208 minimum: 1
17209 Workers:
17210 type: integer
17211 description: Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0.
17212 format: int32
17213 awsAuth:
17214 type: string
17215 description: Enable AWS Sigv4 Authentication for Amazon OpenSearch Service.
17216 awsExternalID:
17217 type: string
17218 description: External ID for the AWS IAM Role specified with aws_role_arn.
17219 awsRegion:
17220 type: string
17221 description: Specify the AWS region for Amazon OpenSearch Service.
17222 awsRoleARN:
17223 type: string
17224 description: AWS IAM Role to assume to put records to your Amazon cluster.
17225 awsSTSEndpoint:
17226 type: string
17227 description: Specify the custom sts endpoint to be used with STS API for Amazon OpenSearch Service.
17228 bufferSize:
17229 type: string
17230 description: Specify the buffer size used to read the response from the OpenSearch HTTP service. This option is useful for debugging purposes where is required to read full responses, note that response size grows depending of the number of records inserted. To set an unlimited amount of memory set this value to False, otherwise the value must be according to the Unit Size specification.
17231 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
17232 currentTimeIndex:
17233 type: boolean
17234 description: Use current time for index generation instead of message record
17235 generateID:
17236 type: boolean
17237 description: When enabled, generate _id for outgoing records. This prevents duplicate records when retrying OpenSearch.
17238 host:
17239 type: string
17240 description: IP address or hostname of the target OpenSearch instance, default `127.0.0.1`
17241 httpPassword:
17242 type: object
17243 description: Password for user defined in HTTP_User
17244 properties:
17245 valueFrom:
17246 type: object
17247 description: ValueSource defines how to find a value's key.
17248 properties:
17249 secretKeyRef:
17250 type: object
17251 description: Selects a key of a secret in the pod's namespace
17252 properties:
17253 name:
17254 type: string
17255 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17256 key:
17257 type: string
17258 description: The key of the secret to select from. Must be a valid secret key.
17259 optional:
17260 type: boolean
17261 description: Specify whether the Secret or its key must be defined
17262 required:
17263 - key
17264 x-kubernetes-map-type: atomic
17265 httpUser:
17266 type: object
17267 description: Optional username credential for access
17268 properties:
17269 valueFrom:
17270 type: object
17271 description: ValueSource defines how to find a value's key.
17272 properties:
17273 secretKeyRef:
17274 type: object
17275 description: Selects a key of a secret in the pod's namespace
17276 properties:
17277 name:
17278 type: string
17279 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17280 key:
17281 type: string
17282 description: The key of the secret to select from. Must be a valid secret key.
17283 optional:
17284 type: boolean
17285 description: Specify whether the Secret or its key must be defined
17286 required:
17287 - key
17288 x-kubernetes-map-type: atomic
17289 idKey:
17290 type: string
17291 description: If set, _id will be the value of the key from incoming record and Generate_ID option is ignored.
17292 includeTagKey:
17293 type: boolean
17294 description: When enabled, it append the Tag name to the record.
17295 index:
17296 type: string
17297 description: Index name
17298 logstashDateFormat:
17299 type: string
17300 description: Time format (based on strftime) to generate the second part of the Index name.
17301 logstashFormat:
17302 type: boolean
17303 description: 'Enable Logstash format compatibility. This option takes a boolean value: True/False, On/Off'
17304 logstashPrefix:
17305 type: string
17306 description: 'When Logstash_Format is enabled, the Index name is composed using a prefix and the date, e.g: If Logstash_Prefix is equals to ''mydata'' your index will become ''mydata-YYYY.MM.DD''. The last string appended belongs to the date when the data is being generated.'
17307 logstashPrefixKey:
17308 type: string
17309 description: Prefix keys with this string
17310 path:
17311 type: string
17312 description: OpenSearch accepts new data on HTTP query path "/_bulk". But it is also possible to serve OpenSearch behind a reverse proxy on a subpath. This option defines such path on the fluent-bit side. It simply adds a path prefix in the indexing HTTP POST URI.
17313 pipeline:
17314 type: string
17315 description: OpenSearch allows to setup filters called pipelines. This option allows to define which pipeline the database should use. For performance reasons is strongly suggested to do parsing and filtering on Fluent Bit side, avoid pipelines.
17316 replaceDots:
17317 type: boolean
17318 description: When enabled, replace field name dots with underscore, required by Elasticsearch 2.0-2.3.
17319 suppressTypeName:
17320 type: boolean
17321 description: When enabled, mapping types is removed and Type option is ignored. Types are deprecated in APIs in v7.0. This options is for v7.0 or later.
17322 tagKey:
17323 type: string
17324 description: When Include_Tag_Key is enabled, this property defines the key name for the tag.
17325 timeKey:
17326 type: string
17327 description: When Logstash_Format is enabled, each record will get a new timestamp field. The Time_Key property defines the name of that field.
17328 timeKeyFormat:
17329 type: string
17330 description: When Logstash_Format is enabled, this property defines the format of the timestamp.
17331 timeKeyNanos:
17332 type: boolean
17333 description: When Logstash_Format is enabled, enabling this property sends nanosecond precision timestamps.
17334 tls:
17335 type: object
17336 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
17337 properties:
17338 caFile:
17339 type: string
17340 description: Absolute path to CA certificate file
17341 caPath:
17342 type: string
17343 description: Absolute path to scan for certificate files
17344 crtFile:
17345 type: string
17346 description: Absolute path to Certificate file
17347 debug:
17348 type: integer
17349 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
17350 enum:
17351 - 0
17352 - 1
17353 - 2
17354 - 3
17355 - 4
17356 format: int32
17357 keyFile:
17358 type: string
17359 description: Absolute path to private Key file
17360 keyPassword:
17361 type: object
17362 description: Optional password for tls.key_file file
17363 properties:
17364 valueFrom:
17365 type: object
17366 description: ValueSource defines how to find a value's key.
17367 properties:
17368 secretKeyRef:
17369 type: object
17370 description: Selects a key of a secret in the pod's namespace
17371 properties:
17372 name:
17373 type: string
17374 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17375 key:
17376 type: string
17377 description: The key of the secret to select from. Must be a valid secret key.
17378 optional:
17379 type: boolean
17380 description: Specify whether the Secret or its key must be defined
17381 required:
17382 - key
17383 x-kubernetes-map-type: atomic
17384 verify:
17385 type: boolean
17386 description: Force certificate validation
17387 vhost:
17388 type: string
17389 description: Hostname to be used for TLS SNI extension
17390 totalLimitSize:
17391 type: string
17392 description: Limit the maximum number of Chunks in the filesystem for the current output logical destination.
17393 traceError:
17394 type: boolean
17395 description: When enabled print the elasticsearch API calls to stdout when elasticsearch returns an error
17396 traceOutput:
17397 type: boolean
17398 description: When enabled print the elasticsearch API calls to stdout (for diag only)
17399 writeOperation:
17400 type: string
17401 description: Operation to use to write in bulk requests.
17402 opentelemetry:
17403 type: object
17404 description: OpenTelemetry defines OpenTelemetry Output configuration.
17405 properties:
17406 port:
17407 type: integer
17408 description: TCP port of the target OpenSearch instance, default `80`
17409 format: int32
17410 maximum: 65535
17411 minimum: 1
17412 addLabel:
17413 type: object
17414 additionalProperties:
17415 type: string
17416 description: This allows you to add custom labels to all metrics exposed through the OpenTelemetry exporter. You may have multiple of these fields.
17417 header:
17418 type: object
17419 additionalProperties:
17420 type: string
17421 description: Add a HTTP header key/value pair. Multiple headers can be set.
17422 host:
17423 type: string
17424 description: IP address or hostname of the target HTTP Server, default `127.0.0.1`
17425 httpPassword:
17426 type: object
17427 description: Password for user defined in HTTP_User
17428 properties:
17429 valueFrom:
17430 type: object
17431 description: ValueSource defines how to find a value's key.
17432 properties:
17433 secretKeyRef:
17434 type: object
17435 description: Selects a key of a secret in the pod's namespace
17436 properties:
17437 name:
17438 type: string
17439 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17440 key:
17441 type: string
17442 description: The key of the secret to select from. Must be a valid secret key.
17443 optional:
17444 type: boolean
17445 description: Specify whether the Secret or its key must be defined
17446 required:
17447 - key
17448 x-kubernetes-map-type: atomic
17449 httpUser:
17450 type: object
17451 description: Optional username credential for access
17452 properties:
17453 valueFrom:
17454 type: object
17455 description: ValueSource defines how to find a value's key.
17456 properties:
17457 secretKeyRef:
17458 type: object
17459 description: Selects a key of a secret in the pod's namespace
17460 properties:
17461 name:
17462 type: string
17463 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17464 key:
17465 type: string
17466 description: The key of the secret to select from. Must be a valid secret key.
17467 optional:
17468 type: boolean
17469 description: Specify whether the Secret or its key must be defined
17470 required:
17471 - key
17472 x-kubernetes-map-type: atomic
17473 logResponsePayload:
17474 type: boolean
17475 description: Log the response payload within the Fluent Bit log.
17476 logsUri:
17477 type: string
17478 description: 'Specify an optional HTTP URI for the target web server listening for logs, e.g: /v1/logs'
17479 metricsUri:
17480 type: string
17481 description: 'Specify an optional HTTP URI for the target web server listening for metrics, e.g: /v1/metrics'
17482 proxy:
17483 type: string
17484 description: Specify an HTTP Proxy. The expected format of this value is http://HOST:PORT. Note that HTTPS is not currently supported. It is recommended not to set this and to configure the HTTP proxy environment variables instead as they support both HTTP and HTTPS.
17485 tls:
17486 type: object
17487 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
17488 properties:
17489 caFile:
17490 type: string
17491 description: Absolute path to CA certificate file
17492 caPath:
17493 type: string
17494 description: Absolute path to scan for certificate files
17495 crtFile:
17496 type: string
17497 description: Absolute path to Certificate file
17498 debug:
17499 type: integer
17500 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
17501 enum:
17502 - 0
17503 - 1
17504 - 2
17505 - 3
17506 - 4
17507 format: int32
17508 keyFile:
17509 type: string
17510 description: Absolute path to private Key file
17511 keyPassword:
17512 type: object
17513 description: Optional password for tls.key_file file
17514 properties:
17515 valueFrom:
17516 type: object
17517 description: ValueSource defines how to find a value's key.
17518 properties:
17519 secretKeyRef:
17520 type: object
17521 description: Selects a key of a secret in the pod's namespace
17522 properties:
17523 name:
17524 type: string
17525 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17526 key:
17527 type: string
17528 description: The key of the secret to select from. Must be a valid secret key.
17529 optional:
17530 type: boolean
17531 description: Specify whether the Secret or its key must be defined
17532 required:
17533 - key
17534 x-kubernetes-map-type: atomic
17535 verify:
17536 type: boolean
17537 description: Force certificate validation
17538 vhost:
17539 type: string
17540 description: Hostname to be used for TLS SNI extension
17541 tracesUri:
17542 type: string
17543 description: 'Specify an optional HTTP URI for the target web server listening for traces, e.g: /v1/traces'
17544 prometheusRemoteWrite:
17545 type: object
17546 description: PrometheusRemoteWrite_types defines Prometheus Remote Write configuration.
17547 properties:
17548 port:
17549 type: integer
17550 description: TCP port of the target HTTP Serveri, default:80
17551 format: int32
17552 maximum: 65535
17553 minimum: 1
17554 addLabels:
17555 type: object
17556 additionalProperties:
17557 type: string
17558 description: This allows you to add custom labels to all metrics exposed through the prometheus exporter. You may have multiple of these fields
17559 headers:
17560 type: object
17561 additionalProperties:
17562 type: string
17563 description: Add a HTTP header key/value pair. Multiple headers can be set.
17564 host:
17565 type: string
17566 description: 'IP address or hostname of the target HTTP Server, default: 127.0.0.1'
17567 httpPasswd:
17568 type: object
17569 description: Basic Auth Password. Requires HTTP_user to be se
17570 properties:
17571 valueFrom:
17572 type: object
17573 description: ValueSource defines how to find a value's key.
17574 properties:
17575 secretKeyRef:
17576 type: object
17577 description: Selects a key of a secret in the pod's namespace
17578 properties:
17579 name:
17580 type: string
17581 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17582 key:
17583 type: string
17584 description: The key of the secret to select from. Must be a valid secret key.
17585 optional:
17586 type: boolean
17587 description: Specify whether the Secret or its key must be defined
17588 required:
17589 - key
17590 x-kubernetes-map-type: atomic
17591 httpUser:
17592 type: object
17593 description: Basic Auth Username
17594 properties:
17595 valueFrom:
17596 type: object
17597 description: ValueSource defines how to find a value's key.
17598 properties:
17599 secretKeyRef:
17600 type: object
17601 description: Selects a key of a secret in the pod's namespace
17602 properties:
17603 name:
17604 type: string
17605 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17606 key:
17607 type: string
17608 description: The key of the secret to select from. Must be a valid secret key.
17609 optional:
17610 type: boolean
17611 description: Specify whether the Secret or its key must be defined
17612 required:
17613 - key
17614 x-kubernetes-map-type: atomic
17615 logResponsePayload:
17616 type: boolean
17617 description: 'Log the response payload within the Fluent Bit log,default: false'
17618 proxy:
17619 type: string
17620 description: Specify an HTTP Proxy. The expected format of this value is http://HOST:PORT.
17621 tls:
17622 type: object
17623 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
17624 properties:
17625 caFile:
17626 type: string
17627 description: Absolute path to CA certificate file
17628 caPath:
17629 type: string
17630 description: Absolute path to scan for certificate files
17631 crtFile:
17632 type: string
17633 description: Absolute path to Certificate file
17634 debug:
17635 type: integer
17636 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
17637 enum:
17638 - 0
17639 - 1
17640 - 2
17641 - 3
17642 - 4
17643 format: int32
17644 keyFile:
17645 type: string
17646 description: Absolute path to private Key file
17647 keyPassword:
17648 type: object
17649 description: Optional password for tls.key_file file
17650 properties:
17651 valueFrom:
17652 type: object
17653 description: ValueSource defines how to find a value's key.
17654 properties:
17655 secretKeyRef:
17656 type: object
17657 description: Selects a key of a secret in the pod's namespace
17658 properties:
17659 name:
17660 type: string
17661 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17662 key:
17663 type: string
17664 description: The key of the secret to select from. Must be a valid secret key.
17665 optional:
17666 type: boolean
17667 description: Specify whether the Secret or its key must be defined
17668 required:
17669 - key
17670 x-kubernetes-map-type: atomic
17671 verify:
17672 type: boolean
17673 description: Force certificate validation
17674 vhost:
17675 type: string
17676 description: Hostname to be used for TLS SNI extension
17677 uri:
17678 type: string
17679 description: 'Specify an optional HTTP URI for the target web server, e.g: /something ,default: /'
17680 workers:
17681 type: integer
17682 description: 'Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0,default : 2'
17683 format: int32
17684 required:
17685 - host
17686 retry_limit:
17687 type: string
17688 description: RetryLimit represents configuration for the scheduler which can be set independently on each output section. This option allows to disable retries or impose a limit to try N times and then discard the data after reaching that limit.
17689 s3:
17690 type: object
17691 description: S3 defines S3 Output configuration.
17692 properties:
17693 AutoRetryRequests:
17694 type: boolean
17695 description: Immediately retry failed requests to AWS services once.
17696 Bucket:
17697 type: string
17698 description: S3 Bucket name
17699 CannedAcl:
17700 type: string
17701 description: Predefined Canned ACL Policy for S3 objects.
17702 Compression:
17703 type: string
17704 description: Compression type for S3 objects.
17705 ContentType:
17706 type: string
17707 description: A standard MIME type for the S3 object; this will be set as the Content-Type HTTP header.
17708 Endpoint:
17709 type: string
17710 description: Custom endpoint for the S3 API.
17711 ExternalId:
17712 type: string
17713 description: Specify an external ID for the STS API, can be used with the role_arn parameter if your role requires an external ID.
17714 JsonDateFormat:
17715 type: string
17716 description: 'Specify the format of the date. Supported formats are double, epoch, iso8601 (eg: 2018-05-30T09:39:52.000681Z) and java_sql_timestamp (eg: 2018-05-30 09:39:52.000681)'
17717 JsonDateKey:
17718 type: string
17719 description: Specify the name of the time key in the output record. To disable the time key just set the value to false.
17720 LogKey:
17721 type: string
17722 description: By default, the whole log record will be sent to S3. If you specify a key name with this option, then only the value of that key will be sent to S3.
17723 PreserveDataOrdering:
17724 type: boolean
17725 description: Normally, when an upload request fails, there is a high chance for the last received chunk to be swapped with a later chunk, resulting in data shuffling. This feature prevents this shuffling by using a queue logic for uploads.
17726 Region:
17727 type: string
17728 description: The AWS region of your S3 bucket
17729 RetryLimit:
17730 type: integer
17731 description: Integer value to set the maximum number of retries allowed.
17732 format: int32
17733 RoleArn:
17734 type: string
17735 description: ARN of an IAM role to assume
17736 S3KeyFormat:
17737 type: string
17738 description: Format string for keys in S3.
17739 S3KeyFormatTagDelimiters:
17740 type: string
17741 description: A series of characters which will be used to split the tag into 'parts' for use with the s3_key_format option.
17742 SendContentMd5:
17743 type: boolean
17744 description: Send the Content-MD5 header with PutObject and UploadPart requests, as is required when Object Lock is enabled.
17745 StaticFilePath:
17746 type: boolean
17747 description: Disables behavior where UUID string is automatically appended to end of S3 key name when $UUID is not provided in s3_key_format. $UUID, time formatters, $TAG, and other dynamic key formatters all work as expected while this feature is set to true.
17748 StorageClass:
17749 type: string
17750 description: Specify the storage class for S3 objects. If this option is not specified, objects will be stored with the default 'STANDARD' storage class.
17751 StoreDir:
17752 type: string
17753 description: Directory to locally buffer data before sending.
17754 StoreDirLimitSize:
17755 type: string
17756 description: The size of the limitation for disk usage in S3.
17757 StsEndpoint:
17758 type: string
17759 description: Custom endpoint for the STS API.
17760 TotalFileSize:
17761 type: string
17762 description: Specifies the size of files in S3. Minimum size is 1M. With use_put_object On the maximum size is 1G. With multipart upload mode, the maximum size is 50G.
17763 UploadChunkSize:
17764 type: string
17765 description: 'The size of each ''part'' for multipart uploads. Max: 50M'
17766 UploadTimeout:
17767 type: string
17768 description: Whenever this amount of time has elapsed, Fluent Bit will complete an upload and create a new file in S3. For example, set this value to 60m and you will get a new file every hour.
17769 UsePutObject:
17770 type: boolean
17771 description: Use the S3 PutObject API, instead of the multipart upload API.
17772 required:
17773 - Bucket
17774 - Region
17775 splunk:
17776 type: object
17777 description: Splunk defines Splunk Output Configuration
17778 properties:
17779 port:
17780 type: integer
17781 description: TCP port of the target Splunk instance, default `8088`
17782 format: int32
17783 maximum: 65535
17784 minimum: 1
17785 Workers:
17786 type: integer
17787 description: Enables dedicated thread(s) for this output. Default value `2` is set since version 1.8.13. For previous versions is 0.
17788 format: int32
17789 channel:
17790 type: string
17791 description: Specify X-Splunk-Request-Channel Header for the HTTP Event Collector interface.
17792 compress:
17793 type: string
17794 description: Set payload compression mechanism. The only available option is gzip.
17795 eventFields:
17796 type: array
17797 description: Set event fields for the record. This option is an array and the format is "key_name record_accessor_pattern".
17798 items:
17799 type: string
17800 eventHost:
17801 type: string
17802 description: Specify the key name that contains the host value. This option allows a record accessors pattern.
17803 eventIndex:
17804 type: string
17805 description: The name of the index by which the event data is to be indexed.
17806 eventIndexKey:
17807 type: string
17808 description: Set a record key that will populate the index field. If the key is found, it will have precedence over the value set in event_index.
17809 eventKey:
17810 type: string
17811 description: Specify the key name that will be used to send a single value as part of the record.
17812 eventSource:
17813 type: string
17814 description: Set the source value to assign to the event data.
17815 eventSourcetype:
17816 type: string
17817 description: Set the sourcetype value to assign to the event data.
17818 eventSourcetypeKey:
17819 type: string
17820 description: Set a record key that will populate 'sourcetype'. If the key is found, it will have precedence over the value set in event_sourcetype.
17821 host:
17822 type: string
17823 description: IP address or hostname of the target OpenSearch instance, default `127.0.0.1`
17824 httpBufferSize:
17825 type: string
17826 description: 'Buffer size used to receive Splunk HTTP responses: Default `2M`'
17827 pattern: ^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
17828 httpDebugBadRequest:
17829 type: boolean
17830 description: If the HTTP server response code is 400 (bad request) and this flag is enabled, it will print the full HTTP request and response to the stdout interface. This feature is available for debugging purposes.
17831 httpPassword:
17832 type: object
17833 description: Password for user defined in HTTP_User
17834 properties:
17835 valueFrom:
17836 type: object
17837 description: ValueSource defines how to find a value's key.
17838 properties:
17839 secretKeyRef:
17840 type: object
17841 description: Selects a key of a secret in the pod's namespace
17842 properties:
17843 name:
17844 type: string
17845 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17846 key:
17847 type: string
17848 description: The key of the secret to select from. Must be a valid secret key.
17849 optional:
17850 type: boolean
17851 description: Specify whether the Secret or its key must be defined
17852 required:
17853 - key
17854 x-kubernetes-map-type: atomic
17855 httpUser:
17856 type: object
17857 description: Optional username credential for access
17858 properties:
17859 valueFrom:
17860 type: object
17861 description: ValueSource defines how to find a value's key.
17862 properties:
17863 secretKeyRef:
17864 type: object
17865 description: Selects a key of a secret in the pod's namespace
17866 properties:
17867 name:
17868 type: string
17869 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17870 key:
17871 type: string
17872 description: The key of the secret to select from. Must be a valid secret key.
17873 optional:
17874 type: boolean
17875 description: Specify whether the Secret or its key must be defined
17876 required:
17877 - key
17878 x-kubernetes-map-type: atomic
17879 splunkSendRaw:
17880 type: boolean
17881 description: When enabled, the record keys and values are set in the top level of the map instead of under the event key. Refer to the Sending Raw Events section from the docs more details to make this option work properly.
17882 splunkToken:
17883 type: object
17884 description: Specify the Authentication Token for the HTTP Event Collector interface.
17885 properties:
17886 valueFrom:
17887 type: object
17888 description: ValueSource defines how to find a value's key.
17889 properties:
17890 secretKeyRef:
17891 type: object
17892 description: Selects a key of a secret in the pod's namespace
17893 properties:
17894 name:
17895 type: string
17896 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17897 key:
17898 type: string
17899 description: The key of the secret to select from. Must be a valid secret key.
17900 optional:
17901 type: boolean
17902 description: Specify whether the Secret or its key must be defined
17903 required:
17904 - key
17905 x-kubernetes-map-type: atomic
17906 tls:
17907 type: object
17908 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
17909 properties:
17910 caFile:
17911 type: string
17912 description: Absolute path to CA certificate file
17913 caPath:
17914 type: string
17915 description: Absolute path to scan for certificate files
17916 crtFile:
17917 type: string
17918 description: Absolute path to Certificate file
17919 debug:
17920 type: integer
17921 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
17922 enum:
17923 - 0
17924 - 1
17925 - 2
17926 - 3
17927 - 4
17928 format: int32
17929 keyFile:
17930 type: string
17931 description: Absolute path to private Key file
17932 keyPassword:
17933 type: object
17934 description: Optional password for tls.key_file file
17935 properties:
17936 valueFrom:
17937 type: object
17938 description: ValueSource defines how to find a value's key.
17939 properties:
17940 secretKeyRef:
17941 type: object
17942 description: Selects a key of a secret in the pod's namespace
17943 properties:
17944 name:
17945 type: string
17946 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
17947 key:
17948 type: string
17949 description: The key of the secret to select from. Must be a valid secret key.
17950 optional:
17951 type: boolean
17952 description: Specify whether the Secret or its key must be defined
17953 required:
17954 - key
17955 x-kubernetes-map-type: atomic
17956 verify:
17957 type: boolean
17958 description: Force certificate validation
17959 vhost:
17960 type: string
17961 description: Hostname to be used for TLS SNI extension
17962 stackdriver:
17963 type: object
17964 description: Stackdriver defines Stackdriver Output Configuration
17965 properties:
17966 namespace:
17967 type: string
17968 description: Namespace identifier. Required if Resource is generic_node or generic_task
17969 labels:
17970 type: array
17971 description: Optional list of comma separated of strings for key/value pairs
17972 items:
17973 type: string
17974 autoformatStackdriverTrace:
17975 type: boolean
17976 description: Rewrite the trace field to be formatted for use with GCP Cloud Trace
17977 customK8sRegex:
17978 type: string
17979 description: A custom regex to extract fields from the local_resource_id of the logs
17980 exportToProjectID:
17981 type: string
17982 description: The GCP Project that should receive the logs
17983 googleServiceCredentials:
17984 type: string
17985 description: Path to GCP Credentials JSON file
17986 job:
17987 type: string
17988 description: Identifier for a grouping of tasks. Required if Resource is generic_task
17989 k8sClusterLocation:
17990 type: string
17991 description: Location of the cluster that contains the pods/nodes. Required if Resource is k8s_container, k8s_node, or k8s_pod
17992 k8sClusterName:
17993 type: string
17994 description: Name of the cluster that the pod is running in. Required if Resource is k8s_container, k8s_node, or k8s_pod
17995 labelsKey:
17996 type: string
17997 description: Used by Stackdriver to find related labels and extract them to LogEntry Labels
17998 location:
17999 type: string
18000 description: GCP/AWS region to store data. Required if Resource is generic_node or generic_task
18001 logNameKey:
18002 type: string
18003 description: The value of this field is set as the logName field in Stackdriver
18004 metadataServer:
18005 type: string
18006 description: Metadata Server Prefix
18007 nodeID:
18008 type: string
18009 description: Node identifier within the namespace. Required if Resource is generic_node or generic_task
18010 resource:
18011 type: string
18012 description: Set resource types of data
18013 resourceLabels:
18014 type: array
18015 description: Optional list of comma seperated strings. Setting these fields overrides the Stackdriver monitored resource API values
18016 items:
18017 type: string
18018 serviceAccountEmail:
18019 type: object
18020 description: Email associated with the service
18021 properties:
18022 valueFrom:
18023 type: object
18024 description: ValueSource defines how to find a value's key.
18025 properties:
18026 secretKeyRef:
18027 type: object
18028 description: Selects a key of a secret in the pod's namespace
18029 properties:
18030 name:
18031 type: string
18032 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18033 key:
18034 type: string
18035 description: The key of the secret to select from. Must be a valid secret key.
18036 optional:
18037 type: boolean
18038 description: Specify whether the Secret or its key must be defined
18039 required:
18040 - key
18041 x-kubernetes-map-type: atomic
18042 serviceAccountSecret:
18043 type: object
18044 description: Private Key associated with the service
18045 properties:
18046 valueFrom:
18047 type: object
18048 description: ValueSource defines how to find a value's key.
18049 properties:
18050 secretKeyRef:
18051 type: object
18052 description: Selects a key of a secret in the pod's namespace
18053 properties:
18054 name:
18055 type: string
18056 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18057 key:
18058 type: string
18059 description: The key of the secret to select from. Must be a valid secret key.
18060 optional:
18061 type: boolean
18062 description: Specify whether the Secret or its key must be defined
18063 required:
18064 - key
18065 x-kubernetes-map-type: atomic
18066 severityKey:
18067 type: string
18068 description: Specify the key that contains the severity information for the logs
18069 tagPrefix:
18070 type: string
18071 description: Used to validate the tags of logs that when the Resource is k8s_container, k8s_node, or k8s_pod
18072 taskID:
18073 type: string
18074 description: Identifier for a task within a namespace. Required if Resource is generic_task
18075 workers:
18076 type: integer
18077 description: Number of dedicated threads for the Stackdriver Output Plugin
18078 format: int32
18079 stdout:
18080 type: object
18081 description: Stdout defines Stdout Output configuration.
18082 properties:
18083 format:
18084 type: string
18085 description: Specify the data format to be printed. Supported formats are msgpack json, json_lines and json_stream.
18086 enum:
18087 - msgpack
18088 - json
18089 - json_lines
18090 - json_stream
18091 jsonDateFormat:
18092 type: string
18093 description: 'Specify the format of the date. Supported formats are double, iso8601 (eg: 2018-05-30T09:39:52.000681Z) and epoch.'
18094 enum:
18095 - double
18096 - iso8601
18097 - epoch
18098 jsonDateKey:
18099 type: string
18100 description: Specify the name of the date field in output.
18101 syslog:
18102 type: object
18103 description: Syslog defines Syslog Output configuration.
18104 properties:
18105 port:
18106 type: integer
18107 description: TCP or UDP port of the remote Syslog server.
18108 format: int32
18109 maximum: 65535
18110 minimum: 1
18111 host:
18112 type: string
18113 description: Host domain or IP address of the remote Syslog server.
18114 mode:
18115 type: string
18116 description: Mode of the desired transport type, the available options are tcp, tls and udp.
18117 syslogAppnameKey:
18118 type: string
18119 description: Key name from the original record that contains the application name that generated the message.
18120 syslogFacilityKey:
18121 type: string
18122 description: Key from the original record that contains the Syslog facility number.
18123 syslogFormat:
18124 type: string
18125 description: Syslog protocol format to use, the available options are rfc3164 and rfc5424.
18126 syslogHostnameKey:
18127 type: string
18128 description: Key name from the original record that contains the hostname that generated the message.
18129 syslogMaxSize:
18130 type: integer
18131 description: Maximum size allowed per message, in bytes.
18132 format: int32
18133 syslogMessageIDKey:
18134 type: string
18135 description: Key name from the original record that contains the Message ID associated to the message.
18136 syslogMessageKey:
18137 type: string
18138 description: Key key name that contains the message to deliver.
18139 syslogProcessIDKey:
18140 type: string
18141 description: Key name from the original record that contains the Process ID that generated the message.
18142 syslogSDKey:
18143 type: string
18144 description: Key name from the original record that contains the Structured Data (SD) content.
18145 syslogSeverityKey:
18146 type: string
18147 description: Key from the original record that contains the Syslog severity number.
18148 tls:
18149 type: object
18150 description: Syslog output plugin supports TTL/SSL, for more details about the properties available and general configuration, please refer to the TLS/SSL section.
18151 properties:
18152 caFile:
18153 type: string
18154 description: Absolute path to CA certificate file
18155 caPath:
18156 type: string
18157 description: Absolute path to scan for certificate files
18158 crtFile:
18159 type: string
18160 description: Absolute path to Certificate file
18161 debug:
18162 type: integer
18163 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
18164 enum:
18165 - 0
18166 - 1
18167 - 2
18168 - 3
18169 - 4
18170 format: int32
18171 keyFile:
18172 type: string
18173 description: Absolute path to private Key file
18174 keyPassword:
18175 type: object
18176 description: Optional password for tls.key_file file
18177 properties:
18178 valueFrom:
18179 type: object
18180 description: ValueSource defines how to find a value's key.
18181 properties:
18182 secretKeyRef:
18183 type: object
18184 description: Selects a key of a secret in the pod's namespace
18185 properties:
18186 name:
18187 type: string
18188 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18189 key:
18190 type: string
18191 description: The key of the secret to select from. Must be a valid secret key.
18192 optional:
18193 type: boolean
18194 description: Specify whether the Secret or its key must be defined
18195 required:
18196 - key
18197 x-kubernetes-map-type: atomic
18198 verify:
18199 type: boolean
18200 description: Force certificate validation
18201 vhost:
18202 type: string
18203 description: Hostname to be used for TLS SNI extension
18204 tcp:
18205 type: object
18206 description: TCP defines TCP Output configuration.
18207 properties:
18208 port:
18209 type: integer
18210 description: TCP Port of the target service.
18211 format: int32
18212 maximum: 65535
18213 minimum: 1
18214 format:
18215 type: string
18216 description: Specify the data format to be printed. Supported formats are msgpack json, json_lines and json_stream.
18217 enum:
18218 - msgpack
18219 - json
18220 - json_lines
18221 - json_stream
18222 host:
18223 type: string
18224 description: Target host where Fluent-Bit or Fluentd are listening for Forward messages.
18225 jsonDateFormat:
18226 type: string
18227 description: 'Specify the format of the date. Supported formats are double, epoch and iso8601 (eg: 2018-05-30T09:39:52.000681Z)'
18228 enum:
18229 - double
18230 - epoch
18231 - iso8601
18232 jsonDateKey:
18233 type: string
18234 description: TSpecify the name of the time key in the output record. To disable the time key just set the value to false.
18235 tls:
18236 type: object
18237 description: Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
18238 properties:
18239 caFile:
18240 type: string
18241 description: Absolute path to CA certificate file
18242 caPath:
18243 type: string
18244 description: Absolute path to scan for certificate files
18245 crtFile:
18246 type: string
18247 description: Absolute path to Certificate file
18248 debug:
18249 type: integer
18250 description: 'Set TLS debug verbosity level. It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose'
18251 enum:
18252 - 0
18253 - 1
18254 - 2
18255 - 3
18256 - 4
18257 format: int32
18258 keyFile:
18259 type: string
18260 description: Absolute path to private Key file
18261 keyPassword:
18262 type: object
18263 description: Optional password for tls.key_file file
18264 properties:
18265 valueFrom:
18266 type: object
18267 description: ValueSource defines how to find a value's key.
18268 properties:
18269 secretKeyRef:
18270 type: object
18271 description: Selects a key of a secret in the pod's namespace
18272 properties:
18273 name:
18274 type: string
18275 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18276 key:
18277 type: string
18278 description: The key of the secret to select from. Must be a valid secret key.
18279 optional:
18280 type: boolean
18281 description: Specify whether the Secret or its key must be defined
18282 required:
18283 - key
18284 x-kubernetes-map-type: atomic
18285 verify:
18286 type: boolean
18287 description: Force certificate validation
18288 vhost:
18289 type: string
18290 description: Hostname to be used for TLS SNI extension
18291 served: true
18292 storage: true
18293---
18294apiVersion: apiextensions.k8s.io/v1
18295kind: CustomResourceDefinition
18296metadata:
18297 name: outputs.fluentd.fluent.io
18298 annotations:
18299 controller-gen.kubebuilder.io/version: v0.11.3
18300 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
18301 pallet.edge.ncr.com/name: fluent-operator
18302 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
18303 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
18304 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
18305 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
18306spec:
18307 group: fluentd.fluent.io
18308 names:
18309 kind: Output
18310 listKind: OutputList
18311 plural: outputs
18312 shortNames:
18313 - fdo
18314 singular: output
18315 scope: Namespaced
18316 versions:
18317 - name: v1alpha1
18318 schema:
18319 openAPIV3Schema:
18320 type: object
18321 description: Output is the Schema for the outputs API
18322 properties:
18323 apiVersion:
18324 type: string
18325 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'
18326 kind:
18327 type: string
18328 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'
18329 metadata:
18330 type: object
18331 spec:
18332 type: object
18333 description: OutputSpec defines the desired state of Output
18334 properties:
18335 outputs:
18336 type: array
18337 items:
18338 type: object
18339 description: Output defines all available output plugins and their parameters
18340 properties:
18341 buffer:
18342 type: object
18343 description: buffer section
18344 properties:
18345 type:
18346 type: string
18347 description: The @type parameter specifies the type of the plugin.
18348 enum:
18349 - file
18350 - memory
18351 - file_single
18352 calcNumRecords:
18353 type: string
18354 description: Calculates the number of records, chunk size, during chunk resume.
18355 chunkFormat:
18356 type: string
18357 description: ChunkFormat specifies the chunk format for calc_num_records.
18358 enum:
18359 - msgpack
18360 - text
18361 - auto
18362 chunkLimitRecords:
18363 type: string
18364 description: The max number of events that each chunks can store in it.
18365 pattern: ^\d+(KB|MB|GB|TB)$
18366 chunkLimitSize:
18367 type: string
18368 description: 'Buffer parameters The max size of each chunks: events will be written into chunks until the size of chunks become this size Default: 8MB (memory) / 256MB (file)'
18369 pattern: ^\d+(KB|MB|GB|TB)$
18370 compress:
18371 type: string
18372 description: Fluentd will decompress these compressed chunks automatically before passing them to the output plugin If gzip is set, Fluentd compresses data records before writing to buffer chunks. Default:text.
18373 enum:
18374 - text
18375 - gzip
18376 delayedCommitTimeout:
18377 type: string
18378 description: The timeout (seconds) until output plugin decides if the async write operation has failed. Default is 60s
18379 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18380 disableChunkBackup:
18381 type: boolean
18382 description: Instead of storing unrecoverable chunks in the backup directory, just discard them. This option is new in Fluentd v1.2.6.
18383 flushAtShutdown:
18384 type: boolean
18385 description: Flush parameters This specifies whether to flush/write all buffer chunks on shutdown or not.
18386 flushInterval:
18387 type: string
18388 description: FlushInterval defines the flush interval
18389 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18390 flushMode:
18391 type: string
18392 description: 'FlushMode defines the flush mode: lazy: flushes/writes chunks once per timekey interval: flushes/writes chunks per specified time via flush_interval immediate: flushes/writes chunks immediately after events are appended into chunks default: equals to lazy if time is specified as chunk key, interval otherwise'
18393 enum:
18394 - default
18395 - lazy
18396 - interval
18397 - immediate
18398 flushThreadCount:
18399 type: string
18400 description: The number of threads to flush/write chunks in parallel
18401 pattern: ^\d+$
18402 id:
18403 type: string
18404 description: The @id parameter specifies a unique name for the configuration.
18405 localtime:
18406 type: boolean
18407 description: If true, uses local time.
18408 logLevel:
18409 type: string
18410 description: The @log_level parameter specifies the plugin-specific logging level
18411 overflowAction:
18412 type: string
18413 description: 'OverflowAtction defines the output plugin behave when its buffer queue is full. Default: throw_exception'
18414 path:
18415 type: string
18416 description: The path where buffer chunks are stored. This field would make no effect in memory buffer plugin.
18417 pathSuffix:
18418 type: string
18419 description: Changes the suffix of the buffer file.
18420 queueLimitLength:
18421 type: string
18422 description: 'The queue length limitation of this buffer plugin instance. Default: 0.95'
18423 pattern: ^\d+.?\d+$
18424 queuedChunksLimitSize:
18425 type: integer
18426 description: 'Limit the number of queued chunks. Default: 1 If a smaller flush_interval is set, e.g. 1s, there are lots of small queued chunks in the buffer. With file buffer, it may consume a lot of fd resources when output destination has a problem. This parameter mitigates such situations.'
18427 minimum: 1
18428 retryExponentialBackoffBase:
18429 type: string
18430 description: The base number of exponential backoff for retries.
18431 pattern: ^\d+(\.[0-9]{0,2})?$
18432 retryForever:
18433 type: boolean
18434 description: If true, plugin will ignore retry_timeout and retry_max_times options and retry flushing forever.
18435 retryMaxInterval:
18436 type: string
18437 description: The maximum interval (seconds) for exponential backoff between retries while failing
18438 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18439 retryMaxTimes:
18440 type: integer
18441 description: 'The maximum number of times to retry to flush the failed chunks. Default: none'
18442 retryRandomize:
18443 type: boolean
18444 description: If true, the output plugin will retry after randomized interval not to do burst retries
18445 retrySecondaryThreshold:
18446 type: string
18447 description: The ratio of retry_timeout to switch to use the secondary while failing.
18448 pattern: ^\d+.?\d+$
18449 retryTimeout:
18450 type: string
18451 description: Retry parameters The maximum time (seconds) to retry to flush again the failed chunks, until the plugin discards the buffer chunks
18452 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18453 retryType:
18454 type: string
18455 description: Output plugin will retry periodically with fixed intervals.
18456 retryWait:
18457 type: string
18458 description: Wait in seconds before the next retry to flush or constant factor of exponential backoff
18459 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18460 tag:
18461 type: string
18462 description: The output plugins group events into chunks. Chunk keys, specified as the argument of <buffer> section, control how to group events into chunks. If tag is empty, which means blank Chunk Keys. Tag also supports Nested Field, combination of Chunk Keys, placeholders, etc. See https://docs.fluentd.org/configuration/buffer-section.
18463 timeFormat:
18464 type: string
18465 description: Process value according to the specified format. This is available only when time_type is string
18466 timeFormatFallbacks:
18467 type: string
18468 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
18469 timeType:
18470 type: string
18471 description: parses/formats value according to this type, default is string
18472 enum:
18473 - float
18474 - unixtime
18475 - string
18476 - mixed
18477 timekey:
18478 type: string
18479 description: Output plugin will flush chunks per specified time (enabled when time is specified in chunk keys)
18480 timekeyWait:
18481 type: string
18482 description: Output plugin will write chunks after timekey_wait seconds later after timekey expiration
18483 timezone:
18484 type: string
18485 description: Uses the specified timezone.
18486 totalLimitSize:
18487 type: string
18488 description: 'The size limitation of this buffer plugin instance Default: 512MB (memory) / 64GB (file)'
18489 pattern: ^\d+(KB|MB|GB|TB)$
18490 utc:
18491 type: boolean
18492 description: If true, uses UTC.
18493 required:
18494 - type
18495 cloudWatch:
18496 type: object
18497 description: out_cloudwatch plugin
18498 properties:
18499 autoCreateStream:
18500 type: boolean
18501 awsEcsAuthentication:
18502 type: boolean
18503 awsKeyId:
18504 type: object
18505 description: Secret defines the key of a value.
18506 properties:
18507 valueFrom:
18508 type: object
18509 description: ValueSource defines how to find a value's key.
18510 properties:
18511 secretKeyRef:
18512 type: object
18513 description: Selects a key of a secret in the pod's namespace
18514 properties:
18515 name:
18516 type: string
18517 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18518 key:
18519 type: string
18520 description: The key of the secret to select from. Must be a valid secret key.
18521 optional:
18522 type: boolean
18523 description: Specify whether the Secret or its key must be defined
18524 required:
18525 - key
18526 x-kubernetes-map-type: atomic
18527 awsSecKey:
18528 type: object
18529 description: Secret defines the key of a value.
18530 properties:
18531 valueFrom:
18532 type: object
18533 description: ValueSource defines how to find a value's key.
18534 properties:
18535 secretKeyRef:
18536 type: object
18537 description: Selects a key of a secret in the pod's namespace
18538 properties:
18539 name:
18540 type: string
18541 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18542 key:
18543 type: string
18544 description: The key of the secret to select from. Must be a valid secret key.
18545 optional:
18546 type: boolean
18547 description: Specify whether the Secret or its key must be defined
18548 required:
18549 - key
18550 x-kubernetes-map-type: atomic
18551 awsStsDurationSeconds:
18552 type: string
18553 awsStsEndpointUrl:
18554 type: string
18555 awsStsExternalId:
18556 type: string
18557 awsStsPolicy:
18558 type: string
18559 awsStsRoleArn:
18560 type: string
18561 awsStsSessionName:
18562 type: string
18563 awsUseSts:
18564 type: boolean
18565 concurrency:
18566 type: integer
18567 durationSeconds:
18568 type: string
18569 endpoint:
18570 type: string
18571 description: Specify an AWS endpoint to send data to.
18572 httpProxy:
18573 type: string
18574 includeTimeKey:
18575 type: boolean
18576 jsonHandler:
18577 type: string
18578 localtime:
18579 type: boolean
18580 logGroupAwsTags:
18581 type: string
18582 logGroupAwsTagsKey:
18583 type: string
18584 logGroupName:
18585 type: string
18586 logGroupNameKey:
18587 type: string
18588 logRejectedRequest:
18589 type: string
18590 logStreamName:
18591 type: string
18592 logStreamNameKey:
18593 type: string
18594 maxEventsPerBatch:
18595 type: string
18596 maxMessageLength:
18597 type: string
18598 messageKeys:
18599 type: string
18600 policy:
18601 type: string
18602 putLogEventsDisableRetryLimit:
18603 type: boolean
18604 putLogEventsRetryLimit:
18605 type: string
18606 putLogEventsRetryWait:
18607 type: string
18608 region:
18609 type: string
18610 description: The AWS region.
18611 removeLogGroupAwsTagsKey:
18612 type: boolean
18613 removeLogGroupNameKey:
18614 type: boolean
18615 removeLogStreamNameKey:
18616 type: boolean
18617 removeRetentionInDaysKey:
18618 type: boolean
18619 retentionInDays:
18620 type: string
18621 retentionInDaysKey:
18622 type: string
18623 roleArn:
18624 type: string
18625 description: ARN of an IAM role to assume (for cross account access).
18626 roleSessionName:
18627 type: string
18628 description: Role Session name
18629 sslVerifyPeer:
18630 type: boolean
18631 useTagAsGroup:
18632 type: string
18633 useTagAsStream:
18634 type: string
18635 webIdentityTokenFile:
18636 type: string
18637 description: Web identity token file
18638 customPlugin:
18639 type: object
18640 description: Custom plugin type
18641 properties:
18642 config:
18643 type: string
18644 required:
18645 - config
18646 datadog:
18647 type: object
18648 description: datadog plugin
18649 properties:
18650 service:
18651 type: string
18652 description: Used by Datadog to correlate between logs, traces and metrics.
18653 port:
18654 type: integer
18655 description: Proxy port when logs are not directly forwarded to Datadog and ssl is not used
18656 format: int32
18657 maximum: 65535
18658 minimum: 1
18659 apiKey:
18660 type: object
18661 description: This parameter is required in order to authenticate your fluent agent.
18662 properties:
18663 valueFrom:
18664 type: object
18665 description: ValueSource defines how to find a value's key.
18666 properties:
18667 secretKeyRef:
18668 type: object
18669 description: Selects a key of a secret in the pod's namespace
18670 properties:
18671 name:
18672 type: string
18673 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18674 key:
18675 type: string
18676 description: The key of the secret to select from. Must be a valid secret key.
18677 optional:
18678 type: boolean
18679 description: Specify whether the Secret or its key must be defined
18680 required:
18681 - key
18682 x-kubernetes-map-type: atomic
18683 compressionLevel:
18684 type: integer
18685 description: Set the log compression level for HTTP (1 to 9, 9 being the best ratio)
18686 format: int32
18687 ddHostname:
18688 type: string
18689 description: Used by Datadog to identify the host submitting the logs.
18690 ddSource:
18691 type: string
18692 description: This tells Datadog what integration it is
18693 ddSourcecategory:
18694 type: string
18695 description: Multiple value attribute. Can be used to refine the source attribute
18696 ddTags:
18697 type: string
18698 description: Custom tags with the following format "key1:value1, key2:value2"
18699 host:
18700 type: string
18701 description: Proxy endpoint when logs are not directly forwarded to Datadog
18702 httpProxy:
18703 type: string
18704 description: HTTP proxy, only takes effect if HTTP forwarding is enabled (use_http). Defaults to HTTP_PROXY/http_proxy env vars.
18705 includeTagKey:
18706 type: boolean
18707 description: Automatically include the Fluentd tag in the record.
18708 maxBackoff:
18709 type: integer
18710 description: The maximum time waited between each retry in seconds
18711 format: int32
18712 maxRetries:
18713 type: integer
18714 description: The number of retries before the output plugin stops. Set to -1 for unlimited retries
18715 format: int32
18716 noSSLValidation:
18717 type: boolean
18718 description: Disable SSL validation (useful for proxy forwarding)
18719 sslPort:
18720 type: integer
18721 description: Port used to send logs over a SSL encrypted connection to Datadog. If use_http is disabled, use 10516 for the US region and 443 for the EU region.
18722 format: int32
18723 maximum: 65535
18724 minimum: 1
18725 tagKey:
18726 type: string
18727 description: Where to store the Fluentd tag.
18728 timestampKey:
18729 type: string
18730 description: Name of the attribute which will contain timestamp of the log event. If nil, timestamp attribute is not added.
18731 useCompression:
18732 type: boolean
18733 description: Enable log compression for HTTP
18734 useHTTP:
18735 type: boolean
18736 description: Enable HTTP forwarding. If you disable it, make sure to change the port to 10514 or ssl_port to 10516
18737 useJson:
18738 type: boolean
18739 description: Event format, if true, the event is sent in json format. Othwerwise, in plain text.
18740 useSSL:
18741 type: boolean
18742 description: If true, the agent initializes a secure connection to Datadog. In clear TCP otherwise.
18743 elasticsearch:
18744 type: object
18745 description: out_es plugin
18746 properties:
18747 port:
18748 type: integer
18749 description: 'The port number of your Elasticsearch node (default: 9200).'
18750 format: int32
18751 maximum: 65535
18752 minimum: 1
18753 host:
18754 type: string
18755 description: 'The hostname of your Elasticsearch node (default: localhost).'
18756 hosts:
18757 type: string
18758 description: Hosts defines a list of hosts if you want to connect to more than one Elasticsearch nodes
18759 indexName:
18760 type: string
18761 description: IndexName defines the placeholder syntax of Fluentd plugin API. See https://docs.fluentd.org/configuration/buffer-section.
18762 logstashFormat:
18763 type: boolean
18764 description: 'If true, Fluentd uses the conventional index name format logstash-%Y.%m.%d (default: false). This option supersedes the index_name option.'
18765 logstashPrefix:
18766 type: string
18767 description: 'LogstashPrefix defines the logstash prefix index name to write events when logstash_format is true (default: logstash).'
18768 password:
18769 type: object
18770 description: Optional, The login credentials to connect to Elasticsearch
18771 properties:
18772 valueFrom:
18773 type: object
18774 description: ValueSource defines how to find a value's key.
18775 properties:
18776 secretKeyRef:
18777 type: object
18778 description: Selects a key of a secret in the pod's namespace
18779 properties:
18780 name:
18781 type: string
18782 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18783 key:
18784 type: string
18785 description: The key of the secret to select from. Must be a valid secret key.
18786 optional:
18787 type: boolean
18788 description: Specify whether the Secret or its key must be defined
18789 required:
18790 - key
18791 x-kubernetes-map-type: atomic
18792 path:
18793 type: string
18794 description: 'Path defines the REST API endpoint of Elasticsearch to post write requests (default: nil).'
18795 scheme:
18796 type: string
18797 description: 'Specify https if your Elasticsearch endpoint supports SSL (default: http).'
18798 user:
18799 type: object
18800 description: Optional, The login credentials to connect to Elasticsearch
18801 properties:
18802 valueFrom:
18803 type: object
18804 description: ValueSource defines how to find a value's key.
18805 properties:
18806 secretKeyRef:
18807 type: object
18808 description: Selects a key of a secret in the pod's namespace
18809 properties:
18810 name:
18811 type: string
18812 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18813 key:
18814 type: string
18815 description: The key of the secret to select from. Must be a valid secret key.
18816 optional:
18817 type: boolean
18818 description: Specify whether the Secret or its key must be defined
18819 required:
18820 - key
18821 x-kubernetes-map-type: atomic
18822 format:
18823 type: object
18824 description: format section
18825 properties:
18826 type:
18827 type: string
18828 description: The @type parameter specifies the type of the plugin.
18829 enum:
18830 - out_file
18831 - json
18832 - ltsv
18833 - csv
18834 - msgpack
18835 - hash
18836 - single_value
18837 delimiter:
18838 type: string
18839 description: Delimiter for each field.
18840 id:
18841 type: string
18842 description: The @id parameter specifies a unique name for the configuration.
18843 localtime:
18844 type: boolean
18845 description: If true, uses local time.
18846 logLevel:
18847 type: string
18848 description: The @log_level parameter specifies the plugin-specific logging level
18849 newline:
18850 type: string
18851 description: Specify newline characters.
18852 enum:
18853 - lf
18854 - crlf
18855 outputTag:
18856 type: boolean
18857 description: Output tag field if true.
18858 outputTime:
18859 type: boolean
18860 description: Output time field if true.
18861 timeFormat:
18862 type: string
18863 description: Process value according to the specified format. This is available only when time_type is string
18864 timeFormatFallbacks:
18865 type: string
18866 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
18867 timeType:
18868 type: string
18869 description: parses/formats value according to this type, default is string
18870 enum:
18871 - float
18872 - unixtime
18873 - string
18874 - mixed
18875 timezone:
18876 type: string
18877 description: Uses the specified timezone.
18878 utc:
18879 type: boolean
18880 description: If true, uses UTC.
18881 forward:
18882 type: object
18883 description: out_forward plugin
18884 properties:
18885 ackResponseTimeout:
18886 type: string
18887 description: This option is used when require_ack_response is true. This default value is based on popular tcp_syn_retries.
18888 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18889 connectTimeout:
18890 type: string
18891 description: The connection timeout for the socket. When the connection is timed out during the connection establishment, Errno::ETIMEDOUT error is raised.
18892 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18893 dnsRoundRobin:
18894 type: boolean
18895 description: Enable client-side DNS round robin. Uniform randomly pick an IP address to send data when a hostname has several IP addresses. heartbeat_type udp is not available with dns_round_robintrue. Use heartbeat_type tcp or heartbeat_type none.
18896 expireDnsCache:
18897 type: string
18898 description: Sets TTL to expire DNS cache in seconds. Set 0 not to use DNS Cache.
18899 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18900 hardTimeout:
18901 type: string
18902 description: The hard timeout used to detect server failure. The default value is equal to the send_timeout parameter.
18903 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18904 heartbeatInterval:
18905 type: string
18906 description: The interval of the heartbeat packer.
18907 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18908 heartbeatType:
18909 type: string
18910 description: Specifies the transport protocol for heartbeats. Set none to disable.
18911 enum:
18912 - transport
18913 - tcp
18914 - udp
18915 - none
18916 ignoreNetworkErrorsAtStartup:
18917 type: boolean
18918 description: Ignores DNS resolution and errors at startup time.
18919 keepalive:
18920 type: boolean
18921 description: Enables the keepalive connection.
18922 keepaliveTimeout:
18923 type: string
18924 description: Timeout for keepalive. Default value is nil which means to keep the connection alive as long as possible.
18925 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18926 phiFailureDetector:
18927 type: boolean
18928 description: Use the "Phi accrual failure detector" to detect server failure.
18929 phiThreshold:
18930 type: integer
18931 description: The threshold parameter used to detect server faults.
18932 recoverWait:
18933 type: string
18934 description: The wait time before accepting a server fault recovery.
18935 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
18936 requireAckResponse:
18937 type: boolean
18938 description: Changes the protocol to at-least-once. The plugin waits the ack from destination's in_forward plugin.
18939 security:
18940 type: object
18941 description: ServiceDiscovery defines the security section
18942 properties:
18943 allowAnonymousSource:
18944 type: string
18945 description: Allows the anonymous source. <client> sections are required, if disabled.
18946 selfHostname:
18947 type: string
18948 description: The hostname.
18949 sharedKey:
18950 type: string
18951 description: The shared key for authentication.
18952 user:
18953 type: object
18954 description: Defines user section directly.
18955 properties:
18956 password:
18957 type: object
18958 description: Secret defines the key of a value.
18959 properties:
18960 valueFrom:
18961 type: object
18962 description: ValueSource defines how to find a value's key.
18963 properties:
18964 secretKeyRef:
18965 type: object
18966 description: Selects a key of a secret in the pod's namespace
18967 properties:
18968 name:
18969 type: string
18970 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18971 key:
18972 type: string
18973 description: The key of the secret to select from. Must be a valid secret key.
18974 optional:
18975 type: boolean
18976 description: Specify whether the Secret or its key must be defined
18977 required:
18978 - key
18979 x-kubernetes-map-type: atomic
18980 username:
18981 type: object
18982 description: Secret defines the key of a value.
18983 properties:
18984 valueFrom:
18985 type: object
18986 description: ValueSource defines how to find a value's key.
18987 properties:
18988 secretKeyRef:
18989 type: object
18990 description: Selects a key of a secret in the pod's namespace
18991 properties:
18992 name:
18993 type: string
18994 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
18995 key:
18996 type: string
18997 description: The key of the secret to select from. Must be a valid secret key.
18998 optional:
18999 type: boolean
19000 description: Specify whether the Secret or its key must be defined
19001 required:
19002 - key
19003 x-kubernetes-map-type: atomic
19004 userAuth:
19005 type: string
19006 description: If true, user-based authentication is used.
19007 sendTimeout:
19008 type: string
19009 description: The timeout time when sending event logs.
19010 pattern: ^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
19011 servers:
19012 type: array
19013 description: Servers defines the servers section, at least one is required
19014 items:
19015 type: object
19016 description: Server defines the common parameters for the server plugin
19017 properties:
19018 name:
19019 type: string
19020 description: Name defines the name of the server. Used for logging and certificate verification in TLS transport (when the host is the address).
19021 type:
19022 type: string
19023 description: The @type parameter specifies the type of the plugin.
19024 port:
19025 type: string
19026 description: Port defines the port number of the host. Note that both TCP packets (event stream) and UDP packets (heartbeat messages) are sent to this port.
19027 host:
19028 type: string
19029 description: Host defines the IP address or host name of the server.
19030 id:
19031 type: string
19032 description: The @id parameter specifies a unique name for the configuration.
19033 logLevel:
19034 type: string
19035 description: The @log_level parameter specifies the plugin-specific logging level
19036 password:
19037 type: object
19038 description: Password defines the password for authentication.
19039 properties:
19040 valueFrom:
19041 type: object
19042 description: ValueSource defines how to find a value's key.
19043 properties:
19044 secretKeyRef:
19045 type: object
19046 description: Selects a key of a secret in the pod's namespace
19047 properties:
19048 name:
19049 type: string
19050 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19051 key:
19052 type: string
19053 description: The key of the secret to select from. Must be a valid secret key.
19054 optional:
19055 type: boolean
19056 description: Specify whether the Secret or its key must be defined
19057 required:
19058 - key
19059 x-kubernetes-map-type: atomic
19060 sharedKey:
19061 type: string
19062 description: SharedKey defines the shared key per server.
19063 standby:
19064 type: string
19065 description: Standby marks a node as the standby node for an Active-Standby model between Fluentd nodes.
19066 username:
19067 type: object
19068 description: Username defines the username for authentication.
19069 properties:
19070 valueFrom:
19071 type: object
19072 description: ValueSource defines how to find a value's key.
19073 properties:
19074 secretKeyRef:
19075 type: object
19076 description: Selects a key of a secret in the pod's namespace
19077 properties:
19078 name:
19079 type: string
19080 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19081 key:
19082 type: string
19083 description: The key of the secret to select from. Must be a valid secret key.
19084 optional:
19085 type: boolean
19086 description: Specify whether the Secret or its key must be defined
19087 required:
19088 - key
19089 x-kubernetes-map-type: atomic
19090 weight:
19091 type: string
19092 description: Weight defines the load balancing weight
19093 serviceDiscovery:
19094 type: object
19095 description: ServiceDiscovery defines the service_discovery section
19096 properties:
19097 type:
19098 type: string
19099 description: The @type parameter specifies the type of the plugin.
19100 enum:
19101 - static
19102 - file
19103 - srv
19104 service:
19105 type: string
19106 description: Service without the underscore in RFC2782.
19107 hostname:
19108 type: string
19109 description: The name in RFC2782.
19110 confEncoding:
19111 type: string
19112 description: The encoding of the configuration file.
19113 dnsLookup:
19114 type: string
19115 description: DnsLookup resolves the hostname to IP address of the SRV's Target.
19116 dnsServerHost:
19117 type: string
19118 description: DnsServerHost defines the hostname of the DNS server to request the SRV record.
19119 id:
19120 type: string
19121 description: The @id parameter specifies a unique name for the configuration.
19122 interval:
19123 type: string
19124 description: Interval defines the interval of sending requests to DNS server.
19125 logLevel:
19126 type: string
19127 description: The @log_level parameter specifies the plugin-specific logging level
19128 path:
19129 type: string
19130 description: The path of the target list. Default is '/etc/fluent/sd.yaml'
19131 proto:
19132 type: string
19133 description: Proto without the underscore in RFC2782.
19134 server:
19135 type: object
19136 description: The server section of this plugin
19137 properties:
19138 name:
19139 type: string
19140 description: Name defines the name of the server. Used for logging and certificate verification in TLS transport (when the host is the address).
19141 type:
19142 type: string
19143 description: The @type parameter specifies the type of the plugin.
19144 port:
19145 type: string
19146 description: Port defines the port number of the host. Note that both TCP packets (event stream) and UDP packets (heartbeat messages) are sent to this port.
19147 host:
19148 type: string
19149 description: Host defines the IP address or host name of the server.
19150 id:
19151 type: string
19152 description: The @id parameter specifies a unique name for the configuration.
19153 logLevel:
19154 type: string
19155 description: The @log_level parameter specifies the plugin-specific logging level
19156 password:
19157 type: object
19158 description: Password defines the password for authentication.
19159 properties:
19160 valueFrom:
19161 type: object
19162 description: ValueSource defines how to find a value's key.
19163 properties:
19164 secretKeyRef:
19165 type: object
19166 description: Selects a key of a secret in the pod's namespace
19167 properties:
19168 name:
19169 type: string
19170 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19171 key:
19172 type: string
19173 description: The key of the secret to select from. Must be a valid secret key.
19174 optional:
19175 type: boolean
19176 description: Specify whether the Secret or its key must be defined
19177 required:
19178 - key
19179 x-kubernetes-map-type: atomic
19180 sharedKey:
19181 type: string
19182 description: SharedKey defines the shared key per server.
19183 standby:
19184 type: string
19185 description: Standby marks a node as the standby node for an Active-Standby model between Fluentd nodes.
19186 username:
19187 type: object
19188 description: Username defines the username for authentication.
19189 properties:
19190 valueFrom:
19191 type: object
19192 description: ValueSource defines how to find a value's key.
19193 properties:
19194 secretKeyRef:
19195 type: object
19196 description: Selects a key of a secret in the pod's namespace
19197 properties:
19198 name:
19199 type: string
19200 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19201 key:
19202 type: string
19203 description: The key of the secret to select from. Must be a valid secret key.
19204 optional:
19205 type: boolean
19206 description: Specify whether the Secret or its key must be defined
19207 required:
19208 - key
19209 x-kubernetes-map-type: atomic
19210 weight:
19211 type: string
19212 description: Weight defines the load balancing weight
19213 required:
19214 - type
19215 tlsAllowSelfSignedCert:
19216 type: boolean
19217 description: Allows self-signed certificates or not.
19218 tlsCertLogicalStoreName:
19219 type: string
19220 description: The certificate logical store name on Windows system certstore. This parameter is for Windows only.
19221 tlsCertPath:
19222 type: string
19223 description: The additional CA certificate path for TLS.
19224 tlsCertThumbprint:
19225 type: string
19226 description: The certificate thumbprint for searching from Windows system certstore. This parameter is for Windows only.
19227 tlsCertUseEnterpriseStore:
19228 type: boolean
19229 description: Enables the certificate enterprise store on Windows system certstore. This parameter is for Windows only.
19230 tlsCiphers:
19231 type: string
19232 description: The cipher configuration of TLS transport.
19233 tlsClientCertPath:
19234 type: string
19235 description: The client certificate path for TLS.
19236 tlsClientPrivateKeyPassphrase:
19237 type: string
19238 description: The TLS private key passphrase for the client.
19239 tlsClientPrivateKeyPath:
19240 type: string
19241 description: The client private key path for TLS.
19242 tlsInsecureMode:
19243 type: boolean
19244 description: Skips all verification of certificates or not.
19245 tlsVerifyHostname:
19246 type: boolean
19247 description: Verifies hostname of servers and certificates or not in TLS transport.
19248 tlsVersion:
19249 type: string
19250 description: The default version of TLS transport.
19251 enum:
19252 - TLSv1_1
19253 - TLSv1_2
19254 verifyConnectionAtStartup:
19255 type: boolean
19256 description: Verify that a connection can be made with one of out_forward nodes at the time of startup.
19257 required:
19258 - servers
19259 http:
19260 type: object
19261 description: out_http plugin
19262 properties:
19263 auth:
19264 type: object
19265 description: Auth section for this plugin
19266 properties:
19267 auth:
19268 type: string
19269 description: The method for HTTP authentication. Now only basic.
19270 password:
19271 type: object
19272 description: The password for basic authentication.
19273 properties:
19274 valueFrom:
19275 type: object
19276 description: ValueSource defines how to find a value's key.
19277 properties:
19278 secretKeyRef:
19279 type: object
19280 description: Selects a key of a secret in the pod's namespace
19281 properties:
19282 name:
19283 type: string
19284 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19285 key:
19286 type: string
19287 description: The key of the secret to select from. Must be a valid secret key.
19288 optional:
19289 type: boolean
19290 description: Specify whether the Secret or its key must be defined
19291 required:
19292 - key
19293 x-kubernetes-map-type: atomic
19294 username:
19295 type: object
19296 description: The username for basic authentication.
19297 properties:
19298 valueFrom:
19299 type: object
19300 description: ValueSource defines how to find a value's key.
19301 properties:
19302 secretKeyRef:
19303 type: object
19304 description: Selects a key of a secret in the pod's namespace
19305 properties:
19306 name:
19307 type: string
19308 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19309 key:
19310 type: string
19311 description: The key of the secret to select from. Must be a valid secret key.
19312 optional:
19313 type: boolean
19314 description: Specify whether the Secret or its key must be defined
19315 required:
19316 - key
19317 x-kubernetes-map-type: atomic
19318 contentType:
19319 type: string
19320 description: ContentType defines Content-Type for HTTP request. out_http automatically set Content-Type for built-in formatters when this parameter is not specified.
19321 endpoint:
19322 type: string
19323 description: Endpoint defines the endpoint for HTTP request. If you want to use HTTPS, use https prefix.
19324 errorResponseAsUnrecoverable:
19325 type: boolean
19326 description: Raise UnrecoverableError when the response code is not SUCCESS.
19327 headers:
19328 type: string
19329 description: Headers defines the additional headers for HTTP request.
19330 headersFromPlaceholders:
19331 type: string
19332 description: Additional placeholder based headers for HTTP request. If you want to use tag or record field, use this parameter instead of headers.
19333 httpMethod:
19334 type: string
19335 description: HttpMethod defines the method for HTTP request.
19336 enum:
19337 - post
19338 - put
19339 jsonArray:
19340 type: boolean
19341 description: JsonArray defines whether to use the array format of JSON or not
19342 openTimeout:
19343 type: integer
19344 description: OpenTimeout defines the connection open timeout in seconds.
19345 proxy:
19346 type: string
19347 description: Proxy defines the proxy for HTTP request.
19348 readTimeout:
19349 type: integer
19350 description: ReadTimeout defines the read timeout in seconds.
19351 retryableResponseCodes:
19352 type: string
19353 description: The list of retryable response codes. If the response code is included in this list, out_http retries the buffer flush.
19354 sslTimeout:
19355 type: integer
19356 description: SslTimeout defines the TLS timeout in seconds.
19357 tlsCaCertPath:
19358 type: string
19359 description: TlsCaCertPath defines the CA certificate path for TLS.
19360 tlsCiphers:
19361 type: string
19362 description: TlsCiphers defines the cipher suites configuration of TLS.
19363 tlsClientCertPath:
19364 type: string
19365 description: TlsClientCertPath defines the client certificate path for TLS.
19366 tlsPrivateKeyPassphrase:
19367 type: string
19368 description: TlsPrivateKeyPassphrase defines the client private key passphrase for TLS.
19369 tlsPrivateKeyPath:
19370 type: string
19371 description: TlsPrivateKeyPath defines the client private key path for TLS.
19372 tlsVerifyMode:
19373 type: string
19374 description: TlsVerifyMode defines the verify mode of TLS.
19375 enum:
19376 - peer
19377 - none
19378 tlsVersion:
19379 type: string
19380 description: TlsVersion defines the default version of TLS transport.
19381 enum:
19382 - TLSv1_1
19383 - TLSv1_2
19384 inject:
19385 type: object
19386 description: inject section
19387 properties:
19388 hostname:
19389 type: string
19390 description: Hostname value
19391 hostnameKey:
19392 type: string
19393 description: The field name to inject hostname
19394 inline:
19395 type: object
19396 description: Time section
19397 properties:
19398 localtime:
19399 type: boolean
19400 description: If true, uses local time.
19401 timeFormat:
19402 type: string
19403 description: Process value according to the specified format. This is available only when time_type is string
19404 timeFormatFallbacks:
19405 type: string
19406 description: Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
19407 timeType:
19408 type: string
19409 description: parses/formats value according to this type, default is string
19410 enum:
19411 - float
19412 - unixtime
19413 - string
19414 - mixed
19415 timezone:
19416 type: string
19417 description: Uses the specified timezone.
19418 utc:
19419 type: boolean
19420 description: If true, uses UTC.
19421 tagKey:
19422 type: string
19423 description: The field name to inject tag
19424 timeKey:
19425 type: string
19426 description: The field name to inject time
19427 workerIdKey:
19428 type: string
19429 description: The field name to inject worker_id
19430 kafka:
19431 type: object
19432 description: out_kafka plugin
19433 properties:
19434 brokers:
19435 type: string
19436 description: 'The list of all seed brokers, with their host and port information. Default: localhost:9092'
19437 compressionCodec:
19438 type: string
19439 description: 'The codec the producer uses to compress messages (default: nil).'
19440 enum:
19441 - gzip
19442 - snappy
19443 defaultTopic:
19444 type: string
19445 description: 'The name of the default topic. (default: nil)'
19446 requiredAcks:
19447 type: integer
19448 description: The number of acks required per request.
19449 topicKey:
19450 type: string
19451 description: The field name for the target topic. If the field value is app, this plugin writes events to the app topic.
19452 useEventTime:
19453 type: boolean
19454 description: Set fluentd event time to Kafka's CreateTime.
19455 logLevel:
19456 type: string
19457 description: The @log_level parameter specifies the plugin-specific logging level
19458 loki:
19459 type: object
19460 description: out_loki plugin
19461 properties:
19462 labels:
19463 type: array
19464 description: Stream labels for API request. It can be multiple comma separated of strings specifying key=value pairs. In addition to fixed parameters, it also allows to add custom record keys (similar to label_keys property).
19465 items:
19466 type: string
19467 dropSingleKey:
19468 type: boolean
19469 description: If a record only has 1 key, then just set the log line to the value and discard the key.
19470 extractKubernetesLabels:
19471 type: boolean
19472 description: If set to true, it will add all Kubernetes labels to the Stream labels.
19473 httpPassword:
19474 type: object
19475 description: Password for user defined in HTTP_User Set HTTP basic authentication password
19476 properties:
19477 valueFrom:
19478 type: object
19479 description: ValueSource defines how to find a value's key.
19480 properties:
19481 secretKeyRef:
19482 type: object
19483 description: Selects a key of a secret in the pod's namespace
19484 properties:
19485 name:
19486 type: string
19487 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19488 key:
19489 type: string
19490 description: The key of the secret to select from. Must be a valid secret key.
19491 optional:
19492 type: boolean
19493 description: Specify whether the Secret or its key must be defined
19494 required:
19495 - key
19496 x-kubernetes-map-type: atomic
19497 httpUser:
19498 type: object
19499 description: Set HTTP basic authentication user name.
19500 properties:
19501 valueFrom:
19502 type: object
19503 description: ValueSource defines how to find a value's key.
19504 properties:
19505 secretKeyRef:
19506 type: object
19507 description: Selects a key of a secret in the pod's namespace
19508 properties:
19509 name:
19510 type: string
19511 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19512 key:
19513 type: string
19514 description: The key of the secret to select from. Must be a valid secret key.
19515 optional:
19516 type: boolean
19517 description: Specify whether the Secret or its key must be defined
19518 required:
19519 - key
19520 x-kubernetes-map-type: atomic
19521 includeThreadLabel:
19522 type: boolean
19523 description: Whether or not to include the fluentd_thread label when multiple threads are used for flushing
19524 insecure:
19525 type: boolean
19526 description: Disable certificate validation
19527 labelKeys:
19528 type: array
19529 description: Optional list of record keys that will be placed as stream labels. This configuration property is for records key only.
19530 items:
19531 type: string
19532 lineFormat:
19533 type: string
19534 description: Format to use when flattening the record to a log line. Valid values are json or key_value. If set to json, the log line sent to Loki will be the Fluentd record dumped as JSON. If set to key_value, the log line will be each item in the record concatenated together (separated by a single space) in the format.
19535 enum:
19536 - json
19537 - key_value
19538 removeKeys:
19539 type: array
19540 description: Optional list of record keys that will be removed from stream labels. This configuration property is for records key only.
19541 items:
19542 type: string
19543 tenantID:
19544 type: object
19545 description: Tenant ID used by default to push logs to Loki. If omitted or empty it assumes Loki is running in single-tenant mode and no X-Scope-OrgID header is sent.
19546 properties:
19547 valueFrom:
19548 type: object
19549 description: ValueSource defines how to find a value's key.
19550 properties:
19551 secretKeyRef:
19552 type: object
19553 description: Selects a key of a secret in the pod's namespace
19554 properties:
19555 name:
19556 type: string
19557 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19558 key:
19559 type: string
19560 description: The key of the secret to select from. Must be a valid secret key.
19561 optional:
19562 type: boolean
19563 description: Specify whether the Secret or its key must be defined
19564 required:
19565 - key
19566 x-kubernetes-map-type: atomic
19567 tlsCaCertFile:
19568 type: string
19569 description: TlsCaCert defines the CA certificate file for TLS.
19570 tlsClientCertFile:
19571 type: string
19572 description: TlsClientCert defines the client certificate file for TLS.
19573 tlsPrivateKeyFile:
19574 type: string
19575 description: TlsPrivateKey defines the client private key file for TLS.
19576 url:
19577 type: string
19578 description: Loki URL.
19579 required:
19580 - url
19581 opensearch:
19582 type: object
19583 description: out_opensearch plugin
19584 properties:
19585 port:
19586 type: integer
19587 description: 'The port number of your Opensearch node (default: 9200).'
19588 format: int32
19589 maximum: 65535
19590 minimum: 1
19591 host:
19592 type: string
19593 description: 'The hostname of your Opensearch node (default: localhost).'
19594 hosts:
19595 type: string
19596 description: Hosts defines a list of hosts if you want to connect to more than one Openearch nodes
19597 indexName:
19598 type: string
19599 description: IndexName defines the placeholder syntax of Fluentd plugin API. See https://docs.fluentd.org/configuration/buffer-section.
19600 logstashFormat:
19601 type: boolean
19602 description: 'If true, Fluentd uses the conventional index name format logstash-%Y.%m.%d (default: false). This option supersedes the index_name option.'
19603 logstashPrefix:
19604 type: string
19605 description: 'LogstashPrefix defines the logstash prefix index name to write events when logstash_format is true (default: logstash).'
19606 password:
19607 type: object
19608 description: Optional, The login credentials to connect to Opensearch
19609 properties:
19610 valueFrom:
19611 type: object
19612 description: ValueSource defines how to find a value's key.
19613 properties:
19614 secretKeyRef:
19615 type: object
19616 description: Selects a key of a secret in the pod's namespace
19617 properties:
19618 name:
19619 type: string
19620 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19621 key:
19622 type: string
19623 description: The key of the secret to select from. Must be a valid secret key.
19624 optional:
19625 type: boolean
19626 description: Specify whether the Secret or its key must be defined
19627 required:
19628 - key
19629 x-kubernetes-map-type: atomic
19630 path:
19631 type: string
19632 description: 'Path defines the REST API endpoint of Opensearch to post write requests (default: nil).'
19633 scheme:
19634 type: string
19635 description: 'Specify https if your Opensearch endpoint supports SSL (default: http).'
19636 user:
19637 type: object
19638 description: Optional, The login credentials to connect to Opensearch
19639 properties:
19640 valueFrom:
19641 type: object
19642 description: ValueSource defines how to find a value's key.
19643 properties:
19644 secretKeyRef:
19645 type: object
19646 description: Selects a key of a secret in the pod's namespace
19647 properties:
19648 name:
19649 type: string
19650 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
19651 key:
19652 type: string
19653 description: The key of the secret to select from. Must be a valid secret key.
19654 optional:
19655 type: boolean
19656 description: Specify whether the Secret or its key must be defined
19657 required:
19658 - key
19659 x-kubernetes-map-type: atomic
19660 s3:
19661 type: object
19662 description: out_s3 plugin
19663 properties:
19664 awsKeyId:
19665 type: string
19666 description: The AWS access key id.
19667 awsSecKey:
19668 type: string
19669 description: The AWS secret key.
19670 path:
19671 type: string
19672 description: The path prefix of the files on S3.
19673 proxyUri:
19674 type: string
19675 description: The proxy URL.
19676 s3Bucket:
19677 type: string
19678 description: The Amazon S3 bucket name.
19679 s3ObjectKeyFormat:
19680 type: string
19681 description: The actual S3 path. This is interpolated to the actual path.
19682 s3Region:
19683 type: string
19684 description: The Amazon S3 region name
19685 sslVerifyPeer:
19686 type: boolean
19687 description: Verify the SSL certificate of the endpoint.
19688 storeAs:
19689 type: string
19690 description: The compression type.
19691 enum:
19692 - gzip
19693 - lzo
19694 - json
19695 - txt
19696 stdout:
19697 type: object
19698 description: out_stdout plugin
19699 tag:
19700 type: string
19701 description: Which tag to be matched.
19702 status:
19703 type: object
19704 description: OutputStatus defines the observed state of Output
19705 served: true
19706 storage: true
19707 subresources:
19708 status: {}
19709---
19710apiVersion: apiextensions.k8s.io/v1
19711kind: CustomResourceDefinition
19712metadata:
19713 name: parsers.fluentbit.fluent.io
19714 annotations:
19715 controller-gen.kubebuilder.io/version: v0.11.3
19716 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
19717 pallet.edge.ncr.com/name: fluent-operator
19718 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
19719 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
19720 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
19721 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
19722spec:
19723 group: fluentbit.fluent.io
19724 names:
19725 kind: Parser
19726 listKind: ParserList
19727 plural: parsers
19728 shortNames:
19729 - fbp
19730 singular: parser
19731 scope: Namespaced
19732 versions:
19733 - name: v1alpha2
19734 schema:
19735 openAPIV3Schema:
19736 type: object
19737 description: Parser is the Schema for namespace level parser API
19738 properties:
19739 apiVersion:
19740 type: string
19741 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'
19742 kind:
19743 type: string
19744 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'
19745 metadata:
19746 type: object
19747 spec:
19748 type: object
19749 description: ParserSpec defines the desired state of ClusterParser
19750 properties:
19751 decoders:
19752 type: array
19753 description: 'Decoders are a built-in feature available through the Parsers file, each Parser definition can optionally set one or multiple decoders. There are two type of decoders type: Decode_Field and Decode_Field_As.'
19754 items:
19755 type: object
19756 properties:
19757 decodeField:
19758 type: string
19759 description: If the content can be decoded in a structured message, append that structure message (keys and values) to the original log message.
19760 decodeFieldAs:
19761 type: string
19762 description: Any content decoded (unstructured or structured) will be replaced in the same key/value, no extra keys are added.
19763 json:
19764 type: object
19765 description: JSON defines json parser configuration.
19766 properties:
19767 timeFormat:
19768 type: string
19769 description: Time_Format, eg. %Y-%m-%dT%H:%M:%S %z
19770 timeKeep:
19771 type: boolean
19772 description: Time_Keep
19773 timeKey:
19774 type: string
19775 description: Time_Key
19776 logfmt:
19777 type: object
19778 description: Logfmt defines logfmt parser configuration.
19779 ltsv:
19780 type: object
19781 description: LTSV defines ltsv parser configuration.
19782 properties:
19783 timeFormat:
19784 type: string
19785 description: Time_Format, eg. %Y-%m-%dT%H:%M:%S %z
19786 timeKeep:
19787 type: boolean
19788 description: Time_Keep
19789 timeKey:
19790 type: string
19791 description: Time_Key
19792 types:
19793 type: string
19794 regex:
19795 type: object
19796 description: Regex defines regex parser configuration.
19797 properties:
19798 regex:
19799 type: string
19800 timeFormat:
19801 type: string
19802 description: Time_Format, eg. %Y-%m-%dT%H:%M:%S %z
19803 timeKeep:
19804 type: boolean
19805 description: Time_Keep
19806 timeKey:
19807 type: string
19808 description: Time_Key
19809 timeOffset:
19810 type: string
19811 description: Time_Offset, eg. +0200
19812 types:
19813 type: string
19814 served: true
19815 storage: true
19816---
19817apiVersion: v1
19818kind: ServiceAccount
19819metadata:
19820 name: fluent-operator
19821 namespace: fluent-operator
19822 labels:
19823 app.kubernetes.io/component: operator
19824 app.kubernetes.io/name: fluent-operator
19825 annotations:
19826 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
19827 pallet.edge.ncr.com/name: fluent-operator
19828 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
19829 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
19830 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
19831 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
19832---
19833apiVersion: rbac.authorization.k8s.io/v1
19834kind: ClusterRole
19835metadata:
19836 name: fluent-operator
19837 labels:
19838 app.kubernetes.io/component: controller
19839 app.kubernetes.io/name: fluent-operator
19840 annotations:
19841 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
19842 pallet.edge.ncr.com/name: fluent-operator
19843 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
19844 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
19845 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
19846 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
19847rules:
19848- resources:
19849 - daemonsets
19850 - statefulsets
19851 apiGroups:
19852 - apps
19853 verbs:
19854 - create
19855 - delete
19856 - get
19857 - list
19858 - patch
19859 - update
19860 - watch
19861- resources:
19862 - pods
19863 apiGroups:
19864 - ""
19865 verbs:
19866 - get
19867- resources:
19868 - secrets
19869 - configmaps
19870 - serviceaccounts
19871 - configmaps
19872 - services
19873 - namespaces
19874 apiGroups:
19875 - ""
19876 verbs:
19877 - create
19878 - delete
19879 - get
19880 - list
19881 - patch
19882 - update
19883 - watch
19884- resources:
19885 - collectors
19886 - fluentbits
19887 - clusterfluentbitconfigs
19888 - clusterfilters
19889 - clusterinputs
19890 - clusteroutputs
19891 - clusterparsers
19892 - fluentbitconfigs
19893 - filters
19894 - outputs
19895 - parsers
19896 apiGroups:
19897 - fluentbit.fluent.io
19898 verbs:
19899 - create
19900 - delete
19901 - get
19902 - list
19903 - patch
19904 - update
19905 - watch
19906- resources:
19907 - fluentds
19908 - fluentds/status
19909 - clusterfluentdconfigs
19910 - clusterfluentdconfigs/status
19911 - fluentdconfigs
19912 - fluentdconfigs/status
19913 - clusterfilters
19914 - filters
19915 - clusteroutputs
19916 - outputs
19917 apiGroups:
19918 - fluentd.fluent.io
19919 verbs:
19920 - create
19921 - delete
19922 - get
19923 - list
19924 - patch
19925 - update
19926 - watch
19927- resources:
19928 - clusterrolebindings
19929 apiGroups:
19930 - rbac.authorization.k8s.io
19931 verbs:
19932 - create
19933 - list
19934 - get
19935 - watch
19936 - patch
19937- resources:
19938 - clusterroles
19939 apiGroups:
19940 - rbac.authorization.k8s.io
19941 verbs:
19942 - create
19943 - list
19944 - get
19945 - watch
19946 - patch
19947---
19948apiVersion: rbac.authorization.k8s.io/v1
19949kind: ClusterRoleBinding
19950metadata:
19951 name: fluent-operator
19952 labels:
19953 app.kubernetes.io/component: controller
19954 app.kubernetes.io/name: fluent-operator
19955 annotations:
19956 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
19957 pallet.edge.ncr.com/name: fluent-operator
19958 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
19959 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
19960 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
19961 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
19962roleRef:
19963 name: fluent-operator
19964 kind: ClusterRole
19965 apiGroup: rbac.authorization.k8s.io
19966subjects:
19967- name: fluent-operator
19968 namespace: fluent-operator
19969 kind: ServiceAccount
19970---
19971apiVersion: apps/v1
19972kind: Deployment
19973metadata:
19974 labels:
19975 app.kubernetes.io/component: operator
19976 app.kubernetes.io/name: fluent-operator
19977 name: fluent-operator
19978 namespace: fluent-operator
19979 annotations:
19980 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
19981 pallet.edge.ncr.com/name: fluent-operator
19982 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
19983 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
19984 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
19985 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
19986spec:
19987 selector:
19988 matchLabels:
19989 app.kubernetes.io/component: operator
19990 app.kubernetes.io/name: fluent-operator
19991 template:
19992 metadata:
19993 labels:
19994 app.kubernetes.io/component: operator
19995 app.kubernetes.io/name: fluent-operator
19996 annotations:
19997 pallet.edge.ncr.com/created: "2023-02-16T21:26:39Z"
19998 pallet.edge.ncr.com/name: fluent-operator
19999 pallet.edge.ncr.com/revision: 696897a3df910b6e84a88c9336907a17b18159c1
20000 pallet.edge.ncr.com/source: https://github.com/ncrvoyix-swt-retail/edge-infra/tree/696897a3df910b6e84a88c9336907a17b18159c1
20001 pallet.edge.ncr.com/team: '@ncrvoyix-swt-retail/edge-logging'
20002 pallet.edge.ncr.com/version: 7.7.7-rc.1676582799+commit.696897a
20003 spec:
20004 containers:
20005 - env:
20006 - name: NAMESPACE
20007 valueFrom:
20008 fieldRef:
20009 apiVersion: v1
20010 fieldPath: metadata.namespace
20011 image: us-east1-docker.pkg.dev/ret-edge-pltf-infra/thirdparty/kubesphere/fluent-operator@sha256:b28a05735624d2212a663fda3b185464ea8250a361b260551beaccdca57138ba
20012 name: fluent-operator
20013 ports:
20014 - containerPort: 8080
20015 name: metrics
20016 protocol: TCP
20017 resources:
20018 limits:
20019 cpu: 200m
20020 memory: 60Mi
20021 requests:
20022 cpu: 100m
20023 memory: 20Mi
20024 volumeMounts:
20025 - mountPath: /fluent-operator
20026 name: env
20027 initContainers: []
20028 serviceAccountName: fluent-operator
20029 volumes:
20030 - hostPath:
20031 path: /var/run/docker.sock
20032 name: dockersock
View as plain text