Update docs for state annotation

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]> fixme Signed-off-by: Niraj Yadav <[email protected]> fixme Signed-off-by: Niraj Yadav <[email protected]>
csi-addons · Oct 24, 2024 · cf2bcce · cf2bcce
1 parent e0a0ea7
commit cf2bcce
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/encryptionkeyrotation.md b/docs/encryptionkeyrotation.md
@@ -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.
diff --git a/docs/reclaimspace.md b/docs/reclaimspace.md
@@ -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.