Skip to content

Commit

Permalink
Updates to Deploy Cluster Profile page
Browse files Browse the repository at this point in the history
  • Loading branch information
achuribooks committed Dec 13, 2024
1 parent 95cd957 commit 752b766
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 30 deletions.
2 changes: 1 addition & 1 deletion _partials/getting-started/_cluster_observability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ partial_category: getting-started
partial_name: cluster-observability
---

As we have seen throughout this tutorial, Palette exposes a set of workload metrics out-of-the-box to help cluster
As we have seen throughout this tutorial, Palette exposes a set of workload metrics out of the box to help cluster
administrators better understand the resource utilization of the cluster. The <VersionedLink text="workload metrics" url="/clusters/cluster-management/workloads/" /> in Palette are a snapshot in
time and do not provide alerting capabilities.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ partial_name: spacetastic-update-cluster-end
Wren and Kai have followed this tutorial and now have a great understanding of what cluster profile updates mean to
deployed clusters. They are impressed with Palette's cluster management capabilities.

> "Neat! Palette's cluster profiles allow us to review all updates we apply to our clusters." says Kai. "I can finally
> "Neat! Palette's cluster profiles allow us to review all updates we apply to our clusters," says Kai. "I can finally
> take my vacation days, once we can safely maintain our clusters."
>
> "Don't I know the feeling?" laughs Wren. "I think we could all use more vacations, quiet weekends and less excitement
> "Don't I know the feeling?" laughs Wren. "I think we could all use more vacations, quiet weekends, and less excitement
> when it comes to the Spacetastic platform."
44 changes: 17 additions & 27 deletions docs/docs-content/getting-started/aws/update-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,11 @@ panel.

![Image that shows how to add a cluster tag](/getting-started/aws/getting-started_update-k8s-cluster_add-service-tag.webp)

Navigate to the left **Main Menu** and select **Clusters** to view your deployed clusters. Click on **Add Filter**, then
select the **Add custom filter** option.

Use the drop-down boxes to fill in the values of the filter. Select **Tags** in the left-hand **drop-down Menu**. Select
**is** in the middle **drop-down Menu**. Fill in **service:hello-universe-frontend** in the right-hand input box.

Click on **Apply Filter**.
Navigate to the left **Main Menu** and select **Clusters** to view your deployed clusters. Click the **filter** icon to expand the **All Filters** pane, and below **Tags**, enter **service:hello-universe-frontend**.

![Image that shows how to add a frontend service filter](/getting-started/aws/getting-started_update-k8s-cluster_apply-frontend-filter.webp)

Once you apply the filter, only the `aws-cluster` with this tag is displayed.
Only the `aws-cluster` with this tag is displayed.

## Version Cluster Profiles

Expand Down Expand Up @@ -117,8 +111,7 @@ Click on **Confirm & Create**. The manifest editor closes.

Click on **Save Changes** to finish the configuration of this cluster profile version.

Navigate to the left **Main Menu** and select **Clusters**. Filter for the cluster with the
**service:hello-universe-frontend** tag. Select it to view its **Overview** tab.
Navigate to the left **Main Menu** and select **Clusters**. Select the `aws-cluster` to view its **Overview** tab.

Select the **Profile** tab of this cluster. You can select a new version of your cluster profile by using the version
dropdown.
Expand All @@ -138,7 +131,7 @@ backups before you make any cluster profile version changes in your production e
:::

Palette now makes the required changes to your cluster according to the specifications of the configured cluster profile
version. Once your changes have completed, Palette marks your layers with the green status indicator. The Kubecost pack
version. Once your changes are applied, Palette marks your layers with the green status indicator. The Kubecost pack
will be successfully deployed.

![Image that shows completed cluster profile updates](/getting-started/aws/getting-started_update-k8s-cluster_completed-cluster-updates.webp)
Expand Down Expand Up @@ -181,17 +174,16 @@ the time to recovery in the event of an incident.

The process to roll back to a previous version is identical to the process for applying a new version.

