2. キーペア削除 (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
- キーペア"handson-cli-keypair"が存在する。
- 事前条件2
- SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"が存在する。
前提と異なることが判明した場合、直ちに処理を中止します。
作業対象 [what]¶
- キーペア
標準時間(合計)¶
8分
パラメータ設定¶
パラメータ設定の標準時間: | 2分 |
---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 鍵ファイル用ディレクトリ
鍵ファイルが存在するディレクトリ"${HOME}/.ssh"です。
リソース2: キーペア名
- 削除するキーペアの名称です。
- 今回は"handson-cli-keypair"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-key_pair-delete.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-ec2-key_pair-delete.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秘密鍵ファイル名を指定します。
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: キーペア"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
2. 主処理¶
2.1. キーペアの削除¶
変数の確認:
cat << ETX # EC2_KEY_PAIR_NAME:"handson-cli-keypair" EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}" ETX
コマンド:
aws ec2 delete-key-pair \ --key-name ${EC2_KEY_PAIR_NAME}
結果(例):
(出力なし)
2.2. SSH秘密鍵の削除¶
変数の確認:
cat << ETX # FILE_SSH_KEY:"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem" FILE_SSH_KEY="${FILE_SSH_KEY}" ETX
コマンド:
rm -f ${FILE_SSH_KEY}
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: キーペア"handson-cli-keypair"が存在しない。
「キーペア"handson-cli-keypair"が存在しない。」ことを確認します。
コマンド:
aws ec2 describe-key-pairs \ --query "KeyPairs[?KeyName == \`${EC2_KEY_PAIR_NAME}\`].KeyName" \ --output text
結果(例):
(出力なし)
完了条件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}
結果(例):
ls: ${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem No such file or directory