Skip to content

Commit 7748b95

Browse files
committed
📝 fix docs
modified: README.md; modified: main.go
1 parent 998b39d commit 7748b95

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ concurrentWorkers: 10
7474

7575
Minimum seconds between pod restart.
7676
This ensures the controller will not restart a pod if the minimum time
77-
has not passed since it has started sampling it.
77+
has not passed since it has started.
7878

7979
--enable-increase (default true)
8080
Enables the controller to increase pod requests
@@ -119,7 +119,7 @@ reqsizer.jatalocks.github.io/mode=min # Sets the request to the MINIMUM of
119119
```
120120
### Disclaimer
121121

122-
`sample-size` is the amount of data-points the controller will store in cache before constructing an average for the pod. After a requests resizing, the cache will clean itself and a new average will be calculated based on the sample size. If `min-seconds` has not yet passed since the pod has last been supposed to be sample-reconciled, the controller will keep sampling the pod until `min-seconds` have been reached and only then zero the sample and restart from cache.
122+
`sample-size` is the amount of data-points the controller will store in cache before constructing an average for the pod. After a requests resizing, the cache will clean itself and a new average will be calculated based on the sample size. If `min-seconds` have not yet passed since the pod has been scheduled, the controller will keep sampling the pod until `min-seconds` have been reached and only then zero the sample and restart from cache.
123123

124124
### Edge Cases
125125

main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ func main() {
8383
flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
8484
flag.IntVar(&sampleSize, "sample-size", 1, "The sample size to create an average from when reconciling.")
8585
flag.Float64Var(&minSecondsBetweenPodRestart, "min-seconds", 1, "Minimum seconds between pod restart. "+
86-
"This ensures the controller will not restart a pod if the minimum time has not passed since it has started sampling it.")
86+
"This ensures the controller will not restart a pod if the minimum time has not passed since it has started.")
8787
flag.BoolVar(&enableLeaderElection, "leader-elect", false,
8888
"Enable leader election for controller manager. "+
8989
"Enabling this will ensure there is only one active controller manager.")

0 commit comments

Comments
 (0)