事前作業2.3. EC2インスタンスの起動 (ユーザーデータ/インスタンスプロファイル/キーペア/パブリックIP: handson-cli-ec2-ami-builder-instance)

手順の目的 [why]

EC2インスタンス名"handson-cli-ec2-ami-builder-instance"を起動します。

設定値の指定

設定値の指定

手順に必要な設定値を変数に格納をします。

0. リージョンの指定

リージョンを指定します。

環境変数の設定:

export AWS_DEFAULT_REGION='ap-northeast-1'

1. EC2インスタンスのタグ名

EC2インスタンスのタグ名の指定します。

変数の設定:

EC2_INSTANCE_TAG_NAME='handson-cli-ec2-ami-builder-instance'

2. 起動時に利用するAMIイメージ名

起動時に利用するAMIイメージ名の指定します。

変数の設定:

EC2_INSTANCE_IMAGE_NAME="amzn2-ami-hvm-2.0.20210813.1-x86_64-gp2"

3. VPCのタグ名

VPCのタグ名の指定します。

変数の設定:

EC2_VPC_TAG_NAME='handson-cli-ec2-ami-vpc'

4. サブネットのタグ名

サブネットのタグ名の指定します。

変数の設定:

EC2_SUBNET_TAG_NAME='handson-cli-ec2-ami-subnet'

5. セキュリティグループ名

セキュリティグループ名の指定します。

変数の設定:

EC2_SECURITY_GROUP_NAME='handson-cli-ec2-ami-sg'

6. EC2インスタンスのインスタンスタイプ

EC2インスタンスのインスタンスタイプの指定します。

変数の設定:

EC2_INSTANCE_TYPE="t2.micro"

7. ユーザーデータファイル

ユーザーデータファイルの指定します。

変数の設定:

USER_DATA_NAME='handson-cli-ec2-ami-builder-userdata'

変数の設定:

DIR_USER_DATA="${HOME}/environment/conf-handson-cli-ec2-ami"

変数の設定:

FILE_USER_DATA="${DIR_USER_DATA}/${USER_DATA_NAME}.bash" \
  && echo ${FILE_USER_DATA}

結果(例):

${HOME}/environment/conf-handson-cli-ec2-ami/handson-cli-ec2-ami-builder-userdata.bash

8. インスタンスプロファイル名

インスタンスプロファイル名を指定します。

変数の設定:

IAM_INSTANCE_PROFILE_NAME='handson-cli-ec2-ami-instance-profile'

9. EC2キーペア名の指定

EC2キーペア名を指定します。

変数の設定:

EC2_KEY_PAIR_NAME="handson-cli-ec2-ami-keypair"

設定値の確認

各変数に正しい設定値が格納されていることを確認しながら保存します。

変数の確認:

cat << END

  # 0. AWS_DEFAULT_REGION:"ap-northeast-1"
       AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 1. EC2_INSTANCE_TAG_NAME:"handson-cli-ec2-ami-builder-instance"
       EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}"
  # 2. EC2_INSTANCE_IMAGE_NAME:"amzn2-ami-hvm-2.0.20210813.1-x86_64-gp2"
       EC2_INSTANCE_IMAGE_NAME="${EC2_INSTANCE_IMAGE_NAME}"
  # 3. EC2_VPC_TAG_NAME:"handson-cli-ec2-ami-vpc"
       EC2_VPC_TAG_NAME="${EC2_VPC_TAG_NAME}"
  # 4. EC2_SUBNET_TAG_NAME:"handson-cli-ec2-ami-subnet"
       EC2_SUBNET_TAG_NAME="${EC2_SUBNET_TAG_NAME}"
  # 5. EC2_SECURITY_GROUP_NAME:"handson-cli-ec2-ami-sg"
       EC2_SECURITY_GROUP_NAME="${EC2_SECURITY_GROUP_NAME}"
  # 6. EC2_INSTANCE_TYPE:"t2.micro"
       EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}"
  # 7. FILE_USER_DATA:"${HOME}/environment/conf-handson-cli-ec2-ami/handson-cli-ec2-ami-builder-userdata.bash"
       FILE_USER_DATA="${FILE_USER_DATA}"
  # 8. IAM_INSTANCE_PROFILE_NAME:"handson-cli-ec2-ami-instance-profile"
       IAM_INSTANCE_PROFILE_NAME="${IAM_INSTANCE_PROFILE_NAME}"
  # 9. EC2_KEY_PAIR_NAME:"handson-cli-ec2-ami-keypair"
       EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}"

END

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

処理の実行

イメージIDを取得します。

コマンド:

EC2_INSTANCE_IMAGE_ID=$( \
  aws ec2 describe-images \
    --filters Name=name,Values="${EC2_INSTANCE_IMAGE_NAME}" \
    --query 'Images[].ImageId' \
    --output text \
) \
  && echo ${EC2_INSTANCE_IMAGE_ID}

結果(例):

ami-02892a4ea9bfa2192

VPC IDを取得します。

コマンド:

EC2_VPC_ID=$( \
  aws ec2 describe-vpcs \
    --filters Name=tag:Name,Values=${EC2_VPC_TAG_NAME}  \
    --query 'Vpcs[].VpcId' \
    --output text \
) \
  && echo ${EC2_VPC_ID}

結果(例):

vpc-xxxxxxxxxxxxxxxxx

サブネットIDを取得します。

コマンド:

EC2_SUBNET_ID=$( \
  aws ec2 describe-subnets \
    --filters Name=vpc-id,Values=${EC2_VPC_ID} \
              Name=tag:Name,Values=${EC2_SUBNET_TAG_NAME}  \
    --query "Subnets[].SubnetId" \
    --output text \
) \
  && echo ${EC2_SUBNET_ID}

結果(例):

subnet-xxxxxxxxxxxxxxxxx

セキュリティグループIDを取得します。

コマンド:

EC2_SECURITY_GROUP_ID=$( \
  aws ec2 describe-security-groups \
    --filter Name=vpc-id,Values=${EC2_VPC_ID} \
      Name=group-name,Values=${EC2_SECURITY_GROUP_NAME} \
    --query "SecurityGroups[].GroupId" \
    --output text \
) \
  && echo ${EC2_SECURITY_GROUP_ID}

結果(例):

sg-xxxxxxxxxxxxxxxxx

セキュリティグループを配列にして変数に格納します。

変数の設定:

ARRAY_EC2_SECURITY_GROUP_IDS="${EC2_SECURITY_GROUP_ID}" \
  && echo ${ARRAY_EC2_SECURITY_GROUP_IDS}

結果(例):

sg-xxxxxxxxxxxxxxxxx

タグ設定文字列を生成して変数に格納します。

変数の設定:

EC2_TAG_KEY='Name'

変数の設定:

STRING_TAG_CONF_INSTANCE="ResourceType=instance,Tags=[{Key=${EC2_TAG_KEY},Value=${EC2_INSTANCE_TAG_NAME}}]" \
  && echo ${STRING_TAG_CONF_INSTANCE}

結果(例):

ResourceType=instance,Tags=[{Key=Name,Value=handson-cli-ec2-ami-builder-instance}]

EC2インスタンスを起動します。

変数の確認:

cat << END

  # EC2_INSTANCE_IMAGE_ID:"ami-02892a4ea9bfa2192"
    EC2_INSTANCE_IMAGE_ID="${EC2_INSTANCE_IMAGE_ID}"
  # EC2_INSTANCE_TYPE:"t2.micro"
    EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}"
  # ARRAY_EC2_SECURITY_GROUP_IDS:"sg-xxxxxxxxxxxxxxxxx"
    ARRAY_EC2_SECURITY_GROUP_IDS="${ARRAY_EC2_SECURITY_GROUP_IDS}"
  # STRING_TAG_CONF_INSTANCE:"ResourceType=instance,Tags=[{Key=Name,Value=handson-cli-ec2-ami-builder-instance}]"
    STRING_TAG_CONF_INSTANCE="${STRING_TAG_CONF_INSTANCE}"
  # EC2_SUBNET_ID:"subnet-xxxxxxxxxxxxxxxxx"
    EC2_SUBNET_ID="${EC2_SUBNET_ID}"
  # FILE_USER_DATA:"${HOME}/environment/conf-handson-cli-ec2-ami/handson-cli-ec2-ami-builder-userdata.bash"
    FILE_USER_DATA="${FILE_USER_DATA}"
  # IAM_INSTANCE_PROFILE_NAME:"handson-cli-ec2-ami-instance-profile"
    IAM_INSTANCE_PROFILE_NAME="${IAM_INSTANCE_PROFILE_NAME}"
  # EC2_KEY_PAIR_NAME:"handson-cli-ec2-ami-keypair"
    EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}"

END

コマンド:

