/
instance_update.go
422 lines (372 loc) · 17.3 KB
/
instance_update.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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
package broker
import (
"context"
"encoding/json"
"fmt"
"net/http"
"strings"
"time"
"github.com/kyma-incubator/compass/components/director/pkg/jsonschema"
"github.com/kyma-project/control-plane/components/kyma-environment-broker/internal/euaccess"
"github.com/google/uuid"
"github.com/pivotal-cf/brokerapi/v8/domain"
"github.com/pivotal-cf/brokerapi/v8/domain/apiresponses"
"github.com/sirupsen/logrus"
"k8s.io/apimachinery/pkg/util/wait"
"github.com/kyma-project/control-plane/components/kyma-environment-broker/internal"
"github.com/kyma-project/control-plane/components/kyma-environment-broker/internal/dashboard"
"github.com/kyma-project/control-plane/components/kyma-environment-broker/internal/ptr"
"github.com/kyma-project/control-plane/components/kyma-environment-broker/internal/storage"
"github.com/kyma-project/control-plane/components/kyma-environment-broker/internal/storage/dberr"
)
type ContextUpdateHandler interface {
Handle(instance *internal.Instance, newCtx internal.ERSContext) (bool, error)
}
type UpdateEndpoint struct {
config Config
log logrus.FieldLogger
instanceStorage storage.Instances
runtimeStates storage.RuntimeStates
contextUpdateHandler ContextUpdateHandler
brokerURL string
processingEnabled bool
subAccountMovementEnabled bool
operationStorage storage.Operations
updatingQueue Queue
plansConfig PlansConfig
planDefaults PlanDefaults
dashboardConfig dashboard.Config
}
func NewUpdate(cfg Config,
instanceStorage storage.Instances,
runtimeStates storage.RuntimeStates,
operationStorage storage.Operations,
ctxUpdateHandler ContextUpdateHandler,
processingEnabled bool,
subAccountMovementEnabled bool,
queue Queue,
plansConfig PlansConfig,
planDefaults PlanDefaults,
log logrus.FieldLogger,
dashboardConfig dashboard.Config,
) *UpdateEndpoint {
return &UpdateEndpoint{
config: cfg,
log: log.WithField("service", "UpdateEndpoint"),
instanceStorage: instanceStorage,
runtimeStates: runtimeStates,
operationStorage: operationStorage,
contextUpdateHandler: ctxUpdateHandler,
processingEnabled: processingEnabled,
subAccountMovementEnabled: subAccountMovementEnabled,
updatingQueue: queue,
plansConfig: plansConfig,
planDefaults: planDefaults,
dashboardConfig: dashboardConfig,
}
}
// Update modifies an existing service instance
//
// PATCH /v2/service_instances/{instance_id}
func (b *UpdateEndpoint) Update(_ context.Context, instanceID string, details domain.UpdateDetails, asyncAllowed bool) (domain.UpdateServiceSpec, error) {
logger := b.log.WithField("instanceID", instanceID)
logger.Infof("Updating instanceID: %s", instanceID)
logger.Infof("Updating asyncAllowed: %v", asyncAllowed)
logger.Infof("Parameters: '%s'", string(details.RawParameters))
instance, err := b.instanceStorage.GetByID(instanceID)
if err != nil && dberr.IsNotFound(err) {
logger.Errorf("unable to get instance: %s", err.Error())
return domain.UpdateServiceSpec{}, apiresponses.NewFailureResponse(err, http.StatusNotFound, fmt.Sprintf("could not execute update for instanceID %s", instanceID))
} else if err != nil {
logger.Errorf("unable to get instance: %s", err.Error())
return domain.UpdateServiceSpec{}, fmt.Errorf("unable to get instance")
}
logger.Infof("Plan ID/Name: %s/%s", instance.ServicePlanID, PlanNamesMapping[instance.ServicePlanID])
var ersContext internal.ERSContext
err = json.Unmarshal(details.RawContext, &ersContext)
if err != nil {
logger.Errorf("unable to decode context: %s", err.Error())
return domain.UpdateServiceSpec{}, fmt.Errorf("unable to unmarshal context")
}
logger.Infof("Global account ID: %s active: %s", instance.GlobalAccountID, ptr.BoolAsString(ersContext.Active))
logger.Infof("Received context: %s", marshallRawContext(hideSensitiveDataFromRawContext(details.RawContext)))
// validation of incoming input
if err := b.validateWithJsonSchemaValidator(details, instance); err != nil {
return domain.UpdateServiceSpec{}, err
}
// If the param contains "expired" - then process expiration (save it in the instance)
instance, err = b.processExpirationParam(instance, details, ersContext, logger)
if err != nil {
logger.Errorf("Unable to update the instance: %s", err.Error())
return domain.UpdateServiceSpec{}, err
}
lastProvisioningOperation, err := b.operationStorage.GetProvisioningOperationByInstanceID(instance.InstanceID)
if err != nil {
logger.Errorf("cannot fetch provisioning lastProvisioningOperation for instance with ID: %s : %s", instance.InstanceID, err.Error())
return domain.UpdateServiceSpec{}, fmt.Errorf("unable to process the update")
}
if lastProvisioningOperation.State == domain.Failed {
return domain.UpdateServiceSpec{}, apiresponses.NewFailureResponse(fmt.Errorf("Unable to process an update of a failed instance"), http.StatusUnprocessableEntity, "")
}
lastDeprovisioningOperation, err := b.operationStorage.GetDeprovisioningOperationByInstanceID(instance.InstanceID)
if err != nil && !dberr.IsNotFound(err) {
logger.Errorf("cannot fetch deprovisioning for instance with ID: %s : %s", instance.InstanceID, err.Error())
return domain.UpdateServiceSpec{}, fmt.Errorf("unable to process the update")
}
if err == nil {
if !lastDeprovisioningOperation.Temporary {
// it is not a suspension, but real deprovisioning
logger.Warnf("Cannot process update, the instance has started deprovisioning process (operationID=%s)", lastDeprovisioningOperation.Operation.ID)
return domain.UpdateServiceSpec{}, apiresponses.NewFailureResponse(fmt.Errorf("Unable to process an update of a deprovisioned instance"), http.StatusUnprocessableEntity, "")
}
}
dashboardURL := instance.DashboardURL
if b.dashboardConfig.LandscapeURL != "" {
dashboardURL = fmt.Sprintf("%s/?kubeconfigID=%s", b.dashboardConfig.LandscapeURL, instanceID)
instance.DashboardURL = dashboardURL
}
if b.processingEnabled {
instance, suspendStatusChange, err := b.processContext(instance, details, lastProvisioningOperation, logger)
if err != nil {
return domain.UpdateServiceSpec{}, err
}
// NOTE: KEB currently can't process update parameters in one call along with context update
// this block makes it that KEB ignores any parameters updates if context update changed suspension state
if !suspendStatusChange && !instance.IsExpired() {
return b.processUpdateParameters(instance, details, lastProvisioningOperation, asyncAllowed, ersContext, logger)
}
}
return domain.UpdateServiceSpec{
IsAsync: false,
DashboardURL: dashboardURL,
OperationData: "",
Metadata: domain.InstanceMetadata{
Labels: ResponseLabels(*lastProvisioningOperation, *instance, b.config.URL, b.config.EnableKubeconfigURLLabel),
},
}, nil
}
func (b *UpdateEndpoint) validateWithJsonSchemaValidator(details domain.UpdateDetails, instance *internal.Instance) error {
if len(details.RawParameters) > 0 {
planValidator, err := b.getJsonSchemaValidator(instance.Provider, instance.ServicePlanID, instance.ProviderRegion)
if err != nil {
return fmt.Errorf("while creating plan validator: %w", err)
}
result, err := planValidator.ValidateString(string(details.RawParameters))
if err != nil {
return fmt.Errorf("while executing JSON schema validator: %w", err)
}
if !result.Valid {
return fmt.Errorf("while validating update parameters: %w", result.Error)
}
}
return nil
}
func shouldUpdate(instance *internal.Instance, details domain.UpdateDetails, ersContext internal.ERSContext) bool {
if len(details.RawParameters) != 0 {
return true
}
return ersContext.ERSUpdate()
}
func (b *UpdateEndpoint) processUpdateParameters(instance *internal.Instance, details domain.UpdateDetails, lastProvisioningOperation *internal.ProvisioningOperation, asyncAllowed bool, ersContext internal.ERSContext, logger logrus.FieldLogger) (domain.UpdateServiceSpec, error) {
if !shouldUpdate(instance, details, ersContext) {
logger.Debugf("Parameters not provided, skipping processing update parameters")
return domain.UpdateServiceSpec{
IsAsync: false,
DashboardURL: instance.DashboardURL,
OperationData: "",
Metadata: domain.InstanceMetadata{
Labels: ResponseLabels(*lastProvisioningOperation, *instance, b.config.URL, b.config.EnableKubeconfigURLLabel),
},
}, nil
}
// asyncAllowed needed, see https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#updating-a-service-instance
if !asyncAllowed {
return domain.UpdateServiceSpec{}, apiresponses.ErrAsyncRequired
}
var params internal.UpdatingParametersDTO
if len(details.RawParameters) != 0 {
err := json.Unmarshal(details.RawParameters, ¶ms)
if err != nil {
logger.Errorf("unable to unmarshal parameters: %s", err.Error())
return domain.UpdateServiceSpec{}, fmt.Errorf("unable to unmarshal parameters")
}
logger.Debugf("Updating with params: %+v", params)
}
if params.OIDC.IsProvided() {
if err := params.OIDC.Validate(); err != nil {
logger.Errorf("invalid OIDC parameters: %s", err.Error())
return domain.UpdateServiceSpec{}, apiresponses.NewFailureResponse(err, http.StatusUnprocessableEntity, err.Error())
}
}
operationID := uuid.New().String()
logger = logger.WithField("operationID", operationID)
logger.Debugf("creating update operation %v", params)
operation := internal.NewUpdateOperation(operationID, instance, params)
planID := instance.Parameters.PlanID
if len(details.PlanID) != 0 {
planID = details.PlanID
}
defaults, err := b.planDefaults(planID, instance.Provider, &instance.Provider)
if err != nil {
logger.Errorf("unable to obtain plan defaults: %s", err.Error())
return domain.UpdateServiceSpec{}, fmt.Errorf("unable to obtain plan defaults")
}
var autoscalerMin, autoscalerMax int
if defaults.GardenerConfig != nil {
p := defaults.GardenerConfig
autoscalerMin, autoscalerMax = p.AutoScalerMin, p.AutoScalerMax
}
if err := operation.ProvisioningParameters.Parameters.AutoScalerParameters.Validate(autoscalerMin, autoscalerMax); err != nil {
logger.Errorf("invalid autoscaler parameters: %s", err.Error())
return domain.UpdateServiceSpec{}, apiresponses.NewFailureResponse(err, http.StatusUnprocessableEntity, err.Error())
}
err = b.operationStorage.InsertOperation(operation)
if err != nil {
return domain.UpdateServiceSpec{}, err
}
var updateStorage []string
if params.OIDC.IsProvided() {
instance.Parameters.Parameters.OIDC = params.OIDC
updateStorage = append(updateStorage, "OIDC")
}
if len(params.RuntimeAdministrators) != 0 {
newAdministrators := make([]string, 0, len(params.RuntimeAdministrators))
newAdministrators = append(newAdministrators, params.RuntimeAdministrators...)
instance.Parameters.Parameters.RuntimeAdministrators = newAdministrators
updateStorage = append(updateStorage, "Runtime Administrators")
}
if params.UpdateAutoScaler(&instance.Parameters.Parameters) {
updateStorage = append(updateStorage, "Auto Scaler parameters")
}
if params.MachineType != nil && *params.MachineType != "" {
instance.Parameters.Parameters.MachineType = params.MachineType
}
if len(updateStorage) > 0 {
if err := wait.Poll(500*time.Millisecond, 2*time.Second, func() (bool, error) {
instance, err = b.instanceStorage.Update(*instance)
if err != nil {
params := strings.Join(updateStorage, ", ")
logger.Warnf("unable to update instance with new %v (%s), retrying", params, err.Error())
return false, nil
}
return true, nil
}); err != nil {
response := apiresponses.NewFailureResponse(fmt.Errorf("Update operation failed"), http.StatusInternalServerError, err.Error())
return domain.UpdateServiceSpec{}, response
}
}
logger.Debugf("Adding update operation to the processing queue")
b.updatingQueue.Add(operationID)
return domain.UpdateServiceSpec{
IsAsync: true,
DashboardURL: instance.DashboardURL,
OperationData: operation.ID,
Metadata: domain.InstanceMetadata{
Labels: ResponseLabels(*lastProvisioningOperation, *instance, b.config.URL, b.config.EnableKubeconfigURLLabel),
},
}, nil
}
func (b *UpdateEndpoint) processContext(instance *internal.Instance, details domain.UpdateDetails, lastProvisioningOperation *internal.ProvisioningOperation, logger logrus.FieldLogger) (*internal.Instance, bool, error) {
var ersContext internal.ERSContext
err := json.Unmarshal(details.RawContext, &ersContext)
if err != nil {
logger.Errorf("unable to decode context: %s", err.Error())
return nil, false, fmt.Errorf("unable to unmarshal context")
}
logger.Infof("Global account ID: %s active: %s", instance.GlobalAccountID, ptr.BoolAsString(ersContext.Active))
lastOp, err := b.operationStorage.GetLastOperation(instance.InstanceID)
if err != nil {
logger.Errorf("unable to get last operation: %s", err.Error())
return nil, false, fmt.Errorf("failed to process ERS context")
}
// todo: remove the code below when we are sure the ERSContext contains required values.
// This code is done because the PATCH request contains only some of fields and that requests made the ERS context empty in the past.
existingSMOperatorCredentials := instance.Parameters.ErsContext.SMOperatorCredentials
instance.Parameters.ErsContext = lastProvisioningOperation.ProvisioningParameters.ErsContext
// but do not change existing SM operator credentials
instance.Parameters.ErsContext.SMOperatorCredentials = existingSMOperatorCredentials
instance.Parameters.ErsContext.Active, err = b.extractActiveValue(instance.InstanceID, *lastProvisioningOperation)
if err != nil {
return nil, false, fmt.Errorf("unable to process the update")
}
instance.Parameters.ErsContext = internal.InheritMissingERSContext(instance.Parameters.ErsContext, lastOp.ProvisioningParameters.ErsContext)
instance.Parameters.ErsContext = internal.UpdateInstanceERSContext(instance.Parameters.ErsContext, ersContext)
changed, err := b.contextUpdateHandler.Handle(instance, ersContext)
if err != nil {
logger.Errorf("processing context updated failed: %s", err.Error())
return nil, changed, fmt.Errorf("unable to process the update")
}
// copy the Active flag if set
if ersContext.Active != nil {
instance.Parameters.ErsContext.Active = ersContext.Active
}
if b.subAccountMovementEnabled {
if instance.GlobalAccountID != ersContext.GlobalAccountID && ersContext.GlobalAccountID != "" {
if instance.SubscriptionGlobalAccountID == "" {
instance.SubscriptionGlobalAccountID = instance.GlobalAccountID
}
instance.GlobalAccountID = ersContext.GlobalAccountID
}
}
newInstance, err := b.instanceStorage.Update(*instance)
if err != nil {
logger.Errorf("processing context updated failed: %s", err.Error())
return nil, changed, fmt.Errorf("unable to process the update")
}
return newInstance, changed, nil
}
func (b *UpdateEndpoint) extractActiveValue(id string, provisioning internal.ProvisioningOperation) (*bool, error) {
deprovisioning, dErr := b.operationStorage.GetDeprovisioningOperationByInstanceID(id)
if dErr != nil && !dberr.IsNotFound(dErr) {
b.log.Errorf("Unable to get deprovisioning operation for the instance %s to check the active flag: %s", id, dErr.Error())
return nil, dErr
}
// there was no any deprovisioning in the past (any suspension)
if deprovisioning == nil {
return ptr.Bool(true), nil
}
return ptr.Bool(deprovisioning.CreatedAt.Before(provisioning.CreatedAt)), nil
}
func (b *UpdateEndpoint) isKyma2(instance *internal.Instance) (bool, string, error) {
s, err := b.runtimeStates.GetLatestWithKymaVersionByRuntimeID(instance.RuntimeID)
if err != nil {
return false, "", err
}
kv := s.GetKymaVersion()
return internal.DetermineMajorVersion(kv) == 2, kv, nil
}
// processExpirationParam returns true, if expired
func (b *UpdateEndpoint) processExpirationParam(instance *internal.Instance, details domain.UpdateDetails, ers internal.ERSContext, logger logrus.FieldLogger) (*internal.Instance, error) {
// if the instance was expired before (in the past), then no need to do any work
if instance.IsExpired() {
return instance, nil
}
if len(details.RawParameters) != 0 {
var params internal.UpdatingParametersDTO
err := json.Unmarshal(details.RawParameters, ¶ms)
if err != nil {
return instance, err
}
if params.Expired {
if !IsTrialPlan(instance.ServicePlanID) {
logger.Warn("Expiration of a non-trial instance is not supported")
return instance, apiresponses.NewFailureResponse(fmt.Errorf("expiration of a non-trial instance is not supported"), http.StatusBadRequest, "")
}
if ers.Active == nil || *ers.Active {
logger.Warn("Parameter 'expired' requires `context.active=false`")
return instance, apiresponses.NewFailureResponse(fmt.Errorf("context.active=false is required for expiration"), http.StatusBadRequest, "")
}
logger.Infof("Saving expiration param for an instance created at %s", instance.CreatedAt)
instance.ExpiredAt = ptr.Time(time.Now())
instance, err := b.instanceStorage.Update(*instance)
return instance, err
}
}
return instance, nil
}
func (b *UpdateEndpoint) getJsonSchemaValidator(provider internal.CloudProvider, planID string, platformRegion string) (JSONSchemaValidator, error) {
plans := Plans(b.plansConfig, provider, b.config.IncludeAdditionalParamsInSchema, euaccess.IsEURestrictedAccess(platformRegion))
plan := plans[planID]
schema := string(Marshal(plan.Schemas.Instance.Update.Parameters))
return jsonschema.NewValidatorFromStringSchema(schema)
}