edit crd comments

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

Author: Ryan Zhang

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

@@ -542,8 +542,8 @@ spec:
                         managed by Fleet (i.e., specified in the hub cluster manifest). This is the default
                         option.
 
-                        Note that this option would revert any ad-hoc changes made on the member cluster side in
-                        the managed fields; if you would like to make temporary edits on the member cluster side
+                        Note that this option would revert any ad-hoc changes made on the member cluster side in the
+                        managed fields; if you would like to make temporary edits on the member cluster side
                         in the managed fields, switch to IfNotDrifted option. Note that changes in unmanaged
                         fields will be left alone; if you use the FullDiff compare option, such changes will
                         be reported as drifts.

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

@@ -53,7 +53,7 @@ spec:
                   We only support Name selector for now.
                 items:
                   description: |-
-                    ClusterResourceSelector is used to select cluster scoped resources as the target resources to be placed.
+                    ResourceSelectorTerm is used to select resources as the target resources to be placed.
                     All the fields are `ANDed`. In other words, a resource must match all the fields to be selected.
                   properties:
                     group:

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

@@ -67,7 +67,7 @@ spec:
                       We only support Name selector for now.
                     items:
                       description: |-
-                        ClusterResourceSelector is used to select cluster scoped resources as the target resources to be placed.
+                        ResourceSelectorTerm is used to select resources as the target resources to be placed.
                         All the fields are `ANDed`. In other words, a resource must match all the fields to be selected.
                       properties:
                         group:

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

@@ -1589,7 +1589,7 @@ spec:
                   You can have 1-100 selectors.
                 items:
                   description: |-
-                    ClusterResourceSelector is used to select cluster scoped resources as the target resources to be placed.
+                    ResourceSelectorTerm is used to select resources as the target resources to be placed.
                     All the fields are `ANDed`. In other words, a resource must match all the fields to be selected.
                   properties:
                     group:
@@ -1667,7 +1667,7 @@ spec:
               revisionHistoryLimit:
                 default: 10
                 description: |-
-                  The number of old ClusterSchedulingPolicySnapshot or ClusterResourceSnapshot resources to retain to allow rollback.
+                  The number of old SchedulingPolicySnapshot or ResourceSnapshot resources to retain to allow rollback.
                   This is a pointer to distinguish between explicit zero and not specified.
                   Defaults to 10.
                 format: int32
@@ -1807,8 +1807,8 @@ spec:
                             managed by Fleet (i.e., specified in the hub cluster manifest). This is the default
                             option.
 
-                            Note that this option would revert any ad-hoc changes made on the member cluster side in
-                            the managed fields; if you would like to make temporary edits on the member cluster side
+                            Note that this option would revert any ad-hoc changes made on the member cluster side in the
+                            managed fields; if you would like to make temporary edits on the member cluster side
                             in the managed fields, switch to IfNotDrifted option. Note that changes in unmanaged
                             fields will be left alone; if you use the FullDiff compare option, such changes will
                             be reported as drifts.

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

@@ -40,6 +40,8 @@ spec:
           Each snapshot MUST have the following labels:
             - `CRPTrackingLabel` which points to its owner CRP.
             - `ResourceIndexLabel` which is the index  of the snapshot group.
+
+          The first snapshot of the index group MAY have the following labels:
             - `IsLatestSnapshotLabel` which indicates whether the snapshot is the latest one.
 
           All the snapshots within the same index group must have the same ResourceIndexLabel.
@@ -50,6 +52,9 @@ spec:
 
           Each snapshot (excluding the first snapshot) MUST have the following annotations:
             - `SubindexOfResourceSnapshotAnnotation` to store the subindex of resource snapshot in the group.
+
+          Snapshot may have the following annotations to indicate the time of next resourceSnapshot candidate detected by the controller:
+            - `NextResourceSnapshotCandidateDetectionTimeAnnotation` to store the time of next resourceSnapshot candidate detected by the controller.
         properties:
           apiVersion:
             description: |-
@@ -186,6 +191,9 @@ spec:
 
           Each snapshot (excluding the first snapshot) MUST have the following annotations:
             - `SubindexOfResourceSnapshotAnnotation` to store the subindex of resource snapshot in the group.
+
+          Snapshot may have the following annotations to indicate the time of next resourceSnapshot candidate detected by the controller:
+            - `NextResourceSnapshotCandidateDetectionTimeAnnotation` to store the time of next resourceSnapshot candidate detected by the controller.
         properties:
           apiVersion:
             description: |-

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

