address comments

Signed-off-by: Ryan Zhang <[email protected]>

Author: ryanzhang-oss

apis/placement/v1beta1/binding_types.go

@@ -37,7 +37,7 @@ const (
 // +kubebuilder:printcolumn:JSONPath=`.metadata.creationTimestamp`,name="Age",type=date
 
 // ClusterResourceBinding represents a scheduling decision that binds a group of resources to a cluster.
-// It MUST have a label named `PlacementTrackingLabel` that points to the cluster resource policy that creates it.
+// It MUST have a label named `CRPTrackingLabel` that points to the cluster resource policy that creates it.
 type ClusterResourceBinding struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -221,7 +221,7 @@ type ClusterResourceBindingList struct {
 // +kubebuilder:printcolumn:JSONPath=`.metadata.creationTimestamp`,name="Age",type=date
 
 // ResourceBinding represents a scheduling decision that binds a group of resources to a cluster.
-// It MUST have a label named `PlacementTrackingLabel` that points to the resource placement that creates it.
+// It MUST have a label named `CRPTrackingLabel` that points to the resource placement that creates it.
 type ResourceBinding struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

apis/placement/v1beta1/clusterresourceplacement_types.go

@@ -1336,7 +1336,7 @@ type ResourcePlacement struct {
 }
 
 // ResourcePlacementList contains a list of ResourcePlacement.
-// +kubebuilder:resource:scope="Cluster"
+// +kubebuilder:resource:scope="Namespaced"
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type ResourcePlacementList struct {
 	metav1.TypeMeta `json:",inline"`

apis/placement/v1beta1/policysnapshot_types.go

@@ -47,7 +47,7 @@ const (
 // The naming convention of a ClusterSchedulingPolicySnapshot is {CRPName}-{PolicySnapshotIndex}.
 // PolicySnapshotIndex will begin with 0.
 // Each snapshot must have the following labels:
-//   - `PlacementTrackingLabel` which points to its owner CRP.
+//   - `CRPTrackingLabel` which points to its owner CRP.
 //   - `PolicyIndexLabel` which is the index of the policy snapshot.
 //   - `IsLatestSnapshotLabel` which indicates whether the snapshot is the latest one.
 type ClusterSchedulingPolicySnapshot struct {
@@ -183,7 +183,7 @@ func (m *ClusterSchedulingPolicySnapshot) GetCondition(conditionType string) *me
 // +genclient
 // +genclient:Namespaced
 // +kubebuilder:object:root=true
-// +kubebuilder:resource:scope="Namespace",shortName=sps,categories={fleet,fleet-placement}
+// +kubebuilder:resource:scope="Namespaced",shortName=sps,categories={fleet,fleet-placement}
 // +kubebuilder:subresource:status
 // +kubebuilder:storageversion
 // +kubebuilder:printcolumn:JSONPath=`.metadata.generation`,name="Gen",type=string
@@ -195,7 +195,7 @@ func (m *ClusterSchedulingPolicySnapshot) GetCondition(conditionType string) *me
 // The naming convention of a SchedulingPolicySnapshot is {RPName}-{PolicySnapshotIndex}.
 // PolicySnapshotIndex will begin with 0.
 // Each snapshot must have the following labels:
-//   - `PlacementTrackingLabel` which points to its placement owner.
+//   - `CRPTrackingLabel` which points to its placement owner.
 //   - `PolicyIndexLabel` which is the index of the policy snapshot.
 //   - `IsLatestSnapshotLabel` which indicates whether the snapshot is the latest one.
 type SchedulingPolicySnapshot struct {
@@ -212,7 +212,7 @@ type SchedulingPolicySnapshot struct {
 }
 
 // SchedulingPolicySnapshotList contains a list of SchedulingPolicySnapshotList.
-// +kubebuilder:resource:scope="Namespace"
+// +kubebuilder:resource:scope="Namespaced"
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type SchedulingPolicySnapshotList struct {
 	metav1.TypeMeta `json:",inline"`

apis/placement/v1beta1/resourcesnapshot_types.go

@@ -64,7 +64,7 @@ const (
 // where the name of the first snapshot of a group has no subindex part so its name is {CRPName}-{resourceIndex}-snapshot.
 // resourceIndex will begin with 0.
 // Each snapshot MUST have the following labels:
-//   - `PlacementTrackingLabel` which points to its owner CRP.
+//   - `CRPTrackingLabel` which points to its owner CRP.
 //   - `ResourceIndexLabel` which is the index  of the snapshot group.
 //   - `IsLatestSnapshotLabel` which indicates whether the snapshot is the latest one.
 //
@@ -140,7 +140,7 @@ type ClusterResourceSnapshotList struct {
 // where the name of the first snapshot of a group has no subindex part so its name is {RPName}-{resourceIndex}-snapshot.
 // resourceIndex will begin with 0.
 // Each snapshot MUST have the following labels:
-//   - `PlacementTrackingLabel` which points to its owner resource placement.
+//   - `CRPTrackingLabel` which points to its owner resource placement.
 //   - `ResourceIndexLabel` which is the index  of the snapshot group.
 //   - `IsLatestSnapshotLabel` which indicates whether the snapshot is the latest one.
 //

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

@@ -390,7 +390,7 @@ spec:
       openAPIV3Schema:
         description: |-
           ClusterResourceBinding represents a scheduling decision that binds a group of resources to a cluster.
-          It MUST have a label named `PlacementTrackingLabel` that points to the cluster resource policy that creates it.
+          It MUST have a label named `CRPTrackingLabel` that points to the cluster resource policy that creates it.
         properties:
           apiVersion:
             description: |-

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

@@ -174,7 +174,7 @@ spec:
           where the name of the first snapshot of a group has no subindex part so its name is {CRPName}-{resourceIndex}-snapshot.
           resourceIndex will begin with 0.
           Each snapshot MUST have the following labels:
-            - `PlacementTrackingLabel` which points to its owner CRP.
+            - `CRPTrackingLabel` which points to its owner CRP.
             - `ResourceIndexLabel` which is the index  of the snapshot group.
             - `IsLatestSnapshotLabel` which indicates whether the snapshot is the latest one.
 

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

@@ -651,7 +651,7 @@ spec:
           The naming convention of a ClusterSchedulingPolicySnapshot is {CRPName}-{PolicySnapshotIndex}.
           PolicySnapshotIndex will begin with 0.
           Each snapshot must have the following labels:
-            - `PlacementTrackingLabel` which points to its owner CRP.
+            - `CRPTrackingLabel` which points to its owner CRP.
             - `PolicyIndexLabel` which is the index of the policy snapshot.
             - `IsLatestSnapshotLabel` which indicates whether the snapshot is the latest one.
         properties:

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

@@ -38,7 +38,7 @@ spec:
       openAPIV3Schema:
         description: |-
           ResourceBinding represents a scheduling decision that binds a group of resources to a cluster.
-          It MUST have a label named `PlacementTrackingLabel` that points to the resource policy that creates it.
+          It MUST have a label named `CRPTrackingLabel` that points to the resource placement that creates it.
         properties:
           apiVersion:
             description: |-

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

@@ -56,8 +56,8 @@ spec:
         description: |-
           ResourcePlacement is used to select namespace scoped resources, including built-in resources and custom resources,
           and placement them onto selected member clusters in a fleet.
-          `SchedulingPolicySnapshot`, `ResourceSnapshot` and `ResourceBinding` objects are created in the same namespace when there are changes in the
-          system to keep the history of the changes affecting a `ResourcePlacement`.
+          `SchedulingPolicySnapshot` and `ResourceSnapshot` objects are created in the same namespace when there are changes in the
+          system to keep the history of the changes affecting a `ResourcePlacement`. We will also create `ResourceBinding` objects in the same namespace.
         properties:
           apiVersion:
             description: |-

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

@@ -38,7 +38,7 @@ spec:
           where the name of the first snapshot of a group has no subindex part so its name is {RPName}-{resourceIndex}-snapshot.
           resourceIndex will begin with 0.
           Each snapshot MUST have the following labels:
-            - `PlacementTrackingLabel` which points to its owner RP.
+            - `CRPTrackingLabel` which points to its owner resource placement.
             - `ResourceIndexLabel` which is the index  of the snapshot group.
             - `IsLatestSnapshotLabel` which indicates whether the snapshot is the latest one.