a

Author: jwtty

apis/placement/v1beta1/clusterresourceplacement_types.go

@@ -827,7 +827,8 @@ type ClusterResourcePlacementStatus struct {
 	// For example, a condition of `ClusterResourcePlacementWorkSynchronized` type
 	// is observing the synchronization status of the resource snapshot with the resource index $ObservedResourceIndex.
 	// If the rollout strategy type is `RollingUpdate`, `ObservedResourceIndex` is the default-latest resource snapshot index.
-	// If the rollout strategy type is `External`, rollout and version control are managed by an external controller, and this field remains empty.
+	// If the rollout strategy type is `External`, rollout and version control are managed by an external controller,
+	// and this field is not empty only if all targeted clusters observe the same resource index in `PlacementStatuses`.
 	// +kubebuilder:validation:Optional
 	ObservedResourceIndex string `json:"observedResourceIndex,omitempty"`
 
@@ -958,13 +959,14 @@ type ResourcePlacementStatus struct {
 	DiffedPlacements []DiffedResourcePlacement `json:"diffedPlacements,omitempty"`
 
 	// ObservedResourceIndex is the index of the resource snapshot that is currently being rolled out to the given cluster.
-	// During rollout, depending on the rollout strategy, clusters may observe different resource snapshot indices.
-	// ObservedResourceIndex is the resource snapshot index observed by the conditions in the ResourcePlacementStatus.
 	// This field is only meaningful if the `ClusterName` is not empty.
 	// +kubebuilder:validation:Optional
 	ObservedResourceIndex string `json:"observedResourceIndex,omitempty"`
 
 	// Conditions is an array of current observed conditions for ResourcePlacementStatus.
+	// Each condition corresponds to the resource at the index specified by `ObservedResourceIndex`.
+	// For example, if the RolloutStarted condition is true,
+	// it refers to the resource currently indicated by `ObservedResourceIndex` is being rolled out.
 	// +kubebuilder:validation:Optional
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }