Skip to content

Commit

Permalink
update table format
Browse files Browse the repository at this point in the history
  • Loading branch information
@killianmuldoon
killianmuldoon committed Oct 19, 2021
1 parent 596efcd commit d7ccecf
Showing 1 changed file with 11 additions and 34 deletions.
45 changes: 11 additions & 34 deletions docs/book/src/tasks/experimental-features/clusterclass-operations.md
View file
Expand Up @@ -10,40 +10,17 @@ If changes are evaluated as potentially leading to a non-functional Cluster, the

Once the changes are applied, the topology controller reacts as described in the following table.

| Changed field | Effects on Clusters |
|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Infrastructure.ref | Corresponding InfrastructureCluster objects are updated (in place update) |
| controlplane.metadata | if labels/annotation are added or their value is changed, ControlPlane objects are updated (in place update) and corresponding control plane Machines are updated (rollout) |
| | |
| | if labels/annotation are deleted, the label is downgraded from managed to instance specific value, but no changes are applied. In order to actually remove the label it is required for the user to change ControlPlane object in place. |
| controlplane.ref | Corresponding ControlPlane objects are updated (in place update) |
| | |
| | If updating ControlPlane objects imply changes in the spec, the corresponding control plane machines are updated accordingly (rollout) |
| controlplane.machineInfrastructure.ref | If the referenced template has changes only in metadata labels or annotations, the corresponding InfrastructureMachineTemplates are updated (in place update) |
| | |
| | If the referenced template has changes in the spec: |
| | Corresponding InfrastructureMachineTemplate are rotated (create new, delete old) |
| | Corresponding ControlPlane objects are updated with the reference to the newly created template (in place update) |
| | The corresponding control plane machines are updated accordingly (rollout) |
| workers.machineDeployments | if a new MachineDeploymentClass is added, no changes are triggered to the Clusters |
| | |
| | if an existing MachineDeploymentClass is changed, effect depends on the type of change (see below) |
| | note: deleting an existing MachineDeploymentClass is not supported. |
| workers.machineDeployments[].metadata | if labels/annotation are added or their value is changed, MachineDeployment objects are updated (in place update) and corresponding worker Machines are updated (rollout) |
| | |
| | if labels/annotation are deleted, the label is downgraded from managed to instance specific value, but no changes are applied. In order to actually remove the label it is required for the user to change MachineDeployments object in place. |
| workers.machineDeployments[].bootstrap.ref | If the referenced template has changes only in metadata labels or annotations, the corresponding BootstrapTemplates are updated (in place update) |
| | |
| | If the referenced template has changes in the spec: |
| | Corresponding BootstrapTemplate are rotated (create new, delete old) |
| | Corresponding MachineDeployments objects are updated with the reference to the newly created template (in place update) |
| | The corresponding worker machines are updated accordingly (rollout) |
| workers.machineDeployments[].infrastructure.ref | If the referenced template has changes only in metadata labels or annotations, the corresponding InfrastructureMachineTemplates are updated (in place update) |
| | |
| | If the referenced template has changes in the spec: |
| | Corresponding InfrastructureMachineTemplate are rotated (create new, delete old) |
| | Corresponding MachineDeployments objects are updated with the reference to the newly created template (in place update) |
| | The corresponding worker machines are updated accordingly (rollout)
| Changed field | Effects on Clusters |
|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Infrastructure.ref | Corresponding InfrastructureCluster objects are updated (in place update) |
| controlplane.metadata | If labels/annotation are added or their value is changed, ControlPlane objects are updated (in place update) and corresponding control plane Machines are updated (rollout). <br /> <br /> If labels/annotation are deleted, the label is downgraded from managed to instance specific value, but no changes are applied. In order to actually remove the label it is required for the user to change ControlPlane object in place. |
| controlplane.ref | Corresponding ControlPlane objects are updated (in place update). If updating ControlPlane objects imply changes in the spec, the corresponding control plane machines are updated accordingly (rollout) |
| controlplane.machineInfrastructure.ref | If the referenced template has changes only in metadata labels or annotations, the corresponding InfrastructureMachineTemplates are updated (in place update). <br /> <br />If the referenced template has changes in the spec:<br /> - Corresponding InfrastructureMachineTemplate are rotated (create new, delete old)<br /> - Corresponding ControlPlane objects are updated with the reference to the newly created template (in place update)<br /> - The corresponding control plane machines are updated accordingly (rollout) |
| workers.machineDeployments | If a new MachineDeploymentClass is added, no changes are triggered to the Clusters. <br /> <br />If an existing MachineDeploymentClass is changed, effect depends on the type of change (see below). <br /><br />Note: Deleting an existing MachineDeploymentClass is not supported.  |
| workers.machineDeployments[].metadata | If labels/annotation are added or their value is changed, MachineDeployment objects are updated (in place update) and corresponding worker Machines are updated (rollout). <br /> <br />If labels/annotation are deleted, the label is downgraded from managed to instance specific value, but no changes are applied. In order to actually remove the label it is required for the user to change MachineDeployments object in place. |
| workers.machineDeployments[].bootstrap.ref | If the referenced template has changes only in metadata labels or annotations, the corresponding BootstrapTemplates are updated (in place update).<br /> <br />If the referenced template has changes in the spec:<br /> - Corresponding BootstrapTemplate are rotated (create new, delete old). <br /> - Corresponding MachineDeployments objects are updated with the reference to the newly created template (in place update). <br /> - The corresponding worker machines are updated accordingly (rollout) |
| workers.machineDeployments[].infrastructure.ref | If the referenced template has changes only in metadata labels or annotations, the corresponding InfrastructureMachineTemplates are updated (in place update). <br /> <br />If the referenced template has changes in the spec:<br /> - Corresponding InfrastructureMachineTemplate are rotated (create new, delete old).<br /> - Corresponding MachineDeployments objects are updated with the reference to the newly created template (in place update). <br /> - The corresponding worker machines are updated accordingly (rollout) |


Warning: changing a ClusterClass triggers changes on all the Clusters using the ClusterClass

Expand Down

0 comments on commit d7ccecf

Please sign in to comment.