@backstage/plugin-events-backend-module-kafka 0.3.5 → 0.3.6-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/config.schema.json +1614 -0
- package/package.json +10 -10
- package/config.d.ts +0 -619
|
@@ -0,0 +1,1614 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"events": {
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"modules": {
|
|
9
|
+
"type": "object",
|
|
10
|
+
"properties": {
|
|
11
|
+
"kafka": {
|
|
12
|
+
"type": "object",
|
|
13
|
+
"properties": {
|
|
14
|
+
"kafkaConsumingEventPublisher": {
|
|
15
|
+
"anyOf": [
|
|
16
|
+
{
|
|
17
|
+
"type": "object",
|
|
18
|
+
"properties": {
|
|
19
|
+
"clientId": {
|
|
20
|
+
"type": "string",
|
|
21
|
+
"description": "(Required) Client ID used by Backstage to identify when connecting to the Kafka cluster."
|
|
22
|
+
},
|
|
23
|
+
"brokers": {
|
|
24
|
+
"type": "array",
|
|
25
|
+
"items": {
|
|
26
|
+
"type": "string"
|
|
27
|
+
},
|
|
28
|
+
"description": "(Required) List of brokers in the Kafka cluster to connect to."
|
|
29
|
+
},
|
|
30
|
+
"ssl": {
|
|
31
|
+
"anyOf": [
|
|
32
|
+
{
|
|
33
|
+
"type": "object",
|
|
34
|
+
"properties": {
|
|
35
|
+
"ca": {
|
|
36
|
+
"type": "array",
|
|
37
|
+
"items": {
|
|
38
|
+
"type": "string"
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
"key": {
|
|
42
|
+
"type": "string",
|
|
43
|
+
"visibility": "secret"
|
|
44
|
+
},
|
|
45
|
+
"cert": {
|
|
46
|
+
"type": "string"
|
|
47
|
+
},
|
|
48
|
+
"rejectUnauthorized": {
|
|
49
|
+
"type": "boolean"
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"type": "boolean"
|
|
55
|
+
}
|
|
56
|
+
],
|
|
57
|
+
"description": "Optional SSL connection parameters to connect to the cluster. Passed directly to Node tls.connect. See https://nodejs.org/dist/latest-v8.x/docs/api/tls.html#tls_tls_createsecurecontext_options"
|
|
58
|
+
},
|
|
59
|
+
"sasl": {
|
|
60
|
+
"type": "object",
|
|
61
|
+
"properties": {
|
|
62
|
+
"mechanism": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"enum": [
|
|
65
|
+
"plain",
|
|
66
|
+
"scram-sha-256",
|
|
67
|
+
"scram-sha-512"
|
|
68
|
+
]
|
|
69
|
+
},
|
|
70
|
+
"username": {
|
|
71
|
+
"type": "string"
|
|
72
|
+
},
|
|
73
|
+
"password": {
|
|
74
|
+
"type": "string",
|
|
75
|
+
"visibility": "secret"
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
"required": [
|
|
79
|
+
"mechanism",
|
|
80
|
+
"username",
|
|
81
|
+
"password"
|
|
82
|
+
],
|
|
83
|
+
"description": "Optional SASL connection parameters."
|
|
84
|
+
},
|
|
85
|
+
"retry": {
|
|
86
|
+
"type": "object",
|
|
87
|
+
"properties": {
|
|
88
|
+
"maxRetryTime": {
|
|
89
|
+
"anyOf": [
|
|
90
|
+
{
|
|
91
|
+
"type": "object",
|
|
92
|
+
"properties": {
|
|
93
|
+
"years": {
|
|
94
|
+
"type": "number"
|
|
95
|
+
},
|
|
96
|
+
"months": {
|
|
97
|
+
"type": "number"
|
|
98
|
+
},
|
|
99
|
+
"weeks": {
|
|
100
|
+
"type": "number"
|
|
101
|
+
},
|
|
102
|
+
"days": {
|
|
103
|
+
"type": "number"
|
|
104
|
+
},
|
|
105
|
+
"hours": {
|
|
106
|
+
"type": "number"
|
|
107
|
+
},
|
|
108
|
+
"minutes": {
|
|
109
|
+
"type": "number"
|
|
110
|
+
},
|
|
111
|
+
"seconds": {
|
|
112
|
+
"type": "number"
|
|
113
|
+
},
|
|
114
|
+
"milliseconds": {
|
|
115
|
+
"type": "number"
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
"description": "Human friendly durations object."
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"type": "string"
|
|
122
|
+
}
|
|
123
|
+
],
|
|
124
|
+
"description": "(Optional) Maximum wait time for a retry Default: 30000 ms."
|
|
125
|
+
},
|
|
126
|
+
"initialRetryTime": {
|
|
127
|
+
"anyOf": [
|
|
128
|
+
{
|
|
129
|
+
"type": "object",
|
|
130
|
+
"properties": {
|
|
131
|
+
"years": {
|
|
132
|
+
"type": "number"
|
|
133
|
+
},
|
|
134
|
+
"months": {
|
|
135
|
+
"type": "number"
|
|
136
|
+
},
|
|
137
|
+
"weeks": {
|
|
138
|
+
"type": "number"
|
|
139
|
+
},
|
|
140
|
+
"days": {
|
|
141
|
+
"type": "number"
|
|
142
|
+
},
|
|
143
|
+
"hours": {
|
|
144
|
+
"type": "number"
|
|
145
|
+
},
|
|
146
|
+
"minutes": {
|
|
147
|
+
"type": "number"
|
|
148
|
+
},
|
|
149
|
+
"seconds": {
|
|
150
|
+
"type": "number"
|
|
151
|
+
},
|
|
152
|
+
"milliseconds": {
|
|
153
|
+
"type": "number"
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
"description": "Human friendly durations object."
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"type": "string"
|
|
160
|
+
}
|
|
161
|
+
],
|
|
162
|
+
"description": "(Optional) Initial value used to calculate the retry (This is still randomized following the randomization factor) Default: 300 ms."
|
|
163
|
+
},
|
|
164
|
+
"factor": {
|
|
165
|
+
"type": "number",
|
|
166
|
+
"description": "(Optional) Randomization factor Default: 0.2."
|
|
167
|
+
},
|
|
168
|
+
"multiplier": {
|
|
169
|
+
"type": "number",
|
|
170
|
+
"description": "(Optional) Exponential factor Default: 2."
|
|
171
|
+
},
|
|
172
|
+
"retries": {
|
|
173
|
+
"type": "number",
|
|
174
|
+
"description": "(Optional) Max number of retries per call Default: 5."
|
|
175
|
+
}
|
|
176
|
+
},
|
|
177
|
+
"description": "Optional retry connection parameters."
|
|
178
|
+
},
|
|
179
|
+
"authenticationTimeout": {
|
|
180
|
+
"anyOf": [
|
|
181
|
+
{
|
|
182
|
+
"type": "object",
|
|
183
|
+
"properties": {
|
|
184
|
+
"years": {
|
|
185
|
+
"type": "number"
|
|
186
|
+
},
|
|
187
|
+
"months": {
|
|
188
|
+
"type": "number"
|
|
189
|
+
},
|
|
190
|
+
"weeks": {
|
|
191
|
+
"type": "number"
|
|
192
|
+
},
|
|
193
|
+
"days": {
|
|
194
|
+
"type": "number"
|
|
195
|
+
},
|
|
196
|
+
"hours": {
|
|
197
|
+
"type": "number"
|
|
198
|
+
},
|
|
199
|
+
"minutes": {
|
|
200
|
+
"type": "number"
|
|
201
|
+
},
|
|
202
|
+
"seconds": {
|
|
203
|
+
"type": "number"
|
|
204
|
+
},
|
|
205
|
+
"milliseconds": {
|
|
206
|
+
"type": "number"
|
|
207
|
+
}
|
|
208
|
+
},
|
|
209
|
+
"description": "Human friendly durations object."
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"type": "string"
|
|
213
|
+
}
|
|
214
|
+
],
|
|
215
|
+
"description": "(Optional) Timeout for authentication requests. Default: 10000 ms."
|
|
216
|
+
},
|
|
217
|
+
"connectionTimeout": {
|
|
218
|
+
"anyOf": [
|
|
219
|
+
{
|
|
220
|
+
"type": "object",
|
|
221
|
+
"properties": {
|
|
222
|
+
"years": {
|
|
223
|
+
"type": "number"
|
|
224
|
+
},
|
|
225
|
+
"months": {
|
|
226
|
+
"type": "number"
|
|
227
|
+
},
|
|
228
|
+
"weeks": {
|
|
229
|
+
"type": "number"
|
|
230
|
+
},
|
|
231
|
+
"days": {
|
|
232
|
+
"type": "number"
|
|
233
|
+
},
|
|
234
|
+
"hours": {
|
|
235
|
+
"type": "number"
|
|
236
|
+
},
|
|
237
|
+
"minutes": {
|
|
238
|
+
"type": "number"
|
|
239
|
+
},
|
|
240
|
+
"seconds": {
|
|
241
|
+
"type": "number"
|
|
242
|
+
},
|
|
243
|
+
"milliseconds": {
|
|
244
|
+
"type": "number"
|
|
245
|
+
}
|
|
246
|
+
},
|
|
247
|
+
"description": "Human friendly durations object."
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"type": "string"
|
|
251
|
+
}
|
|
252
|
+
],
|
|
253
|
+
"description": "(Optional) Time to wait for a successful connection. Default: 1000 ms."
|
|
254
|
+
},
|
|
255
|
+
"requestTimeout": {
|
|
256
|
+
"anyOf": [
|
|
257
|
+
{
|
|
258
|
+
"type": "object",
|
|
259
|
+
"properties": {
|
|
260
|
+
"years": {
|
|
261
|
+
"type": "number"
|
|
262
|
+
},
|
|
263
|
+
"months": {
|
|
264
|
+
"type": "number"
|
|
265
|
+
},
|
|
266
|
+
"weeks": {
|
|
267
|
+
"type": "number"
|
|
268
|
+
},
|
|
269
|
+
"days": {
|
|
270
|
+
"type": "number"
|
|
271
|
+
},
|
|
272
|
+
"hours": {
|
|
273
|
+
"type": "number"
|
|
274
|
+
},
|
|
275
|
+
"minutes": {
|
|
276
|
+
"type": "number"
|
|
277
|
+
},
|
|
278
|
+
"seconds": {
|
|
279
|
+
"type": "number"
|
|
280
|
+
},
|
|
281
|
+
"milliseconds": {
|
|
282
|
+
"type": "number"
|
|
283
|
+
}
|
|
284
|
+
},
|
|
285
|
+
"description": "Human friendly durations object."
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"type": "string"
|
|
289
|
+
}
|
|
290
|
+
],
|
|
291
|
+
"description": "(Optional) Time to wait for a successful request. Default: 30000 ms."
|
|
292
|
+
},
|
|
293
|
+
"enforceRequestTimeout": {
|
|
294
|
+
"type": "boolean",
|
|
295
|
+
"description": "(Optional) The request timeout can be disabled by setting enforceRequestTimeout to false. Default: true"
|
|
296
|
+
},
|
|
297
|
+
"topics": {
|
|
298
|
+
"type": "array",
|
|
299
|
+
"items": {
|
|
300
|
+
"type": "object",
|
|
301
|
+
"properties": {
|
|
302
|
+
"topic": {
|
|
303
|
+
"type": "string",
|
|
304
|
+
"description": "(Required) The Backstage topic to publish to"
|
|
305
|
+
},
|
|
306
|
+
"kafka": {
|
|
307
|
+
"type": "object",
|
|
308
|
+
"properties": {
|
|
309
|
+
"topics": {
|
|
310
|
+
"type": "array",
|
|
311
|
+
"items": {
|
|
312
|
+
"type": "string"
|
|
313
|
+
},
|
|
314
|
+
"description": "(Required) The Kafka topics to subscribe to"
|
|
315
|
+
},
|
|
316
|
+
"groupId": {
|
|
317
|
+
"type": "string",
|
|
318
|
+
"description": "(Required) The GroupId to be used by the topic consumers"
|
|
319
|
+
},
|
|
320
|
+
"sessionTimeout": {
|
|
321
|
+
"anyOf": [
|
|
322
|
+
{
|
|
323
|
+
"type": "object",
|
|
324
|
+
"properties": {
|
|
325
|
+
"years": {
|
|
326
|
+
"type": "number"
|
|
327
|
+
},
|
|
328
|
+
"months": {
|
|
329
|
+
"type": "number"
|
|
330
|
+
},
|
|
331
|
+
"weeks": {
|
|
332
|
+
"type": "number"
|
|
333
|
+
},
|
|
334
|
+
"days": {
|
|
335
|
+
"type": "number"
|
|
336
|
+
},
|
|
337
|
+
"hours": {
|
|
338
|
+
"type": "number"
|
|
339
|
+
},
|
|
340
|
+
"minutes": {
|
|
341
|
+
"type": "number"
|
|
342
|
+
},
|
|
343
|
+
"seconds": {
|
|
344
|
+
"type": "number"
|
|
345
|
+
},
|
|
346
|
+
"milliseconds": {
|
|
347
|
+
"type": "number"
|
|
348
|
+
}
|
|
349
|
+
},
|
|
350
|
+
"description": "Human friendly durations object."
|
|
351
|
+
},
|
|
352
|
+
{
|
|
353
|
+
"type": "string"
|
|
354
|
+
}
|
|
355
|
+
],
|
|
356
|
+
"description": "(Optional) Timeout used to detect failures. The consumer sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this consumer from the group and initiate a rebalance Default: 30000 ms."
|
|
357
|
+
},
|
|
358
|
+
"rebalanceTimeout": {
|
|
359
|
+
"anyOf": [
|
|
360
|
+
{
|
|
361
|
+
"type": "object",
|
|
362
|
+
"properties": {
|
|
363
|
+
"years": {
|
|
364
|
+
"type": "number"
|
|
365
|
+
},
|
|
366
|
+
"months": {
|
|
367
|
+
"type": "number"
|
|
368
|
+
},
|
|
369
|
+
"weeks": {
|
|
370
|
+
"type": "number"
|
|
371
|
+
},
|
|
372
|
+
"days": {
|
|
373
|
+
"type": "number"
|
|
374
|
+
},
|
|
375
|
+
"hours": {
|
|
376
|
+
"type": "number"
|
|
377
|
+
},
|
|
378
|
+
"minutes": {
|
|
379
|
+
"type": "number"
|
|
380
|
+
},
|
|
381
|
+
"seconds": {
|
|
382
|
+
"type": "number"
|
|
383
|
+
},
|
|
384
|
+
"milliseconds": {
|
|
385
|
+
"type": "number"
|
|
386
|
+
}
|
|
387
|
+
},
|
|
388
|
+
"description": "Human friendly durations object."
|
|
389
|
+
},
|
|
390
|
+
{
|
|
391
|
+
"type": "string"
|
|
392
|
+
}
|
|
393
|
+
],
|
|
394
|
+
"description": "(Optional) The maximum time that the coordinator will wait for each member to rejoin when rebalancing the group Default: 60000 ms."
|
|
395
|
+
},
|
|
396
|
+
"heartbeatInterval": {
|
|
397
|
+
"anyOf": [
|
|
398
|
+
{
|
|
399
|
+
"type": "object",
|
|
400
|
+
"properties": {
|
|
401
|
+
"years": {
|
|
402
|
+
"type": "number"
|
|
403
|
+
},
|
|
404
|
+
"months": {
|
|
405
|
+
"type": "number"
|
|
406
|
+
},
|
|
407
|
+
"weeks": {
|
|
408
|
+
"type": "number"
|
|
409
|
+
},
|
|
410
|
+
"days": {
|
|
411
|
+
"type": "number"
|
|
412
|
+
},
|
|
413
|
+
"hours": {
|
|
414
|
+
"type": "number"
|
|
415
|
+
},
|
|
416
|
+
"minutes": {
|
|
417
|
+
"type": "number"
|
|
418
|
+
},
|
|
419
|
+
"seconds": {
|
|
420
|
+
"type": "number"
|
|
421
|
+
},
|
|
422
|
+
"milliseconds": {
|
|
423
|
+
"type": "number"
|
|
424
|
+
}
|
|
425
|
+
},
|
|
426
|
+
"description": "Human friendly durations object."
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"type": "string"
|
|
430
|
+
}
|
|
431
|
+
],
|
|
432
|
+
"description": "(Optional) The expected time between heartbeats to the consumer coordinator. Heartbeats are used to ensure that the consumer's session stays active. The value must be set lower than session timeout Default: 3000 ms."
|
|
433
|
+
},
|
|
434
|
+
"metadataMaxAge": {
|
|
435
|
+
"anyOf": [
|
|
436
|
+
{
|
|
437
|
+
"type": "object",
|
|
438
|
+
"properties": {
|
|
439
|
+
"years": {
|
|
440
|
+
"type": "number"
|
|
441
|
+
},
|
|
442
|
+
"months": {
|
|
443
|
+
"type": "number"
|
|
444
|
+
},
|
|
445
|
+
"weeks": {
|
|
446
|
+
"type": "number"
|
|
447
|
+
},
|
|
448
|
+
"days": {
|
|
449
|
+
"type": "number"
|
|
450
|
+
},
|
|
451
|
+
"hours": {
|
|
452
|
+
"type": "number"
|
|
453
|
+
},
|
|
454
|
+
"minutes": {
|
|
455
|
+
"type": "number"
|
|
456
|
+
},
|
|
457
|
+
"seconds": {
|
|
458
|
+
"type": "number"
|
|
459
|
+
},
|
|
460
|
+
"milliseconds": {
|
|
461
|
+
"type": "number"
|
|
462
|
+
}
|
|
463
|
+
},
|
|
464
|
+
"description": "Human friendly durations object."
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
"type": "string"
|
|
468
|
+
}
|
|
469
|
+
],
|
|
470
|
+
"description": "(Optional) The period of time after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions Default: 300000 ms (5 minutes)."
|
|
471
|
+
},
|
|
472
|
+
"maxBytesPerPartition": {
|
|
473
|
+
"type": "number",
|
|
474
|
+
"description": "(Optional) The maximum amount of data per-partition the server will return. This size must be at least as large as the maximum message size the server allows or else it is possible for the producer to send messages larger than the consumer can fetch. If that happens, the consumer can get stuck trying to fetch a large message on a certain partition Default: 1048576 (1MB)"
|
|
475
|
+
},
|
|
476
|
+
"minBytes": {
|
|
477
|
+
"type": "number",
|
|
478
|
+
"description": "(Optional) Minimum amount of data the server should return for a fetch request, otherwise wait up to maxWaitTime for more data to accumulate. Default: 1"
|
|
479
|
+
},
|
|
480
|
+
"maxBytes": {
|
|
481
|
+
"type": "number",
|
|
482
|
+
"description": "(Optional) Maximum amount of bytes to accumulate in the response. Supported by Kafka >= 0.10.1.0 Default: 10485760 (10MB)"
|
|
483
|
+
},
|
|
484
|
+
"maxWaitTime": {
|
|
485
|
+
"anyOf": [
|
|
486
|
+
{
|
|
487
|
+
"type": "object",
|
|
488
|
+
"properties": {
|
|
489
|
+
"years": {
|
|
490
|
+
"type": "number"
|
|
491
|
+
},
|
|
492
|
+
"months": {
|
|
493
|
+
"type": "number"
|
|
494
|
+
},
|
|
495
|
+
"weeks": {
|
|
496
|
+
"type": "number"
|
|
497
|
+
},
|
|
498
|
+
"days": {
|
|
499
|
+
"type": "number"
|
|
500
|
+
},
|
|
501
|
+
"hours": {
|
|
502
|
+
"type": "number"
|
|
503
|
+
},
|
|
504
|
+
"minutes": {
|
|
505
|
+
"type": "number"
|
|
506
|
+
},
|
|
507
|
+
"seconds": {
|
|
508
|
+
"type": "number"
|
|
509
|
+
},
|
|
510
|
+
"milliseconds": {
|
|
511
|
+
"type": "number"
|
|
512
|
+
}
|
|
513
|
+
},
|
|
514
|
+
"description": "Human friendly durations object."
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"type": "string"
|
|
518
|
+
}
|
|
519
|
+
],
|
|
520
|
+
"description": "(Optional) The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy the requirement given by minBytes Default: 5000"
|
|
521
|
+
},
|
|
522
|
+
"fromBeginning": {
|
|
523
|
+
"type": "boolean",
|
|
524
|
+
"description": "(Optional) If true, the consumer group will start from the earliest offset when no committed offset is found. If false or not specified, it will start from the latest offset. Default: undefined (start from latest)"
|
|
525
|
+
},
|
|
526
|
+
"autoCommit": {
|
|
527
|
+
"type": "boolean",
|
|
528
|
+
"description": "(Optional) Enable auto-commit of offsets. When true (default), offsets are automatically committed at regular intervals (at-most-once delivery). When false, offsets are only committed after successful message processing (at-least-once delivery). Default: true (auto-commit enabled for backward compatibility)"
|
|
529
|
+
},
|
|
530
|
+
"pauseOnError": {
|
|
531
|
+
"type": "boolean",
|
|
532
|
+
"description": "(Optional) When true, the consumer will pause on error and stop processing messages. When false (default), the consumer will skip failed messages and continue processing. Note: When pauseOnError is false and autoCommit is also false, failed messages will still have their offsets committed. Default: false (skip errors for backward compatibility)"
|
|
533
|
+
}
|
|
534
|
+
},
|
|
535
|
+
"required": [
|
|
536
|
+
"topics",
|
|
537
|
+
"groupId"
|
|
538
|
+
],
|
|
539
|
+
"description": "(Required) KafkaConsumer-related configuration."
|
|
540
|
+
}
|
|
541
|
+
},
|
|
542
|
+
"required": [
|
|
543
|
+
"topic",
|
|
544
|
+
"kafka"
|
|
545
|
+
]
|
|
546
|
+
},
|
|
547
|
+
"description": "Contains an object per topic for which a Kafka queue should be used as source of events."
|
|
548
|
+
}
|
|
549
|
+
},
|
|
550
|
+
"required": [
|
|
551
|
+
"clientId",
|
|
552
|
+
"brokers",
|
|
553
|
+
"topics"
|
|
554
|
+
]
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"type": "object",
|
|
558
|
+
"additionalProperties": {
|
|
559
|
+
"type": "object",
|
|
560
|
+
"properties": {
|
|
561
|
+
"clientId": {
|
|
562
|
+
"type": "string",
|
|
563
|
+
"description": "(Required) Client ID used by Backstage to identify when connecting to the Kafka cluster."
|
|
564
|
+
},
|
|
565
|
+
"brokers": {
|
|
566
|
+
"type": "array",
|
|
567
|
+
"items": {
|
|
568
|
+
"type": "string"
|
|
569
|
+
},
|
|
570
|
+
"description": "(Required) List of brokers in the Kafka cluster to connect to."
|
|
571
|
+
},
|
|
572
|
+
"ssl": {
|
|
573
|
+
"anyOf": [
|
|
574
|
+
{
|
|
575
|
+
"type": "object",
|
|
576
|
+
"properties": {
|
|
577
|
+
"ca": {
|
|
578
|
+
"type": "array",
|
|
579
|
+
"items": {
|
|
580
|
+
"type": "string"
|
|
581
|
+
}
|
|
582
|
+
},
|
|
583
|
+
"key": {
|
|
584
|
+
"type": "string",
|
|
585
|
+
"visibility": "secret"
|
|
586
|
+
},
|
|
587
|
+
"cert": {
|
|
588
|
+
"type": "string"
|
|
589
|
+
},
|
|
590
|
+
"rejectUnauthorized": {
|
|
591
|
+
"type": "boolean"
|
|
592
|
+
}
|
|
593
|
+
}
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
"type": "boolean"
|
|
597
|
+
}
|
|
598
|
+
],
|
|
599
|
+
"description": "Optional SSL connection parameters to connect to the cluster. Passed directly to Node tls.connect. See https://nodejs.org/dist/latest-v8.x/docs/api/tls.html#tls_tls_createsecurecontext_options"
|
|
600
|
+
},
|
|
601
|
+
"sasl": {
|
|
602
|
+
"type": "object",
|
|
603
|
+
"properties": {
|
|
604
|
+
"mechanism": {
|
|
605
|
+
"type": "string",
|
|
606
|
+
"enum": [
|
|
607
|
+
"plain",
|
|
608
|
+
"scram-sha-256",
|
|
609
|
+
"scram-sha-512"
|
|
610
|
+
]
|
|
611
|
+
},
|
|
612
|
+
"username": {
|
|
613
|
+
"type": "string"
|
|
614
|
+
},
|
|
615
|
+
"password": {
|
|
616
|
+
"type": "string",
|
|
617
|
+
"visibility": "secret"
|
|
618
|
+
}
|
|
619
|
+
},
|
|
620
|
+
"required": [
|
|
621
|
+
"mechanism",
|
|
622
|
+
"username",
|
|
623
|
+
"password"
|
|
624
|
+
],
|
|
625
|
+
"description": "Optional SASL connection parameters."
|
|
626
|
+
},
|
|
627
|
+
"retry": {
|
|
628
|
+
"type": "object",
|
|
629
|
+
"properties": {
|
|
630
|
+
"maxRetryTime": {
|
|
631
|
+
"anyOf": [
|
|
632
|
+
{
|
|
633
|
+
"type": "object",
|
|
634
|
+
"properties": {
|
|
635
|
+
"years": {
|
|
636
|
+
"type": "number"
|
|
637
|
+
},
|
|
638
|
+
"months": {
|
|
639
|
+
"type": "number"
|
|
640
|
+
},
|
|
641
|
+
"weeks": {
|
|
642
|
+
"type": "number"
|
|
643
|
+
},
|
|
644
|
+
"days": {
|
|
645
|
+
"type": "number"
|
|
646
|
+
},
|
|
647
|
+
"hours": {
|
|
648
|
+
"type": "number"
|
|
649
|
+
},
|
|
650
|
+
"minutes": {
|
|
651
|
+
"type": "number"
|
|
652
|
+
},
|
|
653
|
+
"seconds": {
|
|
654
|
+
"type": "number"
|
|
655
|
+
},
|
|
656
|
+
"milliseconds": {
|
|
657
|
+
"type": "number"
|
|
658
|
+
}
|
|
659
|
+
},
|
|
660
|
+
"description": "Human friendly durations object."
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
"type": "string"
|
|
664
|
+
}
|
|
665
|
+
],
|
|
666
|
+
"description": "(Optional) Maximum wait time for a retry Default: 30000 ms."
|
|
667
|
+
},
|
|
668
|
+
"initialRetryTime": {
|
|
669
|
+
"anyOf": [
|
|
670
|
+
{
|
|
671
|
+
"type": "object",
|
|
672
|
+
"properties": {
|
|
673
|
+
"years": {
|
|
674
|
+
"type": "number"
|
|
675
|
+
},
|
|
676
|
+
"months": {
|
|
677
|
+
"type": "number"
|
|
678
|
+
},
|
|
679
|
+
"weeks": {
|
|
680
|
+
"type": "number"
|
|
681
|
+
},
|
|
682
|
+
"days": {
|
|
683
|
+
"type": "number"
|
|
684
|
+
},
|
|
685
|
+
"hours": {
|
|
686
|
+
"type": "number"
|
|
687
|
+
},
|
|
688
|
+
"minutes": {
|
|
689
|
+
"type": "number"
|
|
690
|
+
},
|
|
691
|
+
"seconds": {
|
|
692
|
+
"type": "number"
|
|
693
|
+
},
|
|
694
|
+
"milliseconds": {
|
|
695
|
+
"type": "number"
|
|
696
|
+
}
|
|
697
|
+
},
|
|
698
|
+
"description": "Human friendly durations object."
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
"type": "string"
|
|
702
|
+
}
|
|
703
|
+
],
|
|
704
|
+
"description": "(Optional) Initial value used to calculate the retry (This is still randomized following the randomization factor) Default: 300 ms."
|
|
705
|
+
},
|
|
706
|
+
"factor": {
|
|
707
|
+
"type": "number",
|
|
708
|
+
"description": "(Optional) Randomization factor Default: 0.2."
|
|
709
|
+
},
|
|
710
|
+
"multiplier": {
|
|
711
|
+
"type": "number",
|
|
712
|
+
"description": "(Optional) Exponential factor Default: 2."
|
|
713
|
+
},
|
|
714
|
+
"retries": {
|
|
715
|
+
"type": "number",
|
|
716
|
+
"description": "(Optional) Max number of retries per call Default: 5."
|
|
717
|
+
}
|
|
718
|
+
},
|
|
719
|
+
"description": "Optional retry connection parameters."
|
|
720
|
+
},
|
|
721
|
+
"authenticationTimeout": {
|
|
722
|
+
"anyOf": [
|
|
723
|
+
{
|
|
724
|
+
"type": "object",
|
|
725
|
+
"properties": {
|
|
726
|
+
"years": {
|
|
727
|
+
"type": "number"
|
|
728
|
+
},
|
|
729
|
+
"months": {
|
|
730
|
+
"type": "number"
|
|
731
|
+
},
|
|
732
|
+
"weeks": {
|
|
733
|
+
"type": "number"
|
|
734
|
+
},
|
|
735
|
+
"days": {
|
|
736
|
+
"type": "number"
|
|
737
|
+
},
|
|
738
|
+
"hours": {
|
|
739
|
+
"type": "number"
|
|
740
|
+
},
|
|
741
|
+
"minutes": {
|
|
742
|
+
"type": "number"
|
|
743
|
+
},
|
|
744
|
+
"seconds": {
|
|
745
|
+
"type": "number"
|
|
746
|
+
},
|
|
747
|
+
"milliseconds": {
|
|
748
|
+
"type": "number"
|
|
749
|
+
}
|
|
750
|
+
},
|
|
751
|
+
"description": "Human friendly durations object."
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"type": "string"
|
|
755
|
+
}
|
|
756
|
+
],
|
|
757
|
+
"description": "(Optional) Timeout for authentication requests. Default: 10000 ms."
|
|
758
|
+
},
|
|
759
|
+
"connectionTimeout": {
|
|
760
|
+
"anyOf": [
|
|
761
|
+
{
|
|
762
|
+
"type": "object",
|
|
763
|
+
"properties": {
|
|
764
|
+
"years": {
|
|
765
|
+
"type": "number"
|
|
766
|
+
},
|
|
767
|
+
"months": {
|
|
768
|
+
"type": "number"
|
|
769
|
+
},
|
|
770
|
+
"weeks": {
|
|
771
|
+
"type": "number"
|
|
772
|
+
},
|
|
773
|
+
"days": {
|
|
774
|
+
"type": "number"
|
|
775
|
+
},
|
|
776
|
+
"hours": {
|
|
777
|
+
"type": "number"
|
|
778
|
+
},
|
|
779
|
+
"minutes": {
|
|
780
|
+
"type": "number"
|
|
781
|
+
},
|
|
782
|
+
"seconds": {
|
|
783
|
+
"type": "number"
|
|
784
|
+
},
|
|
785
|
+
"milliseconds": {
|
|
786
|
+
"type": "number"
|
|
787
|
+
}
|
|
788
|
+
},
|
|
789
|
+
"description": "Human friendly durations object."
|
|
790
|
+
},
|
|
791
|
+
{
|
|
792
|
+
"type": "string"
|
|
793
|
+
}
|
|
794
|
+
],
|
|
795
|
+
"description": "(Optional) Time to wait for a successful connection. Default: 1000 ms."
|
|
796
|
+
},
|
|
797
|
+
"requestTimeout": {
|
|
798
|
+
"anyOf": [
|
|
799
|
+
{
|
|
800
|
+
"type": "object",
|
|
801
|
+
"properties": {
|
|
802
|
+
"years": {
|
|
803
|
+
"type": "number"
|
|
804
|
+
},
|
|
805
|
+
"months": {
|
|
806
|
+
"type": "number"
|
|
807
|
+
},
|
|
808
|
+
"weeks": {
|
|
809
|
+
"type": "number"
|
|
810
|
+
},
|
|
811
|
+
"days": {
|
|
812
|
+
"type": "number"
|
|
813
|
+
},
|
|
814
|
+
"hours": {
|
|
815
|
+
"type": "number"
|
|
816
|
+
},
|
|
817
|
+
"minutes": {
|
|
818
|
+
"type": "number"
|
|
819
|
+
},
|
|
820
|
+
"seconds": {
|
|
821
|
+
"type": "number"
|
|
822
|
+
},
|
|
823
|
+
"milliseconds": {
|
|
824
|
+
"type": "number"
|
|
825
|
+
}
|
|
826
|
+
},
|
|
827
|
+
"description": "Human friendly durations object."
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"type": "string"
|
|
831
|
+
}
|
|
832
|
+
],
|
|
833
|
+
"description": "(Optional) Time to wait for a successful request. Default: 30000 ms."
|
|
834
|
+
},
|
|
835
|
+
"enforceRequestTimeout": {
|
|
836
|
+
"type": "boolean",
|
|
837
|
+
"description": "(Optional) The request timeout can be disabled by setting enforceRequestTimeout to false. Default: true"
|
|
838
|
+
},
|
|
839
|
+
"topics": {
|
|
840
|
+
"type": "array",
|
|
841
|
+
"items": {
|
|
842
|
+
"type": "object",
|
|
843
|
+
"properties": {
|
|
844
|
+
"topic": {
|
|
845
|
+
"type": "string",
|
|
846
|
+
"description": "(Required) The Backstage topic to publish to"
|
|
847
|
+
},
|
|
848
|
+
"kafka": {
|
|
849
|
+
"type": "object",
|
|
850
|
+
"properties": {
|
|
851
|
+
"topics": {
|
|
852
|
+
"type": "array",
|
|
853
|
+
"items": {
|
|
854
|
+
"type": "string"
|
|
855
|
+
},
|
|
856
|
+
"description": "(Required) The Kafka topics to subscribe to"
|
|
857
|
+
},
|
|
858
|
+
"groupId": {
|
|
859
|
+
"type": "string",
|
|
860
|
+
"description": "(Required) The GroupId to be used by the topic consumers"
|
|
861
|
+
},
|
|
862
|
+
"sessionTimeout": {
|
|
863
|
+
"anyOf": [
|
|
864
|
+
{
|
|
865
|
+
"type": "object",
|
|
866
|
+
"properties": {
|
|
867
|
+
"years": {
|
|
868
|
+
"type": "number"
|
|
869
|
+
},
|
|
870
|
+
"months": {
|
|
871
|
+
"type": "number"
|
|
872
|
+
},
|
|
873
|
+
"weeks": {
|
|
874
|
+
"type": "number"
|
|
875
|
+
},
|
|
876
|
+
"days": {
|
|
877
|
+
"type": "number"
|
|
878
|
+
},
|
|
879
|
+
"hours": {
|
|
880
|
+
"type": "number"
|
|
881
|
+
},
|
|
882
|
+
"minutes": {
|
|
883
|
+
"type": "number"
|
|
884
|
+
},
|
|
885
|
+
"seconds": {
|
|
886
|
+
"type": "number"
|
|
887
|
+
},
|
|
888
|
+
"milliseconds": {
|
|
889
|
+
"type": "number"
|
|
890
|
+
}
|
|
891
|
+
},
|
|
892
|
+
"description": "Human friendly durations object."
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
"type": "string"
|
|
896
|
+
}
|
|
897
|
+
],
|
|
898
|
+
"description": "(Optional) Timeout used to detect failures. The consumer sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this consumer from the group and initiate a rebalance Default: 30000 ms."
|
|
899
|
+
},
|
|
900
|
+
"rebalanceTimeout": {
|
|
901
|
+
"anyOf": [
|
|
902
|
+
{
|
|
903
|
+
"type": "object",
|
|
904
|
+
"properties": {
|
|
905
|
+
"years": {
|
|
906
|
+
"type": "number"
|
|
907
|
+
},
|
|
908
|
+
"months": {
|
|
909
|
+
"type": "number"
|
|
910
|
+
},
|
|
911
|
+
"weeks": {
|
|
912
|
+
"type": "number"
|
|
913
|
+
},
|
|
914
|
+
"days": {
|
|
915
|
+
"type": "number"
|
|
916
|
+
},
|
|
917
|
+
"hours": {
|
|
918
|
+
"type": "number"
|
|
919
|
+
},
|
|
920
|
+
"minutes": {
|
|
921
|
+
"type": "number"
|
|
922
|
+
},
|
|
923
|
+
"seconds": {
|
|
924
|
+
"type": "number"
|
|
925
|
+
},
|
|
926
|
+
"milliseconds": {
|
|
927
|
+
"type": "number"
|
|
928
|
+
}
|
|
929
|
+
},
|
|
930
|
+
"description": "Human friendly durations object."
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
"type": "string"
|
|
934
|
+
}
|
|
935
|
+
],
|
|
936
|
+
"description": "(Optional) The maximum time that the coordinator will wait for each member to rejoin when rebalancing the group Default: 60000 ms."
|
|
937
|
+
},
|
|
938
|
+
"heartbeatInterval": {
|
|
939
|
+
"anyOf": [
|
|
940
|
+
{
|
|
941
|
+
"type": "object",
|
|
942
|
+
"properties": {
|
|
943
|
+
"years": {
|
|
944
|
+
"type": "number"
|
|
945
|
+
},
|
|
946
|
+
"months": {
|
|
947
|
+
"type": "number"
|
|
948
|
+
},
|
|
949
|
+
"weeks": {
|
|
950
|
+
"type": "number"
|
|
951
|
+
},
|
|
952
|
+
"days": {
|
|
953
|
+
"type": "number"
|
|
954
|
+
},
|
|
955
|
+
"hours": {
|
|
956
|
+
"type": "number"
|
|
957
|
+
},
|
|
958
|
+
"minutes": {
|
|
959
|
+
"type": "number"
|
|
960
|
+
},
|
|
961
|
+
"seconds": {
|
|
962
|
+
"type": "number"
|
|
963
|
+
},
|
|
964
|
+
"milliseconds": {
|
|
965
|
+
"type": "number"
|
|
966
|
+
}
|
|
967
|
+
},
|
|
968
|
+
"description": "Human friendly durations object."
|
|
969
|
+
},
|
|
970
|
+
{
|
|
971
|
+
"type": "string"
|
|
972
|
+
}
|
|
973
|
+
],
|
|
974
|
+
"description": "(Optional) The expected time between heartbeats to the consumer coordinator. Heartbeats are used to ensure that the consumer's session stays active. The value must be set lower than session timeout Default: 3000 ms."
|
|
975
|
+
},
|
|
976
|
+
"metadataMaxAge": {
|
|
977
|
+
"anyOf": [
|
|
978
|
+
{
|
|
979
|
+
"type": "object",
|
|
980
|
+
"properties": {
|
|
981
|
+
"years": {
|
|
982
|
+
"type": "number"
|
|
983
|
+
},
|
|
984
|
+
"months": {
|
|
985
|
+
"type": "number"
|
|
986
|
+
},
|
|
987
|
+
"weeks": {
|
|
988
|
+
"type": "number"
|
|
989
|
+
},
|
|
990
|
+
"days": {
|
|
991
|
+
"type": "number"
|
|
992
|
+
},
|
|
993
|
+
"hours": {
|
|
994
|
+
"type": "number"
|
|
995
|
+
},
|
|
996
|
+
"minutes": {
|
|
997
|
+
"type": "number"
|
|
998
|
+
},
|
|
999
|
+
"seconds": {
|
|
1000
|
+
"type": "number"
|
|
1001
|
+
},
|
|
1002
|
+
"milliseconds": {
|
|
1003
|
+
"type": "number"
|
|
1004
|
+
}
|
|
1005
|
+
},
|
|
1006
|
+
"description": "Human friendly durations object."
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
"type": "string"
|
|
1010
|
+
}
|
|
1011
|
+
],
|
|
1012
|
+
"description": "(Optional) The period of time after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions Default: 300000 ms (5 minutes)."
|
|
1013
|
+
},
|
|
1014
|
+
"maxBytesPerPartition": {
|
|
1015
|
+
"type": "number",
|
|
1016
|
+
"description": "(Optional) The maximum amount of data per-partition the server will return. This size must be at least as large as the maximum message size the server allows or else it is possible for the producer to send messages larger than the consumer can fetch. If that happens, the consumer can get stuck trying to fetch a large message on a certain partition Default: 1048576 (1MB)"
|
|
1017
|
+
},
|
|
1018
|
+
"minBytes": {
|
|
1019
|
+
"type": "number",
|
|
1020
|
+
"description": "(Optional) Minimum amount of data the server should return for a fetch request, otherwise wait up to maxWaitTime for more data to accumulate. Default: 1"
|
|
1021
|
+
},
|
|
1022
|
+
"maxBytes": {
|
|
1023
|
+
"type": "number",
|
|
1024
|
+
"description": "(Optional) Maximum amount of bytes to accumulate in the response. Supported by Kafka >= 0.10.1.0 Default: 10485760 (10MB)"
|
|
1025
|
+
},
|
|
1026
|
+
"maxWaitTime": {
|
|
1027
|
+
"anyOf": [
|
|
1028
|
+
{
|
|
1029
|
+
"type": "object",
|
|
1030
|
+
"properties": {
|
|
1031
|
+
"years": {
|
|
1032
|
+
"type": "number"
|
|
1033
|
+
},
|
|
1034
|
+
"months": {
|
|
1035
|
+
"type": "number"
|
|
1036
|
+
},
|
|
1037
|
+
"weeks": {
|
|
1038
|
+
"type": "number"
|
|
1039
|
+
},
|
|
1040
|
+
"days": {
|
|
1041
|
+
"type": "number"
|
|
1042
|
+
},
|
|
1043
|
+
"hours": {
|
|
1044
|
+
"type": "number"
|
|
1045
|
+
},
|
|
1046
|
+
"minutes": {
|
|
1047
|
+
"type": "number"
|
|
1048
|
+
},
|
|
1049
|
+
"seconds": {
|
|
1050
|
+
"type": "number"
|
|
1051
|
+
},
|
|
1052
|
+
"milliseconds": {
|
|
1053
|
+
"type": "number"
|
|
1054
|
+
}
|
|
1055
|
+
},
|
|
1056
|
+
"description": "Human friendly durations object."
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
"type": "string"
|
|
1060
|
+
}
|
|
1061
|
+
],
|
|
1062
|
+
"description": "(Optional) The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy the requirement given by minBytes Default: 5000"
|
|
1063
|
+
},
|
|
1064
|
+
"fromBeginning": {
|
|
1065
|
+
"type": "boolean",
|
|
1066
|
+
"description": "(Optional) If true, the consumer group will start from the earliest offset when no committed offset is found. If false or not specified, it will start from the latest offset. Default: undefined (start from latest)"
|
|
1067
|
+
},
|
|
1068
|
+
"autoCommit": {
|
|
1069
|
+
"type": "boolean",
|
|
1070
|
+
"description": "(Optional) Enable auto-commit of offsets. When true (default), offsets are automatically committed at regular intervals (at-most-once delivery). When false, offsets are only committed after successful message processing (at-least-once delivery). Default: true (auto-commit enabled for backward compatibility)"
|
|
1071
|
+
},
|
|
1072
|
+
"pauseOnError": {
|
|
1073
|
+
"type": "boolean",
|
|
1074
|
+
"description": "(Optional) When true, the consumer will pause on error and stop processing messages. When false (default), the consumer will skip failed messages and continue processing. Note: When pauseOnError is false and autoCommit is also false, failed messages will still have their offsets committed. Default: false (skip errors for backward compatibility)"
|
|
1075
|
+
}
|
|
1076
|
+
},
|
|
1077
|
+
"required": [
|
|
1078
|
+
"topics",
|
|
1079
|
+
"groupId"
|
|
1080
|
+
],
|
|
1081
|
+
"description": "(Required) KafkaConsumer-related configuration."
|
|
1082
|
+
}
|
|
1083
|
+
},
|
|
1084
|
+
"required": [
|
|
1085
|
+
"topic",
|
|
1086
|
+
"kafka"
|
|
1087
|
+
]
|
|
1088
|
+
},
|
|
1089
|
+
"description": "Contains an object per topic for which a Kafka queue should be used as source of events."
|
|
1090
|
+
}
|
|
1091
|
+
},
|
|
1092
|
+
"required": [
|
|
1093
|
+
"clientId",
|
|
1094
|
+
"brokers",
|
|
1095
|
+
"topics"
|
|
1096
|
+
]
|
|
1097
|
+
}
|
|
1098
|
+
}
|
|
1099
|
+
],
|
|
1100
|
+
"description": "Configuration for KafkaConsumingEventPublisher\n\nSupports either: 1. Single configuration object (legacy format) 2. Multiple named instances as a record where each key is a unique name for the Kafka instance"
|
|
1101
|
+
},
|
|
1102
|
+
"kafkaPublishingEventConsumer": {
|
|
1103
|
+
"type": "object",
|
|
1104
|
+
"additionalProperties": {
|
|
1105
|
+
"type": "object",
|
|
1106
|
+
"properties": {
|
|
1107
|
+
"clientId": {
|
|
1108
|
+
"type": "string",
|
|
1109
|
+
"description": "(Required) Client ID used by Backstage to identify when connecting to the Kafka cluster."
|
|
1110
|
+
},
|
|
1111
|
+
"brokers": {
|
|
1112
|
+
"type": "array",
|
|
1113
|
+
"items": {
|
|
1114
|
+
"type": "string"
|
|
1115
|
+
},
|
|
1116
|
+
"description": "(Required) List of brokers in the Kafka cluster to connect to."
|
|
1117
|
+
},
|
|
1118
|
+
"ssl": {
|
|
1119
|
+
"anyOf": [
|
|
1120
|
+
{
|
|
1121
|
+
"type": "object",
|
|
1122
|
+
"properties": {
|
|
1123
|
+
"ca": {
|
|
1124
|
+
"type": "array",
|
|
1125
|
+
"items": {
|
|
1126
|
+
"type": "string"
|
|
1127
|
+
}
|
|
1128
|
+
},
|
|
1129
|
+
"key": {
|
|
1130
|
+
"type": "string",
|
|
1131
|
+
"visibility": "secret"
|
|
1132
|
+
},
|
|
1133
|
+
"cert": {
|
|
1134
|
+
"type": "string"
|
|
1135
|
+
},
|
|
1136
|
+
"rejectUnauthorized": {
|
|
1137
|
+
"type": "boolean"
|
|
1138
|
+
}
|
|
1139
|
+
}
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"type": "boolean"
|
|
1143
|
+
}
|
|
1144
|
+
],
|
|
1145
|
+
"description": "Optional SSL connection parameters to connect to the cluster. Passed directly to Node tls.connect. See https://nodejs.org/dist/latest-v8.x/docs/api/tls.html#tls_tls_createsecurecontext_options"
|
|
1146
|
+
},
|
|
1147
|
+
"sasl": {
|
|
1148
|
+
"type": "object",
|
|
1149
|
+
"properties": {
|
|
1150
|
+
"mechanism": {
|
|
1151
|
+
"type": "string",
|
|
1152
|
+
"enum": [
|
|
1153
|
+
"plain",
|
|
1154
|
+
"scram-sha-256",
|
|
1155
|
+
"scram-sha-512"
|
|
1156
|
+
]
|
|
1157
|
+
},
|
|
1158
|
+
"username": {
|
|
1159
|
+
"type": "string"
|
|
1160
|
+
},
|
|
1161
|
+
"password": {
|
|
1162
|
+
"type": "string",
|
|
1163
|
+
"visibility": "secret"
|
|
1164
|
+
}
|
|
1165
|
+
},
|
|
1166
|
+
"required": [
|
|
1167
|
+
"mechanism",
|
|
1168
|
+
"username",
|
|
1169
|
+
"password"
|
|
1170
|
+
],
|
|
1171
|
+
"description": "Optional SASL connection parameters."
|
|
1172
|
+
},
|
|
1173
|
+
"retry": {
|
|
1174
|
+
"type": "object",
|
|
1175
|
+
"properties": {
|
|
1176
|
+
"maxRetryTime": {
|
|
1177
|
+
"anyOf": [
|
|
1178
|
+
{
|
|
1179
|
+
"type": "object",
|
|
1180
|
+
"properties": {
|
|
1181
|
+
"years": {
|
|
1182
|
+
"type": "number"
|
|
1183
|
+
},
|
|
1184
|
+
"months": {
|
|
1185
|
+
"type": "number"
|
|
1186
|
+
},
|
|
1187
|
+
"weeks": {
|
|
1188
|
+
"type": "number"
|
|
1189
|
+
},
|
|
1190
|
+
"days": {
|
|
1191
|
+
"type": "number"
|
|
1192
|
+
},
|
|
1193
|
+
"hours": {
|
|
1194
|
+
"type": "number"
|
|
1195
|
+
},
|
|
1196
|
+
"minutes": {
|
|
1197
|
+
"type": "number"
|
|
1198
|
+
},
|
|
1199
|
+
"seconds": {
|
|
1200
|
+
"type": "number"
|
|
1201
|
+
},
|
|
1202
|
+
"milliseconds": {
|
|
1203
|
+
"type": "number"
|
|
1204
|
+
}
|
|
1205
|
+
},
|
|
1206
|
+
"description": "Human friendly durations object."
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"type": "string"
|
|
1210
|
+
}
|
|
1211
|
+
],
|
|
1212
|
+
"description": "(Optional) Maximum wait time for a retry Default: 30000 ms."
|
|
1213
|
+
},
|
|
1214
|
+
"initialRetryTime": {
|
|
1215
|
+
"anyOf": [
|
|
1216
|
+
{
|
|
1217
|
+
"type": "object",
|
|
1218
|
+
"properties": {
|
|
1219
|
+
"years": {
|
|
1220
|
+
"type": "number"
|
|
1221
|
+
},
|
|
1222
|
+
"months": {
|
|
1223
|
+
"type": "number"
|
|
1224
|
+
},
|
|
1225
|
+
"weeks": {
|
|
1226
|
+
"type": "number"
|
|
1227
|
+
},
|
|
1228
|
+
"days": {
|
|
1229
|
+
"type": "number"
|
|
1230
|
+
},
|
|
1231
|
+
"hours": {
|
|
1232
|
+
"type": "number"
|
|
1233
|
+
},
|
|
1234
|
+
"minutes": {
|
|
1235
|
+
"type": "number"
|
|
1236
|
+
},
|
|
1237
|
+
"seconds": {
|
|
1238
|
+
"type": "number"
|
|
1239
|
+
},
|
|
1240
|
+
"milliseconds": {
|
|
1241
|
+
"type": "number"
|
|
1242
|
+
}
|
|
1243
|
+
},
|
|
1244
|
+
"description": "Human friendly durations object."
|
|
1245
|
+
},
|
|
1246
|
+
{
|
|
1247
|
+
"type": "string"
|
|
1248
|
+
}
|
|
1249
|
+
],
|
|
1250
|
+
"description": "(Optional) Initial value used to calculate the retry (This is still randomized following the randomization factor) Default: 300 ms."
|
|
1251
|
+
},
|
|
1252
|
+
"factor": {
|
|
1253
|
+
"type": "number",
|
|
1254
|
+
"description": "(Optional) Randomization factor Default: 0.2."
|
|
1255
|
+
},
|
|
1256
|
+
"multiplier": {
|
|
1257
|
+
"type": "number",
|
|
1258
|
+
"description": "(Optional) Exponential factor Default: 2."
|
|
1259
|
+
},
|
|
1260
|
+
"retries": {
|
|
1261
|
+
"type": "number",
|
|
1262
|
+
"description": "(Optional) Max number of retries per call Default: 5."
|
|
1263
|
+
}
|
|
1264
|
+
},
|
|
1265
|
+
"description": "Optional retry connection parameters."
|
|
1266
|
+
},
|
|
1267
|
+
"authenticationTimeout": {
|
|
1268
|
+
"anyOf": [
|
|
1269
|
+
{
|
|
1270
|
+
"type": "object",
|
|
1271
|
+
"properties": {
|
|
1272
|
+
"years": {
|
|
1273
|
+
"type": "number"
|
|
1274
|
+
},
|
|
1275
|
+
"months": {
|
|
1276
|
+
"type": "number"
|
|
1277
|
+
},
|
|
1278
|
+
"weeks": {
|
|
1279
|
+
"type": "number"
|
|
1280
|
+
},
|
|
1281
|
+
"days": {
|
|
1282
|
+
"type": "number"
|
|
1283
|
+
},
|
|
1284
|
+
"hours": {
|
|
1285
|
+
"type": "number"
|
|
1286
|
+
},
|
|
1287
|
+
"minutes": {
|
|
1288
|
+
"type": "number"
|
|
1289
|
+
},
|
|
1290
|
+
"seconds": {
|
|
1291
|
+
"type": "number"
|
|
1292
|
+
},
|
|
1293
|
+
"milliseconds": {
|
|
1294
|
+
"type": "number"
|
|
1295
|
+
}
|
|
1296
|
+
},
|
|
1297
|
+
"description": "Human friendly durations object."
|
|
1298
|
+
},
|
|
1299
|
+
{
|
|
1300
|
+
"type": "string"
|
|
1301
|
+
}
|
|
1302
|
+
],
|
|
1303
|
+
"description": "(Optional) Timeout for authentication requests. Default: 10000 ms."
|
|
1304
|
+
},
|
|
1305
|
+
"connectionTimeout": {
|
|
1306
|
+
"anyOf": [
|
|
1307
|
+
{
|
|
1308
|
+
"type": "object",
|
|
1309
|
+
"properties": {
|
|
1310
|
+
"years": {
|
|
1311
|
+
"type": "number"
|
|
1312
|
+
},
|
|
1313
|
+
"months": {
|
|
1314
|
+
"type": "number"
|
|
1315
|
+
},
|
|
1316
|
+
"weeks": {
|
|
1317
|
+
"type": "number"
|
|
1318
|
+
},
|
|
1319
|
+
"days": {
|
|
1320
|
+
"type": "number"
|
|
1321
|
+
},
|
|
1322
|
+
"hours": {
|
|
1323
|
+
"type": "number"
|
|
1324
|
+
},
|
|
1325
|
+
"minutes": {
|
|
1326
|
+
"type": "number"
|
|
1327
|
+
},
|
|
1328
|
+
"seconds": {
|
|
1329
|
+
"type": "number"
|
|
1330
|
+
},
|
|
1331
|
+
"milliseconds": {
|
|
1332
|
+
"type": "number"
|
|
1333
|
+
}
|
|
1334
|
+
},
|
|
1335
|
+
"description": "Human friendly durations object."
|
|
1336
|
+
},
|
|
1337
|
+
{
|
|
1338
|
+
"type": "string"
|
|
1339
|
+
}
|
|
1340
|
+
],
|
|
1341
|
+
"description": "(Optional) Time to wait for a successful connection. Default: 1000 ms."
|
|
1342
|
+
},
|
|
1343
|
+
"requestTimeout": {
|
|
1344
|
+
"anyOf": [
|
|
1345
|
+
{
|
|
1346
|
+
"type": "object",
|
|
1347
|
+
"properties": {
|
|
1348
|
+
"years": {
|
|
1349
|
+
"type": "number"
|
|
1350
|
+
},
|
|
1351
|
+
"months": {
|
|
1352
|
+
"type": "number"
|
|
1353
|
+
},
|
|
1354
|
+
"weeks": {
|
|
1355
|
+
"type": "number"
|
|
1356
|
+
},
|
|
1357
|
+
"days": {
|
|
1358
|
+
"type": "number"
|
|
1359
|
+
},
|
|
1360
|
+
"hours": {
|
|
1361
|
+
"type": "number"
|
|
1362
|
+
},
|
|
1363
|
+
"minutes": {
|
|
1364
|
+
"type": "number"
|
|
1365
|
+
},
|
|
1366
|
+
"seconds": {
|
|
1367
|
+
"type": "number"
|
|
1368
|
+
},
|
|
1369
|
+
"milliseconds": {
|
|
1370
|
+
"type": "number"
|
|
1371
|
+
}
|
|
1372
|
+
},
|
|
1373
|
+
"description": "Human friendly durations object."
|
|
1374
|
+
},
|
|
1375
|
+
{
|
|
1376
|
+
"type": "string"
|
|
1377
|
+
}
|
|
1378
|
+
],
|
|
1379
|
+
"description": "(Optional) Time to wait for a successful request. Default: 30000 ms."
|
|
1380
|
+
},
|
|
1381
|
+
"enforceRequestTimeout": {
|
|
1382
|
+
"type": "boolean",
|
|
1383
|
+
"description": "(Optional) The request timeout can be disabled by setting enforceRequestTimeout to false. Default: true"
|
|
1384
|
+
},
|
|
1385
|
+
"topics": {
|
|
1386
|
+
"type": "array",
|
|
1387
|
+
"items": {
|
|
1388
|
+
"type": "object",
|
|
1389
|
+
"properties": {
|
|
1390
|
+
"topic": {
|
|
1391
|
+
"type": "string",
|
|
1392
|
+
"description": "(Required) The Backstage topic to consume from"
|
|
1393
|
+
},
|
|
1394
|
+
"kafka": {
|
|
1395
|
+
"type": "object",
|
|
1396
|
+
"properties": {
|
|
1397
|
+
"topic": {
|
|
1398
|
+
"type": "string",
|
|
1399
|
+
"description": "(Required) The Kafka topic to publish to"
|
|
1400
|
+
},
|
|
1401
|
+
"allowAutoTopicCreation": {
|
|
1402
|
+
"type": "boolean",
|
|
1403
|
+
"description": "(Optional) Allow topic creation when querying metadata for non-existent topics. Default: true"
|
|
1404
|
+
},
|
|
1405
|
+
"metadataMaxAge": {
|
|
1406
|
+
"anyOf": [
|
|
1407
|
+
{
|
|
1408
|
+
"type": "object",
|
|
1409
|
+
"properties": {
|
|
1410
|
+
"years": {
|
|
1411
|
+
"type": "number"
|
|
1412
|
+
},
|
|
1413
|
+
"months": {
|
|
1414
|
+
"type": "number"
|
|
1415
|
+
},
|
|
1416
|
+
"weeks": {
|
|
1417
|
+
"type": "number"
|
|
1418
|
+
},
|
|
1419
|
+
"days": {
|
|
1420
|
+
"type": "number"
|
|
1421
|
+
},
|
|
1422
|
+
"hours": {
|
|
1423
|
+
"type": "number"
|
|
1424
|
+
},
|
|
1425
|
+
"minutes": {
|
|
1426
|
+
"type": "number"
|
|
1427
|
+
},
|
|
1428
|
+
"seconds": {
|
|
1429
|
+
"type": "number"
|
|
1430
|
+
},
|
|
1431
|
+
"milliseconds": {
|
|
1432
|
+
"type": "number"
|
|
1433
|
+
}
|
|
1434
|
+
},
|
|
1435
|
+
"description": "Human friendly durations object."
|
|
1436
|
+
},
|
|
1437
|
+
{
|
|
1438
|
+
"type": "string"
|
|
1439
|
+
}
|
|
1440
|
+
],
|
|
1441
|
+
"description": "(Optional) The period of time after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions Default: 300000 ms (5 minutes)."
|
|
1442
|
+
},
|
|
1443
|
+
"transactionTimeout": {
|
|
1444
|
+
"anyOf": [
|
|
1445
|
+
{
|
|
1446
|
+
"type": "object",
|
|
1447
|
+
"properties": {
|
|
1448
|
+
"years": {
|
|
1449
|
+
"type": "number"
|
|
1450
|
+
},
|
|
1451
|
+
"months": {
|
|
1452
|
+
"type": "number"
|
|
1453
|
+
},
|
|
1454
|
+
"weeks": {
|
|
1455
|
+
"type": "number"
|
|
1456
|
+
},
|
|
1457
|
+
"days": {
|
|
1458
|
+
"type": "number"
|
|
1459
|
+
},
|
|
1460
|
+
"hours": {
|
|
1461
|
+
"type": "number"
|
|
1462
|
+
},
|
|
1463
|
+
"minutes": {
|
|
1464
|
+
"type": "number"
|
|
1465
|
+
},
|
|
1466
|
+
"seconds": {
|
|
1467
|
+
"type": "number"
|
|
1468
|
+
},
|
|
1469
|
+
"milliseconds": {
|
|
1470
|
+
"type": "number"
|
|
1471
|
+
}
|
|
1472
|
+
},
|
|
1473
|
+
"description": "Human friendly durations object."
|
|
1474
|
+
},
|
|
1475
|
+
{
|
|
1476
|
+
"type": "string"
|
|
1477
|
+
}
|
|
1478
|
+
],
|
|
1479
|
+
"description": "(Optional) The maximum amount of time in ms that the transaction coordinator will wait for a transaction status update from the producer before proactively aborting the ongoing transaction. If this value is larger than the `transaction.max.timeout.ms`` setting in the broker, the request will fail with a `InvalidTransactionTimeout` error Default: 60000 ms."
|
|
1480
|
+
},
|
|
1481
|
+
"idempotent": {
|
|
1482
|
+
"type": "boolean",
|
|
1483
|
+
"description": "(Optional) Experimental. If enabled producer will ensure each message is written exactly once. Acks must be set to -1 (\"all\"). Retries will default to MAX_SAFE_INTEGER. Default: false."
|
|
1484
|
+
},
|
|
1485
|
+
"maxInFlightRequests": {
|
|
1486
|
+
"type": "number",
|
|
1487
|
+
"description": "(Optional) Max number of requests that may be in progress at any time. If falsey then no limit. Default: null."
|
|
1488
|
+
},
|
|
1489
|
+
"retry": {
|
|
1490
|
+
"type": "object",
|
|
1491
|
+
"properties": {
|
|
1492
|
+
"maxRetryTime": {
|
|
1493
|
+
"anyOf": [
|
|
1494
|
+
{
|
|
1495
|
+
"type": "object",
|
|
1496
|
+
"properties": {
|
|
1497
|
+
"years": {
|
|
1498
|
+
"type": "number"
|
|
1499
|
+
},
|
|
1500
|
+
"months": {
|
|
1501
|
+
"type": "number"
|
|
1502
|
+
},
|
|
1503
|
+
"weeks": {
|
|
1504
|
+
"type": "number"
|
|
1505
|
+
},
|
|
1506
|
+
"days": {
|
|
1507
|
+
"type": "number"
|
|
1508
|
+
},
|
|
1509
|
+
"hours": {
|
|
1510
|
+
"type": "number"
|
|
1511
|
+
},
|
|
1512
|
+
"minutes": {
|
|
1513
|
+
"type": "number"
|
|
1514
|
+
},
|
|
1515
|
+
"seconds": {
|
|
1516
|
+
"type": "number"
|
|
1517
|
+
},
|
|
1518
|
+
"milliseconds": {
|
|
1519
|
+
"type": "number"
|
|
1520
|
+
}
|
|
1521
|
+
},
|
|
1522
|
+
"description": "Human friendly durations object."
|
|
1523
|
+
},
|
|
1524
|
+
{
|
|
1525
|
+
"type": "string"
|
|
1526
|
+
}
|
|
1527
|
+
],
|
|
1528
|
+
"description": "(Optional) Maximum wait time for a retry Default: 30000 ms."
|
|
1529
|
+
},
|
|
1530
|
+
"initialRetryTime": {
|
|
1531
|
+
"anyOf": [
|
|
1532
|
+
{
|
|
1533
|
+
"type": "object",
|
|
1534
|
+
"properties": {
|
|
1535
|
+
"years": {
|
|
1536
|
+
"type": "number"
|
|
1537
|
+
},
|
|
1538
|
+
"months": {
|
|
1539
|
+
"type": "number"
|
|
1540
|
+
},
|
|
1541
|
+
"weeks": {
|
|
1542
|
+
"type": "number"
|
|
1543
|
+
},
|
|
1544
|
+
"days": {
|
|
1545
|
+
"type": "number"
|
|
1546
|
+
},
|
|
1547
|
+
"hours": {
|
|
1548
|
+
"type": "number"
|
|
1549
|
+
},
|
|
1550
|
+
"minutes": {
|
|
1551
|
+
"type": "number"
|
|
1552
|
+
},
|
|
1553
|
+
"seconds": {
|
|
1554
|
+
"type": "number"
|
|
1555
|
+
},
|
|
1556
|
+
"milliseconds": {
|
|
1557
|
+
"type": "number"
|
|
1558
|
+
}
|
|
1559
|
+
},
|
|
1560
|
+
"description": "Human friendly durations object."
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"type": "string"
|
|
1564
|
+
}
|
|
1565
|
+
],
|
|
1566
|
+
"description": "(Optional) Initial value used to calculate the retry (This is still randomized following the randomization factor) Default: 300 ms."
|
|
1567
|
+
},
|
|
1568
|
+
"factor": {
|
|
1569
|
+
"type": "number",
|
|
1570
|
+
"description": "(Optional) Randomization factor Default: 0.2."
|
|
1571
|
+
},
|
|
1572
|
+
"multiplier": {
|
|
1573
|
+
"type": "number",
|
|
1574
|
+
"description": "(Optional) Exponential factor Default: 2."
|
|
1575
|
+
},
|
|
1576
|
+
"retries": {
|
|
1577
|
+
"type": "number",
|
|
1578
|
+
"description": "(Optional) Max number of retries per call Default: 5."
|
|
1579
|
+
}
|
|
1580
|
+
},
|
|
1581
|
+
"description": "Optional retry connection parameters."
|
|
1582
|
+
}
|
|
1583
|
+
},
|
|
1584
|
+
"required": [
|
|
1585
|
+
"topic"
|
|
1586
|
+
],
|
|
1587
|
+
"description": "(Required) KafkaProducer-related configuration."
|
|
1588
|
+
}
|
|
1589
|
+
},
|
|
1590
|
+
"required": [
|
|
1591
|
+
"topic",
|
|
1592
|
+
"kafka"
|
|
1593
|
+
]
|
|
1594
|
+
},
|
|
1595
|
+
"description": "Contains an object per topic for which a Kafka queue should be used as destination for events."
|
|
1596
|
+
}
|
|
1597
|
+
},
|
|
1598
|
+
"required": [
|
|
1599
|
+
"clientId",
|
|
1600
|
+
"brokers",
|
|
1601
|
+
"topics"
|
|
1602
|
+
]
|
|
1603
|
+
},
|
|
1604
|
+
"description": "Configuration for KafkaPublishingEventConsumer\n\nSupports multiple named instances as a record where each key is a unique name for the Kafka producer configuration."
|
|
1605
|
+
}
|
|
1606
|
+
},
|
|
1607
|
+
"description": "events-backend-module-kafka plugin configuration."
|
|
1608
|
+
}
|
|
1609
|
+
}
|
|
1610
|
+
}
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1613
|
+
}
|
|
1614
|
+
}
|