-
Notifications
You must be signed in to change notification settings - Fork 51
/
base_controller.go
332 lines (287 loc) · 11.5 KB
/
base_controller.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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
package controllers
import (
"context"
"fmt"
"net/http"
v1 "k8s.io/api/core/v1"
"k8s.io/client-go/tools/record"
"github.com/SAP/sap-btp-service-operator/client/sm"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
ctrl "sigs.k8s.io/controller-runtime"
"k8s.io/apimachinery/pkg/api/meta"
apimachinerytypes "k8s.io/apimachinery/pkg/types"
smTypes "github.com/Peripli/service-manager/pkg/types"
servicesv1alpha1 "github.com/SAP/sap-btp-service-operator/api/v1alpha1"
"github.com/SAP/sap-btp-service-operator/internal/config"
"github.com/SAP/sap-btp-service-operator/internal/secrets"
"github.com/go-logr/logr"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
)
const (
namespaceLabel = "_namespace"
k8sNameLabel = "_k8sname"
clusterIDLabel = "_clusterid"
Created = "Created"
Updated = "Updated"
Deleted = "Deleted"
Finished = "Finished"
CreateInProgress = "CreateInProgress"
UpdateInProgress = "UpdateInProgress"
DeleteInProgress = "DeleteInProgress"
InProgress = "InProgress"
CreateFailed = "CreateFailed"
UpdateFailed = "UpdateFailed"
DeleteFailed = "DeleteFailed"
Failed = "Failed"
Blocked = "Blocked"
Unknown = "Unknown"
)
type BaseReconciler struct {
client.Client
Log logr.Logger
Scheme *runtime.Scheme
SMClient func() sm.Client
Config config.Config
SecretResolver *secrets.SecretResolver
Recorder record.EventRecorder
}
func (r *BaseReconciler) getSMClient(ctx context.Context, object servicesv1alpha1.SAPBTPResource, log logr.Logger) (sm.Client, error) {
if r.SMClient != nil {
return r.SMClient(), nil
}
secret, err := r.SecretResolver.GetSecretForResource(ctx, object.GetNamespace(), secrets.SAPBTPOperatorSecretName)
if err != nil {
return nil, err
}
secretData := secret.Data
cfg := &sm.ClientConfig{
ClientID: string(secretData["clientid"]),
ClientSecret: string(secretData["clientsecret"]),
URL: string(secretData["url"]),
TokenURL: string(secretData["tokenurl"]),
TokenURLSuffix: string(secretData["tokenurlsuffix"]),
SSLDisabled: false,
}
tls, err := r.SecretResolver.GetSecretForResource(ctx, object.GetNamespace(), secrets.SAPBTPOperatorTLSSecretName)
if client.IgnoreNotFound(err) != nil {
return nil, err
}
if tls != nil {
cfg.TLSCertKey = string(tls.Data[v1.TLSCertKey])
cfg.TLSPrivateKey = string(tls.Data[v1.TLSPrivateKeyKey])
log.Info("found tls configuration", "client", cfg.ClientID)
}
cl, err := sm.NewClient(ctx, cfg, nil)
return cl, err
}
func (r *BaseReconciler) removeFinalizer(ctx context.Context, object servicesv1alpha1.SAPBTPResource, finalizerName string, log logr.Logger) error {
if controllerutil.ContainsFinalizer(object, finalizerName) {
controllerutil.RemoveFinalizer(object, finalizerName)
if err := r.Update(ctx, object); err != nil {
if err := r.Get(ctx, apimachinerytypes.NamespacedName{Name: object.GetName(), Namespace: object.GetNamespace()}, object); err != nil {
return client.IgnoreNotFound(err)
}
controllerutil.RemoveFinalizer(object, finalizerName)
if err := r.Update(ctx, object); err != nil {
return fmt.Errorf("failed to remove the finalizer '%s'. Error: %v", finalizerName, err)
}
}
log.Info(fmt.Sprintf("removed finalizer %s from %s", finalizerName, object.GetControllerName()))
return nil
}
return nil
}
func (r *BaseReconciler) updateStatus(ctx context.Context, object servicesv1alpha1.SAPBTPResource) error {
return r.Status().Update(ctx, object)
}
func (r *BaseReconciler) init(ctx context.Context, obj servicesv1alpha1.SAPBTPResource) error {
obj.SetReady(metav1.ConditionFalse)
setInProgressConditions(smTypes.CREATE, "Pending", obj)
if err := r.updateStatus(ctx, obj); err != nil {
return err
}
return nil
}
func getConditionReason(opType smTypes.OperationCategory, state smTypes.OperationState) string {
switch state {
case smTypes.SUCCEEDED:
if opType == smTypes.CREATE {
return Created
} else if opType == smTypes.UPDATE {
return Updated
} else if opType == smTypes.DELETE {
return Deleted
} else {
return Finished
}
case smTypes.IN_PROGRESS, smTypes.PENDING:
if opType == smTypes.CREATE {
return CreateInProgress
} else if opType == smTypes.UPDATE {
return UpdateInProgress
} else if opType == smTypes.DELETE {
return DeleteInProgress
} else {
return InProgress
}
case smTypes.FAILED:
if opType == smTypes.CREATE {
return CreateFailed
} else if opType == smTypes.UPDATE {
return UpdateFailed
} else if opType == smTypes.DELETE {
return DeleteFailed
} else {
return Failed
}
}
return Unknown
}
func setInProgressConditions(operationType smTypes.OperationCategory, message string, object servicesv1alpha1.SAPBTPResource) {
if len(message) == 0 {
if operationType == smTypes.CREATE {
message = fmt.Sprintf("%s is being created", object.GetControllerName())
} else if operationType == smTypes.UPDATE {
message = fmt.Sprintf("%s is being updated", object.GetControllerName())
} else if operationType == smTypes.DELETE {
message = fmt.Sprintf("%s is being deleted", object.GetControllerName())
}
}
conditions := object.GetConditions()
if len(conditions) > 0 {
meta.RemoveStatusCondition(&conditions, servicesv1alpha1.ConditionFailed)
}
lastOpCondition := metav1.Condition{
Type: servicesv1alpha1.ConditionSucceeded,
Status: metav1.ConditionFalse,
Reason: getConditionReason(operationType, smTypes.IN_PROGRESS),
Message: message,
ObservedGeneration: object.GetGeneration(),
}
meta.SetStatusCondition(&conditions, lastOpCondition)
meta.SetStatusCondition(&conditions, getReadyCondition(object))
object.SetConditions(conditions)
}
func setSuccessConditions(operationType smTypes.OperationCategory, object servicesv1alpha1.SAPBTPResource) {
var message string
if operationType == smTypes.CREATE {
message = fmt.Sprintf("%s provisioned successfully", object.GetControllerName())
} else if operationType == smTypes.UPDATE {
message = fmt.Sprintf("%s updated successfully", object.GetControllerName())
} else if operationType == smTypes.DELETE {
message = fmt.Sprintf("%s deleted successfully", object.GetControllerName())
}
conditions := object.GetConditions()
if len(conditions) > 0 {
meta.RemoveStatusCondition(&conditions, servicesv1alpha1.ConditionFailed)
}
lastOpCondition := metav1.Condition{
Type: servicesv1alpha1.ConditionSucceeded,
Status: metav1.ConditionTrue,
Reason: getConditionReason(operationType, smTypes.SUCCEEDED),
Message: message,
ObservedGeneration: object.GetGeneration(),
}
meta.SetStatusCondition(&conditions, lastOpCondition)
meta.SetStatusCondition(&conditions, getReadyCondition(object))
object.SetConditions(conditions)
}
func setFailureConditions(operationType smTypes.OperationCategory, errorMessage string, object servicesv1alpha1.SAPBTPResource) {
var message string
if operationType == smTypes.CREATE {
message = fmt.Sprintf("%s create failed: %s", object.GetControllerName(), errorMessage)
} else if operationType == smTypes.UPDATE {
message = fmt.Sprintf("%s update failed: %s", object.GetControllerName(), errorMessage)
} else if operationType == smTypes.DELETE {
message = fmt.Sprintf("%s deletion failed: %s", object.GetControllerName(), errorMessage)
}
var reason string
if operationType != Unknown {
reason = getConditionReason(operationType, smTypes.FAILED)
} else {
reason = object.GetConditions()[0].Reason
}
conditions := object.GetConditions()
lastOpCondition := metav1.Condition{
Type: servicesv1alpha1.ConditionSucceeded,
Status: metav1.ConditionFalse,
Reason: reason,
Message: message,
ObservedGeneration: object.GetGeneration(),
}
meta.SetStatusCondition(&conditions, lastOpCondition)
failedCondition := metav1.Condition{
Type: servicesv1alpha1.ConditionFailed,
Status: metav1.ConditionTrue,
Reason: reason,
Message: message,
ObservedGeneration: object.GetGeneration(),
}
meta.SetStatusCondition(&conditions, failedCondition)
meta.SetStatusCondition(&conditions, getReadyCondition(object))
object.SetConditions(conditions)
}
//blocked condition marks to the user that action from his side is required, this is considered as in progress operation
func setBlockedCondition(message string, object servicesv1alpha1.SAPBTPResource) {
setInProgressConditions(Unknown, message, object)
lastOpCondition := meta.FindStatusCondition(object.GetConditions(), servicesv1alpha1.ConditionSucceeded)
lastOpCondition.Reason = Blocked
}
func isDelete(object metav1.ObjectMeta) bool {
return !object.DeletionTimestamp.IsZero()
}
func isTransientError(err error, log logr.Logger) bool {
if smError, ok := err.(*sm.ServiceManagerError); ok {
log.Info(fmt.Sprintf("SM returned error status code %d", smError.StatusCode))
return smError.StatusCode == http.StatusTooManyRequests || smError.StatusCode == http.StatusServiceUnavailable || smError.StatusCode == http.StatusGatewayTimeout || smError.StatusCode == http.StatusNotFound
}
return false
}
func (r *BaseReconciler) markAsNonTransientError(ctx context.Context, operationType smTypes.OperationCategory, nonTransientErr error, object servicesv1alpha1.SAPBTPResource, log logr.Logger) (ctrl.Result, error) {
setFailureConditions(operationType, nonTransientErr.Error(), object)
if operationType != smTypes.DELETE {
log.Info(fmt.Sprintf("operation %s of %s encountered a non transient error %s, giving up operation :(", operationType, object.GetControllerName(), nonTransientErr.Error()))
}
object.SetObservedGeneration(object.GetGeneration())
err := r.updateStatus(ctx, object)
if err != nil {
return ctrl.Result{}, err
}
if operationType == smTypes.DELETE {
return ctrl.Result{}, nonTransientErr
}
return ctrl.Result{}, nil
}
func (r *BaseReconciler) markAsTransientError(ctx context.Context, operationType smTypes.OperationCategory, transientErr error, object servicesv1alpha1.SAPBTPResource, log logr.Logger) (ctrl.Result, error) {
setInProgressConditions(operationType, transientErr.Error(), object)
log.Info(fmt.Sprintf("operation %s of %s encountered a transient error %s, retrying operation :)", operationType, object.GetControllerName(), transientErr.Error()))
if err := r.updateStatus(ctx, object); err != nil {
return ctrl.Result{}, err
}
return ctrl.Result{}, transientErr
}
func isInProgress(object servicesv1alpha1.SAPBTPResource) bool {
conditions := object.GetConditions()
return meta.IsStatusConditionPresentAndEqual(conditions, servicesv1alpha1.ConditionSucceeded, metav1.ConditionFalse) &&
!meta.IsStatusConditionPresentAndEqual(conditions, servicesv1alpha1.ConditionFailed, metav1.ConditionTrue)
}
func isFailed(resource servicesv1alpha1.SAPBTPResource) bool {
if len(resource.GetConditions()) == 0 {
return false
}
return meta.IsStatusConditionPresentAndEqual(resource.GetConditions(), servicesv1alpha1.ConditionFailed, metav1.ConditionTrue) ||
(resource.GetConditions()[0].Status == metav1.ConditionFalse &&
resource.GetConditions()[0].Type == servicesv1alpha1.ConditionSucceeded &&
resource.GetConditions()[0].Reason == Blocked)
}
func getReadyCondition(object servicesv1alpha1.SAPBTPResource) metav1.Condition {
status := metav1.ConditionFalse
reason := "NotProvisioned"
if object.GetReady() == metav1.ConditionTrue {
status = metav1.ConditionTrue
reason = "Provisioned"
}
return metav1.Condition{Type: servicesv1alpha1.ConditionReady, Status: status, Reason: reason}
}