feat: Revision History Limit for sensor. Closes #1786 (#2244)

Signed-off-by: Derek Wang <[email protected]>
argoproj · Dec 12, 2022 · 3a0fb22 · 3a0fb22
1 parent 314f07b
commit 3a0fb22
Show file tree

Hide file tree

Showing 12 changed files with 403 additions and 271 deletions.
diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json
@@ -3847,6 +3847,11 @@
           "format": "int32",
           "type": "integer"
         },
+        "revisionHistoryLimit": {
+          "description": "RevisionHistoryLimit specifies how many old deployment revisions to retain",
+          "format": "int32",
+          "type": "integer"
+        },
         "template": {
           "$ref": "#/definitions/io.argoproj.sensor.v1alpha1.Template",
           "description": "Template is the pod specification for the sensor"

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
diff --git a/api/sensor.html b/api/sensor.html
diff --git a/api/sensor.md b/api/sensor.md
diff --git a/controllers/sensor/resource.go b/controllers/sensor/resource.go
@@ -278,7 +278,8 @@ func buildDeploymentSpec(args *AdaptorArgs) (*appv1.DeploymentSpec, error) {
 		Selector: &metav1.LabelSelector{
 			MatchLabels: args.Labels,
 		},
-		Replicas: &replicas,
+		Replicas:             &replicas,
+		RevisionHistoryLimit: args.Sensor.Spec.RevisionHistoryLimit,
 		Template: corev1.PodTemplateSpec{
 			ObjectMeta: metav1.ObjectMeta{
 				Labels: podTemplateLabels,

diff --git a/controllers/sensor/resource_test.go b/controllers/sensor/resource_test.go
@@ -151,6 +151,20 @@ func Test_BuildDeployment(t *testing.T) {
 		assert.True(t, hasTmpVolume)
 		assert.True(t, len(deployment.Spec.Template.Spec.ImagePullSecrets) > 0)
 		assert.Equal(t, deployment.Spec.Template.Spec.PriorityClassName, "test-class")
+		assert.Nil(t, deployment.Spec.RevisionHistoryLimit)
+	})
+	t.Run("test revisionHistoryLimit", func(t *testing.T) {
+		sensorWithRevisionHistoryLimit := sensorObj.DeepCopy()
+		sensorWithRevisionHistoryLimit.Spec.RevisionHistoryLimit = func() *int32 { i := int32(3); return &i }()
+		args := &AdaptorArgs{
+			Image:  testImage,
+			Sensor: sensorWithRevisionHistoryLimit,
+			Labels: testLabels,
+		}
+		deployment, err := buildDeployment(args, fakeEventBus)
+		assert.Nil(t, err)
+		assert.NotNil(t, deployment)
+		assert.Equal(t, int32(3), *deployment.Spec.RevisionHistoryLimit)
 	})
 }
 

diff --git a/docs/sensors/more-about-sensors-and-triggers.md b/docs/sensors/more-about-sensors-and-triggers.md
@@ -124,3 +124,13 @@ spec:
         # Requests per unit
         requestsPerUnit: 20
 ```
+
+## Revision History Limit
+
+Optionally, a `revisionHistoryLimit` may be configured in the spec as following:
+
+```yaml
+spec:
+  # Optional
+  revisionHistoryLimit: 3
+```
diff --git a/pkg/apis/sensor/v1alpha1/generated.pb.go b/pkg/apis/sensor/v1alpha1/generated.pb.go
diff --git a/pkg/apis/sensor/v1alpha1/generated.proto b/pkg/apis/sensor/v1alpha1/generated.proto
diff --git a/pkg/apis/sensor/v1alpha1/openapi_generated.go b/pkg/apis/sensor/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/sensor/v1alpha1/types.go b/pkg/apis/sensor/v1alpha1/types.go
@@ -107,6 +107,9 @@ type SensorSpec struct {
 	EventBusName string `json:"eventBusName,omitempty" protobuf:"bytes,5,opt,name=eventBusName"`
 	// Replicas is the sensor deployment replicas
 	Replicas *int32 `json:"replicas,omitempty" protobuf:"varint,6,opt,name=replicas"`
+	// RevisionHistoryLimit specifies how many old deployment revisions to retain
+	// +optional
+	RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty" protobuf:"varint,7,opt,name=revisionHistoryLimit"`
 }
 
 func (s SensorSpec) GetReplicas() int32 {

diff --git a/pkg/apis/sensor/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/sensor/v1alpha1/zz_generated.deepcopy.go