forked from kubernetes-client/java
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path040-Crd-kafka.yaml
6038 lines (6036 loc) · 355 KB
/
040-Crd-kafka.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:
name: kafkas.kafka.strimzi.io
labels:
app: strimzi
strimzi.io/crd-install: "true"
spec:
group: kafka.strimzi.io
names:
kind: Kafka
listKind: KafkaList
singular: kafka
plural: kafkas
shortNames:
- k
categories:
- strimzi
scope: Namespaced
conversion:
strategy: None
versions:
- name: v1beta2
served: true
storage: true
subresources:
status: {}
additionalPrinterColumns:
- name: Desired Kafka replicas
description: The desired number of Kafka replicas in the cluster
jsonPath: .spec.kafka.replicas
type: integer
- name: Desired ZK replicas
description: The desired number of ZooKeeper replicas in the cluster
jsonPath: .spec.zookeeper.replicas
type: integer
- name: Ready
description: The state of the custom resource
jsonPath: ".status.conditions[?(@.type==\"Ready\")].status"
type: string
- name: Warnings
description: Warnings related to the custom resource
jsonPath: ".status.conditions[?(@.type==\"Warning\")].status"
type: string
schema:
openAPIV3Schema:
type: object
properties:
spec:
type: object
properties:
kafka:
type: object
properties:
version:
type: string
description: "The kafka broker version. Defaults to {DefaultKafkaVersion}. Consult the user documentation to understand the process required to upgrade or downgrade the version."
replicas:
type: integer
minimum: 1
description: The number of pods in the cluster.
image:
type: string
description: The docker image for the pods. The default value depends on the configured `Kafka.spec.kafka.version`.
listeners:
type: array
minItems: 1
items:
type: object
properties:
name:
type: string
pattern: "^[a-z0-9]{1,11}$"
description: Name of the listener. The name will be used to identify the listener and the related Kubernetes objects. The name has to be unique within given a Kafka cluster. The name can consist of lowercase characters and numbers and be up to 11 characters long.
port:
type: integer
minimum: 9092
description: "Port number used by the listener inside Kafka. The port number has to be unique within a given Kafka cluster. Allowed port numbers are 9092 and higher with the exception of ports 9404 and 9999, which are already used for Prometheus and JMX. Depending on the listener type, the port number might not be the same as the port number that connects Kafka clients."
type:
type: string
enum:
- internal
- route
- loadbalancer
- nodeport
- ingress
description: "Type of the listener. Currently the supported types are `internal`, `route`, `loadbalancer`, `nodeport` and `ingress`. \n\n* `internal` type exposes Kafka internally only within the Kubernetes cluster.\n* `route` type uses OpenShift Routes to expose Kafka.\n* `loadbalancer` type uses LoadBalancer type services to expose Kafka.\n* `nodeport` type uses NodePort type services to expose Kafka.\n* `ingress` type uses Kubernetes Nginx Ingress to expose Kafka.\n"
tls:
type: boolean
description: Enables TLS encryption on the listener. This is a required property.
authentication:
type: object
properties:
accessTokenIsJwt:
type: boolean
description: Configure whether the access token is treated as JWT. This must be set to `false` if the authorization server returns opaque tokens. Defaults to `true`.
checkAccessTokenType:
type: boolean
description: Configure whether the access token type check is performed or not. This should be set to `false` if the authorization server does not include 'typ' claim in JWT token. Defaults to `true`.
checkAudience:
type: boolean
description: "Enable or disable audience checking. Audience checks identify the recipients of tokens. If audience checking is enabled, the OAuth Client ID also has to be configured using the `clientId` property. The Kafka broker will reject tokens that do not have its `clientId` in their `aud` (audience) claim.Default value is `false`."
checkIssuer:
type: boolean
description: Enable or disable issuer checking. By default issuer is checked using the value configured by `validIssuerUri`. Default value is `true`.
clientAudience:
type: string
description: The audience to use when making requests to the authorization server's token endpoint. Used for inter-broker authentication and for configuring OAuth 2.0 over PLAIN using the `clientId` and `secret` method.
clientId:
type: string
description: OAuth Client ID which the Kafka broker can use to authenticate against the authorization server and use the introspect endpoint URI.
clientScope:
type: string
description: The scope to use when making requests to the authorization server's token endpoint. Used for inter-broker authentication and for configuring OAuth 2.0 over PLAIN using the `clientId` and `secret` method.
clientSecret:
type: object
properties:
key:
type: string
description: The key under which the secret value is stored in the Kubernetes Secret.
secretName:
type: string
description: The name of the Kubernetes Secret containing the secret value.
required:
- key
- secretName
description: Link to Kubernetes Secret containing the OAuth client secret which the Kafka broker can use to authenticate against the authorization server and use the introspect endpoint URI.
connectTimeoutSeconds:
type: integer
description: "The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds."
customClaimCheck:
type: string
description: JsonPath filter query to be applied to the JWT token or to the response of the introspection endpoint for additional token validation. Not set by default.
disableTlsHostnameVerification:
type: boolean
description: Enable or disable TLS hostname verification. Default value is `false`.
enableECDSA:
type: boolean
description: Enable or disable ECDSA support by installing BouncyCastle crypto provider. ECDSA support is always enabled. The BouncyCastle libraries are no longer packaged with Strimzi. Value is ignored.
enableOauthBearer:
type: boolean
description: Enable or disable OAuth authentication over SASL_OAUTHBEARER. Default value is `true`.
enablePlain:
type: boolean
description: Enable or disable OAuth authentication over SASL_PLAIN. There is no re-authentication support when this mechanism is used. Default value is `false`.
fallbackUserNameClaim:
type: string
description: The fallback username claim to be used for the user id if the claim specified by `userNameClaim` is not present. This is useful when `client_credentials` authentication only results in the client id being provided in another claim. It only takes effect if `userNameClaim` is set.
fallbackUserNamePrefix:
type: string
description: "The prefix to use with the value of `fallbackUserNameClaim` to construct the user id. This only takes effect if `fallbackUserNameClaim` is true, and the value is present for the claim. Mapping usernames and client ids into the same user id space is useful in preventing name collisions."
groupsClaim:
type: string
description: JsonPath query used to extract groups for the user during authentication. Extracted groups can be used by a custom authorizer. By default no groups are extracted.
groupsClaimDelimiter:
type: string
description: "A delimiter used to parse groups when they are extracted as a single String value rather than a JSON array. Default value is ',' (comma)."
introspectionEndpointUri:
type: string
description: URI of the token introspection endpoint which can be used to validate opaque non-JWT tokens.
jwksEndpointUri:
type: string
description: "URI of the JWKS certificate endpoint, which can be used for local JWT validation."
jwksExpirySeconds:
type: integer
minimum: 1
description: Configures how often are the JWKS certificates considered valid. The expiry interval has to be at least 60 seconds longer then the refresh interval specified in `jwksRefreshSeconds`. Defaults to 360 seconds.
jwksMinRefreshPauseSeconds:
type: integer
minimum: 0
description: "The minimum pause between two consecutive refreshes. When an unknown signing key is encountered the refresh is scheduled immediately, but will always wait for this minimum pause. Defaults to 1 second."
jwksRefreshSeconds:
type: integer
minimum: 1
description: Configures how often are the JWKS certificates refreshed. The refresh interval has to be at least 60 seconds shorter then the expiry interval specified in `jwksExpirySeconds`. Defaults to 300 seconds.
listenerConfig:
x-kubernetes-preserve-unknown-fields: true
type: object
description: Configuration to be used for a specific listener. All values are prefixed with listener.name._<listener_name>_.
maxSecondsWithoutReauthentication:
type: integer
description: "Maximum number of seconds the authenticated session remains valid without re-authentication. This enables Apache Kafka re-authentication feature, and causes sessions to expire when the access token expires. If the access token expires before max time or if max time is reached, the client has to re-authenticate, otherwise the server will drop the connection. Not set by default - the authenticated session does not expire when the access token expires. This option only applies to SASL_OAUTHBEARER authentication mechanism (when `enableOauthBearer` is `true`)."
readTimeoutSeconds:
type: integer
description: "The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds."
sasl:
type: boolean
description: Enable or disable SASL on this listener.
secrets:
type: array
items:
type: object
properties:
key:
type: string
description: The key under which the secret value is stored in the Kubernetes Secret.
secretName:
type: string
description: The name of the Kubernetes Secret containing the secret value.
required:
- key
- secretName
description: Secrets to be mounted to /opt/kafka/custom-authn-secrets/custom-listener-_<listener_name>-<port>_/_<secret_name>_.
tlsTrustedCertificates:
type: array
items:
type: object
properties:
certificate:
type: string
description: The name of the file certificate in the Secret.
secretName:
type: string
description: The name of the Secret containing the certificate.
required:
- certificate
- secretName
description: Trusted certificates for TLS connection to the OAuth server.
tokenEndpointUri:
type: string
description: "URI of the Token Endpoint to use with SASL_PLAIN mechanism when the client authenticates with `clientId` and a `secret`. If set, the client can authenticate over SASL_PLAIN by either setting `username` to `clientId`, and setting `password` to client `secret`, or by setting `username` to account username, and `password` to access token prefixed with `$accessToken:`. If this option is not set, the `password` is always interpreted as an access token (without a prefix), and `username` as the account username (a so called 'no-client-credentials' mode)."
type:
type: string
enum:
- tls
- scram-sha-512
- oauth
- custom
description: Authentication type. `oauth` type uses SASL OAUTHBEARER Authentication. `scram-sha-512` type uses SASL SCRAM-SHA-512 Authentication. `tls` type uses TLS Client Authentication. `tls` type is supported only on TLS listeners.`custom` type allows for any authentication type to be used.
userInfoEndpointUri:
type: string
description: 'URI of the User Info Endpoint to use as a fallback to obtaining the user id when the Introspection Endpoint does not return information that can be used for the user id. '
userNameClaim:
type: string
description: "Name of the claim from the JWT authentication token, Introspection Endpoint response or User Info Endpoint response which will be used to extract the user id. Defaults to `sub`."
validIssuerUri:
type: string
description: URI of the token issuer used for authentication.
validTokenType:
type: string
description: "Valid value for the `token_type` attribute returned by the Introspection Endpoint. No default value, and not checked by default."
required:
- type
description: Authentication configuration for this listener.
configuration:
type: object
properties:
brokerCertChainAndKey:
type: object
properties:
certificate:
type: string
description: The name of the file certificate in the Secret.
key:
type: string
description: The name of the private key in the Secret.
secretName:
type: string
description: The name of the Secret containing the certificate.
required:
- certificate
- key
- secretName
description: Reference to the `Secret` which holds the certificate and private key pair which will be used for this listener. The certificate can optionally contain the whole chain. This field can be used only with listeners with enabled TLS encryption.
externalTrafficPolicy:
type: string
enum:
- Local
- Cluster
description: "Specifies whether the service routes external traffic to node-local or cluster-wide endpoints. `Cluster` may cause a second hop to another node and obscures the client source IP. `Local` avoids a second hop for LoadBalancer and Nodeport type services and preserves the client source IP (when supported by the infrastructure). If unspecified, Kubernetes will use `Cluster` as the default.This field can be used only with `loadbalancer` or `nodeport` type listener."
loadBalancerSourceRanges:
type: array
items:
type: string
description: "A list of CIDR ranges (for example `10.0.0.0/8` or `130.211.204.1/32`) from which clients can connect to load balancer type listeners. If supported by the platform, traffic through the loadbalancer is restricted to the specified CIDR ranges. This field is applicable only for loadbalancer type services and is ignored if the cloud provider does not support the feature. This field can be used only with `loadbalancer` type listener."
bootstrap:
type: object
properties:
alternativeNames:
type: array
items:
type: string
description: Additional alternative names for the bootstrap service. The alternative names will be added to the list of subject alternative names of the TLS certificates.
host:
type: string
description: The bootstrap host. This field will be used in the Ingress resource or in the Route resource to specify the desired hostname. This field can be used only with `route` (optional) or `ingress` (required) type listeners.
nodePort:
type: integer
description: Node port for the bootstrap service. This field can be used only with `nodeport` type listener.
loadBalancerIP:
type: string
description: The loadbalancer is requested with the IP address specified in this field. This feature depends on whether the underlying cloud provider supports specifying the `loadBalancerIP` when a load balancer is created. This field is ignored if the cloud provider does not support the feature.This field can be used only with `loadbalancer` type listener.
annotations:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "Annotations that will be added to the `Ingress`, `Route`, or `Service` resource. You can use this field to configure DNS providers such as External DNS. This field can be used only with `loadbalancer`, `nodeport`, `route`, or `ingress` type listeners."
labels:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "Labels that will be added to the `Ingress`, `Route`, or `Service` resource. This field can be used only with `loadbalancer`, `nodeport`, `route`, or `ingress` type listeners."
description: Bootstrap configuration.
brokers:
type: array
items:
type: object
properties:
broker:
type: integer
description: ID of the kafka broker (broker identifier). Broker IDs start from 0 and correspond to the number of broker replicas.
advertisedHost:
type: string
description: The host name which will be used in the brokers' `advertised.brokers`.
advertisedPort:
type: integer
description: The port number which will be used in the brokers' `advertised.brokers`.
host:
type: string
description: The broker host. This field will be used in the Ingress resource or in the Route resource to specify the desired hostname. This field can be used only with `route` (optional) or `ingress` (required) type listeners.
nodePort:
type: integer
description: Node port for the per-broker service. This field can be used only with `nodeport` type listener.
loadBalancerIP:
type: string
description: The loadbalancer is requested with the IP address specified in this field. This feature depends on whether the underlying cloud provider supports specifying the `loadBalancerIP` when a load balancer is created. This field is ignored if the cloud provider does not support the feature.This field can be used only with `loadbalancer` type listener.
annotations:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "Annotations that will be added to the `Ingress` or `Service` resource. You can use this field to configure DNS providers such as External DNS. This field can be used only with `loadbalancer`, `nodeport`, or `ingress` type listeners."
labels:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "Labels that will be added to the `Ingress`, `Route`, or `Service` resource. This field can be used only with `loadbalancer`, `nodeport`, `route`, or `ingress` type listeners."
required:
- broker
description: Per-broker configurations.
ipFamilyPolicy:
type: string
enum:
- SingleStack
- PreferDualStack
- RequireDualStack
description: "Specifies the IP Family Policy used by the service. Available options are `SingleStack`, `PreferDualStack` and `RequireDualStack`. `SingleStack` is for a single IP family. `PreferDualStack` is for two IP families on dual-stack configured clusters or a single IP family on single-stack clusters. `RequireDualStack` fails unless there are two IP families on dual-stack configured clusters. If unspecified, Kubernetes will choose the default value based on the service type. Available on Kubernetes 1.20 and newer."
ipFamilies:
type: array
items:
type: string
enum:
- IPv4
- IPv6
description: "Specifies the IP Families used by the service. Available options are `IPv4` and `IPv6. If unspecified, Kubernetes will choose the default value based on the `ipFamilyPolicy` setting. Available on Kubernetes 1.20 and newer."
createBootstrapService:
type: boolean
description: Whether to create the bootstrap service or not. The bootstrap service is created by default (if not specified differently). This field can be used with the `loadBalancer` type listener.
class:
type: string
description: "Configures the `Ingress` class that defines which `Ingress` controller will be used. This field can be used only with `ingress` type listener. If not specified, the default Ingress controller will be used."
finalizers:
type: array
items:
type: string
description: "A list of finalizers which will be configured for the `LoadBalancer` type Services created for this listener. If supported by the platform, the finalizer `service.kubernetes.io/load-balancer-cleanup` to make sure that the external load balancer is deleted together with the service.For more information, see https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#garbage-collecting-load-balancers. This field can be used only with `loadbalancer` type listeners."
maxConnectionCreationRate:
type: integer
description: The maximum connection creation rate we allow in this listener at any time. New connections will be throttled if the limit is reached.
maxConnections:
type: integer
description: The maximum number of connections we allow for this listener in the broker at any time. New connections are blocked if the limit is reached.
preferredNodePortAddressType:
type: string
enum:
- ExternalIP
- ExternalDNS
- InternalIP
- InternalDNS
- Hostname
description: |-
Defines which address type should be used as the node address. Available types are: `ExternalDNS`, `ExternalIP`, `InternalDNS`, `InternalIP` and `Hostname`. By default, the addresses will be used in the following order (the first one found will be used):
* `ExternalDNS`
* `ExternalIP`
* `InternalDNS`
* `InternalIP`
* `Hostname`
This field is used to select the preferred address type, which is checked first. If no address is found for this address type, the other types are checked in the default order. This field can only be used with `nodeport` type listener.
useServiceDnsDomain:
type: boolean
description: "Configures whether the Kubernetes service DNS domain should be used or not. If set to `true`, the generated addresses will contain the service DNS domain suffix (by default `.cluster.local`, can be configured using environment variable `KUBERNETES_SERVICE_DNS_DOMAIN`). Defaults to `false`.This field can be used only with `internal` type listener."
description: Additional listener configuration.
networkPolicyPeers:
type: array
items:
type: object
properties:
ipBlock:
type: object
properties:
cidr:
type: string
except:
type: array
items:
type: string
namespaceSelector:
type: object
properties:
matchExpressions:
type: array
items:
type: object
properties:
key:
type: string
operator:
type: string
values:
type: array
items:
type: string
matchLabels:
x-kubernetes-preserve-unknown-fields: true
type: object
podSelector:
type: object
properties:
matchExpressions:
type: array
items:
type: object
properties:
key:
type: string
operator:
type: string
values:
type: array
items:
type: string
matchLabels:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "List of peers which should be able to connect to this listener. Peers in this list are combined using a logical OR operation. If this field is empty or missing, all connections will be allowed for this listener. If this field is present and contains at least one item, the listener only allows the traffic which matches at least one item in this list."
required:
- name
- port
- type
- tls
description: Configures listeners of Kafka brokers.
config:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "Kafka broker config properties with the following prefixes cannot be set: listeners, advertised., broker., listener., host.name, port, inter.broker.listener.name, sasl., ssl., security., password., log.dir, zookeeper.connect, zookeeper.set.acl, zookeeper.ssl, zookeeper.clientCnxnSocket, authorizer., super.user, cruise.control.metrics.topic, cruise.control.metrics.reporter.bootstrap.servers,node.id, process.roles, controller. (with the exception of: zookeeper.connection.timeout.ms, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols,cruise.control.metrics.topic.num.partitions, cruise.control.metrics.topic.replication.factor, cruise.control.metrics.topic.retention.ms,cruise.control.metrics.topic.auto.create.retries, cruise.control.metrics.topic.auto.create.timeout.ms,cruise.control.metrics.topic.min.insync.replicas,controller.quorum.election.backoff.max.ms, controller.quorum.election.timeout.ms, controller.quorum.fetch.timeout.ms)."
storage:
type: object
properties:
class:
type: string
description: The storage class to use for dynamic volume allocation.
deleteClaim:
type: boolean
description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
id:
type: integer
minimum: 0
description: Storage identification number. It is mandatory only for storage volumes defined in a storage of type 'jbod'.
overrides:
type: array
items:
type: object
properties:
class:
type: string
description: The storage class to use for dynamic volume allocation for this broker.
broker:
type: integer
description: Id of the kafka broker (broker identifier).
description: Overrides for individual brokers. The `overrides` field allows to specify a different configuration for different brokers.
selector:
x-kubernetes-preserve-unknown-fields: true
type: object
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
description: "When type=ephemeral, defines the total amount of local storage required for this EmptyDir volume (for example 1Gi)."
type:
type: string
enum:
- ephemeral
- persistent-claim
- jbod
description: "Storage type, must be either 'ephemeral', 'persistent-claim', or 'jbod'."
volumes:
type: array
items:
type: object
properties:
class:
type: string
description: The storage class to use for dynamic volume allocation.
deleteClaim:
type: boolean
description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
id:
type: integer
minimum: 0
description: Storage identification number. It is mandatory only for storage volumes defined in a storage of type 'jbod'.
overrides:
type: array
items:
type: object
properties:
class:
type: string
description: The storage class to use for dynamic volume allocation for this broker.
broker:
type: integer
description: Id of the kafka broker (broker identifier).
description: Overrides for individual brokers. The `overrides` field allows to specify a different configuration for different brokers.
selector:
x-kubernetes-preserve-unknown-fields: true
type: object
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
description: "When type=ephemeral, defines the total amount of local storage required for this EmptyDir volume (for example 1Gi)."
type:
type: string
enum:
- ephemeral
- persistent-claim
description: "Storage type, must be either 'ephemeral' or 'persistent-claim'."
required:
- type
description: List of volumes as Storage objects representing the JBOD disks array.
required:
- type
description: Storage configuration (disk). Cannot be updated.
authorization:
type: object
properties:
allowOnError:
type: boolean
description: "Defines whether a Kafka client should be allowed or denied by default when the authorizer fails to query the Open Policy Agent, for example, when it is temporarily unavailable). Defaults to `false` - all actions will be denied."
authorizerClass:
type: string
description: "Authorization implementation class, which must be available in classpath."
clientId:
type: string
description: OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
connectTimeoutSeconds:
type: integer
minimum: 1
description: "The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds."
delegateToKafkaAcls:
type: boolean
description: Whether authorization decision should be delegated to the 'Simple' authorizer if DENIED by Keycloak Authorization Services policies. Default value is `false`.
disableTlsHostnameVerification:
type: boolean
description: Enable or disable TLS hostname verification. Default value is `false`.
enableMetrics:
type: boolean
description: Defines whether the Open Policy Agent authorizer plugin should provide metrics. Defaults to `false`.
expireAfterMs:
type: integer
description: The expiration of the records kept in the local cache to avoid querying the Open Policy Agent for every request. Defines how often the cached authorization decisions are reloaded from the Open Policy Agent server. In milliseconds. Defaults to `3600000`.
grantsRefreshPeriodSeconds:
type: integer
minimum: 0
description: The time between two consecutive grants refresh runs in seconds. The default value is 60.
grantsRefreshPoolSize:
type: integer
minimum: 1
description: "The number of threads to use to refresh grants for active sessions. The more threads, the more parallelism, so the sooner the job completes. However, using more threads places a heavier load on the authorization server. The default value is 5."
initialCacheCapacity:
type: integer
description: Initial capacity of the local cache used by the authorizer to avoid querying the Open Policy Agent for every request Defaults to `5000`.
maximumCacheSize:
type: integer
description: Maximum capacity of the local cache used by the authorizer to avoid querying the Open Policy Agent for every request. Defaults to `50000`.
readTimeoutSeconds:
type: integer
minimum: 1
description: "The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds."
superUsers:
type: array
items:
type: string
description: "List of super users, which are user principals with unlimited access rights."
supportsAdminApi:
type: boolean
description: Indicates whether the custom authorizer supports the APIs for managing ACLs using the Kafka Admin API. Defaults to `false`.
tlsTrustedCertificates:
type: array
items:
type: object
properties:
certificate:
type: string
description: The name of the file certificate in the Secret.
secretName:
type: string
description: The name of the Secret containing the certificate.
required:
- certificate
- secretName
description: Trusted certificates for TLS connection to the OAuth server.
tokenEndpointUri:
type: string
description: Authorization server token endpoint URI.
type:
type: string
enum:
- simple
- opa
- keycloak
- custom
description: "Authorization type. Currently, the supported types are `simple`, `keycloak`, `opa` and `custom`. `simple` authorization type uses Kafka's `kafka.security.authorizer.AclAuthorizer` class for authorization. `keycloak` authorization type uses Keycloak Authorization Services for authorization. `opa` authorization type uses Open Policy Agent based authorization.`custom` authorization type uses user-provided implementation for authorization."
url:
type: string
example: http://opa:8181/v1/data/kafka/authz/allow
description: The URL used to connect to the Open Policy Agent server. The URL has to include the policy which will be queried by the authorizer. This option is required.
required:
- type
description: Authorization configuration for Kafka brokers.
rack:
type: object
properties:
topologyKey:
type: string
example: topology.kubernetes.io/zone
description: A key that matches labels assigned to the Kubernetes cluster nodes. The value of the label is used to set the broker's `broker.rack` config and `client.rack` in Kafka Connect.
required:
- topologyKey
description: Configuration of the `broker.rack` broker config.
brokerRackInitImage:
type: string
description: The image of the init container used for initializing the `broker.rack`.
livenessProbe:
type: object
properties:
failureThreshold:
type: integer
minimum: 1
description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
initialDelaySeconds:
type: integer
minimum: 0
description: The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.
periodSeconds:
type: integer
minimum: 1
description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThreshold:
type: integer
minimum: 1
description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
timeoutSeconds:
type: integer
minimum: 1
description: The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.
description: Pod liveness checking.
readinessProbe:
type: object
properties:
failureThreshold:
type: integer
minimum: 1
description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
initialDelaySeconds:
type: integer
minimum: 0
description: The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.
periodSeconds:
type: integer
minimum: 1
description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThreshold:
type: integer
minimum: 1
description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
timeoutSeconds:
type: integer
minimum: 1
description: The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.
description: Pod readiness checking.
jvmOptions:
type: object
properties:
"-XX":
x-kubernetes-preserve-unknown-fields: true
type: object
description: A map of -XX options to the JVM.
"-Xms":
type: string
pattern: "^[0-9]+[mMgG]?$"
description: -Xms option to to the JVM.
"-Xmx":
type: string
pattern: "^[0-9]+[mMgG]?$"
description: -Xmx option to to the JVM.
gcLoggingEnabled:
type: boolean
description: Specifies whether the Garbage Collection logging is enabled. The default is false.
javaSystemProperties:
type: array
items:
type: object
properties:
name:
type: string
description: The system property name.
value:
type: string
description: The system property value.
description: A map of additional system properties which will be passed using the `-D` option to the JVM.
description: JVM Options for pods.
jmxOptions:
type: object
properties:
authentication:
type: object
properties:
type:
type: string
enum:
- password
description: Authentication type. Currently the only supported types are `password`.`password` type creates a username and protected port with no TLS.
required:
- type
description: Authentication configuration for connecting to the JMX port.
description: JMX Options for Kafka brokers.
resources:
type: object
properties:
limits:
x-kubernetes-preserve-unknown-fields: true
type: object
requests:
x-kubernetes-preserve-unknown-fields: true
type: object
description: CPU and memory resources to reserve.
metricsConfig:
type: object
properties:
type:
type: string
enum:
- jmxPrometheusExporter
description: Metrics type. Only 'jmxPrometheusExporter' supported currently.
valueFrom:
type: object
properties:
configMapKeyRef:
type: object
properties:
key:
type: string
name:
type: string
optional:
type: boolean
description: Reference to the key in the ConfigMap containing the configuration.
description: "ConfigMap entry where the Prometheus JMX Exporter configuration is stored. For details of the structure of this configuration, see the {JMXExporter}."
required:
- type
- valueFrom
description: Metrics configuration.
logging:
type: object
properties:
loggers:
x-kubernetes-preserve-unknown-fields: true
type: object
description: A Map from logger name to logger level.
type:
type: string
enum:
- inline
- external
description: "Logging type, must be either 'inline' or 'external'."
valueFrom:
type: object
properties:
configMapKeyRef:
type: object
properties:
key:
type: string
name:
type: string
optional:
type: boolean
description: Reference to the key in the ConfigMap containing the configuration.
description: '`ConfigMap` entry where the logging configuration is stored. '
required:
- type
description: Logging configuration for Kafka.
template:
type: object
properties:
statefulset:
type: object
properties:
metadata:
type: object
properties:
labels:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "Labels added to the resource template. Can be applied to different resources such as `StatefulSets`, `Deployments`, `Pods`, and `Services`."
annotations:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "Annotations added to the resource template. Can be applied to different resources such as `StatefulSets`, `Deployments`, `Pods`, and `Services`."
description: Metadata applied to the resource.
podManagementPolicy:
type: string
enum:
- OrderedReady
- Parallel
description: PodManagementPolicy which will be used for this StatefulSet. Valid values are `Parallel` and `OrderedReady`. Defaults to `Parallel`.
description: Template for Kafka `StatefulSet`.
pod:
type: object
properties:
metadata:
type: object
properties:
labels:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "Labels added to the resource template. Can be applied to different resources such as `StatefulSets`, `Deployments`, `Pods`, and `Services`."
annotations:
x-kubernetes-preserve-unknown-fields: true
type: object
description: "Annotations added to the resource template. Can be applied to different resources such as `StatefulSets`, `Deployments`, `Pods`, and `Services`."
description: Metadata applied to the resource.
imagePullSecrets:
type: array
items:
type: object
properties:
name:
type: string
description: "List of references to secrets in the same namespace to use for pulling any of the images used by this Pod. When the `STRIMZI_IMAGE_PULL_SECRETS` environment variable in Cluster Operator and the `imagePullSecrets` option are specified, only the `imagePullSecrets` variable is used and the `STRIMZI_IMAGE_PULL_SECRETS` variable is ignored."
securityContext:
type: object
properties:
fsGroup:
type: integer
fsGroupChangePolicy:
type: string
runAsGroup:
type: integer
runAsNonRoot:
type: boolean
runAsUser:
type: integer
seLinuxOptions:
type: object
properties:
level:
type: string
role:
type: string
type:
type: string
user:
type: string
seccompProfile:
type: object
properties:
localhostProfile:
type: string
type:
type: string
supplementalGroups:
type: array
items:
type: integer
sysctls:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
windowsOptions:
type: object
properties:
gmsaCredentialSpec:
type: string
gmsaCredentialSpecName:
type: string
hostProcess:
type: boolean
runAsUserName:
type: string
description: Configures pod-level security attributes and common container settings.
terminationGracePeriodSeconds:
type: integer
minimum: 0
description: "The grace period is the duration in seconds after the processes running in the pod are sent a termination signal, and the time when the processes are forcibly halted with a kill signal. Set this value to longer than the expected cleanup time for your process. Value must be a non-negative integer. A zero value indicates delete immediately. You might need to increase the grace period for very large Kafka clusters, so that the Kafka brokers have enough time to transfer their work to another broker before they are terminated. Defaults to 30 seconds."
affinity:
type: object
properties:
nodeAffinity:
type: object
properties:
preferredDuringSchedulingIgnoredDuringExecution:
type: array
items:
type: object
properties:
preference:
type: object
properties:
matchExpressions:
type: array
items:
type: object
properties:
key:
type: string
operator:
type: string
values:
type: array
items:
type: string
matchFields:
type: array
items:
type: object
properties:
key:
type: string
operator:
type: string
values:
type: array
items:
type: string
weight:
type: integer
requiredDuringSchedulingIgnoredDuringExecution:
type: object
properties:
nodeSelectorTerms:
type: array
items:
type: object
properties:
matchExpressions:
type: array
items:
type: object
properties:
key:
type: string
operator:
type: string
values:
type: array
items:
type: string
matchFields:
type: array
items:
type: object
properties:
key:
type: string
operator:
type: string
values:
type: array
items:
type: string
podAffinity:
type: object
properties:
preferredDuringSchedulingIgnoredDuringExecution:
type: array
items:
type: object
properties:
podAffinityTerm:
type: object
properties: