1. EC2キーペアの作成 (handson-cli-keypair)

作業の目的 [why]

キーペア"handson-cli-keypair"を作成します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1
キーペア"handson-cli-keypair"が存在する。
完了条件2
SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"が存在する。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1
鍵ファイル用ディレクトリが存在する。
事前条件2
キーペア"handson-cli-keypair"が存在しない。
事前条件3
SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"が存在しない。

前提と異なることが判明した場合、直ちに処理を中止します。

作業対象 [what]

  • EC2サービス

標準時間(合計)

8分

パラメータ設定

パラメータ設定の標準時間:2分

作業に必要なモノ・情報 [resource]

作業開始には、以下が全て揃っていることが必要です。

リソース1: 鍵ファイル用ディレクトリ

  • 今回は"${HOME}/.ssh"を鍵ファイル用ディレクトリとします。

ディレクトリが存在することを確認します。

コマンド:

ls -d ${HOME}/.ssh

結果(例:存在する場合):

${HOME}/.ssh

存在しない場合は作成します。

コマンド:

mkdir -p ${HOME}/.ssh

パーミッションは700にします。

コマンド:

chmod 700 ${HOME}/.ssh

リソース2: キーペア名

  • 作成するキーペアの名称です。
  • 今回は"handson-cli-keypair"とします。

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='us-west-2'

0.1. 鍵ファイルディレクトリの指定

変数の設定:

DIR_KEY="${HOME}/.ssh"

0.2. キーペア名の指定

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

変数の設定:

EC2_KEY_PAIR_NAME='handson-cli-keypair'

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-key_pair-create.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-ec2-key_pair-create.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"us-west-2"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. DIR_KEY:"${HOME}/.ssh"
         DIR_KEY="${DIR_KEY}"
  # 0.2. EC2_KEY_PAIR_NAME:"handson-cli-keypair"
         EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 状態確認に必要な情報の取得

AWS IDの取得

コマンド:

AWS_ID=$( \
  aws sts get-caller-identity \
    --query 'Account' \
    --output text \
) \
  && echo ${AWS_ID}

結果(例):

XXXXXXXXXXXX

SSH秘密鍵ファイル名の指定

SSH秘密鍵ファイル名を指定します。

変数の設定:

FILE_SSH_KEY="${DIR_KEY}/${EC2_KEY_PAIR_NAME}-${AWS_ID}-${AWS_DEFAULT_REGION}-ec2.pem" \
  && echo ${FILE_SSH_KEY}

結果(例):

${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem

1.2. 処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: 鍵ファイル用ディレクトリが存在する。

「鍵ファイル用ディレクトリが存在する。」ことを確認します。

コマンド:

ls -d ${DIR_KEY}

結果(例):

${HOME}/.ssh

事前条件2: キーペア"handson-cli-keypair"が存在しない。

「キーペア"handson-cli-keypair"が存在しない。」ことを確認します。

コマンド:

aws ec2 describe-key-pairs \
  --query "KeyPairs[?KeyName == \`${EC2_KEY_PAIR_NAME}\`].KeyName" \
  --output text

結果(例):

(出力なし)

事前条件3: SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"が存在しない。

「SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_SSH_KEY}

結果:

ls: ${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem No such file or directory

2. 主処理

キーペアの作成

変数の確認:

cat << ETX

  # EC2_KEY_PAIR_NAME:"handson-cli-keypair"
    EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}"
  # FILE_SSH_KEY:"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"
    FILE_SSH_KEY="${FILE_SSH_KEY}"

ETX

コマンド:

aws ec2 create-key-pair \
  --key-name ${EC2_KEY_PAIR_NAME} \
  --query 'KeyMaterial' --output text \
> ${FILE_SSH_KEY} \
&& cat ${FILE_SSH_KEY} \
&& chmod 400 ${FILE_SSH_KEY}

結果(例):

