🌱 make spec.collisionProtection required in ClusterObjectSet and ClusterObjectDeployment

api/v1/clusterobjectdeployment_types.go

@@ -68,13 +68,11 @@ type ClusterObjectDeploymentTemplateSpec struct {
 	// +listType=atomic
 	ProgressionProbes []ProgressionProbe `json:"progressionProbes,omitempty"`
 
-	// collisionProtection is the default strategy for objects in the revision.
-	// Objects and phases may override it. When omitted the controller uses Prevent
-	// in the generated ClusterObjectSet. Omission remains distinct from explicit
-	// Prevent for template identity; admission does not default this field.
-	// +optional
+	// collisionProtection is the required default collision protection strategy for objects in the revision.
+	// Objects and phases may override it.
+	// +required
 	// +kubebuilder:validation:Enum=Prevent;IfNoController;None
-	CollisionProtection CollisionProtection `json:"collisionProtection,omitempty"`
+	CollisionProtection CollisionProtection `json:"collisionProtection"`
 }
 
 // ClusterObjectDeploymentStatus reports rollout progress.

api/v1/clusterobjectdeployment_types_test.go

@@ -34,6 +34,7 @@ func TestClusterObjectDeploymentValidity(t *testing.T) {
 		{name: "collision protection IfNoController", mutate: codCollisionProtection(CollisionProtectionIfNoController), valid: true},
 		{name: "collision protection None", mutate: codCollisionProtection(CollisionProtectionNone), valid: true},
 		{name: "collision protection invalid", mutate: codCollisionProtection("Invalid")},
+		{name: "collision protection empty", mutate: codCollisionProtection("")},
 		{name: "phases omitted", mutate: func(cod *ClusterObjectDeployment) { cod.Spec.Template.Spec.Phases = nil }},
 		{name: "phases empty", mutate: func(cod *ClusterObjectDeployment) { cod.Spec.Template.Spec.Phases = []ClusterObjectSetPhase{} }},
 		{name: "20 phases", mutate: codPhases(20), valid: true},
@@ -104,24 +105,28 @@ func TestClusterObjectDeploymentValidity(t *testing.T) {
 	}
 }
 
