-
Notifications
You must be signed in to change notification settings - Fork 96
/
values.go
1897 lines (1615 loc) · 67.6 KB
/
values.go
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
// +gotohelm:filename=_values.go.tpl
package redpanda
import (
"fmt"
cmmeta "github.com/cert-manager/cert-manager/pkg/apis/meta/v1"
"github.com/invopop/jsonschema"
monitoringv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
"github.com/redpanda-data/console/backend/pkg/config"
"github.com/redpanda-data/helm-charts/pkg/gotohelm/helmette"
orderedmap "github.com/wk8/go-ordered-map/v2"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
"k8s.io/utils/ptr"
)
const (
fiveGiB = 5368709120
// That default path inside Redpanda container which is based on debian.
defaultTruststorePath = "/etc/ssl/certs/ca-certificates.crt"
// RedpandaContainerName is the user facing name of the redpanda container
// in the redpanda StatefulSet. While the name of the container can
// technically change, this is the name that is used to locate the
// [corev1.Container] that will be smp'd into the redpanda container.
RedpandaContainerName = "redpanda"
// PostUpgradeContainerName is the user facing name of the post-install
// job's container.
PostInstallContainerName = "post-install"
// PostUpgradeContainerName is the user facing name of the post-upgrade
// job's container.
PostUpgradeContainerName = "post-upgrade"
)
// values.go contains a collection of go structs that (loosely) map to
// values.yaml and are used for generating values.schema.json. Commented out
// struct fields are fields that are valid in the eyes of values.yaml but are
// not present in the hand written jsonschema. While the migration to a
// generated jsonschema is underway, there will be a variety of hacks,
// one-offs, and anonymous structs all aimed at minimizing the diff between the
// handwritten schema and the now generated one. Over time these oddities will
// be smoothed out and removed. Eventually, values.yaml will be generated from
// the Values struct as well to ensure that nothing can ever get out of sync.
type Values struct {
NameOverride string `json:"nameOverride"`
FullnameOverride string `json:"fullnameOverride"`
ClusterDomain string `json:"clusterDomain"`
CommonLabels map[string]string `json:"commonLabels"`
NodeSelector map[string]string `json:"nodeSelector"`
Affinity corev1.Affinity `json:"affinity" jsonschema:"required"`
Tolerations []corev1.Toleration `json:"tolerations"`
Image Image `json:"image" jsonschema:"required,description=Values used to define the container image to be used for Redpanda"`
Service *Service `json:"service"`
ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets"`
LicenseKey string `json:"license_key" jsonschema:"deprecated,pattern=^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?\\.(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$|^$"`
LicenseSecretRef *LicenseSecretRef `json:"license_secret_ref" jsonschema:"deprecated"`
AuditLogging AuditLogging `json:"auditLogging"`
Enterprise Enterprise `json:"enterprise"`
RackAwareness RackAwareness `json:"rackAwareness"`
Console Console `json:"console"`
Connectors Connectors `json:"connectors"`
Auth Auth `json:"auth"`
TLS TLS `json:"tls"`
External ExternalConfig `json:"external"`
Logging Logging `json:"logging"`
Monitoring Monitoring `json:"monitoring"`
Resources RedpandaResources `json:"resources"`
Storage Storage `json:"storage"`
PostInstallJob PostInstallJob `json:"post_install_job"`
PostUpgradeJob PostUpgradeJob `json:"post_upgrade_job"`
Statefulset Statefulset `json:"statefulset"`
ServiceAccount ServiceAccountCfg `json:"serviceAccount"`
RBAC RBAC `json:"rbac"`
Tuning Tuning `json:"tuning"`
Listeners Listeners `json:"listeners"`
Config Config `json:"config"`
Tests *struct {
Enabled bool `json:"enabled"`
} `json:"tests"`
Force bool `json:"force"`
}
type Console struct {
Enabled bool `json:"enabled"`
Console struct {
Config map[string]any `json:"config"`
} `json:"console"`
}
type Connectors struct {
Enabled bool `json:"enabled"`
Connectors ConnectorsChartValues `json:"connectors"`
}
type ConnectorsChartValues struct {
RestPort int `json:"restPort"`
FullnameOverwrite string `json:"fullnameOverwrite"`
}
// +gotohelm:ignore=true
func (Values) JSONSchemaExtend(schema *jsonschema.Schema) {
deprecate(schema, "license_key", "license_secret_ref")
}
// SecurityContext is a legacy mishmash of [corev1.PodSecurityContext] and
// [corev1.SecurityContext]. It's type exists for backwards compat purposes
// only.
type SecurityContext struct {
RunAsUser *int64 `json:"runAsUser"`
RunAsGroup *int64 `json:"runAsGroup"`
AllowPrivilegeEscalation *bool `json:"allowPrivilegeEscalation"`
// AllowPriviledgeEscalation is typoed version of
// [SecurityContext.AllowPrivilegeEscalation]. It's respected for backwards
// compatibility.
// Deprecated: Prefer AllowPrivilegeEscalation.
AllowPriviledgeEscalation *bool `json:"allowPriviledgeEscalation"`
RunAsNonRoot *bool `json:"runAsNonRoot"`
FSGroup *int64 `json:"fsGroup"`
FSGroupChangePolicy *corev1.PodFSGroupChangePolicy `json:"fsGroupChangePolicy"`
}
type Image struct {
Repository string `json:"repository" jsonschema:"required,default=docker.redpanda.com/redpandadata/redpanda"`
Tag ImageTag `json:"tag" jsonschema:"default=Chart.appVersion"`
PullPolicy string `json:"pullPolicy" jsonschema:"required,pattern=^(Always|Never|IfNotPresent)$,description=The Kubernetes Pod image pull policy."`
}
// +gotohelm:ignore=true
func (Image) JSONSchemaExtend(schema *jsonschema.Schema) {
tag, _ := schema.Properties.Get("tag")
repo, _ := schema.Properties.Get("repository")
tag.Description = "The container image tag. Use the Redpanda release version. Must be a valid semver prefixed with a 'v'."
repo.Description = "container image repository"
}
type Service struct {
Name *string `json:"name"`
Internal struct {
Annotations map[string]string `json:"annotations"`
} `json:"internal"`
}
type LicenseSecretRef struct {
SecretName string `json:"secret_name"`
SecretKey string `json:"secret_key"`
}
type AuditLogging struct {
Enabled bool `json:"enabled"`
Listener string `json:"listener"`
Partitions int `json:"partitions"`
EnabledEventTypes []string `json:"enabledEventTypes"`
ExcludedTopics []string `json:"excludedTopics"`
ExcludedPrincipals []string `json:"excludedPrincipals"`
ClientMaxBufferSize int `json:"clientMaxBufferSize"`
QueueDrainIntervalMS int `json:"queueDrainIntervalMs"`
QueueMaxBufferSizeperShard int `json:"queueMaxBufferSizePerShard"`
ReplicationFactor int `json:"replicationFactor"`
}
// +gotohelm:ignore=true
func (AuditLogging) JSONSchemaExtend(schema *jsonschema.Schema) {
makeNullable(schema, "replicationFactor", "enabledEventTypes", "excludedPrincipals", "excludedTopics")
}
func (a *AuditLogging) Translate(dot *helmette.Dot, isSASLEnabled bool) map[string]any {
result := map[string]any{}
if !RedpandaAtLeast_23_3_0(dot) {
return result
}
enabled := a.Enabled && isSASLEnabled
result["audit_enabled"] = enabled
if !enabled {
return result
}
if int(a.ClientMaxBufferSize) != 16777216 {
result["audit_client_max_buffer_size"] = a.ClientMaxBufferSize
}
if int(a.QueueDrainIntervalMS) != 500 {
result["audit_queue_drain_interval_ms"] = a.QueueDrainIntervalMS
}
if int(a.QueueMaxBufferSizeperShard) != 1048576 {
result["audit_queue_max_buffer_size_per_shard"] = a.QueueMaxBufferSizeperShard
}
if int(a.Partitions) != 12 {
result["audit_log_num_partitions"] = a.Partitions
}
if a.ReplicationFactor != 0 {
result["audit_log_replication_factor"] = a.ReplicationFactor
}
if len(a.EnabledEventTypes) > 0 {
result["audit_enabled_event_types"] = a.EnabledEventTypes
}
if len(a.ExcludedTopics) > 0 {
result["audit_excluded_topics"] = a.ExcludedTopics
}
if len(a.ExcludedPrincipals) > 0 {
result["audit_excluded_principals"] = a.ExcludedPrincipals
}
return result
}
type Enterprise struct {
License string `json:"license"`
LicenseSecretRef *struct {
Key string `json:"key"`
Name string `json:"name"`
} `json:"licenseSecretRef"`
}
type RackAwareness struct {
Enabled bool `json:"enabled" jsonschema:"required"`
NodeAnnotation string `json:"nodeAnnotation" jsonschema:"required"`
}
type Auth struct {
SASL *SASLAuth `json:"sasl" jsonschema:"required"`
}
func (a *Auth) IsSASLEnabled() bool {
if a.SASL == nil {
return false
}
return a.SASL.Enabled
}
func (a *Auth) Translate(isSASLEnabled bool) map[string]any {
if !isSASLEnabled {
return nil
}
users := []string{a.SASL.BootstrapUser.Username()}
for _, u := range a.SASL.Users {
users = append(users, u.Name)
}
return map[string]any{
"superusers": users,
}
}
type TLS struct {
Enabled bool `json:"enabled" jsonschema:"required"`
Certs TLSCertMap `json:"certs" jsonschema:"required"`
}
type ExternalConfig struct {
Addresses []string `json:"addresses"`
Annotations map[string]string `json:"annotations"`
Domain *string `json:"domain"`
Enabled bool `json:"enabled" jsonschema:"required"`
Type corev1.ServiceType `json:"type" jsonschema:"pattern=^(LoadBalancer|NodePort)$"`
PrefixTemplate string `json:"prefixTemplate"`
SourceRanges []string `json:"sourceRanges"`
Service Enableable `json:"service"`
ExternalDNS *Enableable `json:"externalDns"`
}
type Enableable struct {
Enabled bool `json:"enabled" jsonschema:"required"`
}
type Logging struct {
LogLevel string `json:"logLevel" jsonschema:"required,pattern=^(error|warn|info|debug|trace)$"`
UseageStats struct {
Enabled bool `json:"enabled" jsonschema:"required"`
ClusterID *string `json:"clusterId"`
} `json:"usageStats" jsonschema:"required"`
}
func (l *Logging) Translate() map[string]any {
result := map[string]any{}
if clusterID := ptr.Deref(l.UseageStats.ClusterID, ""); clusterID != "" {
result["cluster_id"] = clusterID
}
return result
}
type Monitoring struct {
Enabled bool `json:"enabled" jsonschema:"required"`
ScrapeInterval monitoringv1.Duration `json:"scrapeInterval" jsonschema:"required"`
Labels map[string]string `json:"labels"`
TLSConfig *monitoringv1.TLSConfig `json:"tlsConfig"`
EnableHttp2 *bool `json:"enableHttp2"`
}
type RedpandaResources struct {
CPU struct {
Cores resource.Quantity `json:"cores" jsonschema:"required"`
Overprovisioned *bool `json:"overprovisioned"`
} `json:"cpu" jsonschema:"required"`
// Memory resources
// For details,
// see the [Pod resources documentation](https://docs.redpanda.com/docs/manage/kubernetes/manage-resources/#configure-memory-resources).
Memory struct {
// Enables memory locking.
// For production, set to `true`.
EnableMemoryLocking *bool `json:"enable_memory_locking"`
// It is recommended to have at least 2Gi of memory per core for the Redpanda binary.
// This memory is taken from the total memory given to each container.
// The Helm chart allocates 80% of the container's memory to Redpanda, leaving the rest for
// the Seastar subsystem (reserveMemory) and other container processes.
// So at least 2.5Gi per core is recommended in order to ensure Redpanda has a full 2Gi.
//
// These values affect `--memory` and `--reserve-memory` flags passed to Redpanda and the memory
// requests/limits in the StatefulSet.
// Valid suffixes: k, M, G, T, P, E, Ki, Mi, Gi, Ti, Pi, Ei
// Suffixes are defined as International System of units (http://physics.nist.gov/cuu/Units/binary.html).
// To create `Guaranteed` Pod QoS for Redpanda brokers, provide both container max and min values for the container.
// For details, see
// https://kubernetes.io/docs/tasks/configure-pod-container/quality-service-pod/#create-a-pod-that-gets-assigned-a-qos-class-of-guaranteed
// * Every container in the Pod must have a memory limit and a memory request.
// * For every container in the Pod, the memory limit must equal the memory request.
Container struct {
// Minimum memory count for each Redpanda broker.
// If omitted, the `min` value is equal to the `max` value (requested resources defaults to limits).
// This setting is equivalent to `resources.requests.memory`.
// For production, use 10Gi or greater.
Min *resource.Quantity `json:"min"`
// Maximum memory count for each Redpanda broker.
// Equivalent to `resources.limits.memory`.
// For production, use `10Gi` or greater.
Max resource.Quantity `json:"max" jsonschema:"required"`
} `json:"container" jsonschema:"required"`
// This optional `redpanda` object allows you to specify the memory size for both the Redpanda
// process and the underlying reserved memory used by Seastar.
// This section is omitted by default, and memory sizes are calculated automatically
// based on container memory.
// Uncommenting this section and setting memory and reserveMemory values will disable
// automatic calculation.
//
// If you are setting the following values manually, keep in mind the following guidelines.
// Getting this wrong may lead to performance issues, instability, and loss of data:
// The amount of memory to allocate to a container is determined by the sum of three values:
// 1. Redpanda (at least 2Gi per core, ~80% of the container's total memory)
// 2. Seastar subsystem (200Mi * 0.2% of the container's total memory, 200Mi < x < 1Gi)
// 3. Other container processes (whatever small amount remains)
Redpanda *struct {
// Memory for the Redpanda process.
// This must be lower than the container's memory (resources.memory.container.min if provided, otherwise
// resources.memory.container.max).
// Equivalent to --memory.
// For production, use 8Gi or greater.
Memory *resource.Quantity `json:"memory"`
// Memory reserved for the Seastar subsystem.
// Any value above 1Gi will provide diminishing performance benefits.
// Equivalent to --reserve-memory.
// For production, use 1Gi.
ReserveMemory *resource.Quantity `json:"reserveMemory"`
} `json:"redpanda"`
} `json:"memory" jsonschema:"required"`
}
func (rr *RedpandaResources) GetOverProvisionValue() bool {
if rr.CPU.Cores.MilliValue() < 1000 {
return true
}
return ptr.Deref(rr.CPU.Overprovisioned, false)
}
type Storage struct {
HostPath string `json:"hostPath" jsonschema:"required"`
Tiered Tiered `json:"tiered" jsonschema:"required"`
PersistentVolume *struct {
Annotations map[string]string `json:"annotations" jsonschema:"required"`
Enabled bool `json:"enabled" jsonschema:"required"`
Labels map[string]string `json:"labels" jsonschema:"required"`
Size resource.Quantity `json:"size" jsonschema:"required"`
StorageClass string `json:"storageClass" jsonschema:"required"`
NameOverwrite string `json:"nameOverwrite"`
} `json:"persistentVolume" jsonschema:"required,deprecated"`
TieredConfig TieredStorageConfig `json:"tieredConfig" jsonschema:"deprecated"`
TieredStorageHostPath string `json:"tieredStorageHostPath" jsonschema:"deprecated"`
TieredStoragePersistentVolume *struct {
Annotations map[string]string `json:"annotations" jsonschema:"required"`
Enabled bool `json:"enabled" jsonschema:"required"`
Labels map[string]string `json:"labels" jsonschema:"required"`
StorageClass string `json:"storageClass" jsonschema:"required"`
} `json:"tieredStoragePersistentVolume" jsonschema:"deprecated"`
}
func (s *Storage) IsTieredStorageEnabled() bool {
conf := s.GetTieredStorageConfig()
b, ok := conf["cloud_storage_enabled"]
return ok && b.(bool)
}
func (s *Storage) GetTieredStorageConfig() TieredStorageConfig {
if len(s.TieredConfig) > 0 {
return s.TieredConfig
}
return s.Tiered.Config
}
// was: storage-tiered-hostpath
func (s *Storage) GetTieredStorageHostPath() string {
hp := s.TieredStorageHostPath
if helmette.Empty(hp) {
hp = s.Tiered.HostPath
}
if helmette.Empty(hp) {
panic(fmt.Sprintf(`storage.tiered.mountType is "%s" but storage.tiered.hostPath is empty`,
s.Tiered.MountType,
))
}
return hp
}
// TieredCacheDirectory was: tieredStorage.cacheDirectory
func (s *Storage) TieredCacheDirectory(dot *helmette.Dot) string {
values := helmette.Unwrap[Values](dot.Values)
if dir, ok := values.Config.Node["cloud_storage_cache_directory"].(string); ok {
return dir
}
// TODO: Deprecate or just remove the ability to set
// cloud_storage_cache_directory in tiered config(s) so their reserved for
// cluster settings only.
tieredConfig := values.Storage.GetTieredStorageConfig()
if dir, ok := tieredConfig["cloud_storage_cache_directory"].(string); ok {
return dir
}
return "/var/lib/redpanda/data/cloud_storage_cache"
}
// TieredMountType was: storage-tiered-mountType
func (s *Storage) TieredMountType() string {
if s.TieredStoragePersistentVolume != nil && s.TieredStoragePersistentVolume.Enabled {
return "persistentVolume"
}
if !helmette.Empty(s.TieredStorageHostPath) {
// XXX type is declared as string, but it's being used as a bool
// This needs some care since transpilation fails with a `!= ""` check,
// missing null values.
return "hostPath"
}
return s.Tiered.MountType
}
// Storage.TieredPersistentVolumeLabels was storage-tiered-persistentVolume.labels
// support legacy storage.tieredStoragePersistentVolume
func (s *Storage) TieredPersistentVolumeLabels() map[string]string {
if s.TieredStoragePersistentVolume != nil {
return s.TieredStoragePersistentVolume.Labels
}
return s.Tiered.PersistentVolume.Labels
}
// Storage.TieredPersistentVolumeAnnotations was storage-tiered-persistentVolume.annotations
// support legacy storage.tieredStoragePersistentVolume
func (s *Storage) TieredPersistentVolumeAnnotations() map[string]string {
if s.TieredStoragePersistentVolume != nil {
return s.TieredStoragePersistentVolume.Annotations
}
return s.Tiered.PersistentVolume.Annotations
}
// storage.TieredPersistentVolumeStorageClass was storage-tiered-persistentVolume.storageClass
// support legacy storage.tieredStoragePersistentVolume
func (s *Storage) TieredPersistentVolumeStorageClass() string {
if s.TieredStoragePersistentVolume != nil {
return s.TieredStoragePersistentVolume.StorageClass
}
return s.Tiered.PersistentVolume.StorageClass
}
// +gotohelm:ignore=true
func (Storage) JSONSchemaExtend(schema *jsonschema.Schema) {
deprecate(schema, "tieredConfig", "persistentVolume", "tieredStorageHostPath", "tieredStoragePersistentVolume")
// TODO note why we do this.
tieredConfig, _ := schema.Properties.Get("tieredConfig")
tieredConfig.Required = []string{}
}
func (s *Storage) StorageMinFreeBytes() int64 {
if s.PersistentVolume != nil && !s.PersistentVolume.Enabled {
// Five GiB literal
return fiveGiB
}
minimumFreeBytes := float64(s.PersistentVolume.Size.Value()) * 0.05
return helmette.Min(fiveGiB, int64(minimumFreeBytes))
}
type PostInstallJob struct {
Resources *corev1.ResourceRequirements `json:"resources"`
Affinity corev1.Affinity `json:"affinity"`
Enabled bool `json:"enabled"`
Labels map[string]string `json:"labels"`
Annotations map[string]string `json:"annotations"`
// Deprecated. Prefer [PodTemplate.Spec.SecurityContext].
SecurityContext *corev1.SecurityContext `json:"securityContext"`
PodTemplate PodTemplate `json:"podTemplate"`
}
type PostUpgradeJob struct {
Resources corev1.ResourceRequirements `json:"resources"`
Affinity corev1.Affinity `json:"affinity"`
Enabled bool `json:"enabled"`
Labels map[string]string `json:"labels"`
Annotations map[string]string `json:"annotations"`
BackoffLimit *int32 `json:"backoffLimit"`
// Deprecated. Prefer [PodTemplate.Spec.Containers.Env].
ExtraEnv []corev1.EnvVar `json:"extraEnv"`
ExtraEnvFrom []corev1.EnvFromSource `json:"extraEnvFrom"`
// Deprecated. Prefer [PodTemplate.Spec.SecurityContext].
SecurityContext *corev1.SecurityContext `json:"securityContext"`
PodTemplate PodTemplate `json:"podTemplate"`
}
type ContainerName string
// +gotohelm:ignore=true
func (ContainerName) JSONSchemaExtend(s *jsonschema.Schema) {
s.Enum = append(s.Enum, RedpandaContainerName, PostInstallContainerName, PostUpgradeContainerName)
}
type Container struct {
Name ContainerName `json:"name" jsonschema:"required"`
SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty"`
Env []corev1.EnvVar `json:"env" jsonschema:"required"`
}
// PodSpec is a subset of [corev1.PodSpec] that will be merged into the objects
// constructed by this helm chart via means of a [strategic merge
// patch](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/#use-a-strategic-merge-patch-to-update-a-deployment).
// NOTE: At the time of writing, merging is manually implemented for each
// field. Ideally, a more generally applicable solution should be used.
type PodSpec struct {
Containers []Container `json:"containers,omitempty" jsonschema:"required"`
SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"`
}
type PodTemplate struct {
Labels map[string]string `json:"labels,omitempty" jsonschema:"required"`
Annotations map[string]string `json:"annotations,omitempty" jsonschema:"required"`
Spec PodSpec `json:"spec,omitempty" jsonschema:"required"`
}
type Statefulset struct {
AdditionalSelectorLabels map[string]string `json:"additionalSelectorLabels" jsonschema:"required"`
NodeAffinity map[string]any `json:"nodeAffinity"`
Replicas int32 `json:"replicas" jsonschema:"required"`
UpdateStrategy struct {
Type string `json:"type" jsonschema:"required,pattern=^(RollingUpdate|OnDelete)$"`
} `json:"updateStrategy" jsonschema:"required"`
AdditionalRedpandaCmdFlags []string `json:"additionalRedpandaCmdFlags"`
// Annotations are used only for `Statefulset.spec.template.metadata.annotations`. The StatefulSet does not have
// any dedicated annotation.
Annotations map[string]string `json:"annotations" jsonschema:"deprecated"`
PodTemplate PodTemplate `json:"podTemplate" jsonschema:"required"`
Budget struct {
MaxUnavailable int32 `json:"maxUnavailable" jsonschema:"required"`
} `json:"budget" jsonschema:"required"`
StartupProbe struct {
InitialDelaySeconds int32 `json:"initialDelaySeconds" jsonschema:"required"`
FailureThreshold int32 `json:"failureThreshold" jsonschema:"required"`
PeriodSeconds int32 `json:"periodSeconds" jsonschema:"required"`
} `json:"startupProbe" jsonschema:"required"`
LivenessProbe struct {
InitialDelaySeconds int32 `json:"initialDelaySeconds" jsonschema:"required"`
FailureThreshold int32 `json:"failureThreshold" jsonschema:"required"`
PeriodSeconds int32 `json:"periodSeconds" jsonschema:"required"`
} `json:"livenessProbe" jsonschema:"required"`
ReadinessProbe struct {
InitialDelaySeconds int32 `json:"initialDelaySeconds" jsonschema:"required"`
FailureThreshold int32 `json:"failureThreshold" jsonschema:"required"`
PeriodSeconds int32 `json:"periodSeconds" jsonschema:"required"`
SuccessThreshold int32 `json:"successThreshold"`
TimeoutSeconds int32 `json:"timeoutSeconds"`
} `json:"readinessProbe" jsonschema:"required"`
PodAffinity map[string]any `json:"podAffinity" jsonschema:"required"`
PodAntiAffinity struct {
TopologyKey string `json:"topologyKey" jsonschema:"required"`
Type string `json:"type" jsonschema:"required,pattern=^(hard|soft|custom)$"`
Weight int32 `json:"weight" jsonschema:"required"`
Custom map[string]any `json:"custom"`
} `json:"podAntiAffinity" jsonschema:"required"`
NodeSelector map[string]string `json:"nodeSelector" jsonschema:"required"`
PriorityClassName string `json:"priorityClassName" jsonschema:"required"`
TerminationGracePeriodSeconds int64 `json:"terminationGracePeriodSeconds"`
TopologySpreadConstraints []struct {
MaxSkew int32 `json:"maxSkew"`
TopologyKey string `json:"topologyKey"`
WhenUnsatisfiable corev1.UnsatisfiableConstraintAction `json:"whenUnsatisfiable" jsonschema:"pattern=^(ScheduleAnyway|DoNotSchedule)$"`
} `json:"topologySpreadConstraints" jsonschema:"required,minItems=1"`
Tolerations []corev1.Toleration `json:"tolerations" jsonschema:"required"`
// Deprecated. Prefer [PodTemplate.Spec.SecurityContext].
PodSecurityContext *SecurityContext `json:"podSecurityContext"`
// Deprecated. Prefer [PodTemplate.Spec.Containers[*].SecurityContext].
SecurityContext SecurityContext `json:"securityContext" jsonschema:"required"`
SideCars struct {
ConfigWatcher struct {
Enabled bool `json:"enabled"`
ExtraVolumeMounts string `json:"extraVolumeMounts"` // XXX this is template-expanded into yaml
Resources map[string]any `json:"resources"`
SecurityContext *corev1.SecurityContext `json:"securityContext"`
} `json:"configWatcher"`
Controllers struct {
Image struct {
Tag ImageTag `json:"tag" jsonschema:"required,default=Chart.appVersion"`
Repository string `json:"repository" jsonschema:"required,default=docker.redpanda.com/redpandadata/redpanda-operator"`
} `json:"image"`
Enabled bool `json:"enabled"`
CreateRBAC bool `json:"createRBAC"`
Resources any `json:"resources"`
SecurityContext *corev1.SecurityContext `json:"securityContext"`
HealthProbeAddress string `json:"healthProbeAddress"`
MetricsAddress string `json:"metricsAddress"`
Run []string `json:"run"`
} `json:"controllers"`
} `json:"sideCars" jsonschema:"required"`
ExtraVolumes string `json:"extraVolumes"` // XXX this is template-expanded into yaml
ExtraVolumeMounts string `json:"extraVolumeMounts"` // XXX this is template-expanded into yaml
InitContainers struct {
Configurator struct {
ExtraVolumeMounts string `json:"extraVolumeMounts"` // XXX this is template-expanded into yaml
Resources map[string]any `json:"resources"`
} `json:"configurator"`
FSValidator struct {
Enabled bool `json:"enabled"`
Resources map[string]any `json:"resources"`
ExtraVolumeMounts string `json:"extraVolumeMounts"` // XXX this is template-expanded into yaml
ExpectedFS string `json:"expectedFS"`
} `json:"fsValidator"`
SetDataDirOwnership struct {
Enabled bool `json:"enabled"`
Resources map[string]any `json:"resources"`
ExtraVolumeMounts string `json:"extraVolumeMounts"` // XXX this is template-expanded into yaml
} `json:"setDataDirOwnership"`
SetTieredStorageCacheDirOwnership struct {
// Enabled bool `json:"enabled"`
Resources map[string]any `json:"resources"`
ExtraVolumeMounts string `json:"extraVolumeMounts"` // XXX this is template-expanded into yaml
} `json:"setTieredStorageCacheDirOwnership"`
Tuning struct {
// Enabled bool `json:"enabled"`
Resources map[string]any `json:"resources"`
ExtraVolumeMounts string `json:"extraVolumeMounts"` // XXX this is template-expanded into yaml
} `json:"tuning"`
ExtraInitContainers string `json:"extraInitContainers"` // XXX this is template-expanded into yaml
} `json:"initContainers"`
InitContainerImage struct {
Repository string `json:"repository"`
Tag string `json:"tag"`
} `json:"initContainerImage"`
}
// +gotohelm:ignore=true
func (Statefulset) JSONSchemaExtend(schema *jsonschema.Schema) {
deprecate(schema, "podSecurityContext", "securityContext")
}
type ServiceAccountCfg struct {
Create bool `json:"create" jsonschema:"required"`
Name string `json:"name" jsonschema:"required"`
Annotations map[string]string `json:"annotations" jsonschema:"required"`
}
type RBAC struct {
Enabled bool `json:"enabled" jsonschema:"required"`
Annotations map[string]string `json:"annotations" jsonschema:"required"`
}
type Tuning struct {
TuneAIOEvents bool `json:"tune_aio_events,omitempty"`
TuneClocksource bool `json:"tune_clocksource,omitempty"`
TuneBallastFile bool `json:"tune_ballast_file,omitempty"`
BallastFilePath string `json:"ballast_file_path,omitempty"`
BallastFileSize string `json:"ballast_file_size,omitempty"`
WellKnownIO string `json:"well_known_io,omitempty"`
}
func (t *Tuning) Translate() map[string]any {
result := map[string]any{}
s := helmette.ToJSON(t)
tune := helmette.FromJSON(s)
m, ok := tune.(map[string]any)
if !ok {
return map[string]any{}
}
for k, v := range m {
result[k] = v
}
return result
}
type Listeners struct {
Admin AdminListeners `json:"admin" jsonschema:"required"`
HTTP HTTPListeners `json:"http" jsonschema:"required"`
Kafka KafkaListeners `json:"kafka" jsonschema:"required"`
SchemaRegistry SchemaRegistryListeners `json:"schemaRegistry" jsonschema:"required"`
RPC struct {
Port int32 `json:"port" jsonschema:"required"`
TLS InternalTLS `json:"tls" jsonschema:"required"`
} `json:"rpc" jsonschema:"required"`
}
func (l *Listeners) CreateSeedServers(replicas int32, fullname, internalDomain string) []map[string]any {
var result []map[string]any
for i := int32(0); i < replicas; i++ {
result = append(result, map[string]any{
"host": map[string]any{
"address": fmt.Sprintf("%s-%d.%s", fullname, i, internalDomain),
"port": l.RPC.Port,
},
})
}
return result
}
func (l *Listeners) AdminList(replicas int32, fullname, internalDomain string) []string {
return ServerList(replicas, "", fullname, internalDomain, l.Admin.Port)
}
func ServerList(replicas int32, prefix, fullname, internalDomain string, port int32) []string {
var result []string
for i := int32(0); i < replicas; i++ {
result = append(result, fmt.Sprintf("%s%s-%d.%s:%d", prefix, fullname, i, internalDomain, int(port)))
}
return result
}
// TrustStoreVolume returns a [corev1.Volume] containing a projected volume
// that mounts all required truststore files. If no truststores are configured,
// it returns nil.
func (l *Listeners) TrustStoreVolume(tls *TLS) *corev1.Volume {
cmSources := map[string][]corev1.KeyToPath{}
secretSources := map[string][]corev1.KeyToPath{}
for _, ts := range l.TrustStores(tls) {
projection := ts.VolumeProjection()
if projection.Secret != nil {
secretSources[projection.Secret.Name] = append(secretSources[projection.Secret.Name], projection.Secret.Items...)
} else {
cmSources[projection.ConfigMap.Name] = append(cmSources[projection.ConfigMap.Name], projection.ConfigMap.Items...)
}
}
var sources []corev1.VolumeProjection
for _, name := range helmette.SortedKeys(cmSources) {
keys := cmSources[name]
sources = append(sources, corev1.VolumeProjection{
ConfigMap: &corev1.ConfigMapProjection{
LocalObjectReference: corev1.LocalObjectReference{
Name: name,
},
Items: dedupKeyToPaths(keys),
},
})
}
for _, name := range helmette.SortedKeys(secretSources) {
keys := secretSources[name]
sources = append(sources, corev1.VolumeProjection{
Secret: &corev1.SecretProjection{
LocalObjectReference: corev1.LocalObjectReference{
Name: name,
},
Items: dedupKeyToPaths(keys),
},
})
}
if len(sources) < 1 {
return nil
}
return &corev1.Volume{
Name: "truststores",
VolumeSource: corev1.VolumeSource{
Projected: &corev1.ProjectedVolumeSource{
Sources: sources,
},
},
}
}
func dedupKeyToPaths(items []corev1.KeyToPath) []corev1.KeyToPath {
// NB: This logic is a non-idiomatic fashion to dance around suspected
// limitations in gotohelm.
seen := map[string]bool{}
var deduped []corev1.KeyToPath
for _, item := range items {
if _, ok := seen[item.Key]; ok {
continue
}
deduped = append(deduped, item)
seen[item.Key] = true
}
return deduped
}
// TrustStores returns an aggregate slice of all "active" [TrustStore]s across
// all listeners.
func (l *Listeners) TrustStores(tls *TLS) []*TrustStore {
tss := l.Kafka.TrustStores(tls)
tss = append(tss, l.Admin.TrustStores(tls)...)
tss = append(tss, l.HTTP.TrustStores(tls)...)
tss = append(tss, l.SchemaRegistry.TrustStores(tls)...)
return tss
}
type Config struct {
Cluster ClusterConfig `json:"cluster" jsonschema:"required"`
Node NodeConfig `json:"node" jsonschema:"required"`
RPK map[string]any `json:"rpk"`
SchemaRegistryClient *SchemaRegistryClient `json:"schema_registry_client"`
PandaProxyClient *PandaProxyClient `json:"pandaproxy_client"`
Tunable TunableConfig `json:"tunable" jsonschema:"required"`
}
func (c *Config) CreateRPKConfiguration() map[string]any {
result := map[string]any{}
for k, v := range c.RPK {
result[k] = v
}
return result
}
type SchemaRegistryClient struct {
Retries int `json:"retries"`
RetryBaseBackoffMS int `json:"retry_base_backoff_ms"`
ProduceBatchRecordCount int `json:"produce_batch_record_count"`
ProduceBatchSizeBytes int `json:"produce_batch_size_bytes"`
ProduceBatchDelayMS int `json:"produce_batch_delay_ms"`
ConsumerRequestTimeoutMS int `json:"consumer_request_timeout_ms"`
ConsumerRequestMaxBytes int `json:"consumer_request_max_bytes"`
ConsumerSessionTimeoutMS int `json:"consumer_session_timeout_ms"`
ConsumerRebalanceTimeoutMS int `json:"consumer_rebalance_timeout_ms"`
ConsumerHeartbeatIntervalMS int `json:"consumer_heartbeat_interval_ms"`
}
type PandaProxyClient struct {
Retries int `json:"retries"`
RetryBaseBackoffMS int `json:"retry_base_backoff_ms"`
ProduceBatchRecordCount int `json:"produce_batch_record_count"`
ProduceBatchSizeBytes int `json:"produce_batch_size_bytes"`
ProduceBatchDelayMS int `json:"produce_batch_delay_ms"`
ConsumerRequestTimeoutMS int `json:"consumer_request_timeout_ms"`
ConsumerRequestMaxBytes int `json:"consumer_request_max_bytes"`
ConsumerSessionTimeoutMS int `json:"consumer_session_timeout_ms"`
ConsumerRebalanceTimeoutMS int `json:"consumer_rebalance_timeout_ms"`
ConsumerHeartbeatIntervalMS int `json:"consumer_heartbeat_interval_ms"`
}
type TLSCert struct {
// Enabled should be interpreted as `true` if not set.
Enabled *bool `json:"enabled"`
CAEnabled bool `json:"caEnabled" jsonschema:"required"`
ApplyInternalDNSNames *bool `json:"applyInternalDNSNames"`
Duration string `json:"duration" jsonschema:"pattern=.*[smh]$"`
IssuerRef *cmmeta.ObjectReference `json:"issuerRef"`
SecretRef *corev1.LocalObjectReference `json:"secretRef"`
ClientSecretRef *corev1.LocalObjectReference `json:"clientSecretRef"`
}
type TLSCertMap map[string]TLSCert
// +gotohelm:ignore=true
func (TLSCertMap) JSONSchemaExtend(schema *jsonschema.Schema) {
schema.PatternProperties = map[string]*jsonschema.Schema{
"^[A-Za-z_][A-Za-z0-9_]*$": schema.AdditionalProperties,
}
minProps := uint64(1)
schema.MinProperties = &minProps
schema.AdditionalProperties = nil
}
func (m TLSCertMap) MustGet(name string) *TLSCert {
cert, ok := m[name]
if !ok {
panic(fmt.Sprintf("Certificate %q referenced, but not found in the tls.certs map", name))
}
return &cert
}
type BootstrapUser struct {
Name *string `json:"name"`
SecretKeyRef *corev1.SecretKeySelector `json:"secretKeyRef"`
Password *string `json:"password"`
Mechanism string `json:"mechanism" jsonschema:"pattern=^(SCRAM-SHA-512|SCRAM-SHA-256)$"`
}
func (b *BootstrapUser) BootstrapEnvironment(fullname string) []corev1.EnvVar {
return append(b.RpkEnvironment(fullname), corev1.EnvVar{
Name: "RP_BOOTSTRAP_USER",
Value: "$(RPK_USER):$(RPK_PASS):$(RPK_SASL_MECHANISM)",
})
}
func (b *BootstrapUser) Username() string {
if b.Name != nil {
return *b.Name
}
return "kubernetes-controller"
}
func (b *BootstrapUser) RpkEnvironment(fullname string) []corev1.EnvVar {
return []corev1.EnvVar{{
Name: "RPK_PASS",
ValueFrom: &corev1.EnvVarSource{
SecretKeyRef: b.SecretKeySelector(fullname),
},
}, {
Name: "RPK_USER",
Value: b.Username(),
}, {
Name: "RPK_SASL_MECHANISM",
Value: b.GetMechanism(),
}}
}
func (b *BootstrapUser) GetMechanism() string {
if b.Mechanism == "" {
return "SCRAM-SHA-256"
}
return b.Mechanism
}
func (b *BootstrapUser) SecretKeySelector(fullname string) *corev1.SecretKeySelector {
if b.SecretKeyRef != nil {
return b.SecretKeyRef
}
return &corev1.SecretKeySelector{
LocalObjectReference: corev1.LocalObjectReference{
Name: fmt.Sprintf("%s-bootstrap-user", fullname),
},
Key: "password",
}
}
type SASLUser struct {
Name string `json:"name"`
Password string `json:"password"`
Mechanism string `json:"mechanism" jsonschema:"pattern=^(SCRAM-SHA-512|SCRAM-SHA-256)$"`
}
type SASLAuth struct {
Enabled bool `json:"enabled" jsonschema:"required"`
Mechanism string `json:"mechanism"`
SecretRef string `json:"secretRef"`
Users []SASLUser `json:"users"`
BootstrapUser BootstrapUser `json:"bootstrapUser"`
}
type TrustStore struct {
ConfigMapKeyRef *corev1.ConfigMapKeySelector `json:"configMapKeyRef"`
SecretKeyRef *corev1.SecretKeySelector `json:"secretKeyRef"`
}
// +gotohelm:ignore=true
func (TrustStore) JSONSchemaExtend(schema *jsonschema.Schema) {
schema.MaxProperties = ptr.To[uint64](1)
schema.MinProperties = ptr.To[uint64](1)
}
func (t *TrustStore) TrustStoreFilePath() string {
return fmt.Sprintf("%s/%s", TrustStoreMountPath, t.RelativePath())
}
func (t *TrustStore) RelativePath() string {
if t.ConfigMapKeyRef != nil {
return fmt.Sprintf("configmaps/%s-%s", t.ConfigMapKeyRef.Name, t.ConfigMapKeyRef.Key)
}