2. SSMパラメータストアの作成 (EC2キーペア: /handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2)

作業の目的 [why]

SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"を作成します。

ここでは、デフォルトのKMSキーを使用して暗号化します。

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

完了条件 [after]

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

完了条件1
SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"が存在する。

事前条件 [before]

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

事前条件1
SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"が存在しない。
事前条件2
SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"が存在する。

作業対象 [what]

  • SSMパラメータストア

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: キーペア名

  • パラメータストアに登録するSSH秘密鍵のキーペア名です。SSMパラメータ名に利用します。
  • 今回は"handson-cli-keypair"とします。

リソース2: SSMパラメータ名

  • 作成するSSMパラメータの名称です。
  • 今回は"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"とします。
  • プレフィクス"/handson-cli"は、パラメータへのアクセス制御のために利用します。

リソース3: SSMパラメータの説明

  • 作成するSSMパラメータの説明です。
  • 今回は"ハンズオン用キーペア"とします。

リソース4: SSH秘密鍵ファイル名

  • パラメータストアに登録するSSH秘密鍵のファイル名です。
  • 今回は"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='us-west-2'

0.1. キーペア名

パラメータに登録するキーペア名を指定します。

変数の設定:

EC2_KEY_PAIR_NAME="handson-cli-keypair"

0.2. SSMパラメータ名の指定

パラメータ名を指定します。

SSMパラメータのプレフィクス指定

変数の設定:

SSM_PARAMETER_PREFIX='handson-cli'

AWS IDの指定

変数の設定:

AWS_ID='XXXXXXXXXXXX'

注釈

キーペアとパラメータストアが同じAWSアカウントの場合は、以下のコマンドで取得できます。

コマンド:

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

結果(例):

XXXXXXXXXXXX

SSMパラメータ名の指定

変数の設定:

SSM_PARAMETER_NAME="/${SSM_PARAMETER_PREFIX}/keypair/${EC2_KEY_PAIR_NAME}-${AWS_ID}-${AWS_DEFAULT_REGION}" \
  && echo ${SSM_PARAMETER_NAME}

結果(例):

/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2

0.3. SSMパラメータの説明

SSMパラメータの説明を指定します。

変数の設定:

SSM_PARAMETER_DESC='ハンズオン用キーペア'

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

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

変数の設定:

FILE_DATA="${HOME}/.ssh/${EC2_KEY_PAIR_NAME}-${AWS_ID}-${AWS_DEFAULT_REGION}-ec2.pem" \
  && echo ${FILE_DATA}

結果(例):

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

パラメータの保存

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

変数の設定:

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

結果(例):

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

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. EC2_KEY_PAIR_NAME:"handson-cli-keypair"
         EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}"
  # 0.2. SSM_PARAMETER_NAME:"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"
         SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}"
  # 0.3. SSM_PARAMETER_DESC:"ハンズオン用キーペア"
         SSM_PARAMETER_DESC="${SSM_PARAMETER_DESC}"
  # 0.4. FILE_DATA:"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"
         FILE_DATA="${FILE_DATA}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

処理対象の状態確認

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

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

事前条件1: SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"が存在しない。

「SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"が存在しない。」ことを確認します。

コマンド:

aws ssm describe-parameters \
  --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \
  --query 'Parameters[].Name' \
  --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_DATA}

結果(例):

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

2. 主処理

SSMパラメータの作成

変数の確認:

cat << ETX

  SSM_PARAMETER_NAME:"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"
  SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}"
  SSM_PARAMETER_DESC:"ハンズオン用キーペア"
  SSM_PARAMETER_DESC="${SSM_PARAMETER_DESC}"
  FILE_DATA:"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-us-west-2-ec2.pem"
  FILE_DATA="${FILE_DATA}"

ETX

コマンド:

aws ssm put-parameter \
  --name ${SSM_PARAMETER_NAME} \
  --description ${SSM_PARAMETER_DESC} \
  --type SecureString \
  --value file:///${FILE_DATA}

結果(例):

{
  "Version": 1
}

3. 後処理

完了条件の確認

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

完了条件1: SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"が存在する。

「SSMパラメータ"/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2"が存在する。」ことを確認します。

コマンド:

aws ssm describe-parameters \
  --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \
  --query 'Parameters[].Name' \
  --output text

結果(例):

/handson-cli/keypair/handson-cli-keypair-XXXXXXXXXXXX-us-west-2

3.2. 後処理に必要な作業

パラメータストアに保存したSSH秘密鍵ファイルが取り出せることを確認します。

SSH秘密鍵ファイル(オリジナル)の移動

コマンド:

mv ${FILE_DATA} ${FILE_DATA}.orig

結果(例):

(出力なし)

SSH秘密鍵ファイルの保存

変数の設定:

DIR_KEY="${HOME}/.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

変数の確認:

cat << ETX

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

ETX

コマンド:

aws ssm get-parameter \
  --name ${SSM_PARAMETER_NAME} \
  --with-decryption \
  --query 'Parameter.Value' \
  --output text \
    > ${FILE_SSH_KEY}

結果(例):

(出力なし)

差分のチェック

コマンド:

diff ${FILE_SSH_KEY} ${FILE_DATA}.orig

結果(例):

24d23
<

注釈

パラメータストア取り出しのリダイレクト時にファイルの末尾に追加される改行が差分となります。

コマンド:

chmod 400 ${FILE_SSH_KEY}

一時ファイルの削除

コマンド:

rm -f ${FILE_DATA}.orig

完了