Skip to content

Commit 5c2cf19

Browse files
committed
Add Memory Value Humanization docs
Signed-off-by: Omer Aplatony <[email protected]>
1 parent 16210e3 commit 5c2cf19

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

vertical-pod-autoscaler/docs/features.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Contents
44

55
- [Limits control](#limits-control)
6+
- [Memory Value Humanization](#memory-value-humanization)
67

78
## Limits control
89

@@ -16,3 +17,18 @@ with VPA resource policy, VPA will follow VPA policy (and set values outside the
1617
range).
1718

1819
To disable getting VPA recommendations for an individual container, set `mode` to `"Off"` in `containerPolicies`.
20+
21+
## Memory Value Humanization
22+
23+
VPA can present memory recommendations in human-readable binary units (KiB, MiB, GiB, TiB) instead of raw bytes, making resource recommendations easier to understand. This feature is controlled by the `--humanize-memory` flag in the recommender component.
24+
25+
When enabled, memory values in recommendations will be:
26+
- Converted to the most appropriate binary unit (KiB, MiB, GiB, or TiB)
27+
- Displayed with up to 2 decimal places for precision
28+
- Applied to target, lower bound, and upper bound recommendations
29+
30+
For example, instead of seeing a memory recommendation of `262144000` bytes, you would see `250.00Mi`.
31+
32+
To enable this feature, set the `--humanize-memory` flag to true when running the VPA recommender:
33+
```bash
34+
--humanize-memory=true

0 commit comments

Comments
 (0)