テンプレートパラメーターに従って、Cloudformationテンプレートで可変数のEC2インスタンスリソースを作成する方法
EC2 APIと管理ツールでは、同じAMIの複数のインスタンスを起動できますが、Cloudformationを使用してこれを行う方法を見つけることができません。
AWS::EC2::Instance
リソースは、基になる MinCount
APIのMaxCount
/RunInstances
パラメータをサポートしていませんなので、このリソースの単一のコピーにパラメーターを渡すことで、可変数のEC2インスタンスを作成することはできません。
テンプレートパラメーターに従ってCloudFormationテンプレートで可変数のEC2インスタンスリソースを作成するには、代わりにAuto Scalingグループをデプロイせずに、2つのオプションがあります。
Conditions
を使用して、パラメーターに応じて可変数のAWS::EC2::Instance
リソースを作成できます。
少し冗長ですが( Fn::Equals
を使用する必要があるため)、機能します。
ユーザーが最大で5インスタンスを指定できるようにする実用的な例を次に示します。
Description: Create a variable number of EC2 instance resources.
Parameters:
InstanceCount:
Description: Number of EC2 instances (must be between 1 and 5).
Type: Number
Default: 1
MinValue: 1
MaxValue: 5
ConstraintDescription: Must be a number between 1 and 5.
ImageId:
Description: Image ID to launch EC2 instances.
Type: AWS::EC2::Image::Id
# amzn-AMI-hvm-2016.09.1.20161221-x86_64-gp2
Default: AMI-9be6f38c
InstanceType:
Description: Instance type to launch EC2 instances.
Type: String
Default: m3.medium
AllowedValues: [ m3.medium, m3.large, m3.xlarge, m3.2xlarge ]
Conditions:
Launch1: !Equals [1, 1]
Launch2: !Not [!Equals [1, !Ref InstanceCount]]
Launch3: !And
- !Not [!Equals [1, !Ref InstanceCount]]
- !Not [!Equals [2, !Ref InstanceCount]]
Launch4: !Or
- !Equals [4, !Ref InstanceCount]
- !Equals [5, !Ref InstanceCount]
Launch5: !Equals [5, !Ref InstanceCount]
Resources:
Instance1:
Condition: Launch1
Type: AWS::EC2::Instance
Properties:
ImageId: !Ref ImageId
InstanceType: !Ref InstanceType
Instance2:
Condition: Launch2
Type: AWS::EC2::Instance
Properties:
ImageId: !Ref ImageId
InstanceType: !Ref InstanceType
Instance3:
Condition: Launch3
Type: AWS::EC2::Instance
Properties:
ImageId: !Ref ImageId
InstanceType: !Ref InstanceType
Instance4:
Condition: Launch4
Type: AWS::EC2::Instance
Properties:
ImageId: !Ref ImageId
InstanceType: !Ref InstanceType
Instance5:
Condition: Launch5
Type: AWS::EC2::Instance
Properties:
ImageId: !Ref ImageId
InstanceType: !Ref InstanceType
上記のバリエーションとして、Rubyの Erb などのテンプレートプリプロセッサを使用して、指定された最大値に基づいて上記のテンプレートを生成し、ソースコードをよりコンパクトにして重複を排除できます。
<%max = 10-%>
Description: Create a variable number of EC2 instance resources.
Parameters:
InstanceCount:
Description: Number of EC2 instances (must be between 1 and <%=max%>).
Type: Number
Default: 1
MinValue: 1
MaxValue: <%=max%>
ConstraintDescription: Must be a number between 1 and <%=max%>.
ImageId:
Description: Image ID to launch EC2 instances.
Type: AWS::EC2::Image::Id
# amzn-AMI-hvm-2016.09.1.20161221-x86_64-gp2
Default: AMI-9be6f38c
InstanceType:
Description: Instance type to launch EC2 instances.
Type: String
Default: m3.medium
AllowedValues: [ m3.medium, m3.large, m3.xlarge, m3.2xlarge ]
Conditions:
Launch1: !Equals [1, 1]
Launch2: !Not [!Equals [1, !Ref InstanceCount]]
<%(3..max-1).each do |x|
low = (max-1)/(x-1) <= 1-%>
Launch<%=x%>: !<%=low ? 'Or' : 'And'%>
<% (1..max).each do |i|
if low && i >= x-%>
- !Equals [<%=i%>, !Ref InstanceCount]
<% elsif !low && i < x-%>
- !Not [!Equals [<%=i%>, !Ref InstanceCount]]
<% end
end
end-%>
Launch<%=max%>: !Equals [<%=max%>, !Ref InstanceCount]
Resources:
<%(1..max).each do |x|-%>
Instance<%=x%>:
Condition: Launch<%=x%>
Type: AWS::EC2::Instance
Properties:
ImageId: !Ref ImageId
InstanceType: !Ref InstanceType
<%end-%>
上記のソースをCloudFormation互換のテンプレートに処理するには、次のコマンドを実行します。
Ruby -rerb -e "puts ERB.new(ARGF.read, nil, '-').result" < template.yml > template-out.yml
便宜上、ここでは 10変数EC2インスタンス に対して生成された出力YAMLを含む要点を示します。
別の方法は、 RunInstances
/ TerminateInstances
APIを直接呼び出す Custom Resource を実装することです。
Description: Create a variable number of EC2 instance resources.
Parameters:
InstanceCount:
Description: Number of EC2 instances (must be between 1 and 10).
Type: Number
Default: 1
MinValue: 1
MaxValue: 10
ConstraintDescription: Must be a number between 1 and 10.
ImageId:
Description: Image ID to launch EC2 instances.
Type: AWS::EC2::Image::Id
# amzn-AMI-hvm-2016.09.1.20161221-x86_64-gp2
Default: AMI-9be6f38c
InstanceType:
Description: Instance type to launch EC2 instances.
Type: String
Default: m3.medium
AllowedValues: [ m3.medium, m3.large, m3.xlarge, m3.2xlarge ]
Resources:
EC2Instances:
Type: Custom::EC2Instances
Properties:
ServiceToken: !GetAtt EC2InstancesFunction.Arn
ImageId: !Ref ImageId
InstanceType: !Ref InstanceType
MinCount: !Ref InstanceCount
MaxCount: !Ref InstanceCount
EC2InstancesFunction:
Type: AWS::Lambda::Function
Properties:
Handler: index.handler
Role: !GetAtt LambdaExecutionRole.Arn
Code:
ZipFile: !Sub |
var response = require('cfn-response');
var AWS = require('aws-sdk');
exports.handler = function(event, context) {
var physicalId = event.PhysicalResourceId || 'none';
function success(data) {
return response.send(event, context, response.SUCCESS, data, physicalId);
}
function failed(e) {
return response.send(event, context, response.FAILED, e, physicalId);
}
var ec2 = new AWS.EC2();
var instances;
if (event.RequestType == 'Create') {
var launchParams = event.ResourceProperties;
delete launchParams.ServiceToken;
ec2.runInstances(launchParams).promise().then((data)=> {
instances = data.Instances.map((data)=> data.InstanceId);
physicalId = instances.join(':');
return ec2.waitFor('instanceRunning', {InstanceIds: instances}).promise();
}).then((data)=> success({Instances: instances})
).catch((e)=> failed(e));
} else if (event.RequestType == 'Delete') {
if (physicalId == 'none') {return success({});}
var deleteParams = {InstanceIds: physicalId.split(':')};
ec2.terminateInstances(deleteParams).promise().then((data)=>
ec2.waitFor('instanceTerminated', deleteParams).promise()
).then((data)=>success({})
).catch((e)=>failed(e));
} else {
return failed({Error: "In-place updates not supported."});
}
};
Runtime: nodejs4.3
Timeout: 300
LambdaExecutionRole:
Type: AWS::IAM::Role
Properties:
AssumeRolePolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Principal: {Service: [lambda.amazonaws.com]}
Action: ['sts:AssumeRole']
Path: /
ManagedPolicyArns:
- arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
Policies:
- PolicyName: EC2Policy
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- 'ec2:RunInstances'
- 'ec2:DescribeInstances'
- 'ec2:DescribeInstanceStatus'
- 'ec2:TerminateInstances'
Resource: ['*']
Outputs:
Instances:
Value: !Join [',', !GetAtt EC2Instances.Instances]
元のポスターの目的は次のようなものだと思います。
"Parameters" : {
"InstanceCount" : {
"Description" : "Number of instances to start",
"Type" : "String"
},
...
"MyAutoScalingGroup" : {
"Type" : "AWS::AutoScaling::AutoScalingGroup",
"Properties" : {
"AvailabilityZones" : {"Fn::GetAZs" : ""},
"LaunchConfigurationName" : { "Ref" : "MyLaunchConfiguration" },
"MinSize" : "1",
"MaxSize" : "2",
"DesiredCapacity" : **{ "Ref" : "InstanceCount" }**,
}
},
...つまり、パラメータから初期インスタンスの数(容量)を挿入します。
簡単に言えば、できません。まったく同じ結果を取得することはできません(N個の同一のEC2インスタンス、自動スケーリンググループに関連付けられていない)。
コンソールから同様に複数のインスタンスを起動することは、必要な容量としてN個のインスタンスを持つ自動スケーリンググループを作成することとは異なります。これは、同じEC2作成プロセスをN回実行する必要がなく、便利なショートカットです。これは「予約」と呼ばれます(予約済みインスタンスとは関係ありません)。自動スケーリンググループは別の獣です(N個の同一のEC2インスタンスで終わる場合でも)。
次のいずれかを行うことができます。
問題は、EC2インスタンスの数が動的ではなく、パラメーターにすることはできないことです。
その間、多くの AWS CloudFormationサンプルテンプレート が利用可能であり、いくつかは複数のインスタンスの起動を含みますが、通常は他の機能を並行して示します。たとえば、 AutoScalingKeepAtNSample.template は、負荷分散された自動スケーリングされたサンプルWebサイトを作成し、2つのEC2インスタンスを開始するように設定されていますこのテンプレートの抜粋によるこの目的:
"WebServerGroup": {
"Type": "AWS::AutoScaling::AutoScalingGroup",
"Properties": {
"AvailabilityZones": {
"Fn::GetAZs": ""
},
"LaunchConfigurationName": {
"Ref": "LaunchConfig"
},
"MinSize": "2",
"MaxSize": "2",
"LoadBalancerNames": [
{
"Ref": "ElasticLoadBalancer"
}
]
}
},
より高度な/完全なサンプルも利用できます。 Drupalのテンプレート マルチAZ Amazon RDSデータベースインスタンスを備え、ファイルコンテンツの格納にS3を使用する高可用性Webサーバー 、現在1〜5を許可するように構成されています Multi-AZ MySQL Amazon RDS データベースインスタンスと通信し、 Elastic Load Balancer の背後で実行されているWebサーバーインスタンスは、Webサーバーインスタンスを介して 自動スケーリング 。
Ref
関数を使用します。
http://docs.aws.Amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html
ユーザー定義変数は、構成ファイルの"Parameters"
セクションで定義されます。構成ファイルの"Resources"
セクションでは、これらのパラメーターへの参照を使用して値を入力できます。
{
"AWSTemplateFormatVersion": "2010-09-09",
...
"Parameters": {
"MinNumInstances": {
"Type": "Number",
"Description": "Minimum number of instances to run.",
"Default": "1",
"ConstraintDescription": "Must be an integer less than MaxNumInstances."
},
"MaxNumInstances": {
"Type": "Number",
"Description": "Maximum number of instances to run.",
"Default": "5",
"ConstraintDescription": "Must be an integer greater than MinNumInstances."
},
"DesiredNumInstances": {
"Type": "Number",
"Description": "Number of instances that need to be running before creation is marked as complete in CloudFormation management console.",
"Default": "1",
"ConstraintDescription": "Must be an integer in the range specified by MinNumInstances..MaxNumInstances."
}
},
"Resources": {
"MyAutoScalingGroup": {
"Type": "AWS::AutoScaling::AutoScalingGroup",
"Properties": {
...
"MinSize": { "Ref": "MinNumInstances" },
"MaxSize": { "Ref": "MaxNumInstances" },
"DesiredCapacity": { "Ref": "DesiredNumInstances" },
...
},
},
...
},
...
}
上記の例では、{ "Ref": ... }
を使用してテンプレートに値を入力しています。この場合、"MinSize"
および"MaxSize"
の値として整数を提供しています。