Skip to content

Commit 249a61c

Browse files
chrissetochrisseto
committed
[K8S-534] redpanda: drop deprecated license fields
(cherry picked from commit dded74b)
1 parent 65eea4d commit 249a61c

14 files changed

+121
-285
lines changed

‎.changes/unreleased/charts-redpanda-Removed-20250328-140428.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
project: charts/redpanda
2+
kind: Removed
3+
body: |-
4+
Removed the deprecated fields `license_key` and `license_secret_ref` in favor
5+
of `enterprise.license` and `enterprise.licenseSecretRef`, respectively.
6+
time: 2025-03-28T14:04:28.760398-04:00

‎charts/redpanda/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ and is generated by [Changie](https://github.com/miniscruff/changie).
3737
The connectors chart may still be deployed separately, though it is not
3838
officially support. If possible, it is recommended to migrate to redpanda
3939
connect.
40+
* Removed the deprecated fields `license_key` and `license_secret_ref` in favor
41+
of `enterprise.license` and `enterprise.licenseSecretRef`, respectively.
4042
* `statefulset.securityContext`, `statefulset.sideCars.configWatcher.securityContext` have been removed.
4143

4244
These fields previously served as both PodSecurityContext and SecurityContext

‎charts/redpanda/README.md‎

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ Enterprise (optional) For details, see the [License documentation](https://docs.
249249
**Default:**
250250

251251
```
252-
{"license":"","licenseSecretRef":{}}
252+
{"license":"","licenseSecretRef":null}
253253
```
254254

255255
### [enterprise.license](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=enterprise.license)
@@ -262,7 +262,7 @@ license (optional).
262262

263263
Secret name and key where the license key is stored.
264264

265-
**Default:** `{}`
265+
**Default:** `nil`
266266

267267
### [external](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=external)
268268

@@ -342,18 +342,6 @@ Pull secrets may be used to provide credentials to image repositories See the [K
342342

343343
**Default:** `[]`
344344

345-
### [license_key](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=license_key)
346-
347-
DEPRECATED Enterprise license key (optional). For details, see the [License documentation](https://docs.redpanda.com/docs/get-started/licenses/?platform=kubernetes#redpanda-enterprise-edition).
348-
349-
**Default:** `""`
350-
351-
### [license_secret_ref](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=license_secret_ref)
352-
353-
DEPRECATED Secret name and secret key where the license key is stored.
354-
355-
**Default:** `{}`
356-
357345
### [listeners](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=listeners)
358346

359347
Listener settings. Override global settings configured above for individual listeners. For details, see the [listeners documentation](https://docs.redpanda.com/docs/manage/kubernetes/networking/configure-listeners/).

‎charts/redpanda/console.tpl.go‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ func consoleChartIntegration(dot *helmette.Dot) []kube.Object {
3636

3737
consoleValue := helmette.UnmarshalInto[console.Values](consoleDot.Values)
3838
// Pass the same Redpanda License to Console
39-
if license := GetLicenseLiteral(dot); license != "" && !ptr.Deref(values.Console.Secret.Create, false) {
39+
if license := values.Enterprise.License; license != "" && !ptr.Deref(values.Console.Secret.Create, false) {
4040
consoleValue.Secret.Create = true
4141
consoleValue.Secret.License = license
4242
}
@@ -70,13 +70,8 @@ func consoleChartIntegration(dot *helmette.Dot) []kube.Object {
7070
}
7171

7272
// Create License reference for Console
73-
if secret := GetLicenseSecretReference(dot); secret != nil {
74-
consoleValue.LicenseSecretRef = &corev1.SecretKeySelector{
75-
LocalObjectReference: corev1.LocalObjectReference{
76-
Name: secret.Name,
77-
},
78-
Key: secret.Key,
79-
}
73+
if secret := values.Enterprise.LicenseSecretRef; secret != nil {
74+
consoleValue.LicenseSecretRef = secret
8075
}
8176

8277
consoleValue.ExtraVolumes = consoleTLSVolumes(dot)

‎charts/redpanda/post_install_upgrade_job.go‎

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -213,13 +213,14 @@ func tolerations(dot *helmette.Dot) []corev1.Toleration {
213213
// container.
214214
func PostInstallUpgradeEnvironmentVariables(dot *helmette.Dot) []corev1.EnvVar {
215215
envars := []corev1.EnvVar{}
216+
values := helmette.Unwrap[Values](dot.Values)
216217

217-
if license := GetLicenseLiteral(dot); license != "" {
218+
if license := values.Enterprise.License; license != "" {
218219
envars = append(envars, corev1.EnvVar{
219220
Name: "REDPANDA_LICENSE",
220221
Value: license,
221222
})
222-
} else if secretReference := GetLicenseSecretReference(dot); secretReference != nil {
223+
} else if secretReference := values.Enterprise.LicenseSecretRef; secretReference != nil {
223224
envars = append(envars, corev1.EnvVar{
224225
Name: "REDPANDA_LICENSE",
225226
ValueFrom: &corev1.EnvVarSource{
@@ -231,36 +232,3 @@ func PostInstallUpgradeEnvironmentVariables(dot *helmette.Dot) []corev1.EnvVar {
231232
// include any authentication envvars as well.
232233
return bootstrapEnvVars(dot, envars)
233234
}
234-
235-
func GetLicenseLiteral(dot *helmette.Dot) string {
236-
values := helmette.Unwrap[Values](dot.Values)
237-
238-
if values.Enterprise.License != "" {
239-
return values.Enterprise.License
240-
}
241-
242-
// Deprecated licenseKey fallback if Enterprise.License is not set
243-
return values.LicenseKey
244-
}
245-
246-
func GetLicenseSecretReference(dot *helmette.Dot) *corev1.SecretKeySelector {
247-
values := helmette.Unwrap[Values](dot.Values)
248-
249-
if !helmette.Empty(values.Enterprise.LicenseSecretRef) {
250-
return &corev1.SecretKeySelector{
251-
LocalObjectReference: corev1.LocalObjectReference{
252-
Name: values.Enterprise.LicenseSecretRef.Name,
253-
},
254-
Key: values.Enterprise.LicenseSecretRef.Key,
255-
}
256-
// Deprecated licenseSecretRef fallback if Enterprise.LicenseSecretRef is not set
257-
} else if !helmette.Empty(values.LicenseSecretRef) {
258-
return &corev1.SecretKeySelector{
259-
LocalObjectReference: corev1.LocalObjectReference{
260-
Name: values.LicenseSecretRef.SecretName,
261-
},
262-
Key: values.LicenseSecretRef.SecretKey,
263-
}
264-
}
265-
return nil
266-
}

‎charts/redpanda/post_install_upgrade_job_test.go‎

Lines changed: 5 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -40,24 +40,15 @@ func TestPostInstallUpgradeEnvironmentVariables(t *testing.T) {
4040
},
4141
[]corev1.EnvVar{{Name: "REDPANDA_LICENSE", Value: "fake.license"}},
4242
},
43-
{
44-
"only-deprecated-literal-license",
45-
Values{
46-
Storage: Storage{Tiered: Tiered{}},
47-
LicenseKey: "fake.license",
48-
},
49-
[]corev1.EnvVar{{Name: "REDPANDA_LICENSE", Value: "fake.license"}},
50-
},
5143
{
5244
name: "only-secret-ref-license",
5345
values: Values{
5446
Storage: Storage{Tiered: Tiered{}},
55-
Enterprise: Enterprise{LicenseSecretRef: &struct {
56-
Key string `json:"key"`
57-
Name string `json:"name"`
58-
}{
59-
Key: "some-key",
60-
Name: "some-secret",
47+
Enterprise: Enterprise{LicenseSecretRef: &corev1.SecretKeySelector{
48+
LocalObjectReference: corev1.LocalObjectReference{
49+
Name: "some-secret",
50+
},
51+
Key: "some-key",
6152
}},
6253
},
6354
expectedEnvVars: []corev1.EnvVar{{Name: "REDPANDA_LICENSE", ValueFrom: &corev1.EnvVarSource{
@@ -67,27 +58,6 @@ func TestPostInstallUpgradeEnvironmentVariables(t *testing.T) {
6758
},
6859
}}},
6960
},
70-
{
71-
name: "only-deprecated-secret-ref-license",
72-
values: Values{
73-
Storage: Storage{Tiered: Tiered{}},
74-
LicenseSecretRef: &LicenseSecretRef{
75-
SecretName: "some-secret",
76-
SecretKey: "some-key",
77-
},
78-
},
79-
expectedEnvVars: []corev1.EnvVar{
80-
{
81-
Name: "REDPANDA_LICENSE",
82-
ValueFrom: &corev1.EnvVarSource{
83-
SecretKeyRef: &corev1.SecretKeySelector{
84-
LocalObjectReference: corev1.LocalObjectReference{Name: "some-secret"},
85-
Key: "some-key",
86-
},
87-
},
88-
},
89-
},
90-
},
9161
{
9262
name: "azure-literal-shared-key",
9363
values: Values{

‎charts/redpanda/templates/_console.go.tpl‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
{{- $consoleDot := (index $dot.Subcharts "console") -}}
1414
{{- $loadedValues := $consoleDot.Values -}}
1515
{{- $consoleValue := $consoleDot.Values -}}
16-
{{- $license_1 := (get (fromJson (include "redpanda.GetLicenseLiteral" (dict "a" (list $dot) ))) "r") -}}
16+
{{- $license_1 := $values.enterprise.license -}}
1717
{{- if (and (ne $license_1 "") (not (get (fromJson (include "_shims.ptr_Deref" (dict "a" (list $values.console.secret.create false) ))) "r"))) -}}
1818
{{- $_ := (set $consoleValue.secret "create" true) -}}
1919
{{- $_ := (set $consoleValue.secret "license" $license_1) -}}
@@ -28,9 +28,9 @@
2828
{{- $command := (list "sh" "-c" (printf "%s%s" (printf "%s%s" (printf "%s%s" (printf "%s%s" (printf "%s%s" (printf "%s%s" (printf "%s%s" "set -e; IFS=':' read -r KAFKA_SASL_USERNAME KAFKA_SASL_PASSWORD KAFKA_SASL_MECHANISM < <(grep \"\" $(find /mnt/users/* -print));" (printf " KAFKA_SASL_MECHANISM=${KAFKA_SASL_MECHANISM:-%s};" (get (fromJson (include "redpanda.GetSASLMechanism" (dict "a" (list $dot) ))) "r"))) " export KAFKA_SASL_USERNAME KAFKA_SASL_PASSWORD KAFKA_SASL_MECHANISM;") " export KAFKA_SCHEMAREGISTRY_USERNAME=$KAFKA_SASL_USERNAME;") " export KAFKA_SCHEMAREGISTRY_PASSWORD=$KAFKA_SASL_PASSWORD;") " export REDPANDA_ADMINAPI_USERNAME=$KAFKA_SASL_USERNAME;") " export REDPANDA_ADMINAPI_PASSWORD=$KAFKA_SASL_PASSWORD;") " /app/console $@") " --") -}}
2929
{{- $_ := (set $consoleValue.deployment "command" $command) -}}
3030
{{- end -}}
31-
{{- $secret_2 := (get (fromJson (include "redpanda.GetLicenseSecretReference" (dict "a" (list $dot) ))) "r") -}}
31+
{{- $secret_2 := $values.enterprise.licenseSecretRef -}}
3232
{{- if (ne (toJson $secret_2) "null") -}}
33-
{{- $_ := (set $consoleValue "licenseSecretRef" (mustMergeOverwrite (dict "key" "" ) (mustMergeOverwrite (dict ) (dict "name" $secret_2.name )) (dict "key" $secret_2.key ))) -}}
33+
{{- $_ := (set $consoleValue "licenseSecretRef" $secret_2) -}}
3434
{{- end -}}
3535
{{- $_ := (set $consoleValue "extraVolumes" (get (fromJson (include "redpanda.consoleTLSVolumes" (dict "a" (list $dot) ))) "r")) -}}
3636
{{- $_ := (set $consoleValue "extraVolumeMounts" (get (fromJson (include "redpanda.consoleTLSVolumesMounts" (dict "a" (list $dot) ))) "r")) -}}
@@ -65,9 +65,9 @@
6565
{{- end -}}
6666
{{- $visitedCert := (dict ) -}}
6767
{{- range $_, $tlsCfg := (list $values.listeners.kafka.tls $values.listeners.schemaRegistry.tls $values.listeners.admin.tls) -}}
68-
{{- $_136___visited := (get (fromJson (include "_shims.dicttest" (dict "a" (list $visitedCert $tlsCfg.cert false) ))) "r") -}}
69-
{{- $_ := (index $_136___visited 0) -}}
70-
{{- $visited := (index $_136___visited 1) -}}
68+
{{- $_131___visited := (get (fromJson (include "_shims.dicttest" (dict "a" (list $visitedCert $tlsCfg.cert false) ))) "r") -}}
69+
{{- $_ := (index $_131___visited 0) -}}
70+
{{- $visited := (index $_131___visited 1) -}}
7171
{{- if (or (not (get (fromJson (include "redpanda.InternalTLS.IsEnabled" (dict "a" (list $tlsCfg $values.tls) ))) "r")) $visited) -}}
7272
{{- continue -}}
7373
{{- end -}}
@@ -99,9 +99,9 @@
9999
{{- end -}}
100100
{{- $visitedCert := (dict ) -}}
101101
{{- range $_, $tlsCfg := (list $values.listeners.kafka.tls $values.listeners.schemaRegistry.tls $values.listeners.admin.tls) -}}
102-
{{- $_177___visited := (get (fromJson (include "_shims.dicttest" (dict "a" (list $visitedCert $tlsCfg.cert false) ))) "r") -}}
103-
{{- $_ := (index $_177___visited 0) -}}
104-
{{- $visited := (index $_177___visited 1) -}}
102+
{{- $_172___visited := (get (fromJson (include "_shims.dicttest" (dict "a" (list $visitedCert $tlsCfg.cert false) ))) "r") -}}
103+
{{- $_ := (index $_172___visited 0) -}}
104+
{{- $visited := (index $_172___visited 1) -}}
105105
{{- if (or (not (get (fromJson (include "redpanda.InternalTLS.IsEnabled" (dict "a" (list $tlsCfg $values.tls) ))) "r")) $visited) -}}
106106
{{- continue -}}
107107
{{- end -}}

‎charts/redpanda/templates/_helpers.tpl‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -243,47 +243,27 @@ advertised-host returns a json string with the data needed for configuring the a
243243
{{- toJson $brokers -}}
244244
{{- end -}}
245245

246-
{{/*
247-
return license checks deprecated values if current values is empty
248-
*/}}
249246
{{- define "enterprise-license" -}}
250247
{{- if dig "license" dict .Values.enterprise -}}
251248
{{- .Values.enterprise.license -}}
252-
{{- else -}}
253-
{{- .Values.license_key -}}
254249
{{- end -}}
255250
{{- end -}}
256251

257-
{{/*
258-
return licenseSecretRef checks deprecated values entry if current values empty
259-
*/}}
260252
{{- define "enterprise-secret" -}}
261253
{{- if ( dig "licenseSecretRef" dict .Values.enterprise ) -}}
262254
{{- .Values.enterprise.licenseSecretRef -}}
263-
{{- else if not (empty .Values.license_secret_ref ) -}}
264-
{{- .Values.license_secret_ref -}}
265255
{{- end -}}
266256
{{- end -}}
267257

268-
{{/*
269-
return licenseSecretRef.name checks deprecated values entry if current values empty
270-
*/}}
271258
{{- define "enterprise-secret-name" -}}
272259
{{- if ( dig "licenseSecretRef" dict .Values.enterprise ) -}}
273260
{{- dig "name" "" .Values.enterprise.licenseSecretRef -}}
274-
{{- else if not (empty .Values.license_secret_ref ) -}}
275-
{{- dig "secret_name" "" .Values.license_secret_ref -}}
276261
{{- end -}}
277262
{{- end -}}
278263

279-
{{/*
280-
return licenseSecretRef.key checks deprecated values entry if current values empty
281-
*/}}
282264
{{- define "enterprise-secret-key" -}}
283265
{{- if ( dig "licenseSecretRef" dict .Values.enterprise ) -}}
284266
{{- dig "key" "" .Values.enterprise.licenseSecretRef -}}
285-
{{- else if not (empty .Values.license_secret_ref ) -}}
286-
{{- dig "secret_key" "" .Values.license_secret_ref -}}
287267
{{- end -}}
288268
{{- end -}}
289269

‎charts/redpanda/templates/_post-install-upgrade-job.go.tpl‎

Lines changed: 3 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,9 @@
7070
{{- range $_ := (list 1) -}}
7171
{{- $_is_returning := false -}}
7272
{{- $envars := (list ) -}}
73-
{{- $license_1 := (get (fromJson (include "redpanda.GetLicenseLiteral" (dict "a" (list $dot) ))) "r") -}}
74-
{{- $secretReference_2 := (get (fromJson (include "redpanda.GetLicenseSecretReference" (dict "a" (list $dot) ))) "r") -}}
73+
{{- $values := $dot.Values.AsMap -}}
74+
{{- $license_1 := $values.enterprise.license -}}
75+
{{- $secretReference_2 := $values.enterprise.licenseSecretRef -}}
7576
{{- if (ne $license_1 "") -}}
7677
{{- $envars = (concat (default (list ) $envars) (list (mustMergeOverwrite (dict "name" "" ) (dict "name" "REDPANDA_LICENSE" "value" $license_1 )))) -}}
7778
{{- else -}}{{- if (ne (toJson $secretReference_2) "null") -}}
@@ -84,40 +85,3 @@
8485
{{- end -}}
8586
{{- end -}}
8687

87-
{{- define "redpanda.GetLicenseLiteral" -}}
88-
{{- $dot := (index .a 0) -}}
89-
{{- range $_ := (list 1) -}}
90-
{{- $_is_returning := false -}}
91-
{{- $values := $dot.Values.AsMap -}}
92-
{{- if (ne $values.enterprise.license "") -}}
93-
{{- $_is_returning = true -}}
94-
{{- (dict "r" $values.enterprise.license) | toJson -}}
95-
{{- break -}}
96-
{{- end -}}
97-
{{- $_is_returning = true -}}
98-
{{- (dict "r" $values.license_key) | toJson -}}
99-
{{- break -}}
100-
{{- end -}}
101-
{{- end -}}
102-
103-
{{- define "redpanda.GetLicenseSecretReference" -}}
104-
{{- $dot := (index .a 0) -}}
105-
{{- range $_ := (list 1) -}}
106-
{{- $_is_returning := false -}}
107-
{{- $values := $dot.Values.AsMap -}}
108-
{{- if (not (empty $values.enterprise.licenseSecretRef)) -}}
109-
{{- $_is_returning = true -}}
110-
{{- (dict "r" (mustMergeOverwrite (dict "key" "" ) (mustMergeOverwrite (dict ) (dict "name" $values.enterprise.licenseSecretRef.name )) (dict "key" $values.enterprise.licenseSecretRef.key ))) | toJson -}}
111-
{{- break -}}
112-
{{- else -}}{{- if (not (empty $values.license_secret_ref)) -}}
113-
{{- $_is_returning = true -}}
114-
{{- (dict "r" (mustMergeOverwrite (dict "key" "" ) (mustMergeOverwrite (dict ) (dict "name" $values.license_secret_ref.secret_name )) (dict "key" $values.license_secret_ref.secret_key ))) | toJson -}}
115-
{{- break -}}
116-
{{- end -}}
117-
{{- end -}}
118-
{{- $_is_returning = true -}}
119-
{{- (dict "r" (coalesce nil)) | toJson -}}
120-
{{- break -}}
121-
{{- end -}}
122-
{{- end -}}
123-

0 commit comments

Comments
 (0)