-
Notifications
You must be signed in to change notification settings - Fork 3
/
AuroraCluster.yml
540 lines (487 loc) · 16.3 KB
/
AuroraCluster.yml
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
AWSTemplateFormatVersion: '2010-09-09'
Description: 'CloudFormation Template to create Aurora MySQL Cluster DB Instance'
# Metadata
Metadata:
AWS::CloudFormation::Interface:
ParameterGroups:
- Label:
default: 'Environment'
Parameters:
- EnvironmentName
- Label:
default: 'DB Parameters'
Parameters:
- DBName
- DBPort
- DBUsername
- DBPassword
- DBInstanceClass
- Engine
- DBSnapshotIdentifier
- DBBackupRetentionPeriod
- PreferredBackupWindow
- PreferredMaintenanceWindow
- KMSKeyID
- NotificationList
- Label:
default: Networking
Parameters:
- ParentVPCStack
- DBSubnetIDs
- Label:
default: Mandatory Tags
Parameters:
- Application
- Team
# Parameters
Parameters:
DBName:
Description: Database Name
Type: String
MinLength: '1'
MaxLength: '64'
AllowedPattern: "^[a-zA-Z]+[0-9a-zA-Z_]*$"
ConstraintDescription: Must start with a letter. Only numbers, letters, and _ accepted. max length 64 characters
DBPort:
Description: TCP/IP Port for the Database Instance
Type: Number
Default: 3306
ConstraintDescription: 'Must be in the range [1115-65535]'
MinValue: 1115
MaxValue: 65535
DBUsername:
Description: Database master username
Type: String
MinLength: '1'
MaxLength: '16'
AllowedPattern: "^[a-zA-Z]+[0-9a-zA-Z_]*$"
ConstraintDescription: Must start with a letter. Only numbers, letters, and _ accepted. max length 16 characters
DBPassword:
Description: Database master password
Type: String
MinLength: '1'
MaxLength: '16'
AllowedPattern: "^[a-zA-Z]+[0-9a-zA-Z_]*$"
ConstraintDescription: Must start with a letter. Only numbers, letters, and _ accepted. max length 16 characters
Engine:
Description: Select Database Engine Version
Type: String
Default: aurora
AllowedValues:
- '5.6.mysql-aurora.1.19.1'
- aurora
- '5.7.mysql-aurora.2.04.3'
- '5.7.mysql-aurora.2.03.4'
- 'aurora-mysql'
DBInstanceClass:
Default: db.r4.large
Description: Database Instance Class.
Type: String
AllowedValues:
- db.t3.medium
- db.r4.large
- db.r4.xlarge
- db.r4.2xlarge
- db.r4.4xlarge
- db.r4.8xlarge
- db.r4.16xlarge
- db.r5.large
- db.r5.xlarge
- db.r5.2xlarge
- db.r5.4xlarge
- db.r5.12xlarge
- db.r5.24xlarge
DBSnapshotIdentifier:
Description: 'Optional identifier for the DB cluster snapshot from which you want to restore (leave blank to create an empty cluster).'
Type: String
Default: ''
DBBackupRetentionPeriod:
Description: 'The number of days to keep snapshots of the cluster.'
Type: Number
MinValue: 1
MaxValue: 35
Default: 14
PreferredBackupWindow:
Description: 'The daily time range in UTC during which you want to create automated backups.'
Type: String
Default: '09:03-09:33'
PreferredMaintenanceWindow:
Description: The weekly time range (in UTC) during which system maintenance can occur.
Type: String
Default: 'sat:04:00-sat:07:30'
ParentVPCStack:
Type: 'AWS::EC2::VPC::Id'
Description : Choose the VPC
DBSubnetIDs:
Type: List<AWS::EC2::Subnet::Id>
Description: Array of subnet IDs for the DBSubnetGroup
KMSKeyID:
Type: String
Description: KMSKeyID from the current account
# Mandatory tags
EnvironmentName:
Type: String
Description: Environment Name of the associated AWS resource.
AllowedValues:
- stage
- prod
Application:
Type: String
Description: The Application name.
AllowedPattern: "^[a-zA-Z]+[a-zA-Z ]+[a-zA-Z]+$"
ConstraintDescription: provide a valid application name containing only letters and spaces
Default: SprintQADevOps
Team:
Type: String
Description: The Team name.
AllowedPattern: "^[a-zA-Z]+[a-zA-Z ]+[a-zA-Z]+$"
ConstraintDescription: provide a valid application name containing only letters and spaces
Default: DevOps
NotificationList:
Type: String
Description: The Email notification list is used to configure a SNS topic for sending cloudwatch alarm and RDS Event notifications
AllowedPattern: '^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$'
ConstraintDescription: provide a valid email address.
Default: devops@sprintqa.com
# Mappings
Mappings:
EngineMap:
aurora:
Engine: aurora
EngineVersion: '5.6.10a'
Port: 3306
ClusterParameterGroupFamily: 'aurora5.6'
ParameterGroupFamily: 'aurora5.6'
'5.6.mysql-aurora.1.19.1':
Engine: aurora
EngineVersion: '5.6.mysql_aurora.1.19.1'
Port: 3306
ClusterParameterGroupFamily: 'aurora5.6'
ParameterGroupFamily: 'aurora5.6'
'aurora-mysql':
Engine: 'aurora-mysql'
EngineVersion: '5.7.12'
Port: 3306
ClusterParameterGroupFamily: 'aurora-mysql5.7'
ParameterGroupFamily: 'aurora-mysql5.7'
'5.7.mysql-aurora.2.03.4':
Engine: 'aurora-mysql'
EngineVersion: '5.7.mysql_aurora.2.03.4'
Port: 3306
ClusterParameterGroupFamily: 'aurora-mysql5.7'
ParameterGroupFamily: 'aurora-mysql5.7'
'5.7.mysql-aurora.2.04.3':
Engine: 'aurora-mysql'
EngineVersion: '5.7.mysql_aurora.2.04.3'
Port: 3306
ClusterParameterGroupFamily: 'aurora-mysql5.7'
ParameterGroupFamily: 'aurora-mysql5.7'
# Conditions
Conditions:
#IsUseDBSnapshot: !Not [!Equals [!Ref DBSnapshotName, ""]]
IsProd: !Equals [!Ref EnvironmentName, 'prod']
HasDBSnapshotIdentifier: !Not [!Equals [!Ref DBSnapshotIdentifier, '']]
HasEngineMySQL: !Or [!Equals [!FindInMap [EngineMap, !Ref Engine, Engine], 'aurora'], !Equals [!FindInMap [EngineMap, !Ref Engine, Engine], 'aurora-mysql']]
# Resources
Resources:
MonitoringIAMRole:
Type: AWS::IAM::Role
Condition: IsProd
Properties:
AssumeRolePolicyDocument:
Version: "2012-10-17"
Statement:
-
Effect: "Allow"
Principal:
Service:
- "monitoring.rds.amazonaws.com"
Action:
- "sts:AssumeRole"
Path: "/"
ManagedPolicyArns:
- arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole
ClusterSecurityGroup:
Type: AWS::EC2::SecurityGroup
Properties:
GroupDescription: Aurora cluster security group
VpcId: !Ref ParentVPCStack
SecurityGroupIngress:
- IpProtocol: tcp
FromPort: 3306
ToPort: 3306
CidrIp: 10.0.0.0/8
- IpProtocol: tcp
FromPort: 3306
ToPort: 3306
CidrIp: 172.16.0.0/12
- IpProtocol: tcp
FromPort: 3306
ToPort: 3306
CidrIp: 192.168.0.0/16
Tags:
- Key: Name
Value: !Sub '${AWS::StackName}-AuroraClusterSecurityGroup'
- Key: Team
Value: !Ref Team
- Key: Application
Value: !Ref Application
DBSNSTopic:
Type: AWS::SNS::Topic
Properties:
Subscription:
- Endpoint: devops@sprintqa.com
Protocol: email
DBSubnetGroup:
Type: 'AWS::RDS::DBSubnetGroup'
Properties:
DBSubnetGroupDescription: DB Subnet group
SubnetIds: !Ref DBSubnetIDs #if this doesn't work use, !Join [",", [!Select [0, !Ref Subnets], !Select [1, !Ref Subnets]]]
DBClusterParameterGroup:
Type: 'AWS::RDS::DBClusterParameterGroup'
Properties:
Description: !Ref 'AWS::StackName'
Family: !FindInMap [EngineMap, !Ref Engine, ClusterParameterGroupFamily]
Parameters: !If
- HasEngineMySQL
- character_set_client: utf8
character_set_connection: utf8
character_set_database: utf8
character_set_filesystem: utf8
character_set_results: utf8
character_set_server: utf8
collation_connection: utf8_general_ci
collation_server: utf8_general_ci
binlog_format: ROW
- client_encoding: 'UTF8'
DBParamGroup:
Type: 'AWS::RDS::DBParameterGroup'
Properties:
Description: !Ref 'AWS::StackName'
Family: !FindInMap [EngineMap, !Ref Engine, ParameterGroupFamily]
AuroraDBCluster:
Type: 'AWS::RDS::DBCluster'
DeletionPolicy: Snapshot # default
UpdateReplacePolicy: Snapshot
Properties:
BackupRetentionPeriod: !Ref DBBackupRetentionPeriod
DatabaseName: !If [HasDBSnapshotIdentifier, !Ref 'AWS::NoValue', !Ref DBName]
DBClusterParameterGroupName: !Ref DBClusterParameterGroup
DBSubnetGroupName: !Ref DBSubnetGroup
Engine: !FindInMap [EngineMap, !Ref Engine, Engine]
EngineMode: provisioned
EngineVersion: !FindInMap [EngineMap, !Ref Engine, EngineVersion]
MasterUsername: !If [HasDBSnapshotIdentifier, !Ref 'AWS::NoValue', !Ref DBUsername]
MasterUserPassword: !If [HasDBSnapshotIdentifier, !Ref 'AWS::NoValue', !Ref DBPassword]
Port: !FindInMap [EngineMap, !Ref Engine, Port]
PreferredBackupWindow: !Ref PreferredBackupWindow
PreferredMaintenanceWindow: !Ref PreferredMaintenanceWindow
SnapshotIdentifier: !If [HasDBSnapshotIdentifier, !Ref DBSnapshotIdentifier, !Ref 'AWS::NoValue']
DeletionProtection: false
KmsKeyId: !Ref KMSKeyID
StorageEncrypted: true
VpcSecurityGroupIds: [!Ref ClusterSecurityGroup]
AuroraDBFirstInstance:
Type: AWS::RDS::DBInstance
Properties:
CopyTagsToSnapshot: true
DBInstanceClass: !Ref DBInstanceClass
DBClusterIdentifier: !Ref AuroraDBCluster
Engine: !FindInMap [EngineMap, !Ref Engine, Engine]
EngineVersion: !FindInMap [EngineMap, !Ref Engine, EngineVersion]
DBParameterGroupName: !Ref DBParamGroup
MonitoringInterval: !If [IsProd, 1, 0]
MonitoringRoleArn: !If [IsProd, !GetAtt MonitoringIAMRole.Arn, !Ref "AWS::NoValue"]
AllowMajorVersionUpgrade: false
AutoMinorVersionUpgrade: !If [IsProd, 'false', 'true']
DBSubnetGroupName: !Ref DBSubnetGroup
PubliclyAccessible: false
Tags:
- Key: Environment
Value: !Ref EnvironmentName
- Key: Application
Value: !Ref Application
- Key: Team
Value: !Ref Team
AuroraDBSecondInstance:
Type: AWS::RDS::DBInstance
Properties:
CopyTagsToSnapshot: true
DBInstanceClass: !Ref DBInstanceClass
DBClusterIdentifier: !Ref AuroraDBCluster
Engine: !FindInMap [EngineMap, !Ref Engine, Engine]
EngineVersion: !FindInMap [EngineMap, !Ref Engine, EngineVersion]
DBParameterGroupName: !Ref DBParamGroup
MonitoringInterval: !If [IsProd, 1, 0]
MonitoringRoleArn: !If [IsProd, !GetAtt MonitoringIAMRole.Arn, !Ref "AWS::NoValue"]
AllowMajorVersionUpgrade: false
AutoMinorVersionUpgrade: !If [IsProd, 'false', 'true']
DBSubnetGroupName: !Ref DBSubnetGroup
PubliclyAccessible: false
Tags:
- Key: Environment
Value: !Ref EnvironmentName
- Key: Application
Value: !Ref Application
- Key: Team
Value: !Ref Team
AuroraClusterDNSRecord:
Type: AWS::Route53::RecordSet
Properties:
HostedZoneName: sprintqa.devops.corporate.
Name: devopsapp.cluster.sprintqa.devops.corporate.
Type: CNAME
TTL: '60'
ResourceRecords:
- !GetAtt AuroraDBCluster.Endpoint.Address
AuroraReaderDNSRecord:
Type: AWS::Route53::RecordSet
Properties:
HostedZoneName: sprintqa.devops.corporate.
Name: devopsapp.reader.sprintqa.devops.corporate.
Type: CNAME
TTL: '60'
ResourceRecords:
- !GetAtt AuroraDBCluster.ReadEndpoint.Address
DatabaseClusterEventSubscription:
Type: 'AWS::RDS::EventSubscription'
Properties:
EventCategories:
- failover
- failure
- notification
SnsTopicArn: !Ref DBSNSTopic
SourceIds: [!Ref AuroraDBCluster]
SourceType: 'db-cluster'
DatabaseInstanceEventSubscription:
Type: 'AWS::RDS::EventSubscription'
Properties:
EventCategories:
- availability
- configuration change
- deletion
- failover
- failure
- maintenance
- notification
- recovery
SnsTopicArn: !Ref DBSNSTopic
SourceIds:
- !Ref AuroraDBFirstInstance
- !Ref AuroraDBSecondInstance
SourceType: 'db-instance'
DBParameterGroupEventSubscription:
Type: 'AWS::RDS::EventSubscription'
Properties:
EventCategories:
- configuration change
SnsTopicArn: !Ref DBSNSTopic
SourceIds: [!Ref DBParamGroup]
SourceType: 'db-parameter-group'
DMLLatencyAlarm1:
Type: "AWS::CloudWatch::Alarm"
Properties:
ActionsEnabled: true
AlarmActions:
- Ref: DBSNSTopic
AlarmDescription: 'DML Latency'
Dimensions:
- Name: DBInstanceIdentifier
Value:
Ref: AuroraDBFirstInstance
MetricName: DMLLatency
Statistic: Maximum
Namespace: 'AWS/RDS'
Threshold: '250'
Unit: Milliseconds
ComparisonOperator: 'GreaterThanOrEqualToThreshold'
Period: '60'
EvaluationPeriods: '5'
TreatMissingData: 'missing'
DMLLatencyAlarm2:
Type: "AWS::CloudWatch::Alarm"
Properties:
ActionsEnabled: true
AlarmActions:
- Ref: DBSNSTopic
AlarmDescription: 'DML Latency'
Dimensions:
- Name: DBInstanceIdentifier
Value:
Ref: AuroraDBSecondInstance
MetricName: DMLLatency
Statistic: Maximum
Namespace: 'AWS/RDS'
Threshold: '250'
Unit: Milliseconds
ComparisonOperator: 'GreaterThanOrEqualToThreshold'
Period: '60'
EvaluationPeriods: '5'
TreatMissingData: 'missing'
SelectLatencyAlarm1:
Type: "AWS::CloudWatch::Alarm"
Properties:
ActionsEnabled: true
AlarmActions:
- Ref: DBSNSTopic
AlarmDescription: 'Select Latency'
Dimensions:
- Name: DBInstanceIdentifier
Value:
Ref: AuroraDBFirstInstance
MetricName: SelectLatency
Statistic: Maximum
Namespace: 'AWS/RDS'
Threshold: '250'
Unit: Milliseconds
ComparisonOperator: 'GreaterThanOrEqualToThreshold'
Period: '60'
EvaluationPeriods: '5'
TreatMissingData: 'missing'
SelectLatencyAlarm2:
Type: "AWS::CloudWatch::Alarm"
Properties:
ActionsEnabled: true
AlarmActions:
- Ref: DBSNSTopic
AlarmDescription: 'Select Latency'
Dimensions:
- Name: DBInstanceIdentifier
Value:
Ref: AuroraDBFirstInstance
MetricName: SelectLatency
Statistic: Maximum
Namespace: 'AWS/RDS'
Threshold: '250'
Unit: Milliseconds
ComparisonOperator: 'GreaterThanOrEqualToThreshold'
Period: '60'
EvaluationPeriods: '5'
TreatMissingData: 'missing'
# Outputs
Outputs:
ClusterEndpoint:
Description: 'Aurora Cluster/Writer Endpoint'
Value: !GetAtt 'AuroraDBCluster.Endpoint.Address'
Export:
Name: DevOpsAppClusterEndpoint
ReaderEndpoint:
Description: 'Aurora Reader Endpoint'
Value: !GetAtt 'AuroraDBCluster.ReadEndpoint.Address'
Export:
Name: DevOpsAppReaderEndpoint
Port:
Description: 'Aurora Endpoint Port'
Value: !GetAtt 'AuroraDBCluster.Endpoint.Port'
DBUsername:
Description: 'Database master username'
Value: !Ref DBUsername
DBName:
Description: 'Database Name'
Value: !Ref DBName
AuroraClusterURL:
Description: 'The public URL for the AuroraCluster'
Value: !Sub '${AuroraClusterDNSRecord}'
AuroraReaderURL:
Description: 'The public URL for the AuroraReader'
Value: !Sub '${AuroraReaderDNSRecord}'