Skip to content

Commit

Permalink
docs: update cluster override behaviour DOC-1240 (#3129)
Browse files Browse the repository at this point in the history
* docs: update cluster override behavior DOC-1240

This patch makes the following updates:
- Updates the Deploy Cluster Profile Updates tutorial with cluster override behaviour
- Updates the corresponding Getting Started page with cluster override behavior
- Adds extra information to the existing info box on the Cluster Update page

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix typo DOC-1240

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
  • Loading branch information
1 parent 73c5d0d commit 5e1191c
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 45 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Palette allows you to update active clusters. You can update any layer of a clus
and add-on layers. Depending on the nature of the update, a cluster update could trigger different cluster repave
operations. For more information, refer to
[Repave Behaviors and Configurations](./node-pool.md#repave-behavior-and-configuration) for non-Edge clusters and
[Edge Cluster Upgrade Behavior](../edge/cluster-management/upgrade-behavior.md) for Edge clusters. operations.
[Edge Cluster Upgrade Behavior](../edge/cluster-management/upgrade-behavior.md) for Edge clusters.

:::info

Expand Down Expand Up @@ -55,7 +55,7 @@ This is the recommended best practice for updating a cluster in Palette.
3. Create a new version of the profile you want to update. For more information, refer to
[Version a Cluster Profile](../../profiles/cluster-profiles/modify-cluster-profiles/version-cluster-profile.md).

4. Navigate to the left **Main Menu** and select **Cluster**.
4. Navigate to the left **Main Menu** and select **Clusters**.

5. Select the cluster you want to update, and navigate to the **Profile** tab of the cluster.

Expand All @@ -64,11 +64,12 @@ This is the recommended best practice for updating a cluster in Palette.
7. Click **Review & Save**. Palette prompts you to preview the change summary.

8. Click **Review changes in Editor**. Palette displays the changes, with the current configuration on the left and the
incoming changes on the right. Review the changes and click **Apply Changes**.
incoming configuration on the right. Review the changes and click **Apply Changes**.

:::info

Make sure to preserve any existing cluster profile overrides.
Make sure to preserve any existing cluster profile overrides by using the editor on the right. Otherwise, the
incoming configuration will be applied as indicated.

:::

Expand Down
42 changes: 20 additions & 22 deletions docs/docs-content/clusters/cluster-management/update-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -511,17 +511,11 @@ Select the **1.1.0** version.
Click **Review & Save**. Palette prompts you to preview the change summary.

Click **Review changes in Editor**. Palette displays the changes, with the current configuration on the left and the
incoming changes on the right.
incoming configuration on the right. The editor shows that the `API_URI` variable is added to the cluster profile.

:::info
Click **Apply Changes**.

Make sure to preserve any existing cluster profile overrides.

:::

After reviewing the changes, click **Apply Changes**.

![Palette Editor that displays changes coming from the profile version update.](/clusters_cluster-management_cluster-updates_preview-profile-ver-changes.webp)
![Palette Editor that displays changes coming from the profile version update.](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_editor-changes.webp)

:::warning

Expand Down Expand Up @@ -946,17 +940,19 @@ updates available.

![Image that shows the pending updates ](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_pending-update-clusters-view.webp)

Select this cluster to open its **Overview** tab. Click on **Updates Available** to begin the cluster update.
Select this cluster to open its **Overview** tab. Click on **Updates** to begin the cluster update.

![Image that shows the Updates Available button](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_updates-available-button-cluster-overview.webp)
![Image that shows the Updates button](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_updates-available-button-cluster-overview.webp)

A dialog appears which shows the changes made in this update. Review the changes and ensure the only change is the
`replicas` field value. The pending update maintains the override you have made and sets the `replicas` field to `1`.
A dialog appears which shows the changes made in this update. Click on **Review changes in Editor**. As previously,
Palette displays the changes, with the current configuration on the left and the incoming configuration on the right.

Review the changes and ensure the only change is the `replicas` field value. You can choose to maintain your cluster
override or apply the incoming cluster profile update.

![Image that shows the available updates dialog ](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_available-updates-dialog.webp)

Set the value of `replicas` to `3` in the right-hand dialog. This removes your cluster override. Click on **Confirm
updates** once you have finished reviewing your changes.
Click on **Apply Changes** once you have finished reviewing your changes. This removes your cluster override.

Palette updates your cluster according to cluster profile specifications. Once these changes are complete, select the
**Workloads** tab. Then, select the **hello-universe** namespace.
Expand Down Expand Up @@ -1019,17 +1015,19 @@ an update available.

![Image that shows the pending updates ](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_pending-update-clusters-view.webp)

Select this cluster to open its **Overview** tab. Click on **Updates Available** to begin the cluster update.
Select this cluster to open its **Overview** tab. Click on **Updates** to begin the cluster update.

![Image that shows the Updates button](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_updates-available-button-cluster-overview.webp)

![Image that shows the Updates Available button](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_updates-available-button-cluster-overview.webp)
A dialog appears which shows the changes made in this update. Click on **Review changes in Editor**. As previously,
Palette displays the changes, with the current configuration on the left and the incoming configuration on the right.

A dialog appears which shows the changes made in this update. Review the changes and ensure the only change is the
`replicas` field value. The pending update maintains the override you have made and sets the `replicas` field to `1`.
Review the changes and ensure the only change is the `replicas` field value. You can choose to maintain your cluster
override or apply the incoming cluster profile update.

![Image that shows the available updates dialog ](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_tf-available-updates-dialog.webp)
![Image that shows the available updates dialog ](/tutorials/deploy-cluster-profile-updates/clusters_cluster-management_deploy-cluster-profile-updates_available-updates-dialog.webp)

Set the value of `replicas` to `3` in the right hand dialog. This removes your cluster override. Click on **Confirm
updates** once you have finished reviewing your changes.
Click on **Apply Changes** once you have finished reviewing your changes. This removes your cluster override.

Palette updates your cluster according to cluster profile specifications. Once these changes are complete, select the
**Workloads** tab. Then, select the **hello-universe** namespace.
Expand Down
30 changes: 11 additions & 19 deletions docs/docs-content/getting-started/update-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,17 +314,11 @@ Select the **1.1.0** version.
Click **Review & Save**. Palette prompts you to preview the change summary.

Click **Review changes in Editor**. Palette displays the changes, with the current configuration on the left and the
incoming changes on the right.
incoming configuration on the right.

:::info

Make sure to preserve any existing cluster profile overrides.

:::
Click **Apply Changes**.

After reviewing the changes, click **Apply Changes**.

![Palette Editor that displays changes coming from the profile version update.](/clusters_cluster-management_cluster-updates_preview-profile-ver-changes.webp)
![Palette Editor that displays changes coming from the profile version update.](/getting-started/getting-started_update-k8s-cluster_editor-changes.webp)

:::warning

Expand Down Expand Up @@ -403,17 +397,19 @@ updates available.

![Image that shows the pending updates ](/getting-started/getting-started_update-k8s-cluster_pending-update-clusters-view.webp)

Select this cluster to open its **Overview** tab. Click on **Updates Available** to begin the cluster update.
Select this cluster to open its **Overview** tab. Click on **Updates** to begin the cluster update.

![Image that shows the Updates button](/getting-started/getting-started_update-k8s-cluster_updates-available-button-cluster-overview.webp)

![Image that shows the Updates Available button](/getting-started/getting-started_update-k8s-cluster_updates-available-button-cluster-overview.webp)
A dialog appears which shows the changes made in this update. Click on **Review changes in Editor**. As previously,
Palette displays the changes, with the current configuration on the left and the incoming configuration on the right.

A dialog appears which shows the changes made in this update. Review the changes and ensure the only change is the
`replicas` field value. The pending update maintains the override you have made and sets the `replicas` field to `1`.
Review the changes and ensure the only change is the `replicas` field value. You can choose to maintain your cluster
override or apply the incoming cluster profile update.

![Image that shows the available updates dialog ](/getting-started/getting-started_update-k8s-cluster_available-updates-dialog.webp)

Set the value of `replicas` to `3` in the right-hand dialog. This removes your cluster override. Click on **Confirm
updates** once you have finished reviewing your changes.
Click on **Apply Changes** once you have finished reviewing your changes. This removes your cluster override.

Palette updates your cluster according to cluster profile specifications. Once these changes are complete, select the
**Workloads** tab. Then, select the **hello-universe** namespace.
Expand All @@ -437,8 +433,6 @@ the delete step. The deletion process takes several minutes to complete.

Repeat the same steps for the other cluster.

<br />

:::info

If a cluster remains in the delete phase for over 15 minutes, it becomes eligible for a force delete. To trigger a force
Expand All @@ -447,8 +441,6 @@ automatically removes clusters stuck in the cluster deletion phase for over 24 h

:::

<br />

Once the cluster is deleted, navigate to the left **Main Menu** and click on **Profiles**. Find the cluster profile you
created and click on the **three-dot Menu** to display the **Delete** button. Select **Delete** and confirm the
selection to remove the cluster profile.
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 comments on commit 5e1191c

Please sign in to comment.