forked from kubernetes/kubernetes
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add apiserver lease garbage collector
- Loading branch information
Showing
2 changed files
with
152 additions
and
1 deletion.
There are no files selected for viewing
135 changes: 135 additions & 0 deletions
135
pkg/controlplane/controller/apiserverleasegc/gc_controller.go
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 |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| /* | ||
| Copyright 2020 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package apiserverleasegc | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| v1 "k8s.io/api/coordination/v1" | ||
| "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/labels" | ||
| utilruntime "k8s.io/apimachinery/pkg/util/runtime" | ||
| "k8s.io/apimachinery/pkg/util/wait" | ||
| informers "k8s.io/client-go/informers/coordination/v1" | ||
| "k8s.io/client-go/kubernetes" | ||
| listers "k8s.io/client-go/listers/coordination/v1" | ||
| "k8s.io/client-go/tools/cache" | ||
|
|
||
| "k8s.io/klog/v2" | ||
| ) | ||
|
|
||
| // Controller deletes expired apiserver leases. | ||
| type Controller struct { | ||
| kubeclientset kubernetes.Interface | ||
|
|
||
| leaseLister listers.LeaseLister | ||
| leaseInformer cache.SharedIndexInformer | ||
| leasesSynced cache.InformerSynced | ||
|
|
||
| leaseNamespace string | ||
|
|
||
| gcCheckPeriod time.Duration | ||
| } | ||
|
|
||
| // NewAPIServerLeaseGC creates a new Controller. | ||
| func NewAPIServerLeaseGC(clientset kubernetes.Interface, gcCheckPeriod time.Duration, leaseNamespace, leaseLabelSelector string) *Controller { | ||
| // we construct our own informer because we need such a small subset of the information available. | ||
| // Just one namespace with label selection. | ||
| leaseInformer := informers.NewFilteredLeaseInformer( | ||
| clientset, | ||
| leaseNamespace, | ||
| 0, | ||
| cache.Indexers{cache.NamespaceIndex: cache.MetaNamespaceIndexFunc}, | ||
| func(listOptions *metav1.ListOptions) { | ||
| listOptions.LabelSelector = leaseLabelSelector | ||
| }) | ||
| return &Controller{ | ||
| kubeclientset: clientset, | ||
| leaseLister: listers.NewLeaseLister(leaseInformer.GetIndexer()), | ||
| leaseInformer: leaseInformer, | ||
| leasesSynced: leaseInformer.HasSynced, | ||
| leaseNamespace: leaseNamespace, | ||
| gcCheckPeriod: gcCheckPeriod, | ||
| } | ||
| } | ||
|
|
||
| // Run starts one worker. | ||
| func (c *Controller) Run(stopCh <-chan struct{}) { | ||
| defer utilruntime.HandleCrash() | ||
| defer klog.Infof("Shutting down apiserver lease garbage collector") | ||
|
|
||
| klog.Infof("Starting apiserver lease garbage collector") | ||
|
|
||
| // we have a personal informer that is narrowly scoped, start it. | ||
| go c.leaseInformer.Run(stopCh) | ||
|
|
||
| if !cache.WaitForCacheSync(stopCh, c.leasesSynced) { | ||
| utilruntime.HandleError(fmt.Errorf("timed out waiting for caches to sync")) | ||
| return | ||
| } | ||
|
|
||
| go wait.Until(c.gc, c.gcCheckPeriod, stopCh) | ||
|
|
||
| <-stopCh | ||
| } | ||
|
|
||
| func (c *Controller) gc() { | ||
| leases, err := c.leaseLister.Leases(c.leaseNamespace).List(labels.Everything()) | ||
| if err != nil { | ||
| klog.Errorf("Error while listing apiserver leases: %v", err) | ||
| return | ||
| } | ||
| for _, lease := range leases { | ||
| // evaluate lease from cache | ||
| if !isLeaseExpired(lease) { | ||
| continue | ||
| } | ||
| // double check latest lease from apiserver before deleting | ||
| lease, err := c.kubeclientset.CoordinationV1().Leases(c.leaseNamespace).Get(context.TODO(), lease.Name, metav1.GetOptions{}) | ||
| if err != nil && !errors.IsNotFound(err) { | ||
| klog.Errorf("Error getting lease: %v", err) | ||
| continue | ||
| } | ||
| if errors.IsNotFound(err) || lease == nil { | ||
| // the lease was deleted by the same GC controller in another apiserver | ||
| continue | ||
| } | ||
| // evaluate lease from apiserver | ||
| if !isLeaseExpired(lease) { | ||
| continue | ||
| } | ||
| if err := c.kubeclientset.CoordinationV1().Leases(c.leaseNamespace).Delete( | ||
| context.TODO(), lease.Name, metav1.DeleteOptions{}); err != nil && !errors.IsNotFound(err) { | ||
| // If we get a 404, the lease was deleted by the same GC controller | ||
| // in another apiserver. Only log error if we get something other than 404. | ||
| klog.Errorf("Error deleting lease: %v", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func isLeaseExpired(lease *v1.Lease) bool { | ||
| currentTime := time.Now() | ||
| // Leases created by the apiserver lease controller should have non-nil renew time | ||
| // and lease duration set. Leases without these fields set are invalid and should | ||
| // be GC'ed. | ||
| return lease.Spec.RenewTime == nil || | ||
| lease.Spec.LeaseDurationSeconds == nil || | ||
| lease.Spec.RenewTime.Add(time.Duration(*lease.Spec.LeaseDurationSeconds)*time.Second).Before(currentTime) | ||
| } |
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