Configurable maxConcurrentReconciles and pollInterval with sensible defaults #140
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,13 +37,14 @@ func main() { | |
| var ( | ||
| app = kingpin.New(filepath.Base(os.Args[0]), "AWS support for Crossplane.").DefaultEnvars() | ||
| debug = app.Flag("debug", "Run with debug logging.").Short('d').Bool() | ||
| syncInterval = app.Flag("sync", "Sync interval controls how often all resources will be double checked for drift.").Short('s').Default("1h").Duration() | ||
| pollInterval = app.Flag("poll", "Poll interval controls how often an individual resource should be checked for drift.").Default("10m").Duration() | ||
| leaderElection = app.Flag("leader-election", "Use leader election for the controller manager.").Short('l').Default("false").OverrideDefaultFromEnvar("LEADER_ELECTION").Bool() | ||
| maxReconcileRate = app.Flag("max-reconcile-rate", "The global maximum rate per second at which resources may be checked for drift from the desired state.").Default("10").Int() | ||
| terraformVersion = app.Flag("terraform-version", "Terraform version.").Required().Envar("TERRAFORM_VERSION").String() | ||
| providerSource = app.Flag("terraform-provider-source", "Terraform provider source.").Required().Envar("TERRAFORM_PROVIDER_SOURCE").String() | ||
| providerVersion = app.Flag("terraform-provider-version", "Terraform provider version.").Required().Envar("TERRAFORM_PROVIDER_VERSION").String() | ||
| nativeProviderPath = app.Flag("terraform-native-provider-path", "Terraform native provider path for shared execution.").Default("").Envar("TERRAFORM_NATIVE_PROVIDER_PATH").String() | ||
|
|
||
| namespace = app.Flag("namespace", "Namespace used to set as default scope in default secret store config.").Default("crossplane-system").Envar("POD_NAMESPACE").String() | ||
| enableExternalSecretStores = app.Flag("enable-external-secret-stores", "Enable support for ExternalSecretStores.").Default("false").Envar("ENABLE_EXTERNAL_SECRET_STORES").Bool() | ||
|
|
@@ -60,15 +61,16 @@ func main() { | |
| ctrl.SetLogger(zl) | ||
| } | ||
|
|
||
| log.Debug("Starting", "sync-interval", syncInterval.String(), | ||
| "poll-interval", pollInterval.String(), "max-reconcile-rate", *maxReconcileRate) | ||
|
|
||
| cfg, err := ctrl.GetConfig() | ||
| kingpin.FatalIfError(err, "Cannot get API server rest config") | ||
|
|
||
| mgr, err := ctrl.NewManager(ratelimiter.LimitRESTConfig(cfg, *maxReconcileRate), ctrl.Options{ | ||
| LeaderElection: *leaderElection, | ||
| LeaderElectionID: "crossplane-leader-election-provider-aws", | ||
| SyncPeriod: syncInterval, | ||
| LeaderElectionResourceLock: resourcelock.LeasesResourceLock, | ||
| LeaseDuration: func() *time.Duration { d := 60 * time.Second; return &d }(), | ||
| RenewDeadline: func() *time.Duration { d := 50 * time.Second; return &d }(), | ||
|
|
@@ -91,8 +93,8 @@ func main() { | |
| Options: xpcontroller.Options{ | ||
| Logger: log, | ||
| GlobalRateLimiter: ratelimiter.NewGlobal(*maxReconcileRate), | ||
| PollInterval: *pollInterval, | ||
| MaxConcurrentReconciles: *maxReconcileRate, | ||
|
There was a problem hiding this comment. Should we have separate parameters for the max reconcile rate (which is a global rate shared between all reconcilers) and the max concurrent reconciles (which is a count of workers consuming the workqueue of a controller)? There was a problem hiding this comment. Thanks for the pointer @turkenh. I agree, we had better follow the convention suggested there. |
||
| Features: &feature.Flags{}, | ||
| }, | ||
| Provider: config.GetProvider(), | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we increasing the poll interval from 1m to 10m?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the proposed value after my experiments in crossplane/upjet#116 (comment) with the motivation below:
In upjet based controllers a typical reconcile loop tooks longer than a native provider due to underlying implementation. If we go with a polling interval like
1m, we immediately cause the work queue to fill up especially when there are multiple instances of the same kind. I believe it is more reasonable to default to a higher value if a typical reconcile loop takes is in the order of ~10s (i.e. refresh/plan).