chore(greptimedb-standalone): setting persistentVolumeClaimRetentionPolicy default is retain #179
Conversation
…olicy default is retain
WalkthroughThe changes in this pull request involve updates to the Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
charts/greptimedb-standalone/templates/statefulset.yaml (1)
21-24: Consider documenting the enableStatefulSetAutoDeletePVC flag.The
persistence.enableStatefulSetAutoDeletePVCflag controls a critical data retention feature. Consider adding a comment explaining its purpose and implications.{{- if and (semverCompare ">= 1.23-0" .Capabilities.KubeVersion.Version) (.Values.persistence.enableStatefulSetAutoDeletePVC) (.Values.persistence.enabled) }} + {{- /* Enable PVC retention policy configuration. This requires K8s >= 1.23 and controls what happens to PVCs when StatefulSet is deleted/scaled */ }} persistentVolumeClaimRetentionPolicy: whenDeleted: {{ .Values.persistentVolumeClaimRetentionPolicy.whenDeleted }} whenScaled: {{ .Values.persistentVolumeClaimRetentionPolicy.whenScaled }} {{- end }}charts/greptimedb-standalone/values.yaml (1)
160-164: LGTM! Consider enhancing the documentation.The addition of
persistentVolumeClaimRetentionPolicywith "Retain" defaults is a good choice for data safety. The configuration is properly structured and uses valid policy values.Consider expanding the documentation comment to explain the impact of each setting:
-# -- PersistentVolumeClaimRetentionPolicyType is a string enumeration of the policies that will determine, when volumes from the VolumeClaimTemplates will be deleted when the controlling StatefulSet is deleted or scaled down. +# -- PersistentVolumeClaimRetentionPolicy determines how PVCs are handled when StatefulSet is deleted or scaled down: +# whenDeleted: Retain - Keep PVCs when StatefulSet is deleted +# whenScaled: Retain - Keep PVCs when StatefulSet is scaled down
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
- charts/greptimedb-standalone/Chart.yaml (1 hunks)
- charts/greptimedb-standalone/README.md (2 hunks)
- charts/greptimedb-standalone/templates/statefulset.yaml (1 hunks)
- charts/greptimedb-standalone/values.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- charts/greptimedb-standalone/Chart.yaml
🔇 Additional comments (3)
charts/greptimedb-standalone/README.md (2)
5-5: LGTM: Version bump is consistent.The version increment from 0.1.25 to 0.1.26 follows semantic versioning and aligns with the configuration changes.
82-82: LGTM: Well-documented configuration.The new
persistentVolumeClaimRetentionPolicyconfiguration is:
- Clearly documented with its purpose
- Properly formatted in the values table
- Correctly sets default values to "Retain" as intended
charts/greptimedb-standalone/templates/statefulset.yaml (1)
22-23: LGTM! Let's verify the default values.The templating changes look good and follow Helm best practices. Let's verify the default values align with the PR objective.
✅ Verification successful
Default values are correctly set to "Retain" as intended ✅
The values.yaml file confirms that both
whenDeletedandwhenScaledare set to "Retain" by default, which aligns perfectly with the PR's objective of setting the default retention policy to "retain".🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that the default retention policy is set to "Retain" # Expected: Should find values.yaml containing default "Retain" for both whenDeleted and whenScaled # Search for the persistentVolumeClaimRetentionPolicy configuration in values.yaml rg -A 2 "persistentVolumeClaimRetentionPolicy:" "charts/greptimedb-standalone/values.yaml"Length of output: 169
Summary by CodeRabbit
New Features
persistentVolumeClaimRetentionPolicysetting, allowing users to control retention of persistent volume claims when the StatefulSet is deleted or scaled down.Updates
0.1.25to0.1.26in the Helm chart and documentation.