-
Notifications
You must be signed in to change notification settings - Fork 25
/
cf.yml
470 lines (426 loc) · 15.1 KB
/
cf.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
AWSTemplateFormatVersion: "2010-09-09"
Description: Factorio Spot Price Server via Docker / ECS
Parameters:
ECSAMI:
Description: AWS ECS AMI ID
Type: AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>
Default: /aws/service/ecs/optimized-ami/amazon-linux-2/recommended/image_id
FactorioImageTag:
Type: String
Description: "(Examples include latest, stable, 0.17, 0.17.33) Refer to tag descriptions available here: https://hub.docker.com/r/factoriotools/factorio/)"
Default: latest
ServerState:
Type: String
Description: "Running: A spot instance will launch shortly after setting this parameter; your Factorio server should start within 5-10 minutes of changing this parameter (once UPDATE_IN_PROGRESS becomes UPDATE_COMPLETE). Stopped: Your spot instance (and thus Factorio container) will be terminated shortly after setting this parameter."
Default: Running
AllowedValues:
- Running
- Stopped
InstanceType:
Type: String
Description: "m3.medium is a good cost effective (albeit older) instance, 1 VCPU and 3.75 GB of RAM with moderate network performance. Change at your discretion. https://aws.amazon.com/ec2/instance-types/."
Default: m3.medium
SpotPrice:
Type: String
Description: "An m3.medium shouldn't cost more than a cent per hour. Note: Leave this blank to use on-demand pricing."
Default: "0.05"
KeyPairName:
Type: String
Description: (Optional - An empty value disables this feature)
Default: ''
YourIp:
Type: String
Description: (Optional - An empty value disables this feature)
Default: ''
HostedZoneId:
Type: String
Description: (Optional - An empty value disables this feature) If you have a hosted zone in Route 53 and wish to set a DNS record whenever your Factorio instance starts, supply the hosted zone ID here.
Default: ''
RecordName:
Type: String
Description: (Optional - An empty value disables this feature) If you have a hosted zone in Route 53 and wish to set a DNS record whenever your Factorio instance starts, supply the name of the record here (e.g. factorio.mydomain.com).
Default: ''
EnableRcon:
Type: String
Description: Refer to https://hub.docker.com/r/factoriotools/factorio/ for further RCON configuration details. This parameter simply opens / closes the port on the security group.
Default: false
AllowedValues:
- true
- false
UpdateModsOnStart:
Type: String
Description: Refer to https://hub.docker.com/r/factoriotools/factorio/ for further configuration details.
Default: false
AllowedValues:
- true
- false
Metadata:
AWS::CloudFormation::Interface:
ParameterGroups:
- Label:
default: Essential Configuration
Parameters:
- FactorioImageTag
- ServerState
- InstanceType
- SpotPrice
- EnableRcon
- UpdateModsOnStart
- Label:
default: Remote Access (SSH) Configuration (Optional)
Parameters:
- KeyPairName
- YourIp
- Label:
default: DNS Configuration (Optional)
Parameters:
- HostedZoneId
- RecordName
ParameterLabels:
FactorioImageTag:
default: "Which version of Factorio do you want to launch?"
ServerState:
default: "Update this parameter to shut down / start up your Factorio server as required to save on cost. Takes a few minutes to take effect."
InstanceType:
default: "Which instance type? You must make sure this is available in your region! https://aws.amazon.com/ec2/pricing/on-demand/"
SpotPrice:
default: "Maximum spot price per hour? Leave blank to disable spot pricing."
KeyPairName:
default: "If you wish to access the instance via SSH, select a Key Pair to use. https://console.aws.amazon.com/ec2/v2/home?#KeyPairs:sort=keyName"
YourIp:
default: "If you wish to access the instance via SSH, provide your public IP address."
HostedZoneId:
default: "If you have a hosted zone in Route 53 and wish to update a DNS record whenever your Factorio instance starts, supply the hosted zone ID here."
RecordName:
default: "If you have a hosted zone in Route 53 and wish to set a DNS record whenever your Factorio instance starts, supply a record name here (e.g. factorio.mydomain.com)."
EnableRcon:
default: "Do you wish to enable RCON?"
UpdateModsOnStart:
default: "Do you wish to update your mods on container start"
Conditions:
KeyPairNameProvided: !Not [ !Equals [ !Ref KeyPairName, '' ] ]
IpAddressProvided: !Not [ !Equals [ !Ref YourIp, '' ] ]
DnsConfigEnabled: !And [ !Not [ !Equals [ !Ref HostedZoneId, '' ] ], !Not [ !Equals [ !Ref RecordName, '' ] ] ]
SpotPriceProvided: !Not [ !Equals [ !Ref SpotPrice, '' ] ]
DoEnableRcon: !Equals [ !Ref EnableRcon, 'true' ]
Mappings:
ServerState:
Running:
DesiredCapacity: 1
Stopped:
DesiredCapacity: 0
Resources:
# ====================================================
# BASIC VPC
# ====================================================
Vpc:
Type: AWS::EC2::VPC
Properties:
CidrBlock: 10.100.0.0/26
EnableDnsSupport: true
EnableDnsHostnames: true
SubnetA:
Type: AWS::EC2::Subnet
Properties:
AvailabilityZone: !Select
- 0
- !GetAZs
Ref: 'AWS::Region'
CidrBlock: !Select [ 0, !Cidr [ 10.100.0.0/26, 4, 4 ] ]
VpcId: !Ref Vpc
SubnetARoute:
Type: AWS::EC2::SubnetRouteTableAssociation
Properties:
RouteTableId: !Ref RouteTable
SubnetId: !Ref SubnetA
SubnetBRoute:
Type: AWS::EC2::SubnetRouteTableAssociation
Properties:
RouteTableId: !Ref RouteTable
SubnetId: !Ref SubnetB
SubnetB:
Type: AWS::EC2::Subnet
Properties:
AvailabilityZone: !Select
- 1
- !GetAZs
Ref: 'AWS::Region'
CidrBlock: !Select [ 1, !Cidr [ 10.100.0.0/26, 4, 4 ] ]
VpcId: !Ref Vpc
InternetGateway:
Type: AWS::EC2::InternetGateway
Properties: {}
InternetGatewayAttachment:
Type: AWS::EC2::VPCGatewayAttachment
Properties:
InternetGatewayId: !Ref InternetGateway
VpcId: !Ref Vpc
RouteTable:
Type: AWS::EC2::RouteTable
Properties:
VpcId: !Ref Vpc
Route:
Type: AWS::EC2::Route
Properties:
DestinationCidrBlock: 0.0.0.0/0
GatewayId: !Ref InternetGateway
RouteTableId: !Ref RouteTable
# ====================================================
# EFS FOR PERSISTENT DATA
# ====================================================
Efs:
Type: AWS::EFS::FileSystem
DeletionPolicy: Retain
Properties:
LifecyclePolicies:
- TransitionToIA: AFTER_7_DAYS
- TransitionToPrimaryStorageClass: AFTER_1_ACCESS
MountA:
Type: AWS::EFS::MountTarget
Properties:
FileSystemId: !Ref Efs
SecurityGroups:
- !Ref EfsSg
SubnetId: !Ref SubnetA
MountB:
Type: AWS::EFS::MountTarget
Properties:
FileSystemId: !Ref Efs
SecurityGroups:
- !Ref EfsSg
SubnetId: !Ref SubnetB
EfsSg:
Type: AWS::EC2::SecurityGroup
Properties:
GroupName: !Sub "${AWS::StackName}-efs"
GroupDescription: !Sub "${AWS::StackName}-efs"
SecurityGroupIngress:
- FromPort: 2049
ToPort: 2049
IpProtocol: tcp
SourceSecurityGroupId: !Ref Ec2Sg
VpcId: !Ref Vpc
# ====================================================
# INSTANCE CONFIG
# ====================================================
Ec2Sg:
Type: AWS::EC2::SecurityGroup
Properties:
GroupName: !Sub "${AWS::StackName}-ec2"
GroupDescription: !Sub "${AWS::StackName}-ec2"
SecurityGroupIngress:
- !If
- IpAddressProvided
- FromPort: 22
ToPort: 22
IpProtocol: tcp
CidrIp: !Sub "${YourIp}/32"
- !Ref 'AWS::NoValue'
- FromPort: 34197
ToPort: 34197
IpProtocol: udp
CidrIp: 0.0.0.0/0
- !If
- DoEnableRcon
- FromPort: 27015
ToPort: 27015
IpProtocol: tcp
CidrIp: 0.0.0.0/0
- !Ref 'AWS::NoValue'
VpcId: !Ref Vpc
LaunchConfiguration:
Type: AWS::AutoScaling::LaunchConfiguration
Properties:
AssociatePublicIpAddress: true
IamInstanceProfile: !Ref InstanceProfile
ImageId: !Ref ECSAMI
InstanceType: !Ref InstanceType
KeyName:
!If [ KeyPairNameProvided, !Ref KeyPairName, !Ref 'AWS::NoValue' ]
SecurityGroups:
- !Ref Ec2Sg
SpotPrice: !If [ SpotPriceProvided, !Ref SpotPrice, !Ref 'AWS::NoValue' ]
UserData:
Fn::Base64: !Sub |
#!/bin/bash -xe
echo ECS_CLUSTER=${EcsCluster} >> /etc/ecs/ecs.config
AutoScalingGroup:
Type: AWS::AutoScaling::AutoScalingGroup
Properties:
AutoScalingGroupName: !Sub "${AWS::StackName}-asg"
DesiredCapacity: !FindInMap [ ServerState, !Ref ServerState, DesiredCapacity ]
LaunchConfigurationName: !Ref LaunchConfiguration
MaxSize: !FindInMap [ ServerState, !Ref ServerState, DesiredCapacity ]
MinSize: !FindInMap [ ServerState, !Ref ServerState, DesiredCapacity ]
VPCZoneIdentifier:
- !Ref SubnetA
- !Ref SubnetB
InstanceRole:
Type: AWS::IAM::Role
Properties:
AssumeRolePolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Principal:
Service:
- ec2.amazonaws.com
Action:
- sts:AssumeRole
ManagedPolicyArns:
- arn:aws:iam::aws:policy/service-role/AmazonEC2ContainerServiceforEC2Role
Policies:
- PolicyName: root
PolicyDocument:
Version: "2012-10-17"
Statement:
- Effect: "Allow"
Action: "route53:*"
Resource: "*"
InstanceProfile:
Type: AWS::IAM::InstanceProfile
Properties:
Roles:
- !Ref InstanceRole
EcsCluster:
Type: AWS::ECS::Cluster
Properties:
ClusterName: !Sub "${AWS::StackName}-cluster"
EcsService:
Type: AWS::ECS::Service
Properties:
Cluster: !Ref EcsCluster
DesiredCount: !FindInMap [ ServerState, !Ref ServerState, DesiredCapacity ]
ServiceName: !Sub "${AWS::StackName}-ecs-service"
TaskDefinition: !Ref EcsTask
DeploymentConfiguration:
MaximumPercent: 100
MinimumHealthyPercent: 0
EcsTask:
Type: AWS::ECS::TaskDefinition
DependsOn:
- MountA
- MountB
Properties:
Volumes:
- Name: factorio
EFSVolumeConfiguration:
FilesystemId: !Ref Efs
TransitEncryption: ENABLED
ContainerDefinitions:
- Name: factorio
MemoryReservation: 1024
Image: !Sub "factoriotools/factorio:${FactorioImageTag}"
PortMappings:
- ContainerPort: 34197
HostPort: 34197
Protocol: udp
- ContainerPort: 27015
HostPort: 27015
Protocol: tcp
MountPoints:
- ContainerPath: /factorio
SourceVolume: factorio
ReadOnly: false
Environment:
- Name: UPDATE_MODS_ON_START
Value: !Sub "${UpdateModsOnStart}"
# ====================================================
# SET DNS RECORD
# ====================================================
SetDNSRecordLambdaRole:
Type: AWS::IAM::Role
Condition: DnsConfigEnabled
Properties:
AssumeRolePolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Principal:
Service:
- lambda.amazonaws.com
Action:
- sts:AssumeRole
ManagedPolicyArns:
- arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
Policies:
- PolicyName: root
PolicyDocument:
Version: "2012-10-17"
Statement:
- Effect: "Allow"
Action: "route53:*"
Resource: "*"
- Effect: "Allow"
Action: "ec2:DescribeInstance*"
Resource: "*"
SetDNSRecordLambda:
Type: "AWS::Lambda::Function"
Condition: DnsConfigEnabled
Properties:
Environment:
Variables:
HostedZoneId: !Ref HostedZoneId
RecordName: !Ref RecordName
Code:
ZipFile: |
import boto3
import os
def handler(event, context):
new_instance = boto3.resource('ec2').Instance(event['detail']['EC2InstanceId'])
boto3.client('route53').change_resource_record_sets(
HostedZoneId= os.environ['HostedZoneId'],
ChangeBatch={
'Comment': 'updating',
'Changes': [
{
'Action': 'UPSERT',
'ResourceRecordSet': {
'Name': os.environ['RecordName'],
'Type': 'A',
'TTL': 60,
'ResourceRecords': [
{
'Value': new_instance.public_ip_address
},
]
}
},
]
})
Description: Sets Route 53 DNS Record for Factorio
FunctionName: !Sub "${AWS::StackName}-set-dns"
Handler: index.handler
MemorySize: 128
Role: !GetAtt SetDNSRecordLambdaRole.Arn
Runtime: python3.12
Timeout: 20
LaunchEvent:
Type: AWS::Events::Rule
Condition: DnsConfigEnabled
Properties:
EventPattern:
source:
- aws.autoscaling
detail-type:
- EC2 Instance Launch Successful
detail:
AutoScalingGroupName:
- !Ref AutoScalingGroup
Name: !Sub "${AWS::StackName}-instance-launch"
State: ENABLED
Targets:
- Arn: !GetAtt SetDNSRecordLambda.Arn
Id: !Sub "${AWS::StackName}-set-dns"
LaunchEventLambdaPermission:
Type: AWS::Lambda::Permission
Condition: DnsConfigEnabled
Properties:
Action: lambda:InvokeFunction
FunctionName: !GetAtt SetDNSRecordLambda.Arn
Principal: events.amazonaws.com
SourceArn: !GetAtt LaunchEvent.Arn
Outputs:
CheckInstanceIp:
Description: To find your Factorio instance IP address, visit the following link. Click on the instance to find its Public IP address.
Value: !Sub "https://${AWS::Region}.console.aws.amazon.com/ec2/v2/home?region=${AWS::Region}#Instances:tag:aws:autoscaling:groupName=${AutoScalingGroup};sort=tag:Name"