Skip to content

Commit 54f61ad

Browse files
committed
upd readme
1 parent cdd9360 commit 54f61ad

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Here's how a typical scenario might unfold:
1616
- **!?!?!?**
1717
- **9:08:00:** HPA scales back down to 10 `SuperHeavyApp` pods, with CPU utilization at 70% (among the 10 pods).
1818

19-
## In this case we have two options:
19+
### In this case we have two options:
2020
- Configure **Horizontal Pod Autoscaler (HPA)** to scale based on **40% CPU usage** with a `stabilizationWindowSeconds` of `3600`. This will keep it upscaled most of the time, leading to wasted resources and money.
2121
- Use **Prescaler**. For the `SuperHeavyApp` HPA/Deployment, configure Prescaler's Custom Resource (CR) to prescale by **+50% at "56 * * * *"**. At 8:56:00, Prescaler will:
2222
- Change HPA's CPU `averageUtilization` from 70% to 35% and set `hpa.Spec.Behavior.ScaleUp.StabilizationWindowSeconds` to 0 (for immediate scale-up).
@@ -28,11 +28,13 @@ Here's how a typical scenario might unfold:
2828
- If the spike ends, HPA will scale down after it concludes (e.g., if the spike ends at 9:03:00, HPA scales down at 9:08:00, i.e., 9:03:00 + 5 minutes).
2929
- This process repeats for every hour.
3030

31-
Important!
32-
If your SuperHeavyApp takes a lot of time to start:
31+
### If your SuperHeavyApp takes a lot of time to start:
3332
- Increase `behavior.scaleDown.stabilizationWindowSeconds` from recommended 10 minutes (for example, to 20 minutes)
3433
- Start prescaling earlier (for example, at `"51 * * * *"`), or use multiple schedules for different times of day.
35-
With the new `schedules` field, you can define multiple prescale actions with different times and percentages, e.g.:
34+
35+
## Deployment and Custom Resources
36+
37+
**Attention!** When you specify a cron schedule, keep in mind a **timezone**! Probably controller will run in your Kubernetes cluster in UTC timezone!
3638

3739
[Helm Chart](dist/chart)
3840

@@ -53,9 +55,7 @@ spec:
5355
revertWaitSeconds: 40 # max wait time before reverting back to original values. It is important, because we must provide Kubernetes time to detect and react on HPA changes (to trigger scaleup desiredReplicas)
5456
```
5557
56-
P.S. Cron/schedule logic was taken from [book.kubebuilder.io/cronjob-tutorial](https://book.kubebuilder.io/cronjob-tutorial/controller-implementation#5-get-the-next-scheduled-run)
57-
58-
## Getting Started
58+
## Getting Started for the Controller development
5959
6060
### Prerequisites
6161
- go version v1.24.0+

0 commit comments

Comments
 (0)