Skip to content

📖 Docs for SyncPeriod: No sync from api-server. #3277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions pkg/cache/cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,10 @@ type Options struct {
Mapper meta.RESTMapper

// SyncPeriod determines the minimum frequency at which watched resources are
// reconciled. A lower period will correct entropy more quickly, but reduce
// reconciled. It causes all resources in the local cache to be re-enqueued
// for reconciliation, even if there are no new events. It does
// not sync between the api-server and the local cache.
// A lower period will correct entropy more quickly, but reduce
// responsiveness to change if there are many watched resources. Change this
// value only if you know what you are doing. Defaults to 10 hours if unset.
// there will a 10 percent jitter between the SyncPeriod of all controllers
Expand All @@ -174,8 +177,8 @@ type Options struct {
// instead of `reconcile.Result{}`.
//
// SyncPeriod will trigger update events with the old object being equal to the new
// object, except when the cache was out of sync.
// If you filter update events like this:
// object. If you filter update events like this:
//
// Controller.Watch(
// &source.Kind{Type: v1.MyCustomKind},
// &handler.EnqueueRequestForObject{},
Expand Down