Skip to content

Commit

Permalink
docs: update cluster profile update guides PEM-6443 (#4859)
Browse files Browse the repository at this point in the history
* docs: update cluster profile update guides PEM-6443

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: rectify misspelling

* ci: auto-formatting prettier issues

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Update docs/docs-content/profiles/cluster-profiles/modify-cluster-profiles/update-cluster-profile.md

Co-authored-by: Ben Radstone <56587332+benradstone@users.noreply.github.com>

* ci: auto-formatting prettier issues

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: addetz <addetz@users.noreply.github.com>
Co-authored-by: Ben Radstone <56587332+benradstone@users.noreply.github.com>
  • Loading branch information
4 people authored Dec 5, 2024
1 parent ad74067 commit 662dd23
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 32 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ 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 configuration on the right. Review the changes and click **Apply Changes**.
8. Click **Review changes in Editor**. Palette displays the changes, with the **Current Configuration** on the left and
the **Pending Configuration** on the right. Review the changes and click **Apply Changes**.

:::info

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.
Make sure to preserve any existing cluster profile overrides by using the editor on the right. Otherwise, the pending
configuration will be applied as indicated.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Refer to the following sections to learn how to update a cluster profile.
profile details and stack.

3. Click on **Settings** and choose **Edit Info** from the **drop-down Menu**. You can modify the profile name, version,
description, and tags.
description, and tags. Save your changes.

:::info

Expand All @@ -54,8 +54,6 @@ Refer to the following sections to learn how to update a cluster profile.

:::

4. Save your changes.

### Validate

1. Log in to [Palette](https://console.spectrocloud.com).
Expand Down Expand Up @@ -89,7 +87,7 @@ To learn how to apply the changes, review [Apply Profile Updates to Clusters](#a
- Select **Add New Pack** and choose a pack to add to the profile.
- Select **Import from cluster** to import a pack from another cluster.

- Select the pack layer you want to update, and edit pack settings in the YAML file that displays in the YAML editor.
- Select the pack layer you want to update, and edit pack values in the YAML file that displays in the editor.

- Click on the **Update** button to view and apply available updates to packs. To learn how to update your customized
packs, review [Update the Pack Version](#update-the-pack-version).
Expand Down Expand Up @@ -157,9 +155,9 @@ Review the following steps to accept incoming pack updates to a cluster profile.

3. Select the profile you want to update to access the profile details page.

4. Palette displays profile details and the profile stack. If there are pending updates, Palette displays a green
**Update** button in the top right-hand corner of the page. Click on the **Update** button to view the changes
summary modal.
4. Palette displays profile details and the profile stack. If there are pending updates, Palette displays the
**Updates** button in the top right-hand corner of the page. Click on the **Updates** button to view the **Changes
Summary** modal.

5. If the changes can be applied without any issues, then Palette will display the **Apply Changes** button.

Expand All @@ -179,10 +177,10 @@ Review the following steps to accept incoming pack updates to a cluster profile.
6. Click on the **Apply Changes** button to apply the updates to the profile. If there are changes that require your
attention, click on the **Review changes in Editor** button to start the review process.

7. The differential editor will display the changes between the current YAML configuration and new incoming YAML
changes. The left side of the editor displays the current configuration. The right side displays the new pack
version's incoming changes. Review the changes and apply them as needed. Use the three buttons at the bottom to
navigate through the changes.
7. The differential editor will display the changes between the **Current Configuration** and **Pending Configuration**.
The left side of the editor displays the current configuration. The right side displays the new pack version's
incoming changes. Review the changes and apply them as needed. Use the three buttons at the bottom to navigate
through the changes.

- **Prev**: Click to navigate to the previous change.
- **Next**: Click to navigate to the next change.
Expand All @@ -191,15 +189,20 @@ Review the following steps to accept incoming pack updates to a cluster profile.
button.

The differential editor will display the changes by highlighting the differences between the configurations. The
color-coded highlights indicate the following:
**Legend** displays the colors and contains tooltips explaining their meanings. The color-coded highlights indicate
the following:

- _Yellow highlight_ indicates a line that has been changed when compared to the original pack default values. These
may be lines you have added in the current configuration or lines that have been removed because they are no longer
valid in the new configuration. If you need them, use the **Keep** button to transfer the lines to the new pack
version. Otherwise, click on **Next** to proceed.

- _Yellow highlight_ indicates text that is not present in the new configuration. These may be lines you have added
in the current configuration or lines that have been removed because they are no longer valid in the new
configuration. If you need them, use the **Keep** button to transfer the lines to the new pack version. Otherwise,
click on **Next** to proceed.
- _Orange highlight_ indicates a difference between the current configuration and the pending pack defaults. These
differences occur when the new pack version changes existing fields to a new default value. The **Pending
Configuration** is editable, so you can change the configurations that you want to keep by editing the pack YAML
specification.

- _Blue highlight_ indicates additions in the new configuration that are not present in the pack version you are
using.
- _Blue highlight_ indicates changes or customizations provided by the pack in the pending configuration.

![Screenshot that shows Palette's pack diff user interface with yellow highlight at left and blue highlight at right](/profiles_cluster-profiles_modify-cluster-incoming-updates.webp)

Expand Down Expand Up @@ -262,13 +265,16 @@ Ensure you follow these practices when updating to a new pack version.

Differences between the displayed configurations are as follows:

- _Yellow highlight_ indicates text that is not present in the new configuration. These may be lines you have added
in the current configuration or lines that have been removed because they are no longer valid in the new
configuration. If you need them, you can use the **Keep** button to transfer the lines to the new pack version.
Otherwise, click on **Next** to proceed.
- _Yellow highlight_ indicates a line that has been changed when compared to the original pack default values. These
may be lines you have added in the current configuration or lines that have been removed because they are no longer
valid in the new configuration. If you need them, use the **Keep** button to transfer the lines to the new pack
version. Otherwise, click on **Next** to proceed.

- _Blue highlight_ indicates additions in the new configuration that are not present in the pack version you are
using.
- _Orange highlight_ indicates a difference between the current configuration and the new pack defaults. These
differences occur when the new pack version changes existing fields to a new default value. The right-hand panel is
editable, so you can change the configurations that you want to keep by editing the pack YAML specification.

- _Blue highlight_ indicates changes or customizations provided by the pack in the pending configuration.

#### Example of Difference Between Current and New Configurations

Expand All @@ -278,16 +284,19 @@ Ensure you follow these practices when updating to a new pack version.
customizations lines you added, use the **Keep** button to transfer the lines to the new version. Otherwise, click on
**Next** to proceed.

6. Check for changed settings in the new configuration, and copy settings from the current configuration to the new
6. Review the orange-highlights in the current configuration. Ensure that the corresponding new blue-highlight values
will suit your needs.

7. Check for changed settings in the new configuration, and copy settings from the current configuration to the new
configuration.

7. Review new sections in the new configuration. You should adopt them, as they are typically needed to support the new
8. Review new sections in the new configuration. You should adopt them, as they are typically needed to support the new
configuration.

8. Check for changes in the same line that have a different value. If it is not a customization you made, you should
9. Check for changes in the same line that have a different value. If it is not a customization you made, you should
adopt the new value, as it is known to be compatible with the new version.

9. Confirm your updates.
10. Confirm your updates.

To learn how to apply the changes, review [Apply Profile Updates to Clusters](#apply-profile-updates-to-clusters).

Expand Down
Binary file not shown.
Binary file modified static/assets/docs/images/integrations_pack_diffs.webp
Binary file not shown.
Binary file not shown.

0 comments on commit 662dd23

Please sign in to comment.