mirror of
				https://github.com/optim-enterprises-bv/kubernetes.git
				synced 2025-11-04 04:08:16 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			252 lines
		
	
	
		
			7.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			252 lines
		
	
	
		
			7.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
/*
 | 
						|
Copyright 2015 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 podgc
 | 
						|
 | 
						|
import (
 | 
						|
	"context"
 | 
						|
	"sort"
 | 
						|
	"sync"
 | 
						|
	"time"
 | 
						|
 | 
						|
	v1 "k8s.io/api/core/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/sets"
 | 
						|
	"k8s.io/apimachinery/pkg/util/wait"
 | 
						|
	coreinformers "k8s.io/client-go/informers/core/v1"
 | 
						|
	clientset "k8s.io/client-go/kubernetes"
 | 
						|
	corelisters "k8s.io/client-go/listers/core/v1"
 | 
						|
	"k8s.io/client-go/tools/cache"
 | 
						|
	"k8s.io/client-go/util/workqueue"
 | 
						|
	"k8s.io/component-base/metrics/prometheus/ratelimiter"
 | 
						|
 | 
						|
	"k8s.io/klog/v2"
 | 
						|
)
 | 
						|
 | 
						|
const (
 | 
						|
	// gcCheckPeriod defines frequency of running main controller loop
 | 
						|
	gcCheckPeriod = 20 * time.Second
 | 
						|
	// quarantineTime defines how long Orphaned GC waits for nodes to show up
 | 
						|
	// in an informer before issuing a GET call to check if they are truly gone
 | 
						|
	quarantineTime = 40 * time.Second
 | 
						|
)
 | 
						|
 | 
						|
type PodGCController struct {
 | 
						|
	kubeClient clientset.Interface
 | 
						|
 | 
						|
	podLister        corelisters.PodLister
 | 
						|
	podListerSynced  cache.InformerSynced
 | 
						|
	nodeLister       corelisters.NodeLister
 | 
						|
	nodeListerSynced cache.InformerSynced
 | 
						|
 | 
						|
	nodeQueue workqueue.DelayingInterface
 | 
						|
 | 
						|
	deletePod              func(namespace, name string) error
 | 
						|
	terminatedPodThreshold int
 | 
						|
}
 | 
						|
 | 
						|
func NewPodGC(ctx context.Context, kubeClient clientset.Interface, podInformer coreinformers.PodInformer,
 | 
						|
	nodeInformer coreinformers.NodeInformer, terminatedPodThreshold int) *PodGCController {
 | 
						|
	if kubeClient != nil && kubeClient.CoreV1().RESTClient().GetRateLimiter() != nil {
 | 
						|
		ratelimiter.RegisterMetricAndTrackRateLimiterUsage("gc_controller", kubeClient.CoreV1().RESTClient().GetRateLimiter())
 | 
						|
	}
 | 
						|
	gcc := &PodGCController{
 | 
						|
		kubeClient:             kubeClient,
 | 
						|
		terminatedPodThreshold: terminatedPodThreshold,
 | 
						|
		podLister:              podInformer.Lister(),
 | 
						|
		podListerSynced:        podInformer.Informer().HasSynced,
 | 
						|
		nodeLister:             nodeInformer.Lister(),
 | 
						|
		nodeListerSynced:       nodeInformer.Informer().HasSynced,
 | 
						|
		nodeQueue:              workqueue.NewNamedDelayingQueue("orphaned_pods_nodes"),
 | 
						|
		deletePod: func(namespace, name string) error {
 | 
						|
			klog.InfoS("PodGC is force deleting Pod", "pod", klog.KRef(namespace, name))
 | 
						|
			return kubeClient.CoreV1().Pods(namespace).Delete(ctx, name, *metav1.NewDeleteOptions(0))
 | 
						|
		},
 | 
						|
	}
 | 
						|
 | 
						|
	return gcc
 | 
						|
}
 | 
						|
 | 
						|
func (gcc *PodGCController) Run(ctx context.Context) {
 | 
						|
	defer utilruntime.HandleCrash()
 | 
						|
 | 
						|
	klog.Infof("Starting GC controller")
 | 
						|
	defer gcc.nodeQueue.ShutDown()
 | 
						|
	defer klog.Infof("Shutting down GC controller")
 | 
						|
 | 
						|
	if !cache.WaitForNamedCacheSync("GC", ctx.Done(), gcc.podListerSynced, gcc.nodeListerSynced) {
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	go wait.UntilWithContext(ctx, gcc.gc, gcCheckPeriod)
 | 
						|
 | 
						|
	<-ctx.Done()
 | 
						|
}
 | 
						|
 | 
						|
func (gcc *PodGCController) gc(ctx context.Context) {
 | 
						|
	pods, err := gcc.podLister.List(labels.Everything())
 | 
						|
	if err != nil {
 | 
						|
		klog.Errorf("Error while listing all pods: %v", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	nodes, err := gcc.nodeLister.List(labels.Everything())
 | 
						|
	if err != nil {
 | 
						|
		klog.Errorf("Error while listing all nodes: %v", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	if gcc.terminatedPodThreshold > 0 {
 | 
						|
		gcc.gcTerminated(pods)
 | 
						|
	}
 | 
						|
	gcc.gcOrphaned(ctx, pods, nodes)
 | 
						|
	gcc.gcUnscheduledTerminating(pods)
 | 
						|
}
 | 
						|
 | 
						|
func isPodTerminated(pod *v1.Pod) bool {
 | 
						|
	if phase := pod.Status.Phase; phase != v1.PodPending && phase != v1.PodRunning && phase != v1.PodUnknown {
 | 
						|
		return true
 | 
						|
	}
 | 
						|
	return false
 | 
						|
}
 | 
						|
 | 
						|
func (gcc *PodGCController) gcTerminated(pods []*v1.Pod) {
 | 
						|
	terminatedPods := []*v1.Pod{}
 | 
						|
	for _, pod := range pods {
 | 
						|
		if isPodTerminated(pod) {
 | 
						|
			terminatedPods = append(terminatedPods, pod)
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	terminatedPodCount := len(terminatedPods)
 | 
						|
	deleteCount := terminatedPodCount - gcc.terminatedPodThreshold
 | 
						|
 | 
						|
	if deleteCount <= 0 {
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	klog.InfoS("Garbage collecting pods", "numPods", deleteCount)
 | 
						|
	// sort only when necessary
 | 
						|
	sort.Sort(byCreationTimestamp(terminatedPods))
 | 
						|
	var wait sync.WaitGroup
 | 
						|
	for i := 0; i < deleteCount; i++ {
 | 
						|
		wait.Add(1)
 | 
						|
		go func(namespace string, name string) {
 | 
						|
			defer wait.Done()
 | 
						|
			if err := gcc.deletePod(namespace, name); err != nil {
 | 
						|
				// ignore not founds
 | 
						|
				defer utilruntime.HandleError(err)
 | 
						|
			}
 | 
						|
		}(terminatedPods[i].Namespace, terminatedPods[i].Name)
 | 
						|
	}
 | 
						|
	wait.Wait()
 | 
						|
}
 | 
						|
 | 
						|
// gcOrphaned deletes pods that are bound to nodes that don't exist.
 | 
						|
func (gcc *PodGCController) gcOrphaned(ctx context.Context, pods []*v1.Pod, nodes []*v1.Node) {
 | 
						|
	klog.V(4).Infof("GC'ing orphaned")
 | 
						|
	existingNodeNames := sets.NewString()
 | 
						|
	for _, node := range nodes {
 | 
						|
		existingNodeNames.Insert(node.Name)
 | 
						|
	}
 | 
						|
	// Add newly found unknown nodes to quarantine
 | 
						|
	for _, pod := range pods {
 | 
						|
		if pod.Spec.NodeName != "" && !existingNodeNames.Has(pod.Spec.NodeName) {
 | 
						|
			gcc.nodeQueue.AddAfter(pod.Spec.NodeName, quarantineTime)
 | 
						|
		}
 | 
						|
	}
 | 
						|
	// Check if nodes are still missing after quarantine period
 | 
						|
	deletedNodesNames, quit := gcc.discoverDeletedNodes(ctx, existingNodeNames)
 | 
						|
	if quit {
 | 
						|
		return
 | 
						|
	}
 | 
						|
	// Delete orphaned pods
 | 
						|
	for _, pod := range pods {
 | 
						|
		if !deletedNodesNames.Has(pod.Spec.NodeName) {
 | 
						|
			continue
 | 
						|
		}
 | 
						|
		klog.V(2).InfoS("Found orphaned Pod assigned to the Node, deleting.", "pod", klog.KObj(pod), "node", pod.Spec.NodeName)
 | 
						|
		if err := gcc.deletePod(pod.Namespace, pod.Name); err != nil {
 | 
						|
			utilruntime.HandleError(err)
 | 
						|
		} else {
 | 
						|
			klog.V(0).InfoS("Forced deletion of orphaned Pod succeeded", "pod", klog.KObj(pod))
 | 
						|
		}
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func (gcc *PodGCController) discoverDeletedNodes(ctx context.Context, existingNodeNames sets.String) (sets.String, bool) {
 | 
						|
	deletedNodesNames := sets.NewString()
 | 
						|
	for gcc.nodeQueue.Len() > 0 {
 | 
						|
		item, quit := gcc.nodeQueue.Get()
 | 
						|
		if quit {
 | 
						|
			return nil, true
 | 
						|
		}
 | 
						|
		nodeName := item.(string)
 | 
						|
		if !existingNodeNames.Has(nodeName) {
 | 
						|
			exists, err := gcc.checkIfNodeExists(ctx, nodeName)
 | 
						|
			switch {
 | 
						|
			case err != nil:
 | 
						|
				klog.ErrorS(err, "Error while getting node", "node", nodeName)
 | 
						|
				// Node will be added back to the queue in the subsequent loop if still needed
 | 
						|
			case !exists:
 | 
						|
				deletedNodesNames.Insert(nodeName)
 | 
						|
			}
 | 
						|
		}
 | 
						|
		gcc.nodeQueue.Done(item)
 | 
						|
	}
 | 
						|
	return deletedNodesNames, false
 | 
						|
}
 | 
						|
 | 
						|
func (gcc *PodGCController) checkIfNodeExists(ctx context.Context, name string) (bool, error) {
 | 
						|
	_, fetchErr := gcc.kubeClient.CoreV1().Nodes().Get(ctx, name, metav1.GetOptions{})
 | 
						|
	if errors.IsNotFound(fetchErr) {
 | 
						|
		return false, nil
 | 
						|
	}
 | 
						|
	return fetchErr == nil, fetchErr
 | 
						|
}
 | 
						|
 | 
						|
// gcUnscheduledTerminating deletes pods that are terminating and haven't been scheduled to a particular node.
 | 
						|
func (gcc *PodGCController) gcUnscheduledTerminating(pods []*v1.Pod) {
 | 
						|
	klog.V(4).Infof("GC'ing unscheduled pods which are terminating.")
 | 
						|
 | 
						|
	for _, pod := range pods {
 | 
						|
		if pod.DeletionTimestamp == nil || len(pod.Spec.NodeName) > 0 {
 | 
						|
			continue
 | 
						|
		}
 | 
						|
 | 
						|
		klog.V(2).InfoS("Found unscheduled terminating Pod not assigned to any Node, deleting.", "pod", klog.KObj(pod))
 | 
						|
		if err := gcc.deletePod(pod.Namespace, pod.Name); err != nil {
 | 
						|
			utilruntime.HandleError(err)
 | 
						|
		} else {
 | 
						|
			klog.V(0).InfoS("Forced deletion of unscheduled terminating Pod succeeded", "pod", klog.KObj(pod))
 | 
						|
		}
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
// byCreationTimestamp sorts a list by creation timestamp, using their names as a tie breaker.
 | 
						|
type byCreationTimestamp []*v1.Pod
 | 
						|
 | 
						|
func (o byCreationTimestamp) Len() int      { return len(o) }
 | 
						|
func (o byCreationTimestamp) Swap(i, j int) { o[i], o[j] = o[j], o[i] }
 | 
						|
 | 
						|
func (o byCreationTimestamp) Less(i, j int) bool {
 | 
						|
	if o[i].CreationTimestamp.Equal(&o[j].CreationTimestamp) {
 | 
						|
		return o[i].Name < o[j].Name
 | 
						|
	}
 | 
						|
	return o[i].CreationTimestamp.Before(&o[j].CreationTimestamp)
 | 
						|
}
 |