Documentation
¶
Index ¶
- Constants
- func DefaultIgnoredResources() map[schema.GroupResource]struct{}
- func GetDeletableResources(logger klog.Logger, discoveryClient discovery.ServerResourcesInterface) (map[schema.GroupVersionResource]struct{}, error)
- func NewDOTVertex(node *node) *dotVertex
- func NewDebugHandler(controller *GarbageCollector) http.Handler
- func NewMissingdotVertex(ownerRef metav1.OwnerReference) *dotVertex
- type GarbageCollector
- func (gc *GarbageCollector) DebuggingHandler() http.Handler
- func (gc *GarbageCollector) GraphHasUID(u types.UID) bool
- func (gc *GarbageCollector) IsSynced(logger klog.Logger) bool
- func (gc *GarbageCollector) Name() string
- func (gc *GarbageCollector) Run(ctx context.Context, workers int)
- func (gc *GarbageCollector) Sync(ctx context.Context, discoveryClient discovery.ServerResourcesInterface, ...)
- type GraphBuilder
- type ObjectMetaForFinalizersPatch
- type ObjectMetaForPatch
- type ReferenceCache
Constants ¶
const ResourceResyncTime time.Duration = 0
ResourceResyncTime defines the resync period of the garbage collector's informers.
Variables ¶
This section is empty.
Functions ¶
func DefaultIgnoredResources ¶ added in v1.7.0
func DefaultIgnoredResources() map[schema.GroupResource]struct{}
DefaultIgnoredResources returns the default set of resources that the garbage collector controller should ignore. This is exposed so downstream integrators can have access to the defaults, and add to them as necessary when constructing the controller.
func GetDeletableResources ¶ added in v1.8.0
func GetDeletableResources(logger klog.Logger, discoveryClient discovery.ServerResourcesInterface) (map[schema.GroupVersionResource]struct{}, error)
GetDeletableResources returns all resources from discoveryClient that the garbage collector should recognize and work with. More specifically, all preferred resources which support the 'delete', 'list', and 'watch' verbs.
If an error was encountered fetching resources from the server, it is included as well, along with any resources that were successfully resolved.
All discovery errors are considered temporary. Upon encountering any error, GetDeletableResources will log and return any discovered resources it was able to process (which may be none).
func NewDOTVertex ¶ added in v1.26.0
func NewDOTVertex(node *node) *dotVertex
NewDOTVertex creates a new dotVertex.
func NewDebugHandler ¶ added in v1.12.0
func NewDebugHandler(controller *GarbageCollector) http.Handler
NewDebugHandler creates a new debugHTTPHandler.
func NewMissingdotVertex ¶ added in v1.26.0
func NewMissingdotVertex(ownerRef metav1.OwnerReference) *dotVertex
NewMissingdotVertex creates a new dotVertex.
Types ¶
type GarbageCollector ¶
type GarbageCollector struct {
// contains filtered or unexported fields
}
GarbageCollector runs reflectors to watch for changes of managed API objects, funnels the results to a single-threaded dependencyGraphBuilder, which builds a graph caching the dependencies among objects. Triggered by the graph changes, the dependencyGraphBuilder enqueues objects that can potentially be garbage-collected to the `attemptToDelete` queue, and enqueues objects whose dependents need to be orphaned to the `attemptToOrphan` queue. The GarbageCollector has workers who consume these two queues, send requests to the API server to delete/update the objects accordingly. Note that having the dependencyGraphBuilder notify the garbage collector ensures that the garbage collector operates with a graph that is at least as up to date as the notification is sent.
func NewGarbageCollector ¶
func NewGarbageCollector( kubeClient clientset.Interface, metadataClient metadata.Interface, mapper meta.ResettableRESTMapper, ignoredResources map[schema.GroupResource]struct{}, sharedInformers informerfactory.InformerFactory, informersStarted <-chan struct{}, ) (*GarbageCollector, error)
NewGarbageCollector creates a new GarbageCollector.
func (*GarbageCollector) DebuggingHandler ¶ added in v1.23.0
func (gc *GarbageCollector) DebuggingHandler() http.Handler
func (*GarbageCollector) GraphHasUID ¶
func (gc *GarbageCollector) GraphHasUID(u types.UID) bool
*FOR TEST USE ONLY* GraphHasUID returns if the GraphBuilder has a particular UID store in its uidToNode graph. It's useful for debugging. This method is used by integration tests.
func (*GarbageCollector) IsSynced ¶ added in v1.8.0
func (gc *GarbageCollector) IsSynced(logger klog.Logger) bool
IsSynced returns true if dependencyGraphBuilder is synced.
func (*GarbageCollector) Name ¶ added in v1.23.0
func (gc *GarbageCollector) Name() string
func (*GarbageCollector) Run ¶
func (gc *GarbageCollector) Run(ctx context.Context, workers int)
Run starts garbage collector workers.
func (*GarbageCollector) Sync ¶ added in v1.8.0
func (gc *GarbageCollector) Sync(ctx context.Context, discoveryClient discovery.ServerResourcesInterface, period time.Duration)
Sync periodically resyncs the garbage collector when new resources are observed from discovery. When new resources are detected, Sync will stop all GC workers, reset gc.restMapper, and resync the monitors.
Note that discoveryClient should NOT be shared with gc.restMapper, otherwise the mapper's underlying discovery client will be unnecessarily reset during the course of detecting new resources.
type GraphBuilder ¶ added in v1.6.0
type GraphBuilder struct {
// contains filtered or unexported fields
}
GraphBuilder processes events supplied by the informers, updates uidToNode, a graph that caches the dependencies as we know, and enqueues items to the attemptToDelete and attemptToOrphan.
func (*GraphBuilder) IsResourceSynced ¶ added in v1.29.0
func (gb *GraphBuilder) IsResourceSynced(resource schema.GroupVersionResource) bool
IsResourceSynced returns true if a monitor exists for the given resource and has synced
func (*GraphBuilder) IsSynced ¶ added in v1.8.0
func (gb *GraphBuilder) IsSynced(logger klog.Logger) bool
IsSynced returns true if any monitors exist AND all those monitors' controllers HasSynced functions return true. This means IsSynced could return true at one time, and then later return false if all monitors were reconstructed.
func (*GraphBuilder) Run ¶ added in v1.6.0
func (gb *GraphBuilder) Run(ctx context.Context)
Run sets the stop channel and starts monitor execution until stopCh is closed. Any running monitors will be stopped before Run returns.
type ObjectMetaForFinalizersPatch ¶ added in v1.16.0
type ObjectMetaForFinalizersPatch struct {
ResourceVersion string `json:"resourceVersion"`
Finalizers []string `json:"finalizers"`
}
ObjectMetaForFinalizersPatch defines object meta struct for finalizers patch operation.
type ObjectMetaForPatch ¶ added in v1.11.0
type ObjectMetaForPatch struct {
ResourceVersion string `json:"resourceVersion"`
OwnerReferences []metav1.OwnerReference `json:"ownerReferences"`
}
ObjectMetaForPatch defines object meta struct for patch operation.
type ReferenceCache ¶ added in v1.20.0
type ReferenceCache struct {
// contains filtered or unexported fields
}
ReferenceCache is an LRU cache for uid.
func NewReferenceCache ¶ added in v1.20.0
func NewReferenceCache(maxCacheEntries int) *ReferenceCache
NewReferenceCache returns a ReferenceCache.
func (*ReferenceCache) Add ¶ added in v1.20.0
func (c *ReferenceCache) Add(reference objectReference)
Add adds a uid to the cache.
func (*ReferenceCache) Has ¶ added in v1.20.0
func (c *ReferenceCache) Has(reference objectReference) bool
Has returns if a uid is in the cache.
Source Files
Directories