feat: Add count-based checkpoint retention policies

- Introduced global, container, pod, and namespace-level policies for checkpoint retention, all based on count limits. - Updated CRD definitions to store the newly added policies. - Added a flag `applyPoliciesImmediately` to enable immediate application of policies upon their update or creation. - Implemented logic to prioritize container, pod, and namespace-specific policies over global policies. Signed-off-by: Parthiba-Hazra <[email protected]>
checkpoint-restore · Jun 23, 2024 · 4ee200b · 4ee200b
1 parent b58ffc3
commit 4ee200b
Show file tree

Hide file tree

Showing 5 changed files with 419 additions and 65 deletions.
diff --git a/api/v1/checkpointrestoreoperator_types.go b/api/v1/checkpointrestoreoperator_types.go
@@ -25,8 +25,36 @@ import (
 // CheckpointRestoreOperatorSpec defines the desired state of CheckpointRestoreOperator
 type CheckpointRestoreOperatorSpec struct {
 	// Important: Run "make" to regenerate code after modifying this file
-	CheckpointDirectory        string `json:"checkpointDirectory,omitempty"`
-	MaxCheckpointsPerContainer *int   `json:"maxCheckpointsPerContainer,omitempty"`
+	CheckpointDirectory      string                `json:"checkpointDirectory,omitempty"`
+	ApplyPoliciesImmediately bool                  `json:"applyPoliciesImmediately,omitempty"`
+	GlobalPolicies           GlobalPolicySpec      `json:"globalPolicy,omitempty"`
+	ContainerPolicies        []ContainerPolicySpec `json:"containerPolicies,omitempty"`
+	PodPolicies              []PodPolicySpec       `json:"podPolicies,omitempty"`
+	NamespacePolicies        []NamespacePolicySpec `json:"namespacePolicies,omitempty"`
+}
+
+type GlobalPolicySpec struct {
+	MaxCheckpointsPerNamespaces *int `json:"maxCheckpointsPerNamespace,omitempty"`
+	MaxCheckpointsPerPod        *int `json:"maxCheckpointsPerPod,omitempty"`
+	MaxCheckpointsPerContainer  *int `json:"maxCheckpointsPerContainer,omitempty"`
+}
+
+type ContainerPolicySpec struct {
+	Namespace      string `json:"namespace,omitempty"`
+	Pod            string `json:"pod,omitempty"`
+	Container      string `json:"container,omitempty"`
+	MaxCheckpoints *int64 `json:"maxCheckpoints,omitempty"`
+}
+
+type PodPolicySpec struct {
+	Namespace      string `json:"namespace,omitempty"`
+	Pod            string `json:"pod,omitempty"`
+	MaxCheckpoints *int64 `json:"maxCheckpoints,omitempty"`
+}
+
+type NamespacePolicySpec struct {
+	Namespace      string `json:"namespace,omitempty"`
+	MaxCheckpoints *int64 `json:"maxCheckpoints,omitempty"`
 }
 
 // CheckpointRestoreOperatorStatus defines the observed state of CheckpointRestoreOperator

diff --git a/api/v1/zz_generated.deepcopy.go b/api/v1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/criu.org_checkpointrestoreoperators.yaml b/config/crd/bases/criu.org_checkpointrestoreoperators.yaml
@@ -41,12 +41,57 @@ spec:
             description: CheckpointRestoreOperatorSpec defines the desired state of
               CheckpointRestoreOperator
             properties:
+              applyPoliciesImmediately:
+                type: boolean
               checkpointDirectory:
                 description: 'Important: Run "make" to regenerate code after modifying
                   this file'
                 type: string
-              maxCheckpointsPerContainer:
-                type: integer
+              containerPolicies:
+                items:
+                  properties:
+                    container:
+                      type: string
+                    maxCheckpoints:
+                      format: int64
+                      type: integer
+                    namespace:
+                      type: string
+                    pod:
+                      type: string
+                  type: object
+                type: array
+              globalPolicy:
+                properties:
+                  maxCheckpointsPerContainer:
+                    type: integer
+                  maxCheckpointsPerNamespace:
+                    type: integer
+                  maxCheckpointsPerPod:
+                    type: integer
+                type: object
+              namespacePolicies:
+                items:
+                  properties:
+                    maxCheckpoints:
+                      format: int64
+                      type: integer
+                    namespace:
+                      type: string
+                  type: object
+                type: array
+              podPolicies:
+                items:
+                  properties:
+                    maxCheckpoints:
+                      format: int64
+                      type: integer
+                    namespace:
+                      type: string
+                    pod:
+                      type: string
+                  type: object
+                type: array
             type: object
           status:
             description: CheckpointRestoreOperatorStatus defines the observed state

diff --git a/config/samples/_v1_checkpointrestoreoperator.yaml b/config/samples/_v1_checkpointrestoreoperator.yaml
@@ -9,5 +9,14 @@ metadata:
     app.kubernetes.io/created-by: checkpoint-restore-operator
   name: checkpointrestoreoperator-sample
 spec:
-  maxCheckpointsPerContainer: 5
   checkpointDirectory: /var/lib/kubelet/checkpoints
+  applyPoliciesImmediately: false
+  globalPolicy:
+    maxCheckpointsPerNamespace: 50
+    maxCheckpointsPerPod: 30
+    maxCheckpointsPerContainer: 10
+  containerPolicies:
+    - namespace: namespace-name
+      pod: pod-name
+      container: container-name
+      maxCheckpoints: 5