Skip to content

Latest commit

 

History

History
100 lines (83 loc) · 4.32 KB

reclaimspace.md

File metadata and controls

100 lines (83 loc) · 4.32 KB
Raw

ReclaimSpaceJob

ReclaimSpaceJob is a namespaced custom resource designed to invoke reclaim space operation on target volume.

apiVersion: csiaddons.openshift.io/v1alpha1
kind: ReclaimSpaceJob
metadata:
  name: sample-1
spec:
  target:
    persistentVolumeClaim: pvc-1
  backOffLimit: 10
  retryDeadlineSeconds: 900
  • target represents volume target on which the operation will be performed.
    • persistentVolumeClaim contains a string indicating the name of PersistentVolumeClaim.
  • backOfflimit specifies the number of retries before marking reclaim space operation as failed. If not specified, defaults to 6. Maximum allowed value is 60 and minimum allowed value is 0.
  • retryDeadlineSeconds specifies the duration in seconds relative to the start time that the operation may be retried; value must be positive integer. If not specified, defaults to 600 seconds. Maximum allowed value is 1800.

ReclaimSpaceCronJob

The ReclaimSpaceCronJob offers an interface very similar to the Kubernetes batch/CronJob. With the schedule attribute, the CSI-Addons Controller will create a ReclaimSpaceJob at the requested time and interval. The Kubernetes documentation for the CronJob and the Golang cron package explain the format of the schedule attribute in more detail.

apiVersion: csiaddons.openshift.io/v1alpha1
kind: ReclaimSpaceCronJob
metadata:
  name: reclaimspacecronjob-sample
spec:
  concurrencyPolicy: Forbid
  failedJobsHistoryLimit: 1
  jobTemplate:
    spec:
      backOffLimit: 6
      retryDeadlineSeconds: 600
      target:
        persistentVolumeClaim: data-pvc
  schedule: '@weekly'
  successfulJobsHistoryLimit: 3
  • concurrencyPolicy describes what happens when a new ReclaimSpaceJob is scheduled by the ReclaimSpaceCronJob, while a previous ReclaimSpaceJob is still running. The default Forbid prevents starting new job, whereas Replace can be used to delete the running job (potentially in a failure state) and create a new one.
  • failedJobsHistoryLimit keeps at most the number of failed ReclaimSpaceJobs around for troubleshooting
  • jobTemplate contains the ReclaimSpaceJob.spec structure, which describes the details of the requested ReclaimSpaceJob operation.
  • schedule is in the same format as Kubernetes CronJobs that sets the and/or interval of the recurring operation request.
  • successfulJobsHistoryLimit can be used to keep at most number of successful ReclaimSpaceJob operations.

Annotating PerstentVolumeClaims

ReclaimSpaceCronJob CR can also be automatically created by adding reclaimspace.csiaddons.openshift.io/schedule: "@midnight" annotation to PersistentVolumeClaim object.

$ kubectl get pvc data-pvc
NAME      STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS      AGE
data-pvc  Bound    pvc-f37b8582-4b04-4676-88dd-e1b95c6abf74   1Gi        RWO            default           20h

$ kubectl annotate pvc data-pvc "reclaimspace.csiaddons.openshift.io/schedule=@midnight"
persistentvolumeclaim/data-pvc annotated

$ kubectl get reclaimspacecronjobs.csiaddons.openshift.io 
NAME                    SCHEDULE    SUSPEND   ACTIVE   LASTSCHEDULE   AGE
data-pvc-1642663516   @midnight                                     3s

$ kubectl annotate pvc data-pvc "reclaimspace.csiaddons.openshift.io/schedule=*/1 * * * *" --overwrite=true
persistentvolumeclaim/data-pvc annotated

$ kubectl get reclaimspacecronjobs.csiaddons.openshift.io
NAME                  SCHEDULE    SUSPEND   ACTIVE   LASTSCHEDULE   AGE
data-pvc-1642664617   */1 * * * *                                   3s
  • Upon adding annotation as shown above, a ReclaimSpaceCronJob with name "<pvc-name>-xxxxxxx" is created (pvc name suffixed with current time hash when the job was created).
  • schedule value is in the same format as Kubernetes CronJobs that sets the and/or interval of the recurring operation request.
  • Default schedule value "@weekly" is used if schedule value is empty or in invalid format.
  • ReclaimSpaceCronJob is recreated when schedule is modified and deleted when the annotation is removed.