From 1694e69b77e8aa8b69222fc08d6116cdf88cc9c9 Mon Sep 17 00:00:00 2001 From: Luiz Aoqui Date: Tue, 2 Jan 2024 14:06:07 -0500 Subject: [PATCH] docs: clarify the behaviour of `lower_bound` and `upper_bound` (#19552) --- .../tools/autoscaling/plugins/strategy/threshold.mdx | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/website/content/tools/autoscaling/plugins/strategy/threshold.mdx b/website/content/tools/autoscaling/plugins/strategy/threshold.mdx index b8b626e86..23c9391ed 100644 --- a/website/content/tools/autoscaling/plugins/strategy/threshold.mdx +++ b/website/content/tools/autoscaling/plugins/strategy/threshold.mdx @@ -57,10 +57,14 @@ policy { ``` - `lower_bound` `(float: )` - The minimum value a metric must have - to be considered with bounds. + to be considered with bounds. This value is always **inclusive**, meaning a + metric with the exact same value as `lower_bound` is considered within + bounds. - `upper_bound` `(float: )` - The maximum value a metric must have - to be considered within bounds. + to be considered within bounds. This value is always **exclusive**, meaning a + metric with the exact same value as `upper_bound` is considered **out** of + bounds. - `delta` `(int: )` - Specifies the relative amount to add (positive value) or remove (negative value) from the current target count. Conflicts @@ -79,8 +83,8 @@ policy { At least one of `lower_bound` or `upper_bound` must be defined. If `lower_bound` is not defined, any value below `upper_bound` is considered -within bounds. Similarly, if `upper_bound` is not defined, any value above -`lower_bound` will be considered within bounds. +within bounds. Similarly, if `upper_bound` is not defined, any value above or +equal to `lower_bound` will be considered within bounds. One, and only one, of `delta`, `percentage`, or `value` must be defined.