docs: Add documentation for disabling ReclaimSpace#701
Merged
Conversation
Member
Author
iPraveenParihar
requested changes
Nov 7, 2024
|
|
||
| ### Disabling Reclaim Space for a Specific PersistentVolumeClaim | ||
|
|
||
| To disable reclaim space for a specific PersistentVolumeClaim (PVC), edit the `ReclaimSpaceCronJob` custom resource (CR) associated with that PVC. Follow these steps: |
Member
There was a problem hiding this comment.
Suggested change
| To disable reclaim space for a specific PersistentVolumeClaim (PVC), edit the `ReclaimSpaceCronJob` custom resource (CR) associated with that PVC. Follow these steps: | |
| To disable reclaim space for a specific PersistentVolumeClaim (PVC), follow these steps to modify the associated `ReclaimSpaceCronJob` CR: |
|
|
||
| Replace `<PVC_NAME>` with the name of your PVC. | ||
|
|
||
| 2. **Edit the `ReclaimSpaceCronJob` CR**: Use the following settings in the CR to disable reclaim space for this specific PVC: |
Member
There was a problem hiding this comment.
Suggested change
| 2. **Edit the `ReclaimSpaceCronJob` CR**: Use the following settings in the CR to disable reclaim space for this specific PVC: | |
| 2. **Edit the `ReclaimSpaceCronJob` CR**: apply the following to disable the reclaim space: |
| Replace `<PVC_NAME>` with the name of your PVC. | ||
|
|
||
| 2. **Edit the `ReclaimSpaceCronJob` CR**: Use the following settings in the CR to disable reclaim space for this specific PVC: | ||
| - Update the `csiaddons.openshift.io/state` annotation from `"managed"` to `"unmanaged"`. |
Member
There was a problem hiding this comment.
will be good if we add example for kubectl annotate and kubectl patch command
Member
Author
There was a problem hiding this comment.
The reason I did not go with that is because
- The annotation would be present on the CR already.
- User needs to just to
kubectl editand can do both the required changes simultaneously.
Lesser the commands, the better it is, WDYT?
Member
There was a problem hiding this comment.
kubectl edit is not something that can be automated easily. I prefer to give the kubectl annotate and kubectl patch commands as examples, in addition to the description you have now.
Fewer commands is nice, but you should also expect that automated tools deploy apps and configure extra things like disabling reclaim space for its PVC(s).
Member
There was a problem hiding this comment.
Please provide the command to annotate the CR as mentioned above
ff4f504 to
4b82cb3
Compare
Madhu-1
reviewed
Nov 12, 2024
|
|
||
| 2. **Edit the `ReclaimSpaceCronJob` CR**: Apply the following to disable the reclaim space: | ||
| - Update the `csiaddons.openshift.io/state` annotation from `"managed"` to `"unmanaged"`. | ||
| - Add `suspend: true` under the `spec` field. |
Member
There was a problem hiding this comment.
please provide `kubectl patch command as well for this one
4b82cb3 to
3cbeadb
Compare
nixpanic
approved these changes
Nov 14, 2024
iPraveenParihar
approved these changes
Nov 18, 2024
This patch updates the documentation with the steps to disable reclaim space operations. Signed-off-by: Niraj Yadav <niryadav@redhat.com>
3cbeadb to
a2e90c2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This patch updates the documentation with the
steps to disable reclaim space operations.