Skip to content

Commit

Permalink
Link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
brstuder authored Nov 20, 2023
1 parent 9f3ba80 commit 96c64c3
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 12 deletions.
2 changes: 1 addition & 1 deletion apis/apis-overview/api-request-right-sizing-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The container request right sizing recommendation API provides recommendations f
{% endswagger-description %}

{% swagger-parameter in="query" name="algorithmCPU" type="string" required="false" %}
The algorithm to be used to calculate CPU recommendations based on historical CPU usage data. Options are `max` and `quantile`. Max recommendations are based on the maximum-observed usage in `window`. Quantile recommendations are based on a quantile of observed usage in `window` (requires the `qCPU` parameter to set the desired quantile). Defaults to `max`. To use the `quantile` algorithm, the [ContainerStats Pipeline](/using-kubecost/navigating-the-kubecost-ui/savings/auto-request-sizing/containerstats-pipeline.md) must be enabled.
The algorithm to be used to calculate CPU recommendations based on historical CPU usage data. Options are `max` and `quantile`. Max recommendations are based on the maximum-observed usage in `window`. Quantile recommendations are based on a quantile of observed usage in `window` (requires the `qCPU` parameter to set the desired quantile). Defaults to `max`. To use the `quantile` algorithm, the [ContainerStats Pipeline](/architecture/containerstats-pipeline.md) must be enabled.
{% endswagger-parameter %}

{% swagger-parameter in="query" name="algorithmRAM" type="string" required="false" %}
Expand Down
4 changes: 2 additions & 2 deletions apis/apis-overview/apis-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,6 @@ Many, but not all, Kubecost APIs power different features in the Kubecost UI. Th
| Cost Events Audit API | [Audits dashboard](/using-kubecost/navigating-the-kubecost-ui/audits.md) |
| Predict API | [Audits dashboard, Estimated monthly cost impact](/using-kubecost/navigating-the-kubecost-ui/audits.md#estimated-monthly-cost-impact) |
| Savings API | [Savings dashboard](/using-kubecost/navigating-the-kubecost-ui/savings/savings.md) |
| Cluster Right Sizing Recommendation API | [Cluster Sizing Recommendations page](/using-kubecost/navigating-the-kubecost-ui/savings/cluster-right-sizing-recommendations/cluster-right-sizing-recommendations.md) |
| Container Request Right Sizing Recommendation API | [Request right sizing recommendations page](/using-kubecost/navigating-the-kubecost-ui/savings/auto-request-sizing/auto-request-sizing.md) |
| Cluster Right Sizing Recommendation API | [Cluster Sizing Recommendations page](/using-kubecost/navigating-the-kubecost-ui/savings/cluster-right-sizing-recommendations.md) |
| Container Request Right Sizing Recommendation API | [Request right sizing recommendations page](/using-kubecost/navigating-the-kubecost-ui/savings/container-request-right-sizing-recommendations.md) |
| Abandoned Workloads API | [Abandoned Workloads page](/using-kubecost/navigating-the-kubecost-ui/savings/abandoned-workloads.md) |
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Kubecost Cloud: Request Right-Sizing Recommendations

{% hint style="info" %}
This documentation should only be consulted when using Kubecost Cloud! For information about request right-sizing recommendations for self-hosted Kubecost, see [here](https://docs.kubecost.com/using-kubecost/navigating-the-kubecost-ui/savings/auto-request-sizing).
This documentation should only be consulted when using Kubecost Cloud! For information about request right-sizing recommendations for self-hosted Kubecost, see [here](/using-kubecost/navigating-the-kubecost-ui/savings/container-request-right-sizing-recommendations.md).
{% endhint %}

Kubecost Cloud is able to provide recommendations for right-sizing your container requests to ensure they are as cost-effective as possible. Recommendations are provided for all namespaces within your cluster.
Expand All @@ -10,7 +10,7 @@ Kubecost Cloud is able to provide recommendations for right-sizing your containe

You can access request right-sizing by selecting _Savings_ in the left navigation, then select the _Right-size your container requests_ panel.

On the Request Right-sizing Recommendations page, you will see a table containing all namespaces/controller pairs and the cluster and container associated with each. You will also see the requested and recommended RAM/CPU, the current efficiency, and finally estimated monthly savings by adopting recommendations.
On the Container Request Right-sizing Recommendations page, you will see a table containing all namespaces/controller pairs and the cluster and container associated with each. You will also see the requested and recommended RAM/CPU, the current efficiency, and finally estimated monthly savings by adopting recommendations.

### Configuring your recommendations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,4 +158,4 @@ The rightmost column in the Allocations metrics table allows you to perform addi

* _Inspect_: Opens an advanced cost overview of the namespace in a new tab.
* _Inspect Shared Costs_: Opens an advanced cost overview of your shared costs in a new tab.
* _View Right-Sizing_: Opens the [Request right-sizing recommendations](/using-kubecost/navigating-the-kubecost-ui/savings/auto-request-sizing/auto-request-sizing.md) page in a new tab.
* _View Right-Sizing_: Opens the [Container Request Right-Sizing Recommendations](/using-kubecost/navigating-the-kubecost-ui/savings/container-request-right-sizing-recommendations.md) page in a new tab.
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Kubecost is also able to implement cluster sizing recommendations on a user-sche

You can access cluster right-sizing by selecting _Savings_ in the left navigation, then select the _Right-size your cluster nodes_ panel.

![Cluster Sizing](/images/clusterrightsizing.png)

Kubecost will offer two recommendations: simple (uses one node type) and complex (uses two or more node types). Kubecost may hide the complex recommendation when it is more expensive than the simple recommendation, and present a single recommendation instead. These recommendations and their metrics will be displayed in a chart next to your existing configuration in order to compare values like total cost, node count, and usage.

### Configuring your cluster right-sizing recommendations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ In order for Kubecost to apply a recommendation, it needs write access to your c

Select _Savings_ in the left navigation, then select _Right-size your container requests_. The Request right-sizing recommendations page opens.

![Request right-sizing recommendations Beta page](../../../../images/rightsizing.png)

Select _Customize_ to modify the right-sizing settings. Your customization settings will tell Kubecost how to calculate its recommendations, so make sure it properly represents your environment and activity:

* Window: Duration of deployment activity Kubecost should observe
Expand Down
4 changes: 2 additions & 2 deletions using-kubecost/navigating-the-kubecost-ui/savings/savings.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The monthly savings values on this page are precomputed every hour for performan

### Kubernetes insights

* [Right-size your cluster nodes](cluster-right-sizing-recommendations/cluster-right-sizing-recommendations.md)
* [Right-size your container requests](auto-request-sizing/auto-request-sizing.md)
* [Right-size your cluster nodes](cluster-right-sizing-recommendations.md)
* [Right-size your container requests](container-request-right-sizing-recommendations.md)
* [Remedy abandoned workloads](abandoned-workloads.md)
* [Manage unclaimed volumes](unclaimed-volumes.md)
* [Manage local disks](local-disks.md)
Expand Down

0 comments on commit 96c64c3

Please sign in to comment.