feat: configurable and more aggressive cleanup of old AnalysisRuns an…

…d Experiments (argoproj#1342) Signed-off-by: Andrii Perenesenko <[email protected]>
mdb · Aug 10, 2021 · 6b66e9d · 6b66e9d
1 parent 6980947
commit 6b66e9d
Show file tree

Hide file tree

Showing 19 changed files with 1,029 additions and 437 deletions.
diff --git a/docs/features/specification.md b/docs/features/specification.md
@@ -11,6 +11,14 @@ spec:
   # Number of desired pods.
   # Defaults to 1.
   replicas: 5
+  analysis:
+    # limits the number of successful analysis runs and experiments to be stored in a history
+    # Defaults to 5.
+    successfulRunHistoryLimit: 10
+    # limits the number of unsuccessful analysis runs and experiments to be stored in a history. 
+    # Stages for unsuccessful: "Error", "Failed", "Inconclusive"
+    # Defaults to 5.
+    unsuccessfulRunHistoryLimit: 10
 
   # Label selector for pods. Existing ReplicaSets whose pods are selected by
   # this will be the ones affected by this rollout. It must match the pod

diff --git a/examples/analysis-templates.yaml b/examples/analysis-templates.yaml
@@ -24,7 +24,7 @@ spec:
                 args: [exit 0]
               restartPolicy: Never
           backoffLimit: 0
-
+    count: 1
 ---
 # This AnalysisTemplate will run a Kubernetes Job every 5 seconds, with a 50% chance of failure.
 # When the number of accumulated failures exceeds failureLimit, it will cause the analysis run to
@@ -36,6 +36,7 @@ metadata:
 spec:
   metrics:
   - name: random-fail
+    count: 2
     interval: 5s
     failureLimit: 1
     provider:

diff --git a/manifests/crds/rollout-crd.yaml b/manifests/crds/rollout-crd.yaml
@@ -47,6 +47,15 @@ spec:
             type: object
           spec:
             properties:
+              analysis:
+                properties:
+                  successfulRunHistoryLimit:
+                    format: int32
+                    type: integer
+                  unsuccessfulRunHistoryLimit:
+                    format: int32
+                    type: integer
+                type: object
               minReadySeconds:
                 format: int32
                 type: integer

diff --git a/manifests/install.yaml b/manifests/install.yaml
@@ -9745,6 +9745,15 @@ spec:
             type: object
           spec:
             properties:
+              analysis:
+                properties:
+                  successfulRunHistoryLimit:
+                    format: int32
+                    type: integer
+                  unsuccessfulRunHistoryLimit:
+                    format: int32
+                    type: integer
+                type: object
               minReadySeconds:
                 format: int32
                 type: integer

diff --git a/manifests/namespace-install.yaml b/manifests/namespace-install.yaml
@@ -9745,6 +9745,15 @@ spec:
             type: object
           spec:
             properties:
+              analysis:
+                properties:
+                  successfulRunHistoryLimit:
+                    format: int32
+                    type: integer
+                  unsuccessfulRunHistoryLimit:
+                    format: int32
+                    type: integer
+                type: object
               minReadySeconds:
                 format: int32
                 type: integer

diff --git a/pkg/apiclient/rollout/rollout.swagger.json b/pkg/apiclient/rollout/rollout.swagger.json
@@ -550,6 +550,22 @@
       },
       "title": "AnalysisRunArgument argument to add to analysisRun"
     },
+    "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AnalysisRunStrategy": {
+      "type": "object",
+      "properties": {
+        "successfulRunHistoryLimit": {
+          "type": "integer",
+          "format": "int32",
+          "title": "SuccessfulRunHistoryLimit limits the number of old successful analysis runs and experiments to be retained in a history"
+        },
+        "unsuccessfulRunHistoryLimit": {
+          "type": "integer",
+          "format": "int32",
+          "title": "UnsuccessfulRunHistoryLimit limits the number of old unsuccessful analysis runs and experiments to be retained in a history.\nStages for unsuccessful: \"Error\", \"Failed\", \"Inconclusive\""
+        }
+      },
+      "title": "AnalysisRunStrategy configuration for the analysis runs and experiments to retain"
+    },
     "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AntiAffinity": {
       "type": "object",
       "properties": {
@@ -1165,6 +1181,10 @@
         "restartAt": {
           "$ref": "#/definitions/k8s.io.apimachinery.pkg.apis.meta.v1.Time",
           "title": "RestartAt indicates when all the pods of a Rollout should be restarted"
+        },
+        "analysis": {
+          "$ref": "#/definitions/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AnalysisRunStrategy",
+          "title": "Analysis configuration for the analysis runs to retain"
         }
       },
       "title": "RolloutSpec is the spec for a Rollout resource"