sigs.k8s.io/cluster-api@v1.7.1/docs/book/src/clusterctl/commands/alpha-rollout.md (about)

     1  # clusterctl alpha rollout
     2  
     3  The `clusterctl alpha rollout` command manages the rollout of a Cluster API resource. It consists of several sub-commands which are documented below. 
     4  
     5  <aside class="note">
     6  
     7  <h1> Valid Resource Types </h1>
     8  
     9  Currently, only the following Cluster API resources are supported by the rollout command:
    10  
    11  - kubeadmcontrolplanes
    12  - machinedeployments
    13  
    14  </aside>
    15  
    16  ### Restart 
    17  
    18  Use the `restart` sub-command to force an immediate rollout. Note that rollout refers to the replacement of existing machines with new machines using the desired rollout strategy (default: rolling update). For example, here the MachineDeployment `my-md-0` will be immediately rolled out:
    19  
    20  ```bash
    21  clusterctl alpha rollout restart machinedeployment/my-md-0
    22  ```
    23  
    24  ### Undo
    25  
    26  Use the `undo` sub-command to rollback to an earlier revision. For example, here the MachineDeployment `my-md-0` will be rolled back to revision number 3. If the `--to-revision` flag is omitted, the MachineDeployment will be rolled back to the revision immediately preceding the current one. If the desired revision does not exist, the undo will return an error.
    27  
    28  ```bash
    29  clusterctl alpha rollout undo machinedeployment/my-md-0 --to-revision=3
    30  ```
    31  
    32  ### Pause/Resume
    33  
    34  Use the `pause` sub-command to pause a Cluster API resource. The command is a NOP if the resource is already paused. Note that internally, this command sets the `Paused` field within the resource spec (e.g. MachineDeployment.Spec.Paused) to true. 
    35  
    36  ```bash
    37  clusterctl alpha rollout pause machinedeployment/my-md-0
    38  ```
    39  
    40  Use the `resume` sub-command to resume a currently paused Cluster API resource. The command is a NOP if the resource is currently not paused. 
    41  
    42  ```bash
    43  clusterctl alpha rollout resume machinedeployment/my-md-0
    44  ```
    45  
    46  <aside class="note warning">
    47  
    48  <h1> Warning </h1>
    49  
    50  Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. 
    51  
    52  </aside>