Helm upgrade is failing to patch PVC

[aa-sravan]

Describe the bug
Unable to re-install/upgrade the helm chart as the STS is getting patched for persistentVolumeClaimRetentionPolicy .

spec:
  persistentVolumeClaimRetentionPolicy:
    whenDeleted: Retain
    whenScaled: Retain

CRD:

sumologic-kubernetes-collection/deploy/helm/sumologic/crds/crd-opentelemetrycollector.yaml

Line 6953 in e7b1392

persistentVolumeClaimRetentionPolicy:

Template:

sumologic-kubernetes-collection/deploy/helm/sumologic/templates/logs/otelcol/statefulset.yaml

Line 20 in e7b1392

whenScaled: {{ .Values.metadata.logs.statefulset.persistentVolumeClaimRetentionPolicywhenScaled }}

Logs
Error: UPGRADE FAILED: failed to create patch: unable to find api field in struct StatefulSetSpec for the json field "persistentVolumeClaimRetentionPolicy" && failed to create patch: unable to find api field in struct StatefulSetSpec for the json field "persistentVolumeClaimRetentionPolicy"

Command used to install/upgrade Collection
helm upgrade --install --wait --timeout 600s -f values.yaml -n sumologic sumologic-release-name sumologic/sumologic --version 4.12.0 --create-namespace
Configuration Configuration used for Collection e.g. user-values.yaml for helm.

To Reproduce Steps to reproduce the behavior.
Upgrade the helm chart with minor changes to otel logs
Expected behavior
Helm release should upgrade without any issue

Environment (please complete the following information):
Production

• Collection version (e.g. helm ls -n sumologic):
  sumologic-stage-ee sumologic 2 2025-03-07 14:38:58.553504137 +0000 UTC failed sumologic-4.12.0 4.12.0
• Kubernetes version (e.g. kubectl version): 1.31
• Cloud provider: aws
• Others:

Anything else do we need to know Add any other context about the problem here, e.g. issue happens only occasionally.

[rnishtala-sumo]

@aa-sravan Just to be clear, is this a new install or an upgrade? The command below indicates a new install?
helm upgrade --install --wait --timeout 600s -f values.yaml -n sumologic sumologic-release-name sumologic/sumologic --version 4.12.0 --create-namespace

You can find more about this field in the docs - https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#persistentvolumeclaim-retention

Also, The StatefulSetAutoDeletePVC feature gate was beta and enabled by default on cluster running Kubernetes 1.27.
https://kubernetes.io/blog/2023/05/04/kubernetes-1-27-statefulset-pvc-auto-deletion-beta/#what-s-next

We haven't been able to reproduce this issue so far.

[anisrini-aa]

This is upgrade @rnishtala-sumo.

[rnishtala-sumo]

@anisrini-aa this patch release comes with a config knob to disable persistentVolumeClaimRetentionPolicy
https://github.com/SumoLogic/sumologic-kubernetes-collection/releases/tag/v4.12.1

[aa-sravan]

Hi @rnishtala-sumo ,

I have tried upgrading the sumo chart from 4.12.0 to 4.12.1 and still face the same issue. Is the fix applied only on 4.12.1 version onwards?

20:38:24  Error: UPGRADE FAILED: failed to create patch: unable to find api field in struct StatefulSetSpec for the json field "persistentVolumeClaimRetentionPolicy" && failed to create patch: unable to find api field in struct StatefulSetSpec for the json field "persistentVolumeClaimRetentionPolicy"

[rnishtala-sumo]

@anisrini-aa this is the config option to disable persistentVolumeClaimRetentionPolicy:

sumologic.persistentVolumeClaimRetentionPolicyEnabled

It is enabled by default.