-
Notifications
You must be signed in to change notification settings - Fork 154
/
Copy pathcluster-logging.clusterserviceversion.yaml
2184 lines (1883 loc) · 89.7 KB
/
cluster-logging.clusterserviceversion.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: operators.coreos.com/v1alpha1
kind: ClusterServiceVersion
metadata:
annotations:
alm-examples: |-
[
{
"apiVersion": "logging.openshift.io/v1alpha1",
"kind": "LogFileMetricExporter",
"metadata": {
"name": "instance",
"namespace": "openshift-logging"
},
"spec": {
"resources": {
"limits": {
"cpu": "500m"
},
"requests": {
"cpu": "200m",
"memory": "128Mi"
}
},
"tolerations": [
{
"effect": "NoSchedule",
"key": "node-role.kubernetes.io/master",
"operator": "Exists"
}
]
}
},
{
"apiVersion": "observability.openshift.io/v1",
"kind": "ClusterLogForwarder",
"metadata": {
"name": "logging",
"namespace": "openshift-logging"
},
"spec": {
"outputs": [
{
"lokiStack": {
"authentication": {
"token": {
"from": "serviceAccount"
}
},
"target": {
"name": "logging-loki"
}
},
"name": "logging-loki",
"tls": {
"ca": {
"configMapName": "openshift-service-ca.crt",
"key": "service-ca.crt"
}
},
"type": "lokiStack"
}
],
"pipelines": [
{
"inputRefs": [
"application",
"infrastructure"
],
"name": "logs-to-loki",
"outputRefs": [
"logging-loki"
]
}
],
"serviceAccount": {
"name": "log-collector"
}
}
}
]
capabilities: Seamless Upgrades
categories: OpenShift Optional, Logging & Tracing
certified: "false"
containerImage: quay.io/openshift-logging/cluster-logging-operator:latest
createdAt: "2025-02-19T19:23:42Z"
description: The Red Hat OpenShift Logging Operator for OCP provides a means for
configuring and managing log collection and forwarding.
features.operators.openshift.io/cnf: "false"
features.operators.openshift.io/cni: "false"
features.operators.openshift.io/csi: "false"
features.operators.openshift.io/disconnected: "true"
features.operators.openshift.io/fips-compliant: "true"
features.operators.openshift.io/proxy-aware: "true"
features.operators.openshift.io/tls-profiles: "true"
features.operators.openshift.io/token-auth-aws: "false"
features.operators.openshift.io/token-auth-azure: "false"
features.operators.openshift.io/token-auth-gcp: "false"
olm.skipRange: '>=5.8.0-0 <6.0.0'
operatorframework.io/cluster-monitoring: "true"
operatorframework.io/initialization-resource: |
{
"apiVersion": "observability.openshift.io/v1",
"kind": "ClusterLogForwarder",
"metadata": {
"name": "logging"
}
}
operatorframework.io/suggested-namespace: openshift-logging
operators.openshift.io/infrastructure-features: '["disconnected","proxy-aware"]'
operators.openshift.io/valid-subscription: '["OpenShift Kubernetes Engine", "OpenShift
Container Platform", "OpenShift Platform Plus"]'
operators.operatorframework.io/builder: operator-sdk-unknown
operators.operatorframework.io/project_layout: go.kubebuilder.io/v4
support: AOS Logging ([email protected])
target.workload.openshift.io/management: '{"effect": "PreferredDuringScheduling"}'
labels:
operatorframework.io/arch.amd64: supported
operatorframework.io/arch.arm64: supported
operatorframework.io/arch.ppc64le: supported
operatorframework.io/arch.s390x: supported
name: cluster-logging.v6.0.0
namespace: openshift-logging
spec:
apiservicedefinitions: {}
customresourcedefinitions:
owned:
- description: |-
ClusterLogForwarder is an API to configure forwarding logs.
You configure forwarding by specifying a list of `pipelines`,
which forward from a set of named inputs to a set of named outputs.
displayName: Cluster Log Forwarder
kind: ClusterLogForwarder
name: clusterlogforwarders.observability.openshift.io
specDescriptors:
- description: |-
Specification of the Collector deployment to define
resource limits and workload placement
displayName: Collector Resources and Placement
path: collector
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced
- description: Define nodes for scheduling the pods.
displayName: Node Selector
path: collector.nodeSelector
- description: The resource requirements for the collector
displayName: Collector Resource Requirements
path: collector.resources
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:resourceRequirements
- description: Define the tolerations the collector pods will accept
displayName: Tolerations
path: collector.tolerations
- description: |-
Filters are applied to log records passing through a pipeline.
There are different types of filter that can select and modify log records in different ways.
See [FilterTypeSpec] for a list of filter types.
displayName: Log Forwarder Pipeline Filters
path: filters
- description: |-
A drop filter applies a sequence of tests to a log record and drops the record if any test passes.
Each test contains a sequence of conditions, all conditions must be true for the test to pass.
A DropTestsSpec contains an array of tests which contains an array of conditions
displayName: Drop Filters
path: filters[0].drop
- description: DropConditions is an array of DropCondition which are conditions
that are ANDed together
displayName: Drop Filter Conditions
path: filters[0].drop[0].test
- description: |-
A dot delimited path to a field in the log record. It must start with a `.`.
The path can contain alpha-numeric characters and underscores (a-zA-Z0-9_).
If segments contain characters outside of this range, the segment must be quoted.
Examples: `.kubernetes.namespace_name`, `.log_type`, '.kubernetes.labels.foobar', `.kubernetes.labels."foo-bar/baz"`
displayName: Field Path
path: filters[0].drop[0].test[0].field
- description: |-
A regular expression that the field will match.
If the value of the field defined in the DropTest matches the regular expression, the log record will be dropped.
Must define only one of matches OR notMatches
displayName: Drop Match Expression
path: filters[0].drop[0].test[0].matches
- description: |-
A regular expression that the field does not match.
If the value of the field defined in the DropTest does not match the regular expression, the log record will be dropped.
Must define only one of matches or notMatches
displayName: Keep Match Expression
path: filters[0].drop[0].test[0].notMatches
- displayName: Kubernetes API Audit Filter
path: filters[0].kubeAPIAudit
- description: Name used to refer to the filter from a "pipeline".
displayName: Filter Name
path: filters[0].name
- description: |-
Labels applied to log records passing through a pipeline.
These labels appear in the `openshift.labels` map in the log record.
displayName: Labels
path: filters[0].openshiftLabels
- description: The PruneFilterSpec consists of two arrays, namely in and notIn,
which dictate the fields to be pruned.
displayName: Prune Filters
path: filters[0].prune
- description: |-
`In` is an array of dot-delimited field paths. Fields included here are removed from the log record.
Each field path expression must start with a "."
The path can contain alphanumeric characters and underscores (a-zA-Z0-9_).
If segments contain characters outside of this range, the segment must be quoted otherwise paths do NOT need to be quoted.
Examples:
- `.kubernetes.namespace_name`
- `.log_type`
- '.kubernetes.labels.foobar'
- `.kubernetes.labels."foo-bar/baz"`
NOTE1: `In` CANNOT contain `.log_type` or `.message` as those fields are required and cannot be pruned.
NOTE2: If this filter is used in a pipeline with GoogleCloudLogging, `.hostname` CANNOT be added to this list as it is a required field.
displayName: Fields to be dropped
path: filters[0].prune.in
- description: |-
`NotIn` is an array of dot-delimited field paths. All fields besides the ones listed here are removed from the log record.
Each field path expression must start with a "."
The path can contain alphanumeric characters and underscores (a-zA-Z0-9_).
If segments contain characters outside of this range, the segment must be quoted otherwise paths do NOT need to be quoted.
Examples:
- `.kubernetes.namespace_name`
- `.log_type`
- '.kubernetes.labels.foobar'
- `.kubernetes.labels."foo-bar/baz"`
NOTE1: `NotIn` MUST contain `.log_type` and `.message` as those fields are required and cannot be pruned.
NOTE2: If this filter is used in a pipeline with GoogleCloudLogging, `.hostname` MUST be added to this list as it is a required field.
displayName: Fields to be kept
path: filters[0].prune.notIn
- description: Type of filter.
displayName: Filter Type
path: filters[0].type
- description: |-
Inputs are named filters for log messages to be forwarded.
There are three built-in inputs named `application`, `infrastructure` and
`audit`. You don't need to define inputs here if those are sufficient for
your needs. See `inputRefs` for more.
displayName: Log Forwarder Inputs
path: inputs
- description: |-
Application, named set of `application` logs that
can specify a set of match criteria
displayName: Application Logs Input
path: inputs[0].application
- description: |-
Excludes is the set of namespaces and containers to ignore when collecting logs.
Takes precedence over Includes option.
displayName: Exclude
path: inputs[0].application.excludes
- description: |-
Container spec the containers from which to collect logs
Supports glob patterns and presumes "*" if omitted.
displayName: Container Glob
path: inputs[0].application.excludes[0].container
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
Namespace specs the namespace from which to collect logs
Supports glob patterns and presumes "*" if omitted.
displayName: Namespace Glob
path: inputs[0].application.excludes[0].namespace
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
Includes is the set of namespaces and containers to include when collecting logs.
Note: infrastructure namespaces are still excluded for "*" values unless a qualifying glob pattern is specified.
displayName: Include
path: inputs[0].application.includes
- description: |-
Container spec the containers from which to collect logs
Supports glob patterns and presumes "*" if omitted.
displayName: Container Glob
path: inputs[0].application.includes[0].container
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
Namespace specs the namespace from which to collect logs
Supports glob patterns and presumes "*" if omitted.
displayName: Namespace Glob
path: inputs[0].application.includes[0].namespace
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
Selector for logs from pods with matching labels.
Only messages from pods with these labels are collected.
If absent or empty, logs are collected regardless of labels.
displayName: Pod Selector
path: inputs[0].application.selector
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:selector:core:v1:Pod
- description: Tuning is the container input tuning spec for this container
sources
displayName: Input Tuning
path: inputs[0].application.tuning
- description: |-
RateLimitPerContainer is the limit applied to each container
by this input. This limit is applied per collector deployment.
displayName: Per-Container Rate Limit
path: inputs[0].application.tuning.rateLimitPerContainer
- description: |-
MaxRecordsPerSecond is the maximum number of log records
allowed per input/output in a pipeline
displayName: Max Records Per Second
path: inputs[0].application.tuning.rateLimitPerContainer.maxRecordsPerSecond
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- description: Audit, enables `audit` logs.
displayName: Audit Logs Input
path: inputs[0].audit
- description: |-
Sources defines the list of audit sources to collect.
This field is optional and its exclusion results in the collection of all audit sources.
displayName: Log Sources
path: inputs[0].audit.sources
- description: Infrastructure, Enables `infrastructure` logs.
displayName: Infrastructure Logs Input
path: inputs[0].infrastructure
- description: |-
Sources defines the list of infrastructure sources to collect.
This field is optional and omission results in the collection of all infrastructure sources.
displayName: Log Sources
path: inputs[0].infrastructure.sources
- description: Name used to refer to the input of a `pipeline`.
displayName: Input Name
path: inputs[0].name
- description: Receiver to receive logs from non-cluster sources.
displayName: Log Receiver
path: inputs[0].receiver
- displayName: HTTP Receiver Configuration
path: inputs[0].receiver.http
- description: Format is the format of incoming log data.
displayName: Data Format
path: inputs[0].receiver.http.format
- description: Port the Receiver listens on. It must be a value between 1024
and 65535
displayName: Listen Port
path: inputs[0].receiver.port
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- description: |-
TLS contains settings for controlling options of TLS connections.
The operator will request certificates from the cluster's cert signing service when TLS is not defined.
The certificates are injected into a secret named "<clusterlogforwarder.name>-<input.name>" which is mounted into
the collector. The collector is configured to use the public and private key provided by the service
displayName: TLS Options
path: inputs[0].receiver.tls
- description: Type of Receiver plugin.
displayName: Receiver Type
path: inputs[0].receiver.type
- description: Type of output sink.
displayName: Input Type
path: inputs[0].type
- description: Indicator if the resource is 'Managed' or 'Unmanaged' by the
operator.
displayName: Management State
path: managementState
- description: Outputs are named destinations for log messages.
displayName: Log Forwarder Outputs
path: outputs
- displayName: Azure Monitor
path: outputs[0].azureMonitor
- description: Authentication sets credentials for authenticating the requests.
displayName: Authentication Options
path: outputs[0].azureMonitor.authentication
- description: SharedKey points to the secret containing the shared key used
for authenticating requests.
displayName: Shared Key
path: outputs[0].azureMonitor.authentication.sharedKey
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].azureMonitor.authentication.sharedKey.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].azureMonitor.authentication.sharedKey.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
AzureResourceId the Resource ID of the Azure resource the data should be associated with.
https://learn.microsoft.com/en-us/azure/azure-monitor/logs/data-collector-api?tabs=powershell#request-headers
displayName: Azure Resource ID
path: outputs[0].azureMonitor.azureResourceId
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
CustomerId che unique identifier for the Log Analytics workspace.
https://learn.microsoft.com/en-us/azure/azure-monitor/logs/data-collector-api?tabs=powershell#request-uri-parameters
displayName: Customer ID
path: outputs[0].azureMonitor.customerId
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
Host alternative host for dedicated Azure regions. (for example for China region)
https://docs.azure.cn/en-us/articles/guidance/developerdifferences#check-endpoints-in-azure
displayName: Azure Host
path: outputs[0].azureMonitor.host
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
LogType the record type of the data that is being submitted.
Can only contain letters, numbers, and underscores (_), and may not exceed 100 characters.
https://learn.microsoft.com/en-us/azure/azure-monitor/logs/data-collector-api?tabs=powershell#request-headers
displayName: Log Type
path: outputs[0].azureMonitor.logType
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Tuning specs tuning for the output
displayName: Tuning Options
path: outputs[0].azureMonitor.tuning
- displayName: Delivery Mode
path: outputs[0].azureMonitor.tuning.deliveryMode
- description: MaxRetryDuration is the maximum time to wait between retry attempts
after a delivery failure.
displayName: Maximum Retry Duration
path: outputs[0].azureMonitor.tuning.maxRetryDuration
- description: MaxWrite limits the maximum payload in terms of bytes of a single
"send" to the output.
displayName: Batch Size
path: outputs[0].azureMonitor.tuning.maxWrite
- description: MinRetryDuration is the minimum time to wait between attempts
to retry after delivery a failure.
displayName: Minimum Retry Duration
path: outputs[0].azureMonitor.tuning.minRetryDuration
- displayName: Amazon CloudWatch
path: outputs[0].cloudwatch
- description: Authentication sets credentials for authenticating the requests.
displayName: Authentication Options
path: outputs[0].cloudwatch.authentication
- description: AWSAccessKey points to the AWS access key id and secret to be
used for authentication.
displayName: Access Key
path: outputs[0].cloudwatch.authentication.awsAccessKey
- description: KeyId points to the AWS access key id to be used for authentication.
displayName: Secret with Access Key ID
path: outputs[0].cloudwatch.authentication.awsAccessKey.keyId
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].cloudwatch.authentication.awsAccessKey.keyId.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].cloudwatch.authentication.awsAccessKey.keyId.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: KeySecret points to the AWS access key secret to be used for
authentication.
displayName: Secret with Access Key Secret
path: outputs[0].cloudwatch.authentication.awsAccessKey.keySecret
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].cloudwatch.authentication.awsAccessKey.keySecret.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].cloudwatch.authentication.awsAccessKey.keySecret.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
IAMRole points to the secret containing the role ARN to be used for authentication.
This can be used for authentication in STS-enabled clusters when additionally specifying
a web identity token
displayName: Amazon IAM Role
path: outputs[0].cloudwatch.authentication.iamRole
- description: |-
RoleARN points to the secret containing the role ARN to be used for authentication.
This is used for authentication in STS-enabled clusters.
displayName: RoleARN Secret
path: outputs[0].cloudwatch.authentication.iamRole.roleARN
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].cloudwatch.authentication.iamRole.roleARN.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].cloudwatch.authentication.iamRole.roleARN.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Token specifies a bearer token to be used for authenticating
requests.
displayName: Token
path: outputs[0].cloudwatch.authentication.iamRole.token
- description: From is the source from where to find the token
displayName: Token Source
path: outputs[0].cloudwatch.authentication.iamRole.token.from
- description: Use Secret if the value should be sourced from a Secret in the
same namespace.
displayName: Token Secret
path: outputs[0].cloudwatch.authentication.iamRole.token.secret
- description: Name of the key used to get the value from the referenced Secret.
displayName: Key Name
path: outputs[0].cloudwatch.authentication.iamRole.token.secret.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Name of secret
displayName: Secret Name
path: outputs[0].cloudwatch.authentication.iamRole.token.secret.name
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Type is the type of cloudwatch authentication to configure
displayName: Authentication Type
path: outputs[0].cloudwatch.authentication.type
- description: |-
GroupName defines the strategy for grouping logstreams
The GroupName can be a combination of static and dynamic values consisting of field paths followed by `||` followed by another field path or a static value.
A dynamic value is encased in single curly brackets `{}` and MUST end with a static fallback value separated with `||`.
Static values can only contain alphanumeric characters along with dashes, underscores, dots and forward slashes.
Example:
1. foo-{.bar||"none"}
2. {.foo||.bar||"missing"}
3. foo.{.bar.baz||.qux.quux.corge||.grault||"nil"}-waldo.fred{.plugh||"none"}
displayName: Group Name
path: outputs[0].cloudwatch.groupName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- displayName: Amazon Region
path: outputs[0].cloudwatch.region
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Tuning specs tuning for the output
displayName: Tuning Options
path: outputs[0].cloudwatch.tuning
- description: |-
Compression causes data to be compressed before sending over the network.
It is an error if the compression type is not supported by the output.
displayName: Compression
path: outputs[0].cloudwatch.tuning.compression
- displayName: Delivery Mode
path: outputs[0].cloudwatch.tuning.deliveryMode
- description: MaxRetryDuration is the maximum time to wait between retry attempts
after a delivery failure.
displayName: Maximum Retry Duration
path: outputs[0].cloudwatch.tuning.maxRetryDuration
- description: MaxWrite limits the maximum payload in terms of bytes of a single
"send" to the output.
displayName: Batch Size
path: outputs[0].cloudwatch.tuning.maxWrite
- description: MinRetryDuration is the minimum time to wait between attempts
to retry after delivery a failure.
displayName: Minimum Retry Duration
path: outputs[0].cloudwatch.tuning.minRetryDuration
- description: |-
URL to send log records to.
The 'username@password' part of `url` is ignored.
displayName: Destination URL
path: outputs[0].cloudwatch.url
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- displayName: ElasticSearch
path: outputs[0].elasticsearch
- description: Authentication sets credentials for authenticating the requests.
displayName: Authentication Options
path: outputs[0].elasticsearch.authentication
- description: Password to use for authenticating requests.
displayName: Password
path: outputs[0].elasticsearch.authentication.password
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].elasticsearch.authentication.password.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].elasticsearch.authentication.password.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Token specifies a bearer token to be used for authenticating
requests.
displayName: Bearer Token
path: outputs[0].elasticsearch.authentication.token
- description: From is the source from where to find the token
displayName: Token Source
path: outputs[0].elasticsearch.authentication.token.from
- description: Use Secret if the value should be sourced from a Secret in the
same namespace.
displayName: Token Secret
path: outputs[0].elasticsearch.authentication.token.secret
- description: Name of the key used to get the value from the referenced Secret.
displayName: Key Name
path: outputs[0].elasticsearch.authentication.token.secret.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Name of secret
displayName: Secret Name
path: outputs[0].elasticsearch.authentication.token.secret.name
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Username to use for authenticating requests.
displayName: Username
path: outputs[0].elasticsearch.authentication.username
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].elasticsearch.authentication.username.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].elasticsearch.authentication.username.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
Index is the index for the logs. This supports template syntax to allow dynamic per-event values.
The Index can be a combination of static and dynamic values consisting of field paths followed by `||` followed by another field path or a static value.
A dynamic value is encased in single curly brackets `{}` and MUST end with a static fallback value separated with `||`.
Static values can only contain alphanumeric characters along with dashes, underscores, dots and forward slashes.
Example:
1. foo-{.bar||"none"}
2. {.foo||.bar||"missing"}
3. foo.{.bar.baz||.qux.quux.corge||.grault||"nil"}-waldo.fred{.plugh||"none"}
displayName: Log Index
path: outputs[0].elasticsearch.index
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Tuning specs tuning for the output
displayName: Tuning Options
path: outputs[0].elasticsearch.tuning
- description: Compression causes data to be compressed before sending over
the network.
displayName: Compression
path: outputs[0].elasticsearch.tuning.compression
- displayName: Delivery Mode
path: outputs[0].elasticsearch.tuning.deliveryMode
- description: MaxRetryDuration is the maximum time to wait between retry attempts
after a delivery failure.
displayName: Maximum Retry Duration
path: outputs[0].elasticsearch.tuning.maxRetryDuration
- description: MaxWrite limits the maximum payload in terms of bytes of a single
"send" to the output.
displayName: Batch Size
path: outputs[0].elasticsearch.tuning.maxWrite
- description: MinRetryDuration is the minimum time to wait between attempts
to retry after delivery a failure.
displayName: Minimum Retry Duration
path: outputs[0].elasticsearch.tuning.minRetryDuration
- description: |-
URL to send log records to.
Basic TLS is enabled if the URL scheme requires it (for example 'https' or 'tls').
The 'username@password' part of `url` is ignored.
displayName: Destination URL
path: outputs[0].elasticsearch.url
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
Version specifies the version of Elasticsearch to be used.
Must be one of: 6-8
displayName: ElasticSearch Version
path: outputs[0].elasticsearch.version
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- displayName: Google Cloud Logging
path: outputs[0].googleCloudLogging
- description: Authentication sets credentials for authenticating the requests.
displayName: Authentication Options
path: outputs[0].googleCloudLogging.authentication
- description: Credentials points to the secret containing the `google-application-credentials.json`.
displayName: Secret with Credentials File
path: outputs[0].googleCloudLogging.authentication.credentials
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].googleCloudLogging.authentication.credentials.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].googleCloudLogging.authentication.credentials.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: ID must be one of the required ID fields for the output
displayName: Logging ID
path: outputs[0].googleCloudLogging.id
- description: Type is the ID type provided
displayName: Logging ID Type
path: outputs[0].googleCloudLogging.id.type
- description: Value is the value of the ID
displayName: Logging ID Value
path: outputs[0].googleCloudLogging.id.value
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
LogId is the log ID to which to publish logs. This identifies log stream.
The LogId can be a combination of static and dynamic values consisting of field paths followed by `||` followed by another field path or a static value.
A dynamic value is encased in single curly brackets `{}` and MUST end with a static fallback value separated with `||`.
Static values can only contain alphanumeric characters along with dashes, underscores, dots and forward slashes.
Example:
1. foo-{.bar||"none"}
2. {.foo||.bar||"missing"}
3. foo.{.bar.baz||.qux.quux.corge||.grault||"nil"}-waldo.fred{.plugh||"none"}
displayName: Log Stream ID
path: outputs[0].googleCloudLogging.logId
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Tuning specs tuning for the output
displayName: Tuning Options
path: outputs[0].googleCloudLogging.tuning
- displayName: Delivery Mode
path: outputs[0].googleCloudLogging.tuning.deliveryMode
- description: MaxRetryDuration is the maximum time to wait between retry attempts
after a delivery failure.
displayName: Maximum Retry Duration
path: outputs[0].googleCloudLogging.tuning.maxRetryDuration
- description: MaxWrite limits the maximum payload in terms of bytes of a single
"send" to the output.
displayName: Batch Size
path: outputs[0].googleCloudLogging.tuning.maxWrite
- description: MinRetryDuration is the minimum time to wait between attempts
to retry after delivery a failure.
displayName: Minimum Retry Duration
path: outputs[0].googleCloudLogging.tuning.minRetryDuration
- displayName: HTTP Output
path: outputs[0].http
- description: Authentication sets credentials for authenticating the requests.
displayName: Authentication Options
path: outputs[0].http.authentication
- description: Password to use for authenticating requests.
displayName: Password
path: outputs[0].http.authentication.password
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].http.authentication.password.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].http.authentication.password.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Token specifies a bearer token to be used for authenticating
requests.
displayName: Bearer Token
path: outputs[0].http.authentication.token
- description: From is the source from where to find the token
displayName: Token Source
path: outputs[0].http.authentication.token.from
- description: Use Secret if the value should be sourced from a Secret in the
same namespace.
displayName: Token Secret
path: outputs[0].http.authentication.token.secret
- description: Name of the key used to get the value from the referenced Secret.
displayName: Key Name
path: outputs[0].http.authentication.token.secret.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Name of secret
displayName: Secret Name
path: outputs[0].http.authentication.token.secret.name
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Username to use for authenticating requests.
displayName: Username
path: outputs[0].http.authentication.username
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].http.authentication.username.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].http.authentication.username.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Headers specify optional headers to be sent with the request
displayName: Headers
path: outputs[0].http.headers
- description: Method specifies the Http method to be used for sending logs.
If not set, 'POST' is used.
displayName: HTTP Method
path: outputs[0].http.method
- description: Timeout specifies the Http request timeout in seconds. If not
set, 10secs is used.
displayName: Timeout
path: outputs[0].http.timeout
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- description: Tuning specs tuning for the output
displayName: Tuning Options
path: outputs[0].http.tuning
- description: Compression causes data to be compressed before sending over
the network.
displayName: Compression
path: outputs[0].http.tuning.compression
- displayName: Delivery Mode
path: outputs[0].http.tuning.deliveryMode
- description: MaxRetryDuration is the maximum time to wait between retry attempts
after a delivery failure.
displayName: Maximum Retry Duration
path: outputs[0].http.tuning.maxRetryDuration
- description: MaxWrite limits the maximum payload in terms of bytes of a single
"send" to the output.
displayName: Batch Size
path: outputs[0].http.tuning.maxWrite
- description: MinRetryDuration is the minimum time to wait between attempts
to retry after delivery a failure.
displayName: Minimum Retry Duration
path: outputs[0].http.tuning.minRetryDuration
- description: |-
URL to send log records to.
Basic TLS is enabled if the URL scheme requires it (for example 'https' or 'tls').
The 'username@password' part of `url` is ignored.
displayName: Destination URL
path: outputs[0].http.url
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- displayName: Apache Kafka
path: outputs[0].kafka
- description: Authentication sets credentials for authenticating the requests.
displayName: Authentication Options
path: outputs[0].kafka.authentication
- description: SASL contains options configuring SASL authentication.
displayName: SASL Options
path: outputs[0].kafka.authentication.sasl
- description: Mechanism sets the SASL mechanism to use.
displayName: SASL Mechanism
path: outputs[0].kafka.authentication.sasl.mechanism
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Username points to the secret to be used as SASL password.
displayName: Secret with Password
path: outputs[0].kafka.authentication.sasl.password
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].kafka.authentication.sasl.password.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].kafka.authentication.sasl.password.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Username points to the secret to be used as SASL username.
displayName: Secret with Username
path: outputs[0].kafka.authentication.sasl.username
- description: Key contains the name of the key inside the referenced Secret.
displayName: Key Name
path: outputs[0].kafka.authentication.sasl.username.key
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: SecretName contains the name of the Secret containing the referenced
value.
displayName: Secret Name
path: outputs[0].kafka.authentication.sasl.username.secretName
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: |-
Brokers specifies the list of broker endpoints of a Kafka cluster.
The list represents only the initial set used by the collector's Kafka client for the
first connection only. The collector's Kafka client fetches constantly an updated list
from Kafka. These updates are not reconciled back to the collector configuration.
If none provided the target URL from the OutputSpec is used as fallback.
displayName: Kafka Brokers
path: outputs[0].kafka.brokers
- description: |-
Topic specifies the target topic to send logs to. The value when not specified is 'topic'
The Topic can be a combination of static and dynamic values consisting of field paths followed by `||` followed by another field path or a static value.
A dynamic value is encased in single curly brackets `{}` and MUST end with a static fallback value separated with `||`.
Static values can only contain alphanumeric characters along with dashes, underscores, dots and forward slashes.
Example:
1. foo-{.bar||"none"}
2. {.foo||.bar||"missing"}
3. foo.{.bar.baz||.qux.quux.corge||.grault||"nil"}-waldo.fred{.plugh||"none"}
displayName: Kafka Topic
path: outputs[0].kafka.topic
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Tuning specs tuning for the output
displayName: Tuning Options
path: outputs[0].kafka.tuning
- description: Compression causes data to be compressed before sending over
the network.
displayName: Compression
path: outputs[0].kafka.tuning.compression
- displayName: Delivery Mode