Change default DeleteStrategy propagationPolicy to Delete and update documentation

Co-authored-by: circy9 <[email protected]>

Author: Copilot

.github/.copilot/breadcrumbs/2025-01-15-1400-crp-delete-policy.md

@@ -21,59 +21,57 @@ The issue requests adding API options to allow customers to choose whether to de
 ## Implementation Plan
 
 ### Phase 1: API Design
-- [x] Add `DeletionPolicy` field to `PlacementSpec` in beta API
-- [x] Define enum values: `Delete` (default), `Orphan`
+- [x] Add `DeleteStrategy` struct to `RolloutStrategy` in beta API
+- [x] Define `PropagationPolicy` field with enum values: `Delete` (default), `Abandon`
 - [x] Update API documentation and validation
+- [x] Move DeleteStrategy inside RolloutStrategy after ApplyStrategy for consistency
 
-### Phase 2: Controller Logic Updates
-- [x] Update scheduler to respect deletion policy when cleaning up bindings
-- [x] Add logic to skip binding deletion when policy is `Orphan`
-- [x] Update CRP controller to handle policy appropriately
+### Phase 2: Implementation Details
+TODO: @Arvindthiru to fill out the details for controller logic implementation.
 
 ### Phase 3: Testing
-- [x] Add unit tests for new deletion policy options
-- [x] Add integration tests to verify behavior
-- [x] Test both `Delete` and `Orphan` scenarios
+- [ ] Add unit tests for new deletion policy options
+- [ ] Add integration tests to verify behavior  
+- [ ] Test both `Delete` and `Abandon` scenarios
 
 ### Phase 4: Documentation & Examples
-- [x] Update CRD documentation
+- [ ] Update CRD documentation
 - [ ] Add example configurations
-- [x] Update any user-facing documentation
+- [ ] Update any user-facing documentation
 
 ## Success Criteria
-- [x] CRP API has `deletionPolicy` field with `Delete`/`Orphan` options
+- [x] CRP API has `deleteStrategy` field with `Delete`/`Abandon` options inside RolloutStrategy
 - [x] Default behavior (`Delete`) preserves current functionality
-- [x] `Orphan` policy leaves placed resources intact when CRP is deleted
-- [x] All tests pass including new deletion policy tests
+- [ ] `Abandon` policy leaves placed resources intact when CRP is deleted
+- [ ] All tests pass including new deletion policy tests
 - [x] Changes are minimal and backwards compatible
 
-## Implementation Details
+## Current API Structure
 
-The key insight is that the scheduler's `cleanUpAllBindingsFor` method is what triggers the deletion of placed resources by deleting the bindings. We need to modify this to respect a deletion policy.
+The DeleteStrategy is now part of RolloutStrategy:
 
-### Changes Made:
+```go
+type RolloutStrategy struct {
+    // ... other fields ...
+    ApplyStrategy *ApplyStrategy `json:"applyStrategy,omitempty"`
+    DeleteStrategy *DeleteStrategy `json:"deleteStrategy,omitempty"`
+}
 
-1. **API Changes**: Added `DeletionPolicy` enum and field to `PlacementSpec` in `apis/placement/v1beta1/clusterresourceplacement_types.go`
-   - Enum with values `Delete` (default) and `Orphan`
-   - Field with proper validation and documentation
+type DeleteStrategy struct {
+    PropagationPolicy DeletePropagationPolicy `json:"propagationPolicy,omitempty"`
+}
 
-2. **Scheduler Logic Changes**: Modified `cleanUpAllBindingsFor` method in `pkg/scheduler/scheduler.go`
-   - Check deletion policy from placement spec
-   - For `Delete` policy: maintain current behavior (delete bindings)
-   - For `Orphan` policy: remove finalizers but don't delete bindings (leaves placed resources intact)
+type DeletePropagationPolicy string
 
-3. **Tests Added**: Extended existing test suite in `pkg/scheduler/scheduler_test.go`
-   - Test cases for both `Delete` and `Orphan` policies
-   - Verified that bindings are deleted with `Delete` policy
-   - Verified that bindings are orphaned (finalizers removed but not deleted) with `Orphan` policy
-
-4. **Generated Artifacts**: 
-   - Updated CRDs with proper enum validation and default value
-   - Regenerated Go code for API types
+const (
+    DeletePropagationPolicyDelete DeletePropagationPolicy = "Delete"    // default
+    DeletePropagationPolicyAbandon DeletePropagationPolicy = "Abandon"
+)
+```
 
 ## Behavior Summary
 
 - **Default (`Delete`)**: When CRP is deleted, all placed resources are removed from member clusters (current behavior)
