add documentation for CPU integer post processor

kubernetes · Dec 2, 2022 · 17ef628 · 17ef628
1 parent 13f8eee
commit 17ef628
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/vertical-pod-autoscaler/FAQ.md b/vertical-pod-autoscaler/FAQ.md
@@ -183,6 +183,7 @@ Name | Type | Description | Default
 `memory-aggregation-interval-count` | Int64 | The number of consecutive memory-aggregation-intervals which make up the MemoryAggregationWindowLength which in turn is the period for memory usage aggregation by VPA. In other words, MemoryAggregationWindowLength = memory-aggregation-interval * memory-aggregation-interval-count. | model.DefaultMemoryAggregationIntervalCount
 `memory-histogram-decay-half-life` | Duration | The amount of time it takes a historical memory usage sample to lose half of its weight. In other words, a fresh usage sample is twice as 'important' as one with age equal to the half life period. | model.DefaultMemoryHistogramDecayHalfLife
 `cpu-histogram-decay-half-life` | Duration | The amount of time it takes a historical CPU usage sample to lose half of its weight. | model.DefaultCPUHistogramDecayHalfLife
+`cpu-integer-post-processor-enabled` | Bool | Enable the CPU integer recommendation post processor | false
 
 ### What are the parameters to VPA updater?
 

diff --git a/vertical-pod-autoscaler/README.md b/vertical-pod-autoscaler/README.md
@@ -19,6 +19,7 @@
   - [Capping to Limit Range](#capping-to-limit-range)
   - [Resource Policy Overriding Limit Range](#resource-policy-overriding-limit-range)
   - [Starting multiple recommenders](#starting-multiple-recommenders)
+  - [Using CPU management with static policy](#using-cpu-management-with-static-policy)
 - [Known limitations](#known-limitations)
 - [Related links](#related-links)
 
@@ -294,6 +295,17 @@ Please note the usage of the following arguments to override default names and p
 
 You can then choose which recommender to use by setting `recommenders` inside the `VerticalPodAutoscaler` spec.
 
+### Using CPU management with static policy
+
+If you are using the [CPU management with static policy](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy) for some containers,
+you probably want the CPU recommendation to be an integer. A dedicated recommendation pre-processor can perform a round up on the CPU recommendation. Recommendation capping still applies after the round up.   
+To activate this feature, pass the flag `--cpu-integer-post-processor-enabled` when you start the recommender. 
+The pre-processor only acts on containers having a specific configuration. This configuration consists in an annotation on your VPA object for each impacted container.
+The annotation format is the following:
+```
+vpa-post-processor.kubernetes.io/{containerName}_integerCPU=true
+```
+ 
 # Known limitations
 
 * Whenever VPA updates the pod resources, the pod is recreated, which causes all