feat: align v1 override types with v1beta1 schema parity (#509)

Signed-off-by: Yetkin Timocin <ytimocin@microsoft.com>

Author: ytimocin

apis/placement/v1/clusterresourceplacement_types.go

@@ -29,11 +29,11 @@ import (
 const (
 	// PlacementCleanupFinalizer is a finalizer added by the placement controller to all placement objects, to make sure
 	// that the placement controller can react to placement object deletions if necessary.
-	PlacementCleanupFinalizer = fleetPrefix + "crp-cleanup"
+	PlacementCleanupFinalizer = FleetPrefix + "crp-cleanup"
 
 	// SchedulerCleanupFinalizer is a finalizer added by the scheduler to placement objects, to make sure
 	// that all bindings derived from a placement object can be cleaned up after the placement object is deleted.
-	SchedulerCleanupFinalizer = fleetPrefix + "scheduler-cleanup"
+	SchedulerCleanupFinalizer = FleetPrefix + "scheduler-cleanup"
 )
 
 // make sure the PlacementObj and PlacementObjList interfaces are implemented by the
@@ -1513,7 +1513,7 @@ func (crpl *ClusterResourcePlacementList) GetPlacementObjs() []PlacementObj {
 const (
 	// ResourcePlacementCleanupFinalizer is a finalizer added by the RP controller to all RPs, to make sure
 	// that the RP controller can react to RP deletions if necessary.
-	ResourcePlacementCleanupFinalizer = fleetPrefix + "rp-cleanup"
+	ResourcePlacementCleanupFinalizer = FleetPrefix + "rp-cleanup"
 )
 
 // +genclient

apis/placement/v1/commons.go

@@ -17,18 +17,19 @@ limitations under the License.
 package v1
 
 const (
-	// fleetPrefix is the prefix used for official fleet labels/annotations.
+	// FleetPrefix is the prefix used for official fleet labels/annotations.
 	// Unprefixed labels/annotations are reserved for end-users
 	// See https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#label-selector-and-annotation-conventions
-	fleetPrefix = "kubernetes-fleet.io/"
+	FleetPrefix = "kubernetes-fleet.io/"
 )
 
 // NamespacedName comprises a resource name, with a mandatory namespace.
 type NamespacedName struct {
 	// Name is the name of the namespaced scope resource.
-	// +required
+	// +kubebuilder:validation:Required
 	Name string `json:"name"`
+
 	// Namespace is namespace of the namespaced scope resource.
-	// +required
+	// +kubebuilder:validation:Required
 	Namespace string `json:"namespace"`
 }

apis/placement/v1/override_types.go

@@ -25,6 +25,7 @@ import (
 // +genclient:nonNamespaced
 // +kubebuilder:object:root=true
 // +kubebuilder:resource:scope="Cluster",categories={fleet,fleet-placement}
+// +kubebuilder:validation:XValidation:rule="!has(self.spec.placement) || self.spec.placement.scope != 'Namespaced'",message="clusterResourceOverride placement reference cannot be Namespaced scope"
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
 // ClusterResourceOverride defines a group of override policies about how to override the selected cluster scope resources
@@ -48,7 +49,6 @@ type ClusterResourceOverrideSpec struct {
 	// If set, the override will trigger the placement rollout immediately when the rollout strategy type is RollingUpdate.
 	// Otherwise, it will be applied to the next rollout.
 	// The recommended way is to set the placement so that the override can be rolled out immediately.
-	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="The placement field is immutable"
 	// +optional
 	Placement *PlacementRef `json:"placement,omitempty"`
 
@@ -84,8 +84,8 @@ const (
 type PlacementRef struct {
 	// Name is the reference to the name of placement.
 	// +required
-
 	Name string `json:"name"`
+
 	// Scope defines the scope of the placement.
 	// A clusterResourceOverride can only reference a clusterResourcePlacement (cluster-scoped),
 	// and a resourceOverride can reference either a clusterResourcePlacement or resourcePlacement (namespaced).

apis/placement/v1/overridesnapshot_types.go

@@ -20,18 +20,18 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 const (
 
-	// OverrideIndexLabel is the label that indicate the policy snapshot index of a cluster policy.
-	OverrideIndexLabel = fleetPrefix + "override-index"
+	// OverrideIndexLabel is the label that indicates the override snapshot index of an override.
+	OverrideIndexLabel = FleetPrefix + "override-index"
 
 	// OverrideSnapshotNameFmt is clusterResourceOverrideSnapshot name format: {CROName}-{OverrideSnapshotIndex}.
 	OverrideSnapshotNameFmt = "%s-%d"
 
 	// OverrideTrackingLabel is the label that points to the cluster resource override that creates a resource snapshot.
-	OverrideTrackingLabel = fleetPrefix + "parent-resource-override"
+	OverrideTrackingLabel = FleetPrefix + "parent-resource-override"
 
 	// OverrideFinalizer is a finalizer added by the override controllers to all override, to make sure
 	// that the override controller can react to override deletions if necessary.
-	OverrideFinalizer = fleetPrefix + "override-cleanup"
+	OverrideFinalizer = FleetPrefix + "override-cleanup"
 )
 
 // +genclient

apis/placement/v1beta1/overridesnapshot_types.go

@@ -20,7 +20,7 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 const (
 
-	// OverrideIndexLabel is the label that indicate the policy snapshot index of a cluster policy.
+	// OverrideIndexLabel is the label that indicates the override snapshot index of an override.
 	OverrideIndexLabel = FleetPrefix + "override-index"
 
 	// OverrideSnapshotNameFmt is clusterResourceOverrideSnapshot name format: {CROName}-{OverrideSnapshotIndex}.

config/crd/bases/placement.kubernetes-fleet.io_clusterresourceoverrides.yaml

@@ -153,6 +153,7 @@ spec:
                   The recommended way is to set the placement so that the override can be rolled out immediately.
                 properties:
                   name:
+                    description: Name is the reference to the name of placement.
                     type: string
                   scope:
                     default: Cluster
@@ -168,9 +169,6 @@ spec:
                 required:
                 - name
                 type: object
-                x-kubernetes-validations:
-                - message: The placement field is immutable
-                  rule: self == oldSelf
               policy:
                 description: Policy defines how to override the selected resources
                   on the target clusters.
@@ -399,6 +397,10 @@ spec:
         required:
         - spec
         type: object
+        x-kubernetes-validations:
+        - message: clusterResourceOverride placement reference cannot be Namespaced
+            scope
+          rule: '!has(self.spec.placement) || self.spec.placement.scope != ''Namespaced'''
     served: true
     storage: false
   - name: v1alpha1

config/crd/bases/placement.kubernetes-fleet.io_clusterresourceoverridesnapshots.yaml

@@ -167,6 +167,7 @@ spec:
                       The recommended way is to set the placement so that the override can be rolled out immediately.
                     properties:
                       name:
+                        description: Name is the reference to the name of placement.
                         type: string
                       scope:
                         default: Cluster
@@ -182,9 +183,6 @@ spec:
                     required:
                     - name
                     type: object
-                    x-kubernetes-validations:
-                    - message: The placement field is immutable
-                      rule: self == oldSelf
                   policy:
                     description: Policy defines how to override the selected resources
                       on the target clusters.

config/crd/bases/placement.kubernetes-fleet.io_resourceoverrides.yaml

@@ -52,6 +52,7 @@ spec:
                   The recommended way is to set the placement so that the override can be rolled out immediately.
                 properties:
                   name:
+                    description: Name is the reference to the name of placement.
                     type: string
                   scope:
                     default: Cluster

config/crd/bases/placement.kubernetes-fleet.io_resourceoverridesnapshots.yaml

@@ -66,6 +66,7 @@ spec:
                       The recommended way is to set the placement so that the override can be rolled out immediately.
                     properties:
                       name:
+                        description: Name is the reference to the name of placement.
                         type: string
                       scope:
                         default: Cluster