[bitnami/redis] Ensure that Redis resources are less than 63 chars

[mboutet]

Description of the change

Make sure to truncate the Statefulsets and Services' name to 63 characters.

Benefits

This guarantees that all the resources are created successfully.

Possible drawback

None, as I made sure to truncate the original fullname while keeping the differentiating suffix as-is (to prevent resource name clash in case the fullname is really long).

Applicable issues

• fixes [bitnami/redis] Long release name breaks statefulset pods #27549

Additional information

I bumped the major version as it could technically cause resources to be recreated due a change in the metadata.name of some Statefulsets and Services. In practice, however, it should not happen as the truncation only happens if really needed, so users already using the chart without issues won't get any truncation. On the other hand, the major bump is also warranted due to the complexity of the chart and the regression risk of this PR even though I tried to not miss anything.

Checklist

• Chart version bumped in Chart.yaml according to semver. This is not necessary when the changes only affect README.md files.
• Variables are documented in the values.yaml and added to the README.md using readme-generator-for-helm
• Title of the pull request follows this pattern [bitnami/<name_of_the_chart>] Descriptive title
• All commits signed off and in agreement of Developer Certificate of Origin (DCO)

[mboutet]

Testing on my end, but encountering few issues with my changes, so I'm setting the PR as draft for now.

EDIT: I think it's good now.

[mboutet]

~Actually, I think there's still an issue with one label having a too long value, but this label comes from the common bitnami chart, so I would have to fix it there :/ ~

It was the value of the controller-revision-hash label in the end.

[mboutet]

Since the Service also uses this helper, it could result in it being recreated for some users. Truncating the equivalent of 0000000000 is only strictly needed for the Statefulset in reality.

[jotamartos]

Thank you for your contribution. Please take a look at my comment to follow the standard approach to truncate the strings and how you can improve the common functions to follow your approach.

[jotamartos]

I like the idea and see it as a good improvement. However, all our solutions use a simpler method

Suggested change

	{{/*
	Return the proper Redis headless fullname
	*/}}
	{{- define "redis.headless.fullname" -}}
	{{- printf "%s-%s" ((include "common.names.fullname" .) | trunc ((sub 63 ("-headless" | len)) | int) | trimSuffix "-") "headless" -}}
	{{- end -}}
	{{/*
	Return the proper Redis headless fullname
	*/}}
	{{- define "redis.headless.fullname" -}}
	{{ printf "%s-headless" (include "common.names.fullname" .) | trunc 63 | trimSuffix "-" }}
	{{- end -}}

I'd follow that approach here (and the other methods) too.

However, the common.names.fullname function can be improve to truncate the strings the way you are suggesting.

https://github.com/bitnami/charts/blob/main/bitnami/common/templates/_names.tpl#L26

You can update that function to accept another string to perform the "sub" method. That way, that function can be added to other charts as well and the whole community will benefit from that.

[mboutet]

Although I think it's a good idea, it would also change the signature of common.names.fullname in a backward incompatible manner, no? Unless conditional logic is added to common.names.fullname to accept both the current and new signature with the custom string to use to calculate the additional truncation. I don't mind doing that, but before I do, I just want to make sure if we're agreeing on the approach of having common.names.fullname handle both signatures.

[jotamartos]

I simply suggested to improve the function to accept a new parameter to perform the "sub" method. The function won't do anything unless you set that new parameter. You can later update the function in the Redis' chart and increase the version to a new major so we avoid issues when updating between minor versions. Sounds good?

[github-actions]

This Pull Request has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thank you for your contribution.

[jotamartos]

Sorry @mboutet, I didn't receive the notification about your comments. Will review everything again and update the PR

[jotamartos]

Hi @mboutet,

I just updated the thread with more information. Let me know if it's clear now.

[github-actions]

This Pull Request has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thank you for your contribution.

[github-actions]

This Pull Request has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thank you for your contribution.

[github-actions]

This Pull Request has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thank you for your contribution.

[github-actions]

This Pull Request has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thank you for your contribution.

[jotamartos]

Sorry @mboutet, I lost track of this ticket. Let me review it again and provide feedback

[jotamartos]

Thanks for your contribution but your changes return errors when deploying the solution

➜  redis git:(truncate-long-redis-name) helm install redis 
Error: INSTALLATION FAILED: parse error at (redis/templates/scripts-configmap.yaml:690): unexpected <template> in command

[jotamartos]

Current fullnames do not include the "0000000000" string, so it's not necessary to remove that

➜  redis git:(main) k get all                      
NAME                   READY   STATUS    RESTARTS   AGE
pod/redis-master-0     1/1     Running   0          2m29s
pod/redis-replicas-0   1/1     Running   0          2m28s
pod/redis-replicas-1   1/1     Running   0          91s
pod/redis-replicas-2   1/1     Running   0          51s

NAME                     TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)    AGE
service/redis-headless   ClusterIP   None           <none>        6379/TCP   2m29s
service/redis-master     ClusterIP   10.0.92.51     <none>        6379/TCP   2m29s
service/redis-replicas   ClusterIP   10.0.203.103   <none>        6379/TCP   2m29s

NAME                              READY   AGE
statefulset.apps/redis-master     1/1     2m30s
statefulset.apps/redis-replicas   3/3     2m30s