@@ -235,8 +235,8 @@ spec:
                         managed by Fleet (i.e., specified in the hub cluster manifest). This is the default
                         option.
 
-                        Note that this option would revert any ad-hoc changes made on the member cluster side in
-                        the managed fields; if you would like to make temporary edits on the member cluster side
+                        Note that this option would revert any ad-hoc changes made on the member cluster side in the
+                        managed fields; if you would like to make temporary edits on the member cluster side
                         in the managed fields, switch to IfNotDrifted option. Note that changes in unmanaged
                         fields will be left alone; if you use the FullDiff compare option, such changes will
                         be reported as drifts.
@@ -1315,8 +1315,8 @@ spec:
                         managed by Fleet (i.e., specified in the hub cluster manifest). This is the default
                         option.
 
-                        Note that this option would revert any ad-hoc changes made on the member cluster side in
-                        the managed fields; if you would like to make temporary edits on the member cluster side
+                        Note that this option would revert any ad-hoc changes made on the member cluster side in the
+                        managed fields; if you would like to make temporary edits on the member cluster side
                         in the managed fields, switch to IfNotDrifted option. Note that changes in unmanaged
                         fields will be left alone; if you use the FullDiff compare option, such changes will
                         be reported as drifts.

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

@@ -190,8 +190,8 @@ spec:
                         managed by Fleet (i.e., specified in the hub cluster manifest). This is the default
                         option.
 
-                        Note that this option would revert any ad-hoc changes made on the member cluster side in
-                        the managed fields; if you would like to make temporary edits on the member cluster side
+                        Note that this option would revert any ad-hoc changes made on the member cluster side in the
+                        managed fields; if you would like to make temporary edits on the member cluster side
                         in the managed fields, switch to IfNotDrifted option. Note that changes in unmanaged
                         fields will be left alone; if you use the FullDiff compare option, such changes will
                         be reported as drifts.

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

@@ -524,7 +524,7 @@ spec:
                   You can have 1-100 selectors.
                 items:
                   description: |-
-                    ClusterResourceSelector is used to select cluster scoped resources as the target resources to be placed.
+                    ResourceSelectorTerm is used to select resources as the target resources to be placed.
                     All the fields are `ANDed`. In other words, a resource must match all the fields to be selected.
                   properties:
                     group:
@@ -602,7 +602,7 @@ spec:
               revisionHistoryLimit:
                 default: 10
                 description: |-
-                  The number of old ClusterSchedulingPolicySnapshot or ClusterResourceSnapshot resources to retain to allow rollback.
+                  The number of old SchedulingPolicySnapshot or ResourceSnapshot resources to retain to allow rollback.
                   This is a pointer to distinguish between explicit zero and not specified.
                   Defaults to 10.
                 format: int32
@@ -742,8 +742,8 @@ spec:
                             managed by Fleet (i.e., specified in the hub cluster manifest). This is the default
                             option.
 
-                            Note that this option would revert any ad-hoc changes made on the member cluster side in
-                            the managed fields; if you would like to make temporary edits on the member cluster side
+                            Note that this option would revert any ad-hoc changes made on the member cluster side in the
+                            managed fields; if you would like to make temporary edits on the member cluster side
                             in the managed fields, switch to IfNotDrifted option. Note that changes in unmanaged
                             fields will be left alone; if you use the FullDiff compare option, such changes will
                             be reported as drifts.

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

@@ -40,6 +40,8 @@ spec:
           Each snapshot MUST have the following labels:
             - `CRPTrackingLabel` which points to its owner resource placement.
             - `ResourceIndexLabel` which is the index  of the snapshot group.
+
+          The first snapshot of the index group MAY have the following labels:
             - `IsLatestSnapshotLabel` which indicates whether the snapshot is the latest one.
 
           All the snapshots within the same index group must have the same ResourceIndexLabel.

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

@@ -433,8 +433,8 @@ spec:
                         managed by Fleet (i.e., specified in the hub cluster manifest). This is the default
                         option.
 
-                        Note that this option would revert any ad-hoc changes made on the member cluster side in
-                        the managed fields; if you would like to make temporary edits on the member cluster side
+                        Note that this option would revert any ad-hoc changes made on the member cluster side in the
+                        managed fields; if you would like to make temporary edits on the member cluster side
                         in the managed fields, switch to IfNotDrifted option. Note that changes in unmanaged
                         fields will be left alone; if you use the FullDiff compare option, such changes will
                         be reported as drifts.