Api refactoring #56
Merged
Api refactoring #56
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Aurel Canciu <aurelcanciu@gmail.com>
Nice 👍 |
relu
force-pushed
the
api-refactoring
branch
2 times, most recently
from
c20dc7c
to
60d669d
Compare
squaremo
requested changes
Nov 23, 2020
This is an attempt to bring the api and controller logic closer to what the other controller components already have set as patterns. 1. Adopt the k8s standard Condition type. 2. Rename `ScanInterval` to `Interval` to be consistent with the `Interval` attribute other Spec types have defined, translating to reconciliation interval. This attribute is now required. 3. Add `ScanTime` attribute to the `ScanResult` type, enabling keeping track of the last successful scan execution. Use this value for scan frequency throttling. 4. Add optional `Timeout` attribute to allow custom scan timeout handling. The default value is equal to that of the `Interval` attr. Signed-off-by: Aurel Canciu <aurelcanciu@gmail.com>
relu
force-pushed
the
api-refactoring
branch
from
60d669d
to
5eec08d
Compare
Too much history rewriting :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an attempt to bring the api and controller logic closer to what
the other controller components already have set as patterns.
ScanIntervaltoIntervalto be consistent with theIntervalattribute other Spec types have defined, translating toreconciliation interval. This attribute is now required.
ScanTimeattribute to theScanResulttype, enabling keepingtrack of the last successful scan execution. Use this value for scan
frequency throttling.
Timeoutattribute to allow custom scan timeouthandling. The default value is equal to that of the
Intervalattr.What is to be debated:
I proposed a different means of handling the reconciliation interval, while previously this was an optional value, it is not required. I think setting the interval should be a conscious decision made by the user considering the expectation of scan frequency and potential throttling imposed by the registry service provider. With this approach, we could recommend a default value while not imposing any restrictions aside from that of it being more than or equal to
1s, the rest of the logic remains in place.A potential future design proposed by @squaremo, is to not enforce a mandatory value and rather scan as often as possible if no value is provided, while also providing an attribute that would set an upper bound for throttling purposes (at most frequent).