-----BEGIN RSA PRIVATE KEY-----
MIIEoQIBAAKCAQEAoeEnI72MIR/mCwTI9qBrD8vMPpBB3Jal5VsUvF4WX8j9q9yy/5SuSnoVptziYhc8n389ZkbHZaBK/hgEcNNecSpYcYSYmrpzLDDs1DTtdlNcLtExA3n0RmXnp1dO5WRmIothbVDzB9tFWURj1z/o4N1N2hMer+tV/0qQdFIG/7XkzzalIGHbbE1q+ZUiwGEygTvbZEjR/BjvT4VKf+Yyp5KrX+ZGpLCntDWoecRZdc1hZE+3mA+mF8p5pDdHR8nNqMVvmBB6uhGqChGsDnDGnIoC1YrV4YrjyZ+ej7W6ljlSmEbk6U4VdTr+GKOq79i1A6rR53/CqAnca3KlGNwuRwIDAQABAoH/fJHGjLpQGy1w2QnVm/PWb1Fk2sAn7pf/EYAFdO7ySMNicd5j4EmJ1cYc40sW6mT3QcWoegv9ZTb0fpP81tXQ10S+ypw+0tKnzlnX5XTVRzjetyhDj2lJkOLaYOvOyrd34R1g275vRpx1wTvfmMSVcHTcc/RCqR1wEARRJTH6MMuH/MfzjZhMSGCyzEL1ZA0p2vzKQIkZj1cUZwsIA6FP+wIEydQXUBrX+GGx5NNq5jU5kvHXUhNaT+xlvIqAWSf/TSC38soPtIfww2EYKIza9bfdBQSwy+gcAp2I+tJcE8N6e7zJgPQ2jMsViiw+q3+42a1F1iab3fG43Iin1wjhAoGBAPkvgR9MBeakAUvPJebv8wpTyzcDmfOVhd0CLD8NdvPiz3Vr9LF1F0DkH9fnQbSXw14+ns1lWenhLkNBp0t24p0QiCdGOM3uh5KQnYfkCy38rrG6JaP9rlm7+AqAE8QNZCx/9ld3SgKblSph9UPqihuVJcBIXy/YOs6h9onWpOERAoGBAKZOb+rBdNcNl4RMRfdkjzkxJG7JhNPhdFobzrwaglArAZZhTLQwpOTEGNlPjzv3N1VMdJlI6Nb/rC8HrZAaHp50/ZTkBnGs4Z49QvIWERyChcezlvPBTGr5OGm0NF1TZKufLmoLsUYszpY0Zeksn/U965GaraOumk8DoR6r4JnXAoGBAIXWfgPRUVoPvKJ7IGBpgKCLYRqrVIUASmXqRNmY4csch1EKKuMlgNfZr0DHdQMKgGSePa0UQrbbu31kRfbCY/T4bCisDtaMx0RxaCsU0OxiS3IqCQ2Ls5l+3DrHj9Y9WxCLqkRQTfAYoIWjF5ji4ErwUNZ2CKop+WwCkeh24RgBAoGAe7HxijFT3zRr0uoMTELOSGKlz4Uxt4qESRVPwhcRf+FM7/X04D0iGElGljOXvKlWzantO6nADVHjVqOmU30p8v/fMKQdquVEdrboGTmShpsKOAv6pdjLJvGxJOX04MlLIl9mXVfPBfwDuDLG7hTT8MuacBUVO559hXGUoESE7McCgYBbI5bGY11Hgq3dv+48FnlxVdd8Yj5KKvkNrAeCwg4aGns+en0tBU1mCIwEUhlJQH5fFdvVlWT98zOzcy5NemNwbD8a6Po3AFi7aIt3J1GpZqmIKaCxGmlREs7bUDGal8N+g0723pGMQVD0mqbw7KTL+6juANXayjaYpFAOwGc8BA==
-----END RSA PRIVATE KEY-----

3. 後処理

完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: キーペア"handson-cli-keypair"が存在する。

「キーペア"handson-cli-keypair"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-key-pairs \
  --query "KeyPairs[?KeyName == \`${EC2_KEY_PAIR_NAME}\`].KeyName" \
  --output text

結果(例):

handson-cli-keypair

完了条件2: SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"が存在する。

「SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"が存在する。」ことを確認します。

コマンド:

ls ${FILE_SSH_KEY}

結果:

${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem

完了