Skip to content

Commit 2581c23

Browse files
committed
Complete PRR section.
1 parent 711132e commit 2581c23

File tree

1 file changed

+19
-13
lines changed
  • keps/sig-autoscaling/4951-configurable-hpa-tolerance

1 file changed

+19
-13
lines changed

keps/sig-autoscaling/4951-configurable-hpa-tolerance/README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -538,6 +538,9 @@ You can take a look at one potential example of such test in:
538538
https://github.com/kubernetes/kubernetes/pull/97058/files#diff-7826f7adbc1996a05ab52e3f5f02429e94b68ce6bce0dc534d1be636154fded3R246-R282
539539
-->
540540

541+
We will add a unit test verifying that HPAs with and without the new fields are
542+
properly validated, both when the feature gate is enabled or not.
543+
541544
### Rollout, Upgrade and Rollback Planning
542545

543546
<!--
@@ -594,6 +597,9 @@ checking if there are objects with field X set) may be a last resort. Avoid
594597
logs or events for this purpose.
595598
-->
596599

600+
The presence of the new `tolerance` HPA field indicates that the feature is
601+
used.
602+
597603
###### How can someone using this feature know that it is working for their instance?
598604

599605
<!--
@@ -605,13 +611,10 @@ and operation of this feature.
605611
Recall that end users cannot usually observe component logs or access metrics.
606612
-->
607613

608-
- [ ] Events
609-
- Event Reason:
610-
- [ ] API .status
611-
- Condition name:
612-
- Other field:
613-
- [ ] Other (treat as last resort)
614-
- Details:
614+
- [X] Events
615+
- Event Reason: `SuccessfulRescale`
616+
617+
Users can monitor the scaling behavior of their HPA.
615618

616619
###### What are the reasonable SLOs (Service Level Objectives) for the enhancement?
617620

@@ -630,18 +633,15 @@ These goals will help you determine what you need to measure (SLIs) in the next
630633
question.
631634
-->
632635

636+
N/A.
637+
633638
###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
634639

635640
<!--
636641
Pick one more of these and delete the rest.
637642
-->
638643

639-
- [ ] Metrics
640-
- Metric name:
641-
- [Optional] Aggregation method:
642-
- Components exposing the metric:
643-
- [ ] Other (treat as last resort)
644-
- Details:
644+
N/A.
645645

646646
###### Are there any missing metrics that would be useful to have to improve observability of this feature?
647647

@@ -650,6 +650,12 @@ Describe the metrics themselves and the reasons why they weren't added (e.g., co
650650
implementation difficulties, etc.).
651651
-->
652652

653+
Users may want to see a signal that autoscaling isn't happening because of the
654+
tolerance, but this is not directly related to this KEP (this problem already
655+
exists today with the hard-coded 10% tolerance), and taking this KEP as an
656+
opportunity to improve the situation is difficult (see
657+
[this thread](https://github.com/kubernetes/enhancements/pull/4954#discussion_r1857098884)).
658+
653659
### Dependencies
654660

655661
<!--

0 commit comments

Comments
 (0)