Merge pull request #384 from Xieql/914

backup: update design of destination
kurator-dev · Sep 15, 2023 · 5734bb7 · 5734bb7
2 parents 1709fe3 + 8ce7eec
commit 5734bb7
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 43 deletions.
diff --git a/docs/content/en/references/backups_v1alpha1_types.html b/docs/content/en/references/backups_v1alpha1_types.html
@@ -464,10 +464,8 @@ <h3 id="backup.kurator.dev/v1alpha1.Destination">Destination
 </em>
 </td>
 <td>
-<em>(Optional)</em>
-<p>Fleet represents the name of a fleet which determines a set of clusters.
-If Fleet is set, it will be used to determine the target clusters.
-If users wish to specify clusters directly, they can use the Clusters field.</p>
+<p>Fleet represents the name of a fleet which determines a set of target clusters within the namespace.
+This field is required to identify the context for cluster selection.</p>
 </td>
 </tr>
 <tr>
@@ -481,9 +479,8 @@ <h3 id="backup.kurator.dev/v1alpha1.Destination">Destination
 </td>
 <td>
 <em>(Optional)</em>
-<p>Clusters allows users to directly specify a set of destination clusters.
-It should be used exclusively to select clusters described within the Fleet.
-If Fleet is set, it takes precedence over the Clusters field.</p>
+<p>Clusters allows users to specify a subset of clusters within the selected fleet for targeted operations.
+If not set, it implies that the operation is targeted at all clusters within the specified fleet.</p>
 </td>
 </tr>
 </tbody>

diff --git a/manifests/charts/fleet-manager/crds/backup.kurator.dev_backups.yaml b/manifests/charts/fleet-manager/crds/backup.kurator.dev_backups.yaml
@@ -51,10 +51,10 @@ spec:
                   be performed.
                 properties:
                   clusters:
-                    description: Clusters allows users to directly specify a set of
-                      destination clusters. It should be used exclusively to select
-                      clusters described within the Fleet. If Fleet is set, it takes
-                      precedence over the Clusters field.
+                    description: Clusters allows users to specify a subset of clusters
+                      within the selected fleet for targeted operations. If not set,
+                      it implies that the operation is targeted at all clusters within
+                      the specified fleet.
                     items:
                       description: "ObjectReference contains enough information to
                         let you inspect or modify the referred object. --- New uses
@@ -120,10 +120,11 @@ spec:
                     type: array
                   fleet:
                     description: Fleet represents the name of a fleet which determines
-                      a set of clusters. If Fleet is set, it will be used to determine
-                      the target clusters. If users wish to specify clusters directly,
-                      they can use the Clusters field.
+                      a set of target clusters within the namespace. This field is
+                      required to identify the context for cluster selection.
                     type: string
+                required:
+                - fleet
                 type: object
               policy:
                 description: Policy are the rules defining how backups should be performed.

diff --git a/manifests/charts/fleet-manager/crds/backup.kurator.dev_migrates.yaml b/manifests/charts/fleet-manager/crds/backup.kurator.dev_migrates.yaml
@@ -314,10 +314,10 @@ spec:
                   to one or more TargetCluster.
                 properties:
                   clusters:
-                    description: Clusters allows users to directly specify a set of
-                      destination clusters. It should be used exclusively to select
-                      clusters described within the Fleet. If Fleet is set, it takes
-                      precedence over the Clusters field.
+                    description: Clusters allows users to specify a subset of clusters
+                      within the selected fleet for targeted operations. If not set,
+                      it implies that the operation is targeted at all clusters within
+                      the specified fleet.
                     items:
                       description: "ObjectReference contains enough information to
                         let you inspect or modify the referred object. --- New uses
@@ -383,19 +383,20 @@ spec:
                     type: array
                   fleet:
                     description: Fleet represents the name of a fleet which determines
