Added more clear description for override API (#318)

Signed-off-by: RainbowMango <renhongcai@huawei.com>

artifacts/deploy/policy.karmada.io_clusteroverridepolicies.yaml

@@ -50,7 +50,7 @@ spec:
                       properties:
                         component:
                           description: 'Component is part of image name. Basically
-                            we presume an image can be make of ''[registry/]repository[:tag]''.
+                            we presume an image can be made of ''[registry/]repository[:tag]''.
                             The registry could be: - k8s.gcr.io - fictional.registry.example:10443
                             The repository could be: - kube-apiserver - fictional/nginx
                             The tag cloud be: - latest - v1.19.1 - @sha256:dbcc1c35ac38df41fd2f5e4130b32ffdb93ebae8b3dbe638c23575912276fc9c'
@@ -125,7 +125,7 @@ spec:
                 type: object
               resourceSelectors:
                 description: ResourceSelectors restricts resource types that this
-                  override policy applies to.
+                  override policy applies to. nil means matching all resources.
                 items:
                   description: ResourceSelector the resources will be selected.
                   properties:
@@ -196,7 +196,8 @@ spec:
                 type: array
               targetCluster:
                 description: TargetCluster defines restrictions on this override policy
-                  that only applies to resources propagated to the matching clusters
+                  that only applies to resources propagated to the matching clusters.
+                  nil means matching all clusters.
                 properties:
                   clusterNames:
                     description: ClusterNames is the list of clusters to be selected.
@@ -293,6 +294,8 @@ spec:
                         type: object
                     type: object
                 type: object
+            required:
+            - overriders
             type: object
         required:
         - spec

artifacts/deploy/policy.karmada.io_overridepolicies.yaml

@@ -50,7 +50,7 @@ spec:
                       properties:
                         component:
                           description: 'Component is part of image name. Basically
-                            we presume an image can be make of ''[registry/]repository[:tag]''.
+                            we presume an image can be made of ''[registry/]repository[:tag]''.
                             The registry could be: - k8s.gcr.io - fictional.registry.example:10443
                             The repository could be: - kube-apiserver - fictional/nginx
                             The tag cloud be: - latest - v1.19.1 - @sha256:dbcc1c35ac38df41fd2f5e4130b32ffdb93ebae8b3dbe638c23575912276fc9c'
@@ -125,7 +125,7 @@ spec:
                 type: object
               resourceSelectors:
                 description: ResourceSelectors restricts resource types that this
-                  override policy applies to.
+                  override policy applies to. nil means matching all resources.
                 items:
                   description: ResourceSelector the resources will be selected.
                   properties:
@@ -196,7 +196,8 @@ spec:
                 type: array
               targetCluster:
                 description: TargetCluster defines restrictions on this override policy
-                  that only applies to resources propagated to the matching clusters
+                  that only applies to resources propagated to the matching clusters.
+                  nil means matching all clusters.
                 properties:
                   clusterNames:
                     description: ClusterNames is the list of clusters to be selected.
@@ -293,6 +294,8 @@ spec:
                         type: object
                     type: object
                 type: object
+            required:
+            - overriders
             type: object
         required:
         - spec

pkg/apis/policy/v1alpha1/override_types.go

@@ -20,14 +20,19 @@ type OverridePolicy struct {
 // OverrideSpec defines the desired behavior of OverridePolicy.
 type OverrideSpec struct {
 	// ResourceSelectors restricts resource types that this override policy applies to.
+	// nil means matching all resources.
+	// +optional
 	ResourceSelectors []ResourceSelector `json:"resourceSelectors,omitempty"`
 
 	// TargetCluster defines restrictions on this override policy
-	// that only applies to resources propagated to the matching clusters
+	// that only applies to resources propagated to the matching clusters.
-	TargetCluster ClusterAffinity `json:"targetCluster,omitempty"`
+	// nil means matching all clusters.
+	// +optional
+	TargetCluster *ClusterAffinity `json:"targetCluster,omitempty"`
 
 	// Overriders represents the override rules that would apply on resources
-	Overriders Overriders `json:"overriders,omitempty"`
+	// +required
+	Overriders Overriders `json:"overriders"`
 }
 
 // Overriders offers various alternatives to represent the override rules.
@@ -62,7 +67,7 @@ type ImageOverrider struct {
 	Predicate *ImagePredicate `json:"predicate,omitempty"`
 
 	// Component is part of image name.
-	// Basically we presume an image can be make of '[registry/]repository[:tag]'.
+	// Basically we presume an image can be made of '[registry/]repository[:tag]'.
 	// The registry could be:
 	// - k8s.gcr.io
 	// - fictional.registry.example:10443

pkg/apis/policy/v1alpha1/zz_generated.deepcopy.go

@@ -319,7 +319,11 @@ func (in *OverrideSpec) DeepCopyInto(out *OverrideSpec) {
 			(*in)[i].DeepCopyInto(&(*out)[i])
 		}
 	}
-	in.TargetCluster.DeepCopyInto(&out.TargetCluster)
+	if in.TargetCluster != nil {
+		in, out := &in.TargetCluster, &out.TargetCluster
+		*out = new(ClusterAffinity)
+		(*in).DeepCopyInto(*out)
+	}
 	in.Overriders.DeepCopyInto(&out.Overriders)
 	return
 }

pkg/util/overridemanager/overridemanager.go

@@ -148,7 +148,12 @@ func (o *overrideManagerImpl) getMatchedClusterOverridePolicy(policies []policyv
 	// select policy which cluster selector matches target resource.
 	clusterMatches := make([]policyv1alpha1.ClusterOverridePolicy, 0)
 	for _, policy := range resourceMatches {
-		if util.ClusterMatches(cluster, policy.Spec.TargetCluster) {
+		if policy.Spec.TargetCluster == nil {
+			clusterMatches = append(clusterMatches, policy)
+			continue
+		}
+
+		if util.ClusterMatches(cluster, *policy.Spec.TargetCluster) {
 			clusterMatches = append(clusterMatches, policy)
 		}
 	}
@@ -173,7 +178,12 @@ func (o *overrideManagerImpl) getMatchedOverridePolicy(policies []policyv1alpha1
 	// select policy which cluster selector matches target resource.
 	clusterMatches := make([]policyv1alpha1.OverridePolicy, 0)
 	for _, policy := range resourceMatches {
-		if util.ClusterMatches(cluster, policy.Spec.TargetCluster) {
+		if policy.Spec.TargetCluster == nil {
+			clusterMatches = append(clusterMatches, policy)
+			continue
+		}
+
+		if util.ClusterMatches(cluster, *policy.Spec.TargetCluster) {
 			clusterMatches = append(clusterMatches, policy)
 		}
 	}