File: gc_controller.go

package info (click to toggle)
golang-k8s-sigs-apiserver-network-proxy 0.33.0%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,068 kB
  • sloc: makefile: 220; sh: 118
file content (110 lines) | stat: -rw-r--r-- 3,635 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
Copyright 2024 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 leases

import (
	"context"
	"errors"
	"time"

	apierrors "k8s.io/apimachinery/pkg/api/errors"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/util/wait"
	"k8s.io/client-go/kubernetes"
	coordinationv1 "k8s.io/client-go/kubernetes/typed/coordination/v1"
	"k8s.io/klog/v2"
	"k8s.io/utils/clock"
	"sigs.k8s.io/apiserver-network-proxy/pkg/server/metrics"
	"sigs.k8s.io/apiserver-network-proxy/pkg/util"
)

type GarbageCollectionController struct {
	leaseInterface coordinationv1.LeaseInterface

	labelSelector string
	gcCheckPeriod time.Duration

	pc clock.PassiveClock
}

func NewGarbageCollectionController(pc clock.PassiveClock, k8sclient kubernetes.Interface, namespace string, gcCheckPeriod time.Duration, leaseSelector string) *GarbageCollectionController {
	return &GarbageCollectionController{
		leaseInterface: k8sclient.CoordinationV1().Leases(namespace),
		gcCheckPeriod:  gcCheckPeriod,
		labelSelector:  leaseSelector,
		pc:             pc,
	}
}

func (c *GarbageCollectionController) Run(ctx context.Context) {
	wait.UntilWithContext(ctx, c.gc, c.gcCheckPeriod)
}

func (c *GarbageCollectionController) gc(ctx context.Context) {
	start := time.Now()
	leases, err := c.leaseInterface.List(ctx, metav1.ListOptions{LabelSelector: c.labelSelector})
	latency := time.Now().Sub(start)
	if err != nil {
		klog.Errorf("Could not list leases to garbage collect: %v", err)

		var apiStatus apierrors.APIStatus
		if errors.As(err, &apiStatus) {
			status := apiStatus.Status()
			metrics.Metrics.ObserveLeaseList(int(status.Code), string(status.Reason))
			metrics.Metrics.ObserveLeaseListLatency(int(status.Code), latency)
		} else {
			klog.Errorf("Lease list error could not be logged to metrics as it is not an APIStatus: %v", err)
		}

		return
	}
	metrics.Metrics.ObserveLeaseList(200, "")
	metrics.Metrics.ObserveLeaseListLatency(200, latency)

	for _, lease := range leases.Items {
		if util.IsLeaseValid(c.pc, lease) {
			continue
		}

		// Optimistic concurrency: if a lease has a different resourceVersion than
		// when we got it, it may have been renewed.
		start := time.Now()
		err := c.leaseInterface.Delete(ctx, lease.Name, *metav1.NewRVDeletionPrecondition(lease.ResourceVersion))
		if apierrors.IsNotFound(err) {
			klog.V(4).Infof("Lease %v was already deleted", lease.Name)
		} else if err != nil {
			klog.Errorf("Could not delete lease %v: %v", lease.Name, err)
		} else {
			metrics.Metrics.CulledLeasesInc()
		}

		// Log metrics for the deletion call.
		latency := time.Now().Sub(start)
		if err != nil {
			var apiStatus apierrors.APIStatus
			if errors.As(err, &apiStatus) {
				status := apiStatus.Status()
				metrics.Metrics.ObserveLeaseDelete(int(status.Code), string(status.Reason))
				metrics.Metrics.ObserveLeaseDeleteLatency(int(status.Code), latency)
			} else {
				klog.Errorf("Lease delete error could not be logged to metrics as it is not an APIStatus: %v", err)
			}
		} else {
			metrics.Metrics.ObserveLeaseDelete(200, "")
			metrics.Metrics.ObserveLeaseDeleteLatency(200, latency)
		}
	}
}