-
Notifications
You must be signed in to change notification settings - Fork 363
/
rdsinstance.go
321 lines (291 loc) · 12.3 KB
/
rdsinstance.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
/*
Copyright 2019 The Crossplane 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 database
import (
"context"
"reflect"
"sort"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
awsrds "github.com/aws/aws-sdk-go-v2/service/rds"
awsrdstypes "github.com/aws/aws-sdk-go-v2/service/rds/types"
"github.com/pkg/errors"
"k8s.io/client-go/util/workqueue"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
"github.com/crossplane/crossplane-runtime/pkg/event"
"github.com/crossplane/crossplane-runtime/pkg/logging"
"github.com/crossplane/crossplane-runtime/pkg/meta"
"github.com/crossplane/crossplane-runtime/pkg/password"
"github.com/crossplane/crossplane-runtime/pkg/ratelimiter"
"github.com/crossplane/crossplane-runtime/pkg/reconciler/managed"
"github.com/crossplane/crossplane-runtime/pkg/resource"
"github.com/crossplane/provider-aws/apis/database/v1beta1"
awsclient "github.com/crossplane/provider-aws/pkg/clients"
"github.com/crossplane/provider-aws/pkg/clients/rds"
)
const (
errNotRDSInstance = "managed resource is not an RDS instance custom resource"
errKubeUpdateFailed = "cannot update RDS instance custom resource"
errCreateFailed = "cannot create RDS instance"
errS3RestoreFailed = "cannot restore RDS instance from S3 backup"
errSnapshotRestoreFailed = "cannot restore RDS instance from snapshot"
errUnknownRestoreSource = "unknown RDS restore souce"
errModifyFailed = "cannot modify RDS instance"
errAddTagsFailed = "cannot add tags to RDS instance"
errDeleteFailed = "cannot delete RDS instance"
errDescribeFailed = "cannot describe RDS instance"
errPatchCreationFailed = "cannot create a patch object"
errUpToDateFailed = "cannot check whether object is up-to-date"
errGetPasswordSecretFailed = "cannot get password secret"
)
// SetupRDSInstance adds a controller that reconciles RDSInstances.
func SetupRDSInstance(mgr ctrl.Manager, l logging.Logger, rl workqueue.RateLimiter, poll time.Duration) error {
name := managed.ControllerName(v1beta1.RDSInstanceGroupKind)
return ctrl.NewControllerManagedBy(mgr).
Named(name).
WithOptions(controller.Options{
RateLimiter: ratelimiter.NewController(rl),
}).
For(&v1beta1.RDSInstance{}).
Complete(managed.NewReconciler(mgr,
resource.ManagedKind(v1beta1.RDSInstanceGroupVersionKind),
managed.WithExternalConnecter(&connector{kube: mgr.GetClient(), newClientFn: rds.NewClient}),
managed.WithInitializers(managed.NewDefaultProviderConfig(mgr.GetClient()), managed.NewNameAsExternalName(mgr.GetClient()), &tagger{kube: mgr.GetClient()}),
managed.WithReferenceResolver(managed.NewAPISimpleReferenceResolver(mgr.GetClient())),
managed.WithPollInterval(poll),
managed.WithLogger(l.WithValues("controller", name)),
managed.WithRecorder(event.NewAPIRecorder(mgr.GetEventRecorderFor(name)))))
}
type connector struct {
kube client.Client
newClientFn func(config *aws.Config) rds.Client
}
func (c *connector) Connect(ctx context.Context, mg resource.Managed) (managed.ExternalClient, error) {
cr, ok := mg.(*v1beta1.RDSInstance)
if !ok {
return nil, errors.New(errNotRDSInstance)
}
cfg, err := awsclient.GetConfig(ctx, c.kube, mg, aws.ToString(cr.Spec.ForProvider.Region))
if err != nil {
return nil, err
}
return &external{c.newClientFn(cfg), c.kube}, nil
}
type external struct {
client rds.Client
kube client.Client
}
func (e *external) Observe(ctx context.Context, mg resource.Managed) (managed.ExternalObservation, error) { // nolint:gocyclo
cr, ok := mg.(*v1beta1.RDSInstance)
if !ok {
return managed.ExternalObservation{}, errors.New(errNotRDSInstance)
}
// TODO(muvaf): There are some parameters that require a specific call
// for retrieval. For example, DescribeDBInstancesOutput does not expose
// the tags map of the RDS instance, you have to make ListTagsForResourceRequest
rsp, err := e.client.DescribeDBInstances(ctx, &awsrds.DescribeDBInstancesInput{DBInstanceIdentifier: aws.String(meta.GetExternalName(cr))})
if err != nil {
return managed.ExternalObservation{}, awsclient.Wrap(resource.Ignore(rds.IsErrorNotFound, err), errDescribeFailed)
}
// Describe requests can be used with filters, which then returns a list.
// But we use an explicit identifier, so, if there is no error, there should
// be only 1 element in the list.
instance := rsp.DBInstances[0]
current := cr.Spec.ForProvider.DeepCopy()
rds.LateInitialize(&cr.Spec.ForProvider, &instance)
cr.Status.AtProvider = rds.GenerateObservation(instance)
switch cr.Status.AtProvider.DBInstanceStatus {
case v1beta1.RDSInstanceStateAvailable, v1beta1.RDSInstanceStateModifying, v1beta1.RDSInstanceStateBackingUp, v1beta1.RDSInstanceStateConfiguringEnhancedMonitoring, v1beta1.RDSInstanceStateStorageOptimization:
cr.Status.SetConditions(xpv1.Available())
case v1beta1.RDSInstanceStateCreating:
cr.Status.SetConditions(xpv1.Creating())
case v1beta1.RDSInstanceStateDeleting:
cr.Status.SetConditions(xpv1.Deleting())
default:
cr.Status.SetConditions(xpv1.Unavailable())
}
upToDate, err := rds.IsUpToDate(ctx, e.kube, cr, instance)
if err != nil {
return managed.ExternalObservation{}, awsclient.Wrap(err, errUpToDateFailed)
}
return managed.ExternalObservation{
ResourceExists: true,
ResourceUpToDate: upToDate,
ResourceLateInitialized: !reflect.DeepEqual(current, &cr.Spec.ForProvider),
ConnectionDetails: rds.GetConnectionDetails(*cr),
}, nil
}
func (e *external) Create(ctx context.Context, mg resource.Managed) (managed.ExternalCreation, error) {
cr, ok := mg.(*v1beta1.RDSInstance)
if !ok {
return managed.ExternalCreation{}, errors.New(errNotRDSInstance)
}
cr.SetConditions(xpv1.Creating())
if cr.Status.AtProvider.DBInstanceStatus == v1beta1.RDSInstanceStateCreating {
return managed.ExternalCreation{}, nil
}
pw, _, err := rds.GetPassword(ctx, e.kube, cr.Spec.ForProvider.MasterPasswordSecretRef, cr.Spec.WriteConnectionSecretToReference)
if err != nil {
return managed.ExternalCreation{}, err
}
if pw == "" {
pw, err = password.Generate()
if err != nil {
return managed.ExternalCreation{}, err
}
}
err = e.RestoreOrCreate(ctx, cr, pw)
if err != nil {
return managed.ExternalCreation{}, err
}
conn := managed.ConnectionDetails{
xpv1.ResourceCredentialsSecretPasswordKey: []byte(pw),
}
if cr.Spec.ForProvider.MasterUsername != nil {
conn[xpv1.ResourceCredentialsSecretUserKey] = []byte(aws.ToString(cr.Spec.ForProvider.MasterUsername))
}
return managed.ExternalCreation{ConnectionDetails: conn}, nil
}
func (e *external) RestoreOrCreate(ctx context.Context, cr *v1beta1.RDSInstance, pw string) error {
if cr.Spec.ForProvider.RestoreFrom == nil {
_, err := e.client.CreateDBInstance(ctx, rds.GenerateCreateDBInstanceInput(meta.GetExternalName(cr), pw, &cr.Spec.ForProvider))
if err != nil {
return awsclient.Wrap(err, errCreateFailed)
}
return nil
}
switch *cr.Spec.ForProvider.RestoreFrom.Source {
case "S3":
_, err := e.client.RestoreDBInstanceFromS3(ctx, rds.GenerateRestoreDBInstanceFromS3Input(meta.GetExternalName(cr), pw, &cr.Spec.ForProvider))
if err != nil {
return awsclient.Wrap(err, errS3RestoreFailed)
}
case "Snapshot":
_, err := e.client.RestoreDBInstanceFromDBSnapshot(ctx, rds.GenerateRestoreDBInstanceFromSnapshotInput(meta.GetExternalName(cr), &cr.Spec.ForProvider))
if err != nil {
return awsclient.Wrap(err, errSnapshotRestoreFailed)
}
default:
return errors.New(errUnknownRestoreSource)
}
return nil
}
func (e *external) Update(ctx context.Context, mg resource.Managed) (managed.ExternalUpdate, error) { // nolint:gocyclo
cr, ok := mg.(*v1beta1.RDSInstance)
if !ok {
return managed.ExternalUpdate{}, errors.New(errNotRDSInstance)
}
switch cr.Status.AtProvider.DBInstanceStatus {
case v1beta1.RDSInstanceStateModifying, v1beta1.RDSInstanceStateCreating:
return managed.ExternalUpdate{}, nil
}
// AWS rejects modification requests if you send fields whose value is same
// as the current one. So, we have to create a patch out of the desired state
// and the current state. Since the DBInstance is not fully mirrored in status,
// we lose the current state after a change is made to spec, which forces us
// to make a DescribeDBInstancesRequest to get the current state.
rsp, err := e.client.DescribeDBInstances(ctx, &awsrds.DescribeDBInstancesInput{DBInstanceIdentifier: aws.String(meta.GetExternalName(cr))})
if err != nil {
return managed.ExternalUpdate{}, awsclient.Wrap(err, errDescribeFailed)
}
patch, err := rds.CreatePatch(&rsp.DBInstances[0], &cr.Spec.ForProvider)
if err != nil {
return managed.ExternalUpdate{}, errors.Wrap(err, errPatchCreationFailed)
}
modify := rds.GenerateModifyDBInstanceInput(meta.GetExternalName(cr), patch)
var conn managed.ConnectionDetails
pwd, changed, err := rds.GetPassword(ctx, e.kube, cr.Spec.ForProvider.MasterPasswordSecretRef, cr.Spec.WriteConnectionSecretToReference)
if err != nil {
return managed.ExternalUpdate{}, err
}
if changed {
conn = managed.ConnectionDetails{
xpv1.ResourceCredentialsSecretPasswordKey: []byte(pwd),
}
modify.MasterUserPassword = aws.String(pwd)
}
if _, err = e.client.ModifyDBInstance(ctx, modify); err != nil {
return managed.ExternalUpdate{}, awsclient.Wrap(err, errModifyFailed)
}
if len(patch.Tags) > 0 {
tags := make([]awsrdstypes.Tag, len(patch.Tags))
for i, t := range patch.Tags {
tags[i] = awsrdstypes.Tag{Key: aws.String(t.Key), Value: aws.String(t.Value)}
}
_, err = e.client.AddTagsToResource(ctx, &awsrds.AddTagsToResourceInput{
ResourceName: aws.String(cr.Status.AtProvider.DBInstanceArn),
Tags: tags,
})
if err != nil {
return managed.ExternalUpdate{}, awsclient.Wrap(err, errAddTagsFailed)
}
}
return managed.ExternalUpdate{ConnectionDetails: conn}, nil
}
func (e *external) Delete(ctx context.Context, mg resource.Managed) error {
cr, ok := mg.(*v1beta1.RDSInstance)
if !ok {
return errors.New(errNotRDSInstance)
}
cr.SetConditions(xpv1.Deleting())
if cr.Status.AtProvider.DBInstanceStatus == v1beta1.RDSInstanceStateDeleting {
return nil
}
// TODO(muvaf): There are cases where deletion results in an error that can
// be solved only by a config change. But to do that, reconciler has to call
// Update before Delete, which is not the case currently. In RDS, deletion
// protection is an example for that and it's pretty common to use it. So,
// until managed reconciler does Update before Delete, we do it here manually.
// Update here is a best effort and deletion should not stop if it fails since
// user may want to delete a resource whose fields are causing error.
_, err := e.Update(ctx, cr)
if rds.IsErrorNotFound(err) {
return nil
}
input := awsrds.DeleteDBInstanceInput{
DBInstanceIdentifier: aws.String(meta.GetExternalName(cr)),
SkipFinalSnapshot: aws.ToBool(cr.Spec.ForProvider.SkipFinalSnapshotBeforeDeletion),
FinalDBSnapshotIdentifier: cr.Spec.ForProvider.FinalDBSnapshotIdentifier,
}
_, err = e.client.DeleteDBInstance(ctx, &input)
return awsclient.Wrap(resource.Ignore(rds.IsErrorNotFound, err), errDeleteFailed)
}
type tagger struct {
kube client.Client
}
func (t *tagger) Initialize(ctx context.Context, mg resource.Managed) error {
cr, ok := mg.(*v1beta1.RDSInstance)
if !ok {
return errors.New(errNotRDSInstance)
}
tagMap := map[string]string{}
for _, t := range cr.Spec.ForProvider.Tags {
tagMap[t.Key] = t.Value
}
for k, v := range resource.GetExternalTags(mg) {
tagMap[k] = v
}
cr.Spec.ForProvider.Tags = make([]v1beta1.Tag, len(tagMap))
i := 0
for k, v := range tagMap {
cr.Spec.ForProvider.Tags[i] = v1beta1.Tag{Key: k, Value: v}
i++
}
sort.Slice(cr.Spec.ForProvider.Tags, func(i, j int) bool {
return cr.Spec.ForProvider.Tags[i].Key < cr.Spec.ForProvider.Tags[j].Key
})
return errors.Wrap(t.kube.Update(ctx, cr), errKubeUpdateFailed)
}