Skip to content

Commit cfd3f53

Browse files
committed
add updateRun tsg and fix rollout doc
1 parent cd4d9f8 commit cfd3f53

4 files changed

Lines changed: 463 additions & 0 deletions

File tree

docs/concepts/StagedUpdateRun/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,7 @@ This cluster-scoped resource requires three key parameters: the `placementName`
119119
An updateRun executes in two phases. During the initialization phase, the controller performs a one-time setup where it captures a snapshot of the updateRun strategy, collects scheduled and to-be-deleted `ClusterResourceBindings`, generates the cluster update sequence, and records all this information in the updateRun status.
120120

121121
In the execution phase, the controller processes each stage sequentially, updates clusters within each stage one at a time, and enforces completion of after-stage tasks. It then executes a final delete stage to clean up resources from unscheduled clusters. The updateRun succeeds when all stages complete successfully. However, it will fail if any execution-affecting events occur, for example, the target ClusterResourcePlacement being deleted, and member cluster changes triggering new scheduling. In such cases, error details are recorded in the updateRun status. Remember that once initialized, an updateRun operates on its strategy snapshot, making it immune to subsequent strategy modifications.
122+
123+
## Next Steps
124+
* Learn how to [rollout CRP resources with Staged Update Run](../../howtos/updaterun.md)
125+
* Learn how to [troubleshoot a Staged Update Run](../../troubleshooting/updaterun.md)

docs/troubleshooting/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The complete progression of `ClusterResourcePlacement` is as follows:
2626
- If this condition is false, refer to [How can I debug when my CRP status is ClusterResourcePlacementScheduled condition status is set to false?](./clusterResourcePlacementScheduled.md).
2727
2. `ClusterResourcePlacementRolloutStarted`: Indicates the rollout process has begun.
2828
- If this condition is false refer to [How can I debug when my CRP status is ClusterResourcePlacementRolloutStarted condition status is set to false?](./clusterResourcePlacementRolloutStarted.md)
29+
- If you are triggering a rollout with a staged update run, refer to [Staged Update Run Troubleshooting Guide](./updaterun.md).
2930
3. `ClusterResourcePlacementOverridden`: Indicates the resource has been overridden.
3031
- If this condition is false, refer to [How can I debug when my CRP status is ClusterResourcePlacementOverridden condition status is set to false?](./clusterResourcePlacementOverridden.md)
3132
4. `ClusterResourcePlacementWorkSynchronized`: Indicates the work objects have been synchronized.

docs/troubleshooting/clusterResourcePlacementRolloutStarted.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# How can I debug when my CRP status is ClusterResourcePlacementRolloutStarted condition status is set to false?
22

33
When using the `ClusterResourcePlacement` API object in Azure Kubernetes Fleet Manager to propagate resources, the selected resources aren't rolled out in all scheduled clusters and the `ClusterResourcePlacementRolloutStarted` condition status shows as `False`.
4+
5+
*This TSG only applies to the `RollingUpdate` rollout strategy, which is the default strategy if you don't specify in the `ClusterResourcePlacement`.*
6+
*To troubleshoot the update run strategy as you specify `External` in the `ClusterResourcePlacement`, please refer to the [Staged Update Run Troubleshooting Guide](updaterun.md).*
7+
48
> Note: To get more information about why the rollout doesn't start, you can check the [rollout controller](https://github.com/Azure/fleet/blob/main/pkg/controllers/rollout/controller.go) to get more information on why the rollout did not start.
59
610
## Common scenarios:

0 commit comments

Comments
 (0)