後始末7. Lightsailキーペアの削除 (handson-cli-lightsail-key_pair)¶
作業の目的 [why]¶
Lightsailキーペア"handson-cli-lightsail-key_pair"を削除します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
Lightsailキーペア"handson-cli-lightsail-key_pair"が存在しない。
- 完了条件2
SSH秘密鍵"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"が存在しない。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
Lightsailキーペア"handson-cli-lightsail-key_pair"が存在する。
- 事前条件2
SSH秘密鍵"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"が存在する。
作業対象 [what]¶
Lightsailキーペア
標準時間(合計)¶
8分
パラメータ設定¶
- パラメータ設定の標準時間
2分
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: Lightsailキーペア名
削除するLightsailキーペアの名称です。
今回は"handson-cli-lightsail-key_pair"とします。
リソース2: SSH秘密鍵ファイル名
削除するキーペアのSSH秘密鍵のファイル名です。
今回は"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. Lightsailキーペア名の指定¶
キーペア名を指定します。
変数の設定:
LIGHTSAIL_KEY_PAIR_NAME="handson-cli-lightsail-key_pair"
0.2. SSH秘密鍵ファイル名の指定¶
ディレクトリを指定します。
変数の設定:
DIR_SSH="${HOME}/.ssh"
AWS IDを取得します。
コマンド:
AWS_ID=$( \ aws sts get-caller-identity \ --query 'Account' \ --output text \ ) \ && echo ${AWS_ID}
結果(例):
XXXXXXXXXXXX
SSH秘密鍵ファイル名を指定します。
変数の設定:
FILE_SSH_KEY_SECRET="${DIR_SSH}/${LIGHTSAIL_KEY_PAIR_NAME}-${AWS_ID}-${AWS_DEFAULT_REGION}-lightsail.pem" \ && echo ${FILE_SSH_KEY_SECRET}
結果(例):
${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-lightsail" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-lightsail-key_pair-delete.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-lightsail/2020-02-10-lightsail-key_pair-delete.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. LIGHTSAIL_KEY_PAIR_NAME:"handson-cli-lightsail-key_pair" LIGHTSAIL_KEY_PAIR_NAME="${LIGHTSAIL_KEY_PAIR_NAME}" # 0.2. FILE_SSH_KEY_SECRET:"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem" FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
- タスク標準時間
6分
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: Lightsailキーペア"handson-cli-lightsail-key_pair"が存在する。
「Lightsailキーペア"handson-cli-lightsail-key_pair"が存在する。」ことを確認します。
コマンド:
aws lightsail get-key-pairs \ --query "keyPairs[?name == \`${LIGHTSAIL_KEY_PAIR_NAME}\`].name" \ --output text
結果(例):
handson-cli-lightsail-key_pair
事前条件2: SSH秘密鍵"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"が存在する。
「SSH秘密鍵"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"が存在する。」ことを確認します。
コマンド:
ls ${FILE_SSH_KEY_SECRET}
結果(例):
${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem
2. 主処理¶
2.1. Lightsailキーペアの削除¶
変数の確認:
cat << ETX # LIGHTSAIL_KEY_PAIR_NAME:"handson-cli-lightsail-key_pair" LIGHTSAIL_KEY_PAIR_NAME="${LIGHTSAIL_KEY_PAIR_NAME}" ETX
コマンド:
aws lightsail delete-key-pair \ --key-pair-name ${LIGHTSAIL_KEY_PAIR_NAME}
結果(例):
{ "operation": { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "resourceName": "handson-cli-lightsail-key_pair", "resourceType": "KeyPair", "createdAt": 1234567890.123, "location": { "availabilityZone": "all", "regionName": "ap-northeast-1" }, "isTerminal": true, "operationType": "DeleteKeyPair", "status": "Succeeded", "statusChangedAt": 1234567890.123 } }
2.2. SSH秘密鍵の削除¶
変数の確認:
cat << ETX # FILE_SSH_KEY_SECRET:"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem" FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}" ETX
コマンド:
rm -f ${FILE_SSH_KEY_SECRET}
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: Lightsailキーペア"handson-cli-lightsail-key_pair"が存在しない。
「Lightsailキーペア"handson-cli-lightsail-key_pair"が存在しない。」ことを確認します。
コマンド:
aws lightsail get-key-pairs \ --query "keyPairs[?name == \`${LIGHTSAIL_KEY_PAIR_NAME}\`].name" \ --output text
結果(例):
(出力なし)
完了条件2: SSH秘密鍵"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"が存在しない。
「SSH秘密鍵"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"が存在しない。」ことを確認します。
コマンド:
! ls ${FILE_SSH_KEY_SECRET}
結果(例):
ls: ${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem No such file or directory