/
logging.openshift.io_clusterloggings.yaml
1582 lines (1582 loc) · 87.7 KB
/
logging.openshift.io_clusterloggings.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.9.2
creationTimestamp: null
name: clusterloggings.logging.openshift.io
spec:
group: logging.openshift.io
names:
categories:
- logging
kind: ClusterLogging
listKind: ClusterLoggingList
plural: clusterloggings
shortNames:
- cl
singular: clusterlogging
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .spec.managementState
name: Management State
type: string
name: v1
schema:
openAPIV3Schema:
description: A Red Hat OpenShift Logging instance. ClusterLogging is the Schema
for the clusterloggings API
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: Specification of the desired behavior of ClusterLogging
properties:
collection:
description: Specification of the Collection component for the cluster
nullable: true
properties:
fluentd:
description: Fluentd represents the configuration for forwarders
of type fluentd.
nullable: true
properties:
buffer:
description: "FluentdBufferSpec represents a subset of fluentd
buffer parameters to tune the buffer configuration for all
fluentd outputs. It supports a subset of parameters to configure
buffer and queue sizing, flush operations and retry flushing.
\n For general parameters refer to: https://docs.fluentd.org/configuration/buffer-section#buffering-parameters
\n For flush parameters refer to: https://docs.fluentd.org/configuration/buffer-section#flushing-parameters
\n For retry parameters refer to: https://docs.fluentd.org/configuration/buffer-section#retries-parameters"
properties:
chunkLimitSize:
description: ChunkLimitSize represents the maximum size
of each chunk. Events will be written into chunks until
the size of chunks become this size.
pattern: ^([0-9]+)([kmgtKMGT]{0,1})$
type: string
flushInterval:
description: 'FlushInterval represents the time duration
to wait between two consecutive flush operations. Takes
only effect used together with `flushMode: interval`.'
pattern: ^([0-9]+)([smhd]{0,1})$
type: string
flushMode:
description: FlushMode represents the mode of the flushing
thread to write chunks. The mode allows lazy (if `time`
parameter set), per interval or immediate flushing.
enum:
- lazy
- interval
- immediate
type: string
flushThreadCount:
description: FlushThreadCount reprents the number of threads
used by the fluentd buffer plugin to flush/write chunks
in parallel.
format: int32
type: integer
overflowAction:
description: 'OverflowAction represents the action for
the fluentd buffer plugin to execute when a buffer queue
is full. (Default: block)'
enum:
- throw_exception
- block
- drop_oldest_chunk
type: string
retryMaxInterval:
description: 'RetryMaxInterval represents the maximum
time interval for exponential backoff between retries.
Takes only effect if used together with `retryType:
exponential_backoff`.'
pattern: ^([0-9]+)([smhd]{0,1})$
type: string
retryTimeout:
description: RetryTimeout represents the maximum time
interval to attempt retries before giving up and the
record is disguarded. If unspecified, the default will
be used
pattern: ^([0-9]+)([smhd]{0,1})$
type: string
retryType:
description: RetryType represents the type of retrying
flush operations. Flush operations can be retried either
periodically or by applying exponential backoff.
enum:
- exponential_backoff
- periodic
type: string
retryWait:
description: RetryWait represents the time duration between
two consecutive retries to flush buffers for periodic
retries or a constant factor of time on retries with
exponential backoff.
pattern: ^([0-9]+)([smhd]{0,1})$
type: string
totalLimitSize:
description: TotalLimitSize represents the threshold of
node space allowed per fluentd buffer to allocate. Once
this threshold is reached, all append operations will
fail with error (and data will be lost).
pattern: ^([0-9]+)([kmgtKMGT]{0,1})$
type: string
type: object
inFile:
description: "FluentdInFileSpec represents a subset of fluentd
in-tail plugin parameters to tune the configuration for
all fluentd in-tail inputs. \n For general parameters refer
to: https://docs.fluentd.org/input/tail#parameters"
properties:
readLinesLimit:
description: ReadLinesLimit represents the number of lines
to read with each I/O operation
type: integer
type: object
type: object
logs:
description: Deprecated. Specification of Log Collection for the
cluster See spec.collection
nullable: true
properties:
fluentd:
description: Specification of the Fluentd Log Collection component
properties:
nodeSelector:
additionalProperties:
type: string
description: Define which Nodes the Pods are scheduled
on.
nullable: true
type: object
resources:
description: The resource requirements for the collector
nullable: true
properties:
claims:
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."
items:
description: ResourceClaim references one entry
in PodSpec.ResourceClaims.
properties:
name:
description: Name must match the name of one
entry in pod.spec.resourceClaims of the Pod
where this field is used. It makes that resource
available inside a container.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount
of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Requests describes the minimum amount
of compute resources required. If Requests is omitted
for a container, it defaults to Limits if that is
explicitly specified, otherwise to an implementation-defined
value. Requests cannot exceed Limits. More info:
https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
tolerations:
description: Define the tolerations the Pods will accept
items:
description: The pod this Toleration is attached to
tolerates any taint that matches the triple <key,value,effect>
using the matching operator <operator>.
properties:
effect:
description: Effect indicates the taint effect to
match. Empty means match all taint effects. When
specified, allowed values are NoSchedule, PreferNoSchedule
and NoExecute.
type: string
key:
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.
type: string
operator:
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.
type: string
tolerationSeconds:
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.
format: int64
type: integer
value:
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.
type: string
type: object
nullable: true
type: array
type: object
type:
description: The type of Log Collection to configure
type: string
required:
- type
type: object
nodeSelector:
additionalProperties:
type: string
description: Define which Nodes the Pods are scheduled on.
nullable: true
type: object
resources:
description: The resource requirements for the collector
nullable: true
properties:
claims:
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."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: Name must match the name of one entry in
pod.spec.resourceClaims of the Pod where this field
is used. It makes that resource available inside a
container.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Requests describes the minimum amount of compute
resources required. If Requests is omitted for a container,
it defaults to Limits if that is explicitly specified, otherwise
to an implementation-defined value. Requests cannot exceed
Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
tolerations:
description: Define the tolerations the Pods will accept
items:
description: The pod this Toleration is attached to tolerates
any taint that matches the triple <key,value,effect> using
the matching operator <operator>.
properties:
effect:
description: Effect indicates the taint effect to match.
Empty means match all taint effects. When specified, allowed
values are NoSchedule, PreferNoSchedule and NoExecute.
type: string
key:
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.
type: string
operator:
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.
type: string
tolerationSeconds:
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.
format: int64
type: integer
value:
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.
type: string
type: object
nullable: true
type: array
type:
description: The type of Log Collection to configure
type: string
type: object
curation:
description: Deprecated. Specification of the Curation component for
the cluster This component was specifically for use with Elasticsearch
and was replaced by index management spec
nullable: true
properties:
curator:
description: The specification of curation to configure
properties:
nodeSelector:
additionalProperties:
type: string
description: Define which Nodes the Pods are scheduled on.
nullable: true
type: object
resources:
description: The resource requirements for Curator
nullable: true
properties:
claims:
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."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: Name must match the name of one entry
in pod.spec.resourceClaims of the Pod where this
field is used. It makes that resource available
inside a container.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Requests describes the minimum amount of
compute resources required. If Requests is omitted for
a container, it defaults to Limits if that is explicitly
specified, otherwise to an implementation-defined value.
Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
schedule:
description: The cron schedule that the Curator job is run.
Defaults to "30 3 * * *"
type: string
tolerations:
items:
description: The pod this Toleration is attached to tolerates
any taint that matches the triple <key,value,effect> using
the matching operator <operator>.
properties:
effect:
description: Effect indicates the taint effect to match.
Empty means match all taint effects. When specified,
allowed values are NoSchedule, PreferNoSchedule and
NoExecute.
type: string
key:
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.
type: string
operator:
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.
type: string
tolerationSeconds:
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.
format: int64
type: integer
value:
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.
type: string
type: object
type: array
required:
- schedule
type: object
type:
description: The kind of curation to configure
type: string
required:
- type
type: object
forwarder:
description: Deprecated. Specification for Forwarder component for
the cluster See spec.collection.fluentd
nullable: true
properties:
fluentd:
description: FluentdForwarderSpec represents the configuration
for forwarders of type fluentd.
properties:
buffer:
description: "FluentdBufferSpec represents a subset of fluentd
buffer parameters to tune the buffer configuration for all
fluentd outputs. It supports a subset of parameters to configure
buffer and queue sizing, flush operations and retry flushing.
\n For general parameters refer to: https://docs.fluentd.org/configuration/buffer-section#buffering-parameters
\n For flush parameters refer to: https://docs.fluentd.org/configuration/buffer-section#flushing-parameters
\n For retry parameters refer to: https://docs.fluentd.org/configuration/buffer-section#retries-parameters"
properties:
chunkLimitSize:
description: ChunkLimitSize represents the maximum size
of each chunk. Events will be written into chunks until
the size of chunks become this size.
pattern: ^([0-9]+)([kmgtKMGT]{0,1})$
type: string
flushInterval:
description: 'FlushInterval represents the time duration
to wait between two consecutive flush operations. Takes
only effect used together with `flushMode: interval`.'
pattern: ^([0-9]+)([smhd]{0,1})$
type: string
flushMode:
description: FlushMode represents the mode of the flushing
thread to write chunks. The mode allows lazy (if `time`
parameter set), per interval or immediate flushing.
enum:
- lazy
- interval
- immediate
type: string
flushThreadCount:
description: FlushThreadCount reprents the number of threads
used by the fluentd buffer plugin to flush/write chunks
in parallel.
format: int32
type: integer
overflowAction:
description: 'OverflowAction represents the action for
the fluentd buffer plugin to execute when a buffer queue
is full. (Default: block)'
enum:
- throw_exception
- block
- drop_oldest_chunk
type: string
retryMaxInterval:
description: 'RetryMaxInterval represents the maximum
time interval for exponential backoff between retries.
Takes only effect if used together with `retryType:
exponential_backoff`.'
pattern: ^([0-9]+)([smhd]{0,1})$
type: string
retryTimeout:
description: RetryTimeout represents the maximum time
interval to attempt retries before giving up and the
record is disguarded. If unspecified, the default will
be used
pattern: ^([0-9]+)([smhd]{0,1})$
type: string
retryType:
description: RetryType represents the type of retrying
flush operations. Flush operations can be retried either
periodically or by applying exponential backoff.
enum:
- exponential_backoff
- periodic
type: string
retryWait:
description: RetryWait represents the time duration between
two consecutive retries to flush buffers for periodic
retries or a constant factor of time on retries with
exponential backoff.
pattern: ^([0-9]+)([smhd]{0,1})$
type: string
totalLimitSize:
description: TotalLimitSize represents the threshold of
node space allowed per fluentd buffer to allocate. Once
this threshold is reached, all append operations will
fail with error (and data will be lost).
pattern: ^([0-9]+)([kmgtKMGT]{0,1})$
type: string
type: object
inFile:
description: "FluentdInFileSpec represents a subset of fluentd
in-tail plugin parameters to tune the configuration for
all fluentd in-tail inputs. \n For general parameters refer
to: https://docs.fluentd.org/input/tail#parameters"
properties:
readLinesLimit:
description: ReadLinesLimit represents the number of lines
to read with each I/O operation
type: integer
type: object
type: object
type: object
logStore:
description: Specification of the Log Storage component for the cluster
nullable: true
properties:
elasticsearch:
description: Specification of the Elasticsearch Log Store component
properties:
nodeCount:
description: Number of nodes to deploy for Elasticsearch
format: int32
type: integer
nodeSelector:
additionalProperties:
type: string
description: Define which Nodes the Pods are scheduled on.
nullable: true
type: object
proxy:
description: Specification of the Elasticsearch Proxy component
properties:
resources:
description: ResourceRequirements describes the compute
resource requirements.
nullable: true
properties:
claims:
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."
items:
description: ResourceClaim references one entry
in PodSpec.ResourceClaims.
properties:
name:
description: Name must match the name of one
entry in pod.spec.resourceClaims of the Pod
where this field is used. It makes that resource
available inside a container.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount
of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Requests describes the minimum amount
of compute resources required. If Requests is omitted
for a container, it defaults to Limits if that is
explicitly specified, otherwise to an implementation-defined
value. Requests cannot exceed Limits. More info:
https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
type: object
redundancyPolicy:
description: The policy towards data redundancy to specify
the number of redundant primary shards
enum:
- FullRedundancy
- MultipleRedundancy
- SingleRedundancy
- ZeroRedundancy
type: string
resources:
description: The resource requirements for Elasticsearch
nullable: true
properties:
claims:
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."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: Name must match the name of one entry
in pod.spec.resourceClaims of the Pod where this
field is used. It makes that resource available
inside a container.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Requests describes the minimum amount of
compute resources required. If Requests is omitted for
a container, it defaults to Limits if that is explicitly
specified, otherwise to an implementation-defined value.
Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
storage:
description: The storage specification for Elasticsearch data
nodes
nullable: true
properties:
size:
anyOf:
- type: integer
- type: string
description: The max storage capacity for the node to
provision.
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
storageClassName:
description: 'The name of the storage class to use with
creating the node''s PVC. More info: https://kubernetes.io/docs/concepts/storage/storage-classes/'
type: string
type: object
tolerations:
items:
description: The pod this Toleration is attached to tolerates
any taint that matches the triple <key,value,effect> using
the matching operator <operator>.
properties:
effect:
description: Effect indicates the taint effect to match.
Empty means match all taint effects. When specified,
allowed values are NoSchedule, PreferNoSchedule and
NoExecute.
type: string
key:
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.
type: string
operator:
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.
type: string
tolerationSeconds:
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.
format: int64
type: integer
value:
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.
type: string
type: object
type: array
type: object
lokistack:
description: "LokiStack contains information about which LokiStack
to use for log storage if Type is set to LogStoreTypeLokiStack.
\n The cluster-logging-operator does not create or manage the
referenced LokiStack."
properties:
name:
description: Name of the LokiStack resource.
type: string
required:
- name
type: object
retentionPolicy:
description: Retention policy defines the maximum age for an Elasticsearch
index after which it should be deleted
nullable: true
properties:
application:
nullable: true
properties:
diskThresholdPercent:
description: The threshold percentage of ES disk usage
that when reached, old indices should be deleted (e.g.
75)
format: int64
type: integer
maxAge:
description: TimeUnit is a time unit like h,m,d
pattern: ^([0-9]+)([wdhHms]{0,1})$
type: string
namespaceSpec:
description: The per namespace specification to delete
documents older than a given minimum age
items:
properties:
minAge:
description: Delete the records matching the namespaces
which are older than this MinAge (e.g. 1d)
pattern: ^([0-9]+)([wdhHms]{0,1})$
type: string
namespace:
description: Target Namespace to delete logs older
than MinAge (defaults to 7d) Can be one namespace
name or a prefix (e.g., "openshift-" covers all
namespaces with this prefix)
type: string
required:
- namespace
type: object
type: array
pruneNamespacesInterval:
description: How often to run a new prune-namespaces job
pattern: ^([0-9]+)([wdhHms]{0,1})$
type: string
type: object
audit:
nullable: true
properties:
diskThresholdPercent:
description: The threshold percentage of ES disk usage
that when reached, old indices should be deleted (e.g.
75)
format: int64
type: integer
maxAge:
description: TimeUnit is a time unit like h,m,d
pattern: ^([0-9]+)([wdhHms]{0,1})$
type: string
namespaceSpec:
description: The per namespace specification to delete
documents older than a given minimum age
items:
properties:
minAge:
description: Delete the records matching the namespaces
which are older than this MinAge (e.g. 1d)
pattern: ^([0-9]+)([wdhHms]{0,1})$
type: string
namespace:
description: Target Namespace to delete logs older
than MinAge (defaults to 7d) Can be one namespace
name or a prefix (e.g., "openshift-" covers all
namespaces with this prefix)
type: string
required:
- namespace
type: object
type: array
pruneNamespacesInterval:
description: How often to run a new prune-namespaces job
pattern: ^([0-9]+)([wdhHms]{0,1})$
type: string
type: object
infra:
nullable: true
properties:
diskThresholdPercent:
description: The threshold percentage of ES disk usage
that when reached, old indices should be deleted (e.g.
75)
format: int64
type: integer
maxAge:
description: TimeUnit is a time unit like h,m,d
pattern: ^([0-9]+)([wdhHms]{0,1})$
type: string
namespaceSpec:
description: The per namespace specification to delete
documents older than a given minimum age
items:
properties:
minAge:
description: Delete the records matching the namespaces
which are older than this MinAge (e.g. 1d)
pattern: ^([0-9]+)([wdhHms]{0,1})$
type: string
namespace:
description: Target Namespace to delete logs older
than MinAge (defaults to 7d) Can be one namespace
name or a prefix (e.g., "openshift-" covers all
namespaces with this prefix)
type: string
required:
- namespace
type: object
type: array
pruneNamespacesInterval:
description: How often to run a new prune-namespaces job
pattern: ^([0-9]+)([wdhHms]{0,1})$
type: string
type: object
type: object
type:
default: lokistack
description: "The Type of Log Storage to configure. The operator
currently supports either using ElasticSearch managed by elasticsearch-operator
or Loki managed by loki-operator (LokiStack) as a default log
store. \n When using ElasticSearch as a log store this operator
also manages the ElasticSearch deployment. \n When using LokiStack
as a log store this operator does not manage the LokiStack,
but only creates configuration referencing an existing LokiStack
deployment. The user is responsible for creating and managing
the LokiStack himself."
enum:
- elasticsearch
- lokistack
type: string
required:
- type
type: object
managementState:
description: Indicator if the resource is 'Managed' or 'Unmanaged'
by the operator
enum:
- Managed
- Unmanaged
type: string
visualization:
description: Specification of the Visualization component for the
cluster
nullable: true
properties:
kibana:
description: Specification of the Kibana Visualization component
nullable: true
properties:
nodeSelector:
additionalProperties:
type: string
description: Define which Nodes the Pods are scheduled on.
nullable: true
type: object
proxy:
description: Specification of the Kibana Proxy component
properties:
resources:
description: ResourceRequirements describes the compute
resource requirements.
nullable: true
properties:
claims:
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."
items:
description: ResourceClaim references one entry
in PodSpec.ResourceClaims.
properties:
name:
description: Name must match the name of one
entry in pod.spec.resourceClaims of the Pod
where this field is used. It makes that resource
available inside a container.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount
of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'