/
base.go
126 lines (108 loc) · 4.58 KB
/
base.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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
package controllers
import (
"context"
clabernetesconstants "github.com/srl-labs/clabernetes/constants"
claberneteslogging "github.com/srl-labs/clabernetes/logging"
clabernetesmanagertypes "github.com/srl-labs/clabernetes/manager/types"
clabernetesutil "github.com/srl-labs/clabernetes/util"
clabernetesutilkubernetes "github.com/srl-labs/clabernetes/util/kubernetes"
clientgorest "k8s.io/client-go/rest"
ctrlruntime "sigs.k8s.io/controller-runtime"
ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
)
// NewController defines a function that creates and returns a clabernetes Controller object.
type NewController func(
clabernetes clabernetesmanagertypes.Clabernetes,
) Controller
// Controller defines a clabernetes controller.
type Controller interface {
// SetupWithManager sets the given controller up with the controller-runtime manager.
SetupWithManager(mgr ctrlruntime.Manager) error
// Reconcile is the actual reconcile function of the controller.
Reconcile(
ctx context.Context,
req ctrlruntime.Request,
) (ctrlruntime.Result, error)
}
// NewBaseController returns a new BaseController object to embed in clabernetes controllers.
func NewBaseController(
ctx context.Context,
controllerName,
appName string,
config *clientgorest.Config,
client ctrlruntimeclient.Client,
) *BaseController {
logManager := claberneteslogging.GetManager()
logger := logManager.MustRegisterAndGetLogger(
controllerName,
clabernetesutil.GetEnvStrOrDefault(
clabernetesconstants.ControllerLoggerLevelEnv,
clabernetesconstants.Info,
),
)
logger.Info("creating controller instance")
return &BaseController{
Ctx: ctx,
AppName: appName,
ControllerNamespace: clabernetesutilkubernetes.MustCurrentNamespace(),
Log: logger,
Config: config,
Client: client,
}
}
// BaseController is the base clabernetes controller that is embedded in all clabernetes
// controllers, it provides common attributes for the controllers such as a log instance.
type BaseController struct {
// Ctx is the outer clabernetes context, controllers can use it to check if it is done, spawn
// new contexts from it, and pass it to other objects such as the messaging client.
Ctx context.Context
// AppName is the name of the clabernetes app (the helm release name).
AppName string
// ControllerNamespace is the namespace the controller is running in.
ControllerNamespace string
Log claberneteslogging.Instance
Config *clientgorest.Config
Client ctrlruntimeclient.Client
}
// LogReconcileStart is a convenience/consistency function to log the start of a reconcile event.
func (c *BaseController) LogReconcileStart(req ctrlruntime.Request) {
c.Log.Info("reconcile started")
c.Log.Debugf("reconcile request namespace/name: %s/%s", req.Namespace, req.Name)
}
// LogReconcileStartDelete is a convenience/consistency function to log the start of a *delete*
// reconcile event.
func (c *BaseController) LogReconcileStartDelete(_ ctrlruntime.Request) {
c.Log.Info("resource is deleting, handling deletion tasks")
}
// LogReconcileCompleteSuccess is a convenience/consistency function to log the successful
// completion of a reconcile.
func (c *BaseController) LogReconcileCompleteSuccess(_ ctrlruntime.Request) {
c.Log.Info("reconcile completed successfully")
}
// LogReconcileCompleteObjectNotExist is a convenience/consistency function to log the successful
// completion of a reconcile when an object doesn't exist anymore.
func (c *BaseController) LogReconcileCompleteObjectNotExist(_ ctrlruntime.Request) {
c.Log.Info("object no longer exists, reconcile completed successfully")
}
// LogReconcileFailedGettingObject is a convenience/consistency function to log an error on failure
// to get the object under reconciliation.
func (c *BaseController) LogReconcileFailedGettingObject(req ctrlruntime.Request, err error) {
c.Log.Criticalf("failed fetching '%s/%s', error: %s", req.Namespace, req.Name, err)
}
// ShouldIgnoreReconcile checks if the given object has the LabelIgnoreReconcile label, if so, it
// logs a message and returns true indicating the concrete controller should skip reconciling the
// object.
func (c *BaseController) ShouldIgnoreReconcile(obj ctrlruntimeclient.Object) bool {
objLabels := obj.GetLabels()
_, hasIgnoreReconcileLabel := objLabels[clabernetesconstants.LabelIgnoreReconcile]
if !hasIgnoreReconcileLabel {
return false
}
c.Log.Infof(
"%s/%s has %q label set, ignoring reconciliation",
obj.GetNamespace(),
obj.GetName(),
clabernetesconstants.LabelIgnoreReconcile,
)
return true
}