Skip to content

Redirect rightsizing branch #5851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rickshar merged 4 commits into from
Aug 25, 2025
Merged

Redirect rightsizing branch #5851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
860f3fa
Update ocean-cluster-right-sizing-tab.md
rickshar Aug 25, 2025
564c92c
Update ocean-cluster-right-sizing-recom-tab.md
rickshar Aug 25, 2025
cf14576
Update ocean-cluster-right-sizing-savings-tab.md
rickshar Aug 25, 2025
0ec4839
Update troubleshoot-right-sizing.md
rickshar Aug 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 1 addition & 209 deletions src/docs/ocean/features/ocean-cluster-right-sizing-recom-tab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,212 +1,4 @@
# Automatic Right-Sizing Recommendations and Rules

Cloud service provider relevance: <font color="#FC01CC">EKS</font>, <font color="#FC01CC">AKS</font>, and <font color="#FC01CC">GKE</font>

This topic shows you how to view right-sizing recommendations for workloads and containers and work with right-sizing rules.

Before you begin, see [Ocean Cluster Automatic Right-Sizing](https://docs.spot.io/ocean/features/ocean-cluster-right-sizing-tab) for a full description of this Ocean feature.

To view your right-sizing recommendations and rules:

1. In the left main menu, click **Ocean** > **Cloud Clusters**.
2. Select a cluster from the list of clusters.
3. Click **Right Sizing > Advanced Optimization**.

The Advanced Optimization tab contains these lists:

* Workloads Optimization List.
* Automation Rules List.

Your workload optimization activities impact the status of the workloads in the [Right Sizing Savings panel](ocean/features/ocean-cluster-right-sizing-tab?id=right-sizing-savings-panel)

## Workloads Optimization List

<img width="1000" src="https://github.com/user-attachments/assets/a6070749-5c8f-4871-b4ff-2c3faccc5755" />

This list displays your right-sizing recommendations per workload and lets you drill down per container.
* [Right Sizing rules](ocean/features/ocean-cluster-right-sizing-recom-tab?id=automation-rules-list) that are attached to specific workloads.
* Workload optimization status: If the workload is [attached](ocean/features/ocean-cluster-right-sizing-recom-tab?id=attach-a-right-sizing-rule-to-one-or-more-workloads) to a right-sizing rule, the name of the rule appears under the **Rules** column. The rule can have one of the following workload (colored) optimization statuses:
* Green (Optimized): Workload is fully optimized, and no action is required.
* Orange (Limited): Ocean applied recommendations to the workload, but there are limitations due to overhead, HPA, etc.
* Blue (Pending): Rule has been attached to the workload but is out of schedule.
* Red (Not Optimized): Issues due to user configuration, for example, thresholds or exclude preliminary recommendations.
* Gray (Rollback): Ocean rolled back to the original deployment request and suspended the workload's attachment to the rule.
* Brown (Not Attached): The Workload is not optimized.
* Workload type and names.
* vCPU and memory right sizing recommendations per deployment. Recommended increases are shown with a green up arrow, and recommended decreases are shown with a red Down arrow.
* HPA: If the workload is configured with HPA, **ON** is displayed under HPA. Hover over the entry for information about the specific HPA trigger (CPU/Memory/other).
* Potential monthly maximums savings if you adopt the recommendations.

> **Notes**:
> - Hover over the Limited and Not optimized statuses to view more details in a tooltip.
> - There are no vCPU / memory recommendations or Potential monthly max if a workload is fully optimized. Savings are displayed for the workload because Ocean is already optimizing it.
>
> - If the <img height="20" src="https://github.com/user-attachments/assets/6160df45-992e-41a8-bcc2-5af1bee732ff" /> button appears on the right of the screen, workloads were moved to rollback status. See [Acknowledge a Workload Rollback](https://docs.spot.io/ocean/features/ocean-cluster-right-sizing-recom-tab?id=acknowledge-a-workload-rollback)

> If a message about VPA not reporting is displayed:
> - You cannot attach rules to workloads.
> - If at least 1 rule was previously attached to a workload, the workload is not optimized due to the missing VPA installation in the cluster.

The graphical display above the list shows the breakdown of these workload optimization statuses.

To view a list of your potential savings and recommendations per container:

* Click on the down arrow to the left of a workload to drill down to the containers. For each container, you can then view the following:

* vCPU Request: showing current and average utilization and a recommended increase or decrease for this resource (in vCPU units). If no changes are required, a Keep icon is displayed.
* Memory Request: This shows current and Average utilization and a recommended increase or decrease for this resource (in MiB units). If no changes are required, a Keep icon is displayed.
* Right-Sizing Recommendations: Show the recommended changes in vCPU and memory. Click on the Copy icon to save these changes for later.

## Automation Rules List

![automation-rules-e](https://github.com/user-attachments/assets/f128606b-a91d-4935-a36a-c3c4984287b8)

This list displays your existing right-sizing rules.
Each rule entry shows relevant information about the parameters that trigger the rule and its scheduling plan.

## Work with Right Sizing Rules

You can create right-sizing rules to trigger immediately after a specific set of requirements is met or at a specific time after the requirements are met.

### Create or Edit a Right-Sizing Rule

To create/edit a right-sizing rule:

1. Click the **Advanced Optimization** tab if not already displayed.
2. To create a new rule, click **+ Add new rule** above the Automation Rules list (or to edit an existing rule, click the pencil icon in the rule).

<img height="700" src="https://github.com/user-attachments/assets/0dcc58d8-86c3-4496-bde8-b1cce5dc2109" />

3. In the Configure Automation Rule dialog box, enter/edit the unique rule name.
4. Select when to apply the recommendation by selecting one of the following options:

* **Once available**: The recommendation is applied immediately after it becomes available.
* **Specific time**: You select when to apply the recommendation after it becomes available.

![rule-when-to-apply-3](https://github.com/user-attachments/assets/5cb76163-9f33-477e-95d6-b99b36f0f200)

5. Turn on **Exclude preliminary recommendation** if you want to suppress recommendations as long as the workload has preliminary status (4 days).
6. Select one of the **Restart replicas** options:
* All manifests.
* Manifests with more than 1 replica only.
* No restart.
7. Click the **Set the resources percentage change** down arrow to apply the recommendation, and set the CPU and Memory percentage thresholds. This is the minimum percentage change from the current request for applying a recommendation. If the right-sizing recommendation exceeds the percentage threshold for either resource (CPU or Memory), it will be applied to both resources, and the resulting status will be **fully optimized**. We do this because the original purpose of the threshold is to prevent unnecessary pod deletion. However, if we need to delete a pod and relaunch a new one for one resource, we do the same for the other.
8. Click the **Set recommendation ranges for resources** down arrow and enter the upper and lower boundary values for CPU (millicpu) and Memory (MiB) requests to apply a recommendation. By default, the minimum values are 10 millicpu for CPU and 32 MiB for memory; no lower values will be accepted.
* If a recommendation is above the set boundaries, automatic right-sizing will apply the recommendation using the maximum value configured in the rule.
* If a recommendation is below the set boundaries, automatic right-sizing will apply the recommendation using the minimum value configured in the rule.
9. Click the **Set overhead for resources** down arrow and set the CPU and memory percentage overheads. An overhead specifies the percentage of extra resources to add to the new request recommendation.
10. Ocean supports automatic right-sizing for HPA-associated workloads. To enable, click **Apply HPA on associated workload**.

11. Turn on **Auto-attach** if you want to automatically attach rules to workloads based on selected criteria.
* In the Auto-attach area, select required namespaces / labels.

<img width="500" src="https://github.com/user-attachments/assets/dae038b7-6dda-4a85-8e2f-bea04c12f517" />

12. After you save the rule, it appears in the area under the [Workloads Optimization list](https://docs.spot.io/ocean/features/ocean-cluster-right-sizing-recom-tab?id=workloads-optimization-list).

> **Notes**:
> - Default values for Overhead and Automation Threshold are **10%** and **5%** respectively.
> - The **10%** default overhead is calculated within the recommendation itself.
> - Threshold value is only used for down-sizing cases

### Attach a Right-Sizing Rule to One or More Workloads

Options:

* Auto-attach: Turn on auto-attach and let Ocean automatically attach rules to workloads based on selected criteria. See [Create or Edit a Right-Sizing Rule](https://docs.spot.io/ocean/features/ocean-cluster-right-sizing-recom-tab?id=create-or-edit-a-right-sizing-rule).
>**Note**: Auto-attach attaches rules to existing and newly-added workloads.

* Manual attach: Manually attach a specific right-sizing rule to one or more workloads.


To manually attach a rule:

1. Select one or more workloads in the Workloads Optimization list.
2. From the Actions drop-down menu above the table, click **Attach Rule**.

![attach-rule-to-workload](https://github.com/user-attachments/assets/be315afa-0ef8-4d30-b1f3-422e8caf8633)

3. You can either attach an existing or new rule you create from scratch (a new rule will be attached to the workload(s) you selected earlier):

* Click the **Select from existing rule** drop-down menu and then select a rule.
* Click **Create new rule from scratch** (see [Create or Edit a Right-Sizing Rule](ocean/features/ocean-cluster-right-sizing-recom-tab?id=create-or-edit-a-right-sizing-rule))

4. Save and apply the rule.

### Detach a Right-Sizing Rule from One or More Workloads

To detach a rule from one or more workloads:

1. Select workloads in the Workloads Optimization list.
2. From the Actions drop-down menu above the list, click **Detach Rule**.

>**Important**: If you encounter Kubernetes issues, we recommend detaching workloads from rules and rolling them in your cluster.

### Delete a Right-Sizing Rule

To delete a right sizing rule:

1. To the right of the row for the rule in the list, click the wastebasket icon.
2. When the confirmation message appears, Click **Delete**, or **Cancel** (if you are unsure).

>**Important**: You cannot restore a deleted right-sizing rule. In addition, a rule may be deleted only if it is no longer attached to a workload.

### Acknowledge a Workload Rollback

If a workload encounters an OOM error, Ocean rolls back to the original deployment request and suspends the workload's attachment to the rule. The workload moves to **rollback** status. When at least one workload has rollback status, the <img height="20" src="https://github.com/user-attachments/assets/6160df45-992e-41a8-bcc2-5af1bee732ff" /> button appears at the top-right of the screen.

To acknowledge a workload rollback:

1. Click **Acknowledge Rollback** to view all the workloads with the rollback status.

![right-sozomg-rollback-dialog](https://github.com/user-attachments/assets/4bb206f5-73e3-4b26-b7fb-19e5e519505f)

* The rollback drill-down list contains the following information:
* Workload Name.
* Namespace.
* CPU Update in vCPUs (before and after rollback).
* Memory Update in MiBs (before and after update).
* Rollback Time: In format MM/DD/YYYY HH:MM:SS AM/PM

2. Select the checkboxes for the required workloads.
3. Click **I Acknowledge the Rollback**.

The workloads are displayed in the [Workloads Optimization List](https://docs.spot.io/ocean/features/ocean-cluster-right-sizing-recom-tab?id=workloads-optimization-list) without any attached rules. Before attaching a rule to a rolled-back workload, first fix the issue.

### Set the vCPU/Memory Percentile

You can select the right-sizing percentile settings to calculate the vCPU and memory recommendations.
The lower the percentile, the stronger the recommendations.

By default:

* vCPU: Right-sizing uses the 85th percentile.
* Memory: Right-sizing uses the maximum value.

>**Important:** Changing the percentile setting will impact the recommendations that were already applied (this may take a few minutes to update).

To change settings:

1. Click **Settings** above the [workloads optimization list](https://docs.spot.io/ocean/features/ocean-cluster-right-sizing-recom-tab?id=workloads-optimization-list).

<img width="500" src="https://github.com/user-attachments/assets/5bcddc81-c527-4f87-a897-369e911bedcc" />

2. Click the arrow on the right for **vCPU** or **Memory** as required (vCPU shown in the example).

<img width="500" src="https://github.com/user-attachments/assets/59b2e755-04d8-4967-9b39-9fc0904e5231" />

3. Change the current value(s) and save.

## Best Practices

These are the Right-Sizing Best Practices:

* Workload limits should not have the same values as requests.
* If you set overheads for resources, start with a relatively high overhead (20%) and decrease it with time.
* If you set boundaries (recommendation ranges for resources), avoid applying the specific rule to all workloads. All services have different purposes.

## Related Topics

* [Right-Sizing Troubleshooting](https://docs.spot.io/ocean/features/troubleshoot-right-sizing)
* [Automatic Right-Sizing -Introduction](https://docs.spot.io/ocean/features/ocean-cluster-right-sizing-tab)
This feature has moved to the new [Flexera documentation portal]( https://docs-spot.flexera.com/ocean/features/ocean-cluster-right-sizing-tab).

56 changes: 1 addition & 55 deletions src/docs/ocean/features/ocean-cluster-right-sizing-savings-tab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,3 @@
# Automatic Right-Sizing Actual Savings

Cloud service provider relevance: <font color="#FC01CC">EKS</font>, <font color="#FC01CC">AKS</font>, and <font color="#FC01CC">GKE</font>

This topic shows you how to view your (actual) right-sizing savings from applying down-sizing recommendations to your workloads.

Before you begin, see [Ocean Cluster Automatic Right-Sizing](https://docs.spot.io/ocean/features/ocean-cluster-right-sizing-tab) for a full description of this Ocean feature.

To view your right-sizing savings:

1. In the left main menu, click **Ocean** > **Cloud Clusters**.
2. Select a cluster from the list of clusters.
3. Click **Right Sizing > Savings**.

The Savings tab contains the following:

* Right-sizing savings panel
* Workload savings list.

<img width="1000" src="https://github.com/user-attachments/assets/83e6c80e-9533-480d-a171-9d872e07550e" />

At the top of the actual savings overview, you can filter according to:

* Time
* Last 30 days.
* Last 7 days.
* This month (from the first day of the month until today).

* Workloads (optimized workloads only).
* Namespaces.

The right-sizing savings panel shows the following:
* Savings in dollars.
* Selected time frame.
* Pie chart together with the savings per namespaces (that affected the most savings).

The workload savings list shows your actual right-sizing savings per workload.
These are the workloads that were optimized automatically based on Ocean's recommendations.

>Note: Only down-sizing recommendations apply.

* Workload Name.
* Namespace.
* Workload Type: (if the workload was deleted, it is marked as Deleted).
* CPU:
* With Ocean (green color): The sum of all the CPU requests that Ocean recommended and applied automatically.
* Without Ocean: The sum of all CPU requests in your original workloads.
* Memory:
* With Ocean (green color): The sum of all of the memory requests that Ocean recommended and applied automatically.
* Without Ocean: The sum of all the memory requests in your original workloads.
* Right-sizing savings (dollars) for the workload.






This feature has moved to the new [Flexera documentation portal]( https://docs-spot.flexera.com/ocean/features/ocean-cluster-right-sizing-tab).
Loading