Add resources ReclaimSpaceCronJob and ReclaimSpaceJob

ocp_resources/reclaim_space_cron_job.py

@@ -0,0 +1,70 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource, MissingRequiredArgumentError
+
+
+class ReclaimSpaceCronJob(NamespacedResource):
+    """
+    https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/reclaimspace.md
+    """
+
+    api_group = NamespacedResource.ApiGroup.CSIADDONS_OPENSHIFT_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        client=None,
+        teardown=True,
+        privileged_client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        schedule=None,
+        job_template=None,
+        concurrency_policy=None,
+        successful_jobs_history_limit=None,
+        failed_jobs_history_limit=None,
+        **kwargs,
+    ):
+        """
+        Args:
+            schedule (str): schedule of the reclaim space cron job
+            job_template (dict): describes the reclaim space job that would be created when a reclaim space cronjob
+                would be executed
+                Example: https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/reclaimspace.md
+            concurrency_policy (str, optional): indicates how to treat concurrent execution of a job
+            successful_jobs_history_limit (int, optional): number of successful jobs to retain
+            failed_jobs_history_limit (int, optional): number of failed jobs to retain start at scheduled time
+        """
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            privileged_client=privileged_client,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.job_template = job_template
+        self.schedule = schedule
+        self.concurrency_policy = concurrency_policy
+        self.successful_jobs_history_limit = successful_jobs_history_limit
+        self.failed_jobs_history_limit = failed_jobs_history_limit
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            if not (self.job_template and self.schedule):
+                raise MissingRequiredArgumentError(argument="'job_template' and 'schedule'")
+            self.res.update({
+                "spec": {
+                    "jobTemplate": self.job_template,
+                    "schedule": self.schedule,
+                }
+            })
+            if self.successful_jobs_history_limit:
+                self.res["spec"]["successfulJobsHistoryLimit"] = self.successful_jobs_history_limit
+            if self.failed_jobs_history_limit:
+                self.res["spec"]["failedJobsHistoryLimit"] = self.failed_jobs_history_limit
+            if self.concurrency_policy:
+                self.res["spec"]["concurrencyPolicy"] = self.concurrency_policy

ocp_resources/reclaim_space_job.py

@@ -0,0 +1,71 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource, MissingRequiredArgumentError
+
+
+class ReclaimSpaceJob(NamespacedResource):
+    """
+    https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/reclaimspace.md
+
+    Args:
+        name (str): ReclaimSpaceJob name.
+        namespace (str): Namespace name.
+        client (DynamicClient): Dynamic client for connecting to a remote cluster.
+        teardown (bool): Indicates if this resource would need to be deleted.
+        privileged_client (DynamicClient): Instance of Dynamic client.
+        yaml_file (str): Yaml file for the resource.
+        delete_timeout (int): Timeout associated with delete action.
+        backoff_limit (int, Optional): The number of retries for a reclaim space job.
+        target (dict): Volume target on which the operation would be performed.
+        retryDeadlineSeconds (int, Optional): Optional. Duration in seconds relative to the start time that the
+            operation may beretried.
+        timeout (int, Optional): specifies the timeout in seconds for the grpc request sent to the CSI driver
+    """
+
+    api_group = NamespacedResource.ApiGroup.CSIADDONS_OPENSHIFT_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        client=None,
+        teardown=True,
+        privileged_client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        backoff_limit=None,
+        target=None,
+        retry_deadline_seconds=None,
+        timeout=None,
+        **kwargs,
+    ):
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            privileged_client=privileged_client,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.backoff_limit = backoff_limit
+        self.target = target
+        self.retry_deadline_seconds = retry_deadline_seconds
+        self.timeout = timeout
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            if not self.target:
+                raise MissingRequiredArgumentError(argument="target")
+            spec_dict = {}
+            if self.target:
+                spec_dict.update({"target": self.target})
+            if self.retry_deadline_seconds:
+                spec_dict.update({"retryDeadlineSeconds": self.retry_deadline_seconds})
+            if self.timeout:
+                spec_dict.update({"timeout": self.timeout})
+            if self.backoff_limit:
+                spec_dict.update({"backOffLimit": self.backoff_limit})
+            if spec_dict:
+                self.res.update({"spec": spec_dict})

ocp_resources/resource.py

@@ -260,6 +260,7 @@ class ApiGroup:
         CONFIG_OPENSHIFT_IO = "config.openshift.io"
         CONSOLE_OPENSHIFT_IO = "console.openshift.io"
         COORDINATION_K8S_IO = "coordination.k8s.io"
+        CSIADDONS_OPENSHIFT_IO = "csiaddons.openshift.io"
         DATA_IMPORT_CRON_TEMPLATE_KUBEVIRT_IO = "dataimportcrontemplate.kubevirt.io"
         DISCOVERY_K8S_IO = "discovery.k8s.io"
         EVENTS_K8S_IO = "events.k8s.io"