Navigate to the left **Main Menu** and select **Clusters**. Filter for the cluster with the
**service:hello-universe-frontend** tag. Select it to view its **Overview** tab.
Navigate to the left **Main Menu** and select **Clusters**. Select the `aws-cluster` to view its **Overview** tab.

Select the **Profile** tab. This cluster is currently deployed using cluster profile version **1.1.0**. Select the
option **1.0.0** in the version dropdown. This process is the reverse of what you have done in the previous section,
option **1.0.0** in the version dropdown. This process is the reverse of what you did in the previous section,
[Version Cluster Profiles](#version-cluster-profiles).

Click on **Save** to confirm your changes.

Palette now makes the changes required for the cluster to return to the state specified in version **1.0.0** of your
cluster profile. Once your changes have completed, Palette marks your layers with the green status indicator.
cluster profile. Once your changes are applied, Palette marks your layers with the green status indicator.

![Cluster details page with service URL highlighted](/getting-started/aws/getting-started_deploy-k8s-cluster_service_url.webp)

Expand All @@ -203,42 +195,40 @@ choose to apply your changes at a convenient time.

The previous state of the cluster profile will not be saved once it is overwritten.

Navigate to the left **Main Menu** and select **Clusters**. Filter for the cluster with the tag
**service:hello-universe-frontend**. Select it to view its **Overview** tab.
Navigate to the left **Main Menu** and select **Clusters**. Select the `aws-cluster` to view its **Overview** tab.

Select the **Profile** tab. Then, select the **hello-universe** pack. Change the `replicas` field to `2` on line `15`.
Click on **Save**. The editor closes.
Select the **Profile** tab. Then, select the **hello-universe** pack. Change the `replicas` field on line `15` to `2` and **Save** your changes.
The editor is closed.

This cluster now contains an override over its cluster profile. Palette uses the configuration you have just provided
for the single cluster over its cluster profile and begins making the appropriate changes.

Once these changes are complete, select the **Workloads** tab. Then, select the **hello-universe** namespace.

Two **ui** pods are available, instead of the one specified by your cluster profile. Your override has been successfully
applied.
applied. If you do not see your changes, use the **refresh** icon.

Navigate to the left **Main Menu** and select **Profiles** to view the cluster profile page. Find the cluster profile
corresponding to your _hello-universe-frontend_ cluster. It is named `aws-profile`.

Click on it to view its details. Select **1.0.0** in the version dropdown.

Select the **hello-universe** pack. The editor appears. Change the `replicas` field to `3` on line `15`. Click on
**Confirm Updates**. The editor closes.
Select the **hello-universe** pack. Change the `replicas` field on line `15` to `3`. Click on
**Confirm Updates**. The editor is closed.

Click on **Save Changes** to confirm the changes you have made to your profile.

Navigate to the left **Main Menu** and select **Clusters**. Filter for the with the **service:hello-universe-frontend**
tag. Palette indicates that the cluster associated with the cluster profile you updated has updates available.
Navigate to the left **Main Menu** and select **Clusters**. Palette indicates that the cluster associated with the cluster profile you edited has updates available.

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

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

![Image that shows the Updates button](/getting-started/aws/getting-started_update-k8s-cluster_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
A dialog appears, showing a summary of packs changed. Select **Review changes in Editor** to review your changes. Ensure the only change is the
`replicas` field value. The pending update removes your cluster override and sets the `replicas` field to `3`. At this
point, you can choose to apply the pending changes or keep it by modifying the right-hand side of the dialog.
point, you can choose to apply the pending changes or make additional changes by modifying the **Pending Configuration** pane on the right side of the editor.

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

Expand All @@ -247,7 +237,7 @@ Click on **Apply Changes** once you have finished reviewing your changes.
Palette updates your cluster according to cluster profile specifications. Once these changes are complete, select the
**Workloads** tab. Then, select the **hello-universe** namespace.

Three **ui** pods are available. The cluster profile update is now reflected by your cluster.
Three **ui** pods are available. The cluster profile update is now reflected by your cluster. If you do not see your changes, use the **refresh** icon.

## Cluster Observability

Expand Down
Binary file not shown.

0 comments on commit 752b766

Please sign in to comment.