/
add.go
106 lines (91 loc) · 3.86 KB
/
add.go
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
// Copyright (c) 2021 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 garbagecollector
import (
"fmt"
"time"
"github.com/spf13/pflag"
"k8s.io/apimachinery/pkg/util/clock"
"k8s.io/client-go/util/workqueue"
"sigs.k8s.io/controller-runtime/pkg/cluster"
crcontroller "sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
// ControllerName is the name of the controller.
const ControllerName = "garbage_collector"
// defaultControllerConfig is the default config for the controller.
var defaultControllerConfig ControllerConfig
// ControllerOptions are options for adding the controller to a Manager.
type ControllerOptions struct {
syncPeriod time.Duration
}
// ControllerConfig is the completed configuration for the controller.
type ControllerConfig struct {
// SyncPeriod is the period how often the controller should check whether garbage can be collected.
SyncPeriod time.Duration
// TargetCluster is the target cluster.
TargetCluster cluster.Cluster
// MinimumObjectLifetime is the duration how long an object must exist before the garbage collector considers it.
MinimumObjectLifetime time.Duration
}
// AddToManagerWithOptions adds the controller to a Manager with the given config.
func AddToManagerWithOptions(mgr manager.Manager, conf ControllerConfig) error {
if conf.SyncPeriod <= 0 {
return nil
}
ctrl, err := crcontroller.New(ControllerName, mgr, crcontroller.Options{
MaxConcurrentReconciles: 1,
Reconciler: &reconciler{
clock: clock.RealClock{},
syncPeriod: conf.SyncPeriod,
targetReader: conf.TargetCluster.GetAPIReader(),
targetWriter: conf.TargetCluster.GetClient(),
minimumObjectLifetime: conf.MinimumObjectLifetime,
},
RecoverPanic: true,
})
if err != nil {
return fmt.Errorf("unable to set up gc controller: %w", err)
}
eventChannel := make(chan event.GenericEvent, 1)
eventChannel <- event.GenericEvent{}
return ctrl.Watch(
&source.Channel{Source: eventChannel},
&handler.Funcs{GenericFunc: func(_ event.GenericEvent, q workqueue.RateLimitingInterface) { q.Add(reconcile.Request{}) }},
)
}
// AddToManager adds the controller to a Manager using the default config.
func AddToManager(mgr manager.Manager) error {
return AddToManagerWithOptions(mgr, defaultControllerConfig)
}
// AddFlags adds the needed command line flags to the given FlagSet.
func (o *ControllerOptions) AddFlags(fs *pflag.FlagSet) {
fs.DurationVar(&o.syncPeriod, "garbage-collector-sync-period", 0, "duration how often the garbage collection should be performed (default: 0, i.e., gc is disabled)")
}
// Complete completes the given command line flags and set the defaultControllerConfig accordingly.
func (o *ControllerOptions) Complete() error {
defaultControllerConfig = ControllerConfig{
SyncPeriod: o.syncPeriod,
MinimumObjectLifetime: 10 * time.Minute,
}
return nil
}
// Completed returns the completed ControllerConfig.
func (o *ControllerOptions) Completed() *ControllerConfig {
return &defaultControllerConfig
}