-                      a set of clusters. If Fleet is set, it will be used to determine
-                      the target clusters. If users wish to specify clusters directly,
-                      they can use the Clusters field.
+                      a set of target clusters within the namespace. This field is
+                      required to identify the context for cluster selection.
                     type: string
+                required:
+                - fleet
                 type: object
               targetCluster:
                 description: TargetCluster represents the target clusters for migration.
                 properties:
                   clusters:
-                    description: Clusters allows users to directly specify a set of
-                      destination clusters. It should be used exclusively to select
-                      clusters described within the Fleet. If Fleet is set, it takes
-                      precedence over the Clusters field.
+                    description: Clusters allows users to specify a subset of clusters
+                      within the selected fleet for targeted operations. If not set,
+                      it implies that the operation is targeted at all clusters within
+                      the specified fleet.
                     items:
                       description: "ObjectReference contains enough information to
                         let you inspect or modify the referred object. --- New uses
@@ -461,10 +462,11 @@ spec:
                     type: array
                   fleet:
                     description: Fleet represents the name of a fleet which determines
-                      a set of clusters. If Fleet is set, it will be used to determine
-                      the target clusters. If users wish to specify clusters directly,
-                      they can use the Clusters field.
+                      a set of target clusters within the namespace. This field is
+                      required to identify the context for cluster selection.
                     type: string
+                required:
+                - fleet
                 type: object
             required:
             - sourceCluster

diff --git a/manifests/charts/fleet-manager/crds/backup.kurator.dev_restores.yaml b/manifests/charts/fleet-manager/crds/backup.kurator.dev_restores.yaml
@@ -51,10 +51,10 @@ spec:
                   will perform restore.
                 properties:
                   clusters:
-                    description: Clusters allows users to directly specify a set of
-                      destination clusters. It should be used exclusively to select
-                      clusters described within the Fleet. If Fleet is set, it takes
-                      precedence over the Clusters field.
+                    description: Clusters allows users to specify a subset of clusters
+                      within the selected fleet for targeted operations. If not set,
+                      it implies that the operation is targeted at all clusters within
+                      the specified fleet.
                     items:
                       description: "ObjectReference contains enough information to
                         let you inspect or modify the referred object. --- New uses
@@ -120,10 +120,11 @@ spec:
                     type: array
                   fleet:
                     description: Fleet represents the name of a fleet which determines
-                      a set of clusters. If Fleet is set, it will be used to determine
-                      the target clusters. If users wish to specify clusters directly,
-                      they can use the Clusters field.
+                      a set of target clusters within the namespace. This field is
+                      required to identify the context for cluster selection.
                     type: string
+                required:
+                - fleet
                 type: object
               policy:
                 description: Policy defines the customization rules for the restore.

diff --git a/pkg/apis/backups/v1alpha1/common_type.go b/pkg/apis/backups/v1alpha1/common_type.go
@@ -23,15 +23,13 @@ import (
 
 // Destination defines a target set of clusters, either through a fleet or by specifying them directly.
 type Destination struct {
-	// Fleet represents the name of a fleet which determines a set of clusters.
-	// If Fleet is set, it will be used to determine the target clusters.
-	// If users wish to specify clusters directly, they can use the Clusters field.
-	// +optional
-	Fleet string `json:"fleet,omitempty"`
+	// Fleet represents the name of a fleet which determines a set of target clusters within the namespace.
+	// This field is required to identify the context for cluster selection.
+	// +required
+	Fleet string `json:"fleet"`
 
-	// Clusters allows users to directly specify a set of destination clusters.
-	// It should be used exclusively to select clusters described within the Fleet.
-	// If Fleet is set, it takes precedence over the Clusters field.
+	// Clusters allows users to specify a subset of clusters within the selected fleet for targeted operations.
+	// If not set, it implies that the operation is targeted at all clusters within the specified fleet.
 	// +optional
 	Clusters []*corev1.ObjectReference `json:"clusters,omitempty"`
 }