-func TestClusterObjectDeploymentDoesNotDefaultTemplate(t *testing.T) {
+func TestClusterObjectDeploymentCollisionProtectionIsRequired(t *testing.T) {
 	c := newClient(t)
-	cod := newTestClusterObjectDeployment("cod-no-defaults")
+
+	// collisionProtection missing rejects the object.
+	cod := newTestClusterObjectDeployment("cod-cp-required")
+	cod.Spec.Template.Spec.CollisionProtection = ""
+	err := c.Create(t.Context(), cod)
+	require.True(t, apierrors.IsInvalid(err), "expected missing collisionProtection to be invalid, got: %v", err)
+
+	// Valid values round-trip correctly; phase and object collisionProtection remain optional.
+	cod = newTestClusterObjectDeployment("cod-cp-roundtrip")
 	require.NoError(t, c.Create(t.Context(), cod))
 	cod = getTestClusterObjectDeployment(t, c, cod.Name)
-	require.Empty(t, cod.Spec.Template.Spec.CollisionProtection)
+	require.Equal(t, CollisionProtectionPrevent, cod.Spec.Template.Spec.CollisionProtection)
 	require.Empty(t, cod.Spec.Template.Spec.Phases[0].CollisionProtection)
 	require.Empty(t, cod.Spec.Template.Spec.Phases[0].Objects[0].CollisionProtection)
 
-	// Omitted and explicitly supplied Prevent remain distinguishable templates.
-	cod.Spec.Template.Spec.CollisionProtection = CollisionProtectionPrevent
-	require.NoError(t, c.Update(t.Context(), cod))
-	cod = getTestClusterObjectDeployment(t, c, cod.Name)
-	require.Equal(t, CollisionProtectionPrevent, cod.Spec.Template.Spec.CollisionProtection)
-	cod.Spec.Template.Spec.CollisionProtection = ""
+	// The field can be changed to another valid value.
+	cod.Spec.Template.Spec.CollisionProtection = CollisionProtectionNone
 	require.NoError(t, c.Update(t.Context(), cod))
 	cod = getTestClusterObjectDeployment(t, c, cod.Name)
-	require.Empty(t, cod.Spec.Template.Spec.CollisionProtection)
+	require.Equal(t, CollisionProtectionNone, cod.Spec.Template.Spec.CollisionProtection)
 }
 
 func TestClusterObjectDeploymentTemplateIsMutable(t *testing.T) {
@@ -154,7 +159,6 @@ func TestClusterObjectDeploymentTemplateIsMutable(t *testing.T) {
 
 	// Optional fields can also be removed after being set.
 	cod.Spec.Template.Spec.ProgressionProbes = nil
-	cod.Spec.Template.Spec.CollisionProtection = ""
 	require.NoError(t, c.Update(t.Context(), cod))
 }
 
@@ -166,6 +170,7 @@ func TestClusterObjectDeploymentUpdateValidation(t *testing.T) {
 	}{
 		{name: "no phases", mutate: func(cod *ClusterObjectDeployment) { cod.Spec.Template.Spec.Phases = nil }},
 		{name: "invalid collision protection", mutate: codCollisionProtection("Invalid")},
+		{name: "empty collision protection", mutate: codCollisionProtection("")},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			cod := newTestClusterObjectDeployment(fmt.Sprintf("cod-update-validity-%d", i))
@@ -306,7 +311,8 @@ func newTestClusterObjectDeployment(name string) *ClusterObjectDeployment {
 		Spec: ClusterObjectDeploymentSpec{
 			Template: ClusterObjectDeploymentTemplate{
 				Spec: ClusterObjectDeploymentTemplateSpec{
-					Phases: []ClusterObjectSetPhase{{Name: "deploy", Objects: []ClusterObjectSetObject{{Object: configMap()}}}},
+					CollisionProtection: CollisionProtectionPrevent,
+					Phases:              []ClusterObjectSetPhase{{Name: "deploy", Objects: []ClusterObjectSetObject{{Object: configMap()}}}},
 				},
 			},
 		},

api/v1/clusterobjectset_types.go

@@ -142,18 +142,16 @@ type ClusterObjectSetSpec struct {
 	// <opcon:experimental>
 	ProgressionProbes []ProgressionProbe `json:"progressionProbes,omitempty"`
 
-	// collisionProtection specifies the default collision protection strategy for all objects
-	// in this revision. Individual phases or objects can override this value.
-	//
-	// When set, this value is used as the default for any phase or object that does not
-	// explicitly specify its own collisionProtection.
+	// collisionProtection is a required field that specifies the default collision protection
+	// strategy for all objects in this revision. Individual phases or objects can override this value.
 	//
-	// The resolution order is: object > phase > spec
+	// This value is used as the default for any phase or object that does not explicitly specify
+	// its own collisionProtection. The resolution order is: object > phase > spec.
 	//
 	// +required
 	// +kubebuilder:validation:Enum=Prevent;IfNoController;None
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="collisionProtection is immutable"
-	CollisionProtection CollisionProtection `json:"collisionProtection,omitempty"`
+	CollisionProtection CollisionProtection `json:"collisionProtection"`
 }
 
 // ProgressionProbe provides a custom probe definition, consisting of an object selection method and assertions.

docs/api-reference/olmv1-api-reference.md

@@ -492,7 +492,7 @@ _Appears in:_
 | --- | --- | --- | --- |
 | `phases` _[ClusterObjectSetPhase](#clusterobjectsetphase) array_ | phases is an ordered list of 1 to 20 uniquely named phases. Each phase contains<br />at most 50 objects using the existing inline object or immutable Secret reference<br />representation. Phase, object, and probe order participate in template identity. |  | MaxItems: 20 <br />MinItems: 1 <br />Required: \{\} <br /> |
 | `progressionProbes` _[ProgressionProbe](#progressionprobe) array_ | progressionProbes supplies custom readiness probes for objects in every phase.<br />The existing ClusterObjectSet selector and assertion semantics apply. |  | MaxItems: 20 <br />MinItems: 1 <br />Optional: \{\} <br /> |
-| `collisionProtection` _[CollisionProtection](#collisionprotection)_ | collisionProtection is the default strategy for objects in the revision.<br />Objects and phases may override it. When omitted the controller uses Prevent<br />in the generated ClusterObjectSet. Omission remains distinct from explicit<br />Prevent for template identity; admission does not default this field. |  | Enum: [Prevent IfNoController None] <br />Optional: \{\} <br /> |
+| `collisionProtection` _[CollisionProtection](#collisionprotection)_ | collisionProtection is the required default collision protection strategy for objects in the revision.<br />Objects and phases may override it. |  | Enum: [Prevent IfNoController None] <br />Required: \{\} <br /> |
 
 
 

helm/olmv1/base/object-controller/crd/experimental/olm.operatorframework.io_clusterobjectdeployments.yaml

@@ -63,10 +63,8 @@ spec:
                     properties:
                       collisionProtection:
                         description: |-
-                          collisionProtection is the default strategy for objects in the revision.
-                          Objects and phases may override it. When omitted the controller uses Prevent
-                          in the generated ClusterObjectSet. Omission remains distinct from explicit
-                          Prevent for template identity; admission does not default this field.
+                          collisionProtection is the required default collision protection strategy for objects in the revision.
+                          Objects and phases may override it.
                         enum:
                         - Prevent
                         - IfNoController
@@ -469,6 +467,7 @@ spec:
                         type: array
                         x-kubernetes-list-type: atomic
                     required:
+                    - collisionProtection
                     - phases
                     type: object
                 required:

helm/olmv1/base/object-controller/crd/experimental/olm.operatorframework.io_clusterobjectsets.yaml

@@ -76,13 +76,11 @@ spec:
             properties:
               collisionProtection:
                 description: |-
-                  collisionProtection specifies the default collision protection strategy for all objects
-                  in this revision. Individual phases or objects can override this value.
+                  collisionProtection is a required field that specifies the default collision protection
+                  strategy for all objects in this revision. Individual phases or objects can override this value.
 
-                  When set, this value is used as the default for any phase or object that does not
-                  explicitly specify its own collisionProtection.
-
-                  The resolution order is: object > phase > spec
+                  This value is used as the default for any phase or object that does not explicitly specify
+                  its own collisionProtection. The resolution order is: object > phase > spec.
                 enum:
                 - Prevent
                 - IfNoController

manifests/experimental-e2e.yaml

@@ -1474,10 +1474,8 @@ spec:
                     properties:
                       collisionProtection:
                         description: |-
-                          collisionProtection is the default strategy for objects in the revision.
-                          Objects and phases may override it. When omitted the controller uses Prevent
-                          in the generated ClusterObjectSet. Omission remains distinct from explicit
-                          Prevent for template identity; admission does not default this field.
+                          collisionProtection is the required default collision protection strategy for objects in the revision.
+                          Objects and phases may override it.
                         enum:
                         - Prevent
                         - IfNoController
@@ -1880,6 +1878,7 @@ spec:
                         type: array
                         x-kubernetes-list-type: atomic
                     required:
+                    - collisionProtection
                     - phases
                     type: object
                 required:
@@ -2048,13 +2047,11 @@ spec:
             properties:
               collisionProtection:
                 description: |-
-                  collisionProtection specifies the default collision protection strategy for all objects
-                  in this revision. Individual phases or objects can override this value.
+                  collisionProtection is a required field that specifies the default collision protection
+                  strategy for all objects in this revision. Individual phases or objects can override this value.
 
-                  When set, this value is used as the default for any phase or object that does not
-                  explicitly specify its own collisionProtection.
-
-                  The resolution order is: object > phase > spec
+                  This value is used as the default for any phase or object that does not explicitly specify
+                  its own collisionProtection. The resolution order is: object > phase > spec.
                 enum:
                 - Prevent
                 - IfNoController

manifests/experimental.yaml

@@ -1435,10 +1435,8 @@ spec:
                     properties:
                       collisionProtection:
                         description: |-
-                          collisionProtection is the default strategy for objects in the revision.
-                          Objects and phases may override it. When omitted the controller uses Prevent
-                          in the generated ClusterObjectSet. Omission remains distinct from explicit
-                          Prevent for template identity; admission does not default this field.
+                          collisionProtection is the required default collision protection strategy for objects in the revision.
+                          Objects and phases may override it.
                         enum:
                         - Prevent
                         - IfNoController
@@ -1841,6 +1839,7 @@ spec:
                         type: array
                         x-kubernetes-list-type: atomic
                     required:
+                    - collisionProtection
                     - phases
                     type: object
                 required:
@@ -2009,13 +2008,11 @@ spec:
             properties:
               collisionProtection:
                 description: |-
-                  collisionProtection specifies the default collision protection strategy for all objects
-                  in this revision. Individual phases or objects can override this value.
+                  collisionProtection is a required field that specifies the default collision protection
+                  strategy for all objects in this revision. Individual phases or objects can override this value.
 
-                  When set, this value is used as the default for any phase or object that does not
-                  explicitly specify its own collisionProtection.
-
-                  The resolution order is: object > phase > spec
+                  This value is used as the default for any phase or object that does not explicitly specify
+                  its own collisionProtection. The resolution order is: object > phase > spec.
                 enum:
                 - Prevent
                 - IfNoController