Skip to content

Commit

Permalink
Elaborate in which cases the client reads from a cache
Browse files Browse the repository at this point in the history
  • Loading branch information
fxierh committed Jan 11, 2024
1 parent 8dab940 commit f29ed4e
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions pkg/client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,18 @@ type CacheOptions struct {
type NewClientFunc func(config *rest.Config, options Options) (Client, error)

// New returns a new Client using the provided config and Options.
// The returned client reads from a local cache or directly from the API server,
// and writes are always performed directly on the API server.
// (read operations may use object caches, but write operations do not).
// It understands how to work with normal types (both custom resources
// and aggregated/built-in resources), as well as unstructured types.
//
// The client's read behavior is determined by Options.Cache.
// If either Options.Cache or Options.Cache.Reader is nil,
// the client reads directly from the API server.
// If both Options.Cache and Options.Cache.Reader are non-nil,
// the client reads from a local cache. However, specific
// resources can still be configured to bypass the cache based
// on Options.Cache.Unstructured and Options.Cache.DisableFor.
// Write operations are always performed directly on the API server.
//
// The client understands how to work with normal types (both custom resources
// and aggregated/built-in resources), as well as unstructured types.
// In the case of normal types, the scheme will be used to look up the
// corresponding group, version, and kind for the given type. In the
// case of unstructured types, the group, version, and kind will be extracted
Expand Down

0 comments on commit f29ed4e

Please sign in to comment.