Skip to content

Commit

Permalink
Update docs for state annotation
Browse files Browse the repository at this point in the history
This commit updates the docs for ReclaimSpace
and EncryptionKeyRotation for the new state
annotation: `csiaddons.openshift.io/state`

Signed-off-by: Niraj Yadav <[email protected]>
  • Loading branch information
black-dragon74 committed Oct 23, 2024
1 parent 059a581 commit 519fb8e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/encryptionkeyrotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,13 @@ over StorageClass annotation. The kubernetes-csi-addons only generate a `Encrypt
if the annotation exists on the StorageClass. If an admin needs to modify or delete the
annotation on the StorageClass, they must perform the same action on all the PersistentVolumeClaims
created from this StorageClass.

## Annotating EncrpytionKeyRotationCronJob

In cases where a certain `EncrpytionKeyRotationCronJob` is to have a different schedule that the one present
in Namespace, StorageClass or PersistentVolumeClaim annotations one could annotate the `EncryptionKeyRotationCronJob`
itself by adding the `csiaddons.openshift.io/state: "unmanaged"` annotation.

CSI Addons will not perform any further modifications on the `EncryptionKeyRotationCronJob` with the `unmanaged` state.

To have a custom schedule the user can then modify the `schedule` field of the `EncryptionKeyRotationCronJob` spec.
10 changes: 10 additions & 0 deletions docs/reclaimspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,3 +144,13 @@ over StorageClass annotation. The kubernetes-csi-addons only generate a `Reclaim
if the annotation exists on the StorageClass. If an admin needs to modify or delete the
annotation on the StorageClass, they must perform the same action on all the PersistentVolumeClaims
created from this StorageClass.

## Annotating ReclaimSpaceCronJob

In cases where a certain `ReclaimSpaceCronJob` is to have a different schedule that the one present
in Namespace, StorageClass or PersistentVolumeClaim annotations one could annotate the `ReclaimSpaceCronJob`
itself by adding the `csiaddons.openshift.io/state: "unmanaged"` annotation.

CSI Addons will not perform any further modifications on the `ReclaimSpaceCronJob` with the `unmanaged` state.

To have a custom schedule the user can then modify the `schedule` field of the `ReclaimSpaceCronJob` spec.

0 comments on commit 519fb8e

Please sign in to comment.