-- **Orphan**: When CRP is deleted, placed resources remain on member clusters but are no longer managed by Fleet
+- **Abandon**: When CRP is deleted, placed resources remain on member clusters but are no longer managed by Fleet
 
 This provides customers with the flexibility to choose between complete cleanup or leaving resources in place when deleting a CRP.

apis/placement/v1beta1/clusterresourceplacement_types.go

@@ -1326,18 +1326,18 @@ const (
 // DeleteStrategy configures the deletion behavior when a placement is deleted.
 type DeleteStrategy struct {
 	// PropagationPolicy controls how the deletion is propagated to placed resources.
-	// Defaults to "Abandon".
+	// Defaults to "Delete".
 	//
 	// Available options:
 	//
-	// * Abandon: all placed resources on member clusters will be left intact (abandoned)
-	//   when the ClusterResourcePlacement is deleted. This is the default behavior.
-	//
 	// * Delete: all placed resources on member clusters will be deleted when the
-	//   ClusterResourcePlacement is deleted.
+	//   ClusterResourcePlacement is deleted. This is the default behavior.
+	//
+	// * Abandon: all placed resources on member clusters will be left intact (abandoned)
+	//   when the ClusterResourcePlacement is deleted.
 	//
 	// +kubebuilder:validation:Enum=Abandon;Delete
-	// +kubebuilder:default=Abandon
+	// +kubebuilder:default=Delete
 	// +kubebuilder:validation:Optional
 	PropagationPolicy DeletePropagationPolicy `json:"propagationPolicy,omitempty"`
 }
@@ -1348,11 +1348,11 @@ type DeletePropagationPolicy string
 
 const (
 	// DeletePropagationPolicyAbandon instructs Fleet to leave (abandon) all placed resources on member
-	// clusters when the ClusterResourcePlacement is deleted. This is the default behavior.
+	// clusters when the ClusterResourcePlacement is deleted.
 	DeletePropagationPolicyAbandon DeletePropagationPolicy = "Abandon"
 
 	// DeletePropagationPolicyDelete instructs Fleet to delete all placed resources on member clusters
-	// when the ClusterResourcePlacement is deleted.
+	// when the ClusterResourcePlacement is deleted. This is the default behavior.
 	DeletePropagationPolicyDelete DeletePropagationPolicy = "Delete"
 )
 

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

@@ -1910,18 +1910,18 @@ spec:
                       the ClusterResourcePlacement is deleted.
                     properties:
                       propagationPolicy:
-                        default: Abandon
+                        default: Delete
                         description: |-
                           PropagationPolicy controls how the deletion is propagated to placed resources.
-                          Defaults to "Abandon".
+                          Defaults to "Delete".
 
                           Available options:
 
-                          * Abandon: all placed resources on member clusters will be left intact (abandoned)
-                            when the ClusterResourcePlacement is deleted. This is the default behavior.
-
                           * Delete: all placed resources on member clusters will be deleted when the
-                            ClusterResourcePlacement is deleted.
+                            ClusterResourcePlacement is deleted. This is the default behavior.
+
+                          * Abandon: all placed resources on member clusters will be left intact (abandoned)
+                            when the ClusterResourcePlacement is deleted.
                         enum:
                         - Abandon
                         - Delete

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

@@ -845,18 +845,18 @@ spec:
                       the ClusterResourcePlacement is deleted.
                     properties:
                       propagationPolicy:
-                        default: Abandon
+                        default: Delete
                         description: |-
                           PropagationPolicy controls how the deletion is propagated to placed resources.
-                          Defaults to "Abandon".
+                          Defaults to "Delete".
 
                           Available options:
 
-                          * Abandon: all placed resources on member clusters will be left intact (abandoned)
-                            when the ClusterResourcePlacement is deleted. This is the default behavior.
-
                           * Delete: all placed resources on member clusters will be deleted when the
-                            ClusterResourcePlacement is deleted.
+                            ClusterResourcePlacement is deleted. This is the default behavior.
+
+                          * Abandon: all placed resources on member clusters will be left intact (abandoned)
+                            when the ClusterResourcePlacement is deleted.
                         enum:
                         - Abandon
                         - Delete