aws ec2 run-instances \
  --image-id ${EC2_INSTANCE_IMAGE_ID} \
  --instance-type ${EC2_INSTANCE_TYPE} \
  --security-group-ids ${ARRAY_EC2_SECURITY_GROUP_IDS} \
  --tag-specifications ${STRING_TAG_CONF_INSTANCE} \
  --subnet-id ${EC2_SUBNET_ID} \
  --user-data file://${FILE_USER_DATA} \
  --iam-instance-profile Name=${IAM_INSTANCE_PROFILE_NAME} \
  --key-name ${EC2_KEY_PAIR_NAME} \
  --associate-public-ip-address

結果(例):

{
  "Instances": [
    {
        "Monitoring": {
            "State": "disabled"
        },
        "PublicDnsName": "",
        "StateReason": {
            "Message": "pending",
            "Code": "pending"
        },
        "State": {
            "Code": 0,
            "Name": "pending"
        },
        "EbsOptimized": false,
        "LaunchTime": "2021-09-12T01:23:45.000Z",
        "PrivateIpAddress": "xxx.xxx.xxx.xxx",
        "ProductCodes": [],
        "VpcId": "vpc-xxxxxxxx",
        "StateTransitionReason": "",
        "InstanceId": "i-xxxxxxxxxxxxxxxxx",
        "ImageId": "ami-xxxxxxxx",
        "PrivateDnsName": "ip-xxx-xxx-xxx-xxx.ap-northeast-1.compute.internal",
        "KeyName": "handson-cli-ec2-ami-keypair",
        "SecurityGroups": [
            {
                "GroupName": "handson-cli-ec2-ami-sg",
                "GroupId": "sg-xxxxxxxx"
            }
        ],
        "ClientToken": "",
        "SubnetId": "subnet-xxxxxxxx",
        "InstanceType": "t2.micro",
        "NetworkInterfaces": [
            {
                "Status": "in-use",
                "MacAddress": "xx:xx:xx:xx:xx:xx",
                "SourceDestCheck": true,
                "VpcId": "vpc-xxxxxxxx",
                "Description": "",
                "NetworkInterfaceId": "eni-xxxxxxxx",
                "PrivateIpAddresses": [
                    {
                        "Primary": true,
                        "PrivateIpAddress": "xxx.xxx.xxx.xxx"
                    }
                ],
                "SubnetId": "subnet-xxxxxxxx",
                "Attachment": {
                    "Status": "attaching",
                    "DeviceIndex": 0,
                    "DeleteOnTermination": true,
                    "AttachmentId": "eni-attach-xxxxxxxx",
                    "AttachTime": "2021-09-12T01:23:45.000Z"
                },
                "Groups": [
                    {
                        "GroupName": "handson-cli-ec2-ami-sg",
                        "GroupId": "sg-xxxxxxxx"
                    }
                ],
                "Ipv6Addresses": [],
                "OwnerId": "XXXXXXXXXXXX",
                "PrivateIpAddress": "xxx.xxx.xxx.xxx"
            }
        ],
        "SourceDestCheck": true,
        "Placement": {
            "Tenancy": "default",
            "GroupName": "",
            "AvailabilityZone": "ap-northeast-1a"
        },
        "Hypervisor": "xen",
        "BlockDeviceMappings": [],
        "Architecture": "x86_64",
        "RootDeviceType": "ebs",
        "IamInstanceProfile": {
            "Id": "AIPAXXXXXXXXXXXXXXXXX",
            "Arn": "arn:aws:iam::XXXXXXXXXXXX:instance-profile/handson-cli-ec2-ami-instance-profile"
        },
        "RootDeviceName": "/dev/xvda",
        "VirtualizationType": "hvm",
        "Tags": [
            {
                "Value": "handson-cli-ec2-ami-builder-instance",
                "Key": "Name"
            }
        ],
        "AmiLaunchIndex": 0
    }
  ],
  "ReservationId": "r-xxxxxxxxxxxxxxxxx",
  "Groups": [],
  "OwnerId": "XXXXXXXXXXXX"
}

完了確認

「ステータスが"running"のEC2インスタンス"handson-cli-ec2-ami-builder-instance"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-instances \
  --filters Name=tag-key,Values=Name \
            Name=tag-value,Values=${EC2_INSTANCE_TAG_NAME} \
            Name=instance-state-name,Values=running \
  --query Reservations[].Instances[].Tags[].Value \
  --output text

結果(例):

handson-cli-ec2-ami-builder-instance

注釈

表示されるまで数十秒程度かかります。

手順の完了