Skip to content

Commit 985f410

Browse files
committed
📝 docs
modified: README.md
1 parent 4312d66 commit 985f410

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,23 @@ auto.request.operator/mode=min # Sets the request to the MINIMUM of all sa
9090
### Disclaimer
9191

9292
`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.
93+
94+
### Edge Cases
95+
96+
1. All samples in a certain cycle report `0` (less than 1):
97+
1. **mode=average**: The controller will ignore the pod and not reconcile.
98+
2. **mode=min**: The controller will put `1m` or `1Mi` as a value.
99+
3. **mode=max**: The controller will ignore the pod and not reconcile.
100+
1. One or more of the samples in a certain cycle reports `0` (less than 1):
101+
1. **mode=average**: Will take the `0` into consideration.
102+
2. **mode=min**: Will consider the `0` as `1`.
103+
3. **mode=max**: Will take the `0` into consideration, but will ignore if *max=0*.
104+
2. Annotation is `true` (`optimize=false` is as strong as **deny**):
105+
1. A namespace has `optimize=false` but a pod has `optimize=true`:
106+
1. The controller will ignore the pod and not reconcile.
107+
2. A namespace has `optimize=true` but a pod has `optimize=false`:
108+
1. The controller will ignore the pod and not reconcile.
109+
93110
## Limitations
94111

95112
- Does not work with CRD controllers (such as Argo Rollouts)

0 commit comments

Comments
 (0)