3.1. SSMパラメータの作成 (SSH秘密鍵: /handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store)

作業の目的 [why]

SSMパラメータ"/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store"を作成します。

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

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

完了条件 [after]

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

完了条件1
SSMパラメータ"/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store"が存在する。

事前条件 [before]

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

事前条件1
SSMパラメータ"/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store"が存在しない。
事前条件2
鍵ファイル用ディレクトリ"${HOME}/.ssh"が存在する。

作業対象 [what]

  • SSMサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

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

鍵ファイルが存在するディレクトリ"${HOME}/.ssh"です。

リソース2: SSH鍵名

  • SSMパラメータストアに登録するSSH鍵の名称です。
  • 今回は"handson-cli-ssm-parameter_store"とします。

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

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

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

  • 作成するSSMパラメータの説明です。
  • 今回は"SSH Secret Key for handson-cli-ssm-parameter_store"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

変数の設定:

DIR_KEY="${HOME}/.ssh"

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

SSH鍵名を指定します。

変数の設定:

OPENSSH_KEY_NAME='handson-cli-ssm-parameter_store'

変数の設定:

FILE_SSH_KEY_SECRET="${DIR_KEY}/${OPENSSH_KEY_NAME}" \
  && echo ${FILE_SSH_KEY_SECRET}

結果(例):

${HOME}/.ssh/handson-cli-ssm-parameter_store

変数の設定:

FILE_DATA="${FILE_SSH_KEY_SECRET}" \
  && echo ${FILE_DATA}

結果(例):

${HOME}/.ssh/handson-cli-ssm-parameter_store

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

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

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

変数の設定:

SSM_PARAMETER_PREFIX='handson-cli-ssm-parameter_store/key/ssh/secret'

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

変数の設定:

SSM_PARAMETER_SUFFIX="${OPENSSH_KEY_NAME}" \
  && echo ${SSM_PARAMETER_SUFFIX}

結果(例):

handson-cli-ssm-parameter_store

SSMパラメータ名の指定

変数の設定:

SSM_PARAMETER_NAME="/${SSM_PARAMETER_PREFIX}/${SSM_PARAMETER_SUFFIX}" \
  && echo ${SSM_PARAMETER_NAME}

結果(例):

/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store

0.4. SSMパラメータの説明

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

変数の設定:

SSM_PARAMETER_DESC='SSH Secret Key for handson-cli-ssm-parameter_store'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-ssm-parameter_store/2019-05-27-ssm-parameter-create-expand-ssh_key_secret.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. DIR_KEY:"${HOME}/.ssh"
         DIR_KEY="${DIR_KEY}"
  # 0.2. FILE_DATA:"${HOME}/.ssh/handson-cli-ssm-parameter_store"
         FILE_DATA="${FILE_DATA}"
  # 0.3. SSM_PARAMETER_NAME:"/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store"
         SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}"
  # 0.4. SSM_PARAMETER_DESC:"SSH Secret Key for handson-cli-ssm-parameter_store"
         SSM_PARAMETER_DESC="${SSM_PARAMETER_DESC}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

処理対象の状態確認

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

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

事前条件1: SSMパラメータ"/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store"が存在しない。

「SSMパラメータ"/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store"が存在しない。」ことを確認します。

コマンド:

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

結果(例):

(出力なし)

事前条件2: 鍵ファイル用ディレクトリ"${HOME}/.ssh"が存在する。

「鍵ファイル用ディレクトリ"${HOME}/.ssh"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_KEY}

結果(例):

${HOME}/.ssh

事前条件3: SSM秘密鍵"${HOME}/.ssh/handson-cli-ssm-parameter_store"が存在する。

「SSM秘密鍵"${HOME}/.ssh/handson-cli-ssm-parameter_store"が存在する。」ことを確認します。

コマンド:

ls ${FILE_DATA}

結果(例):

${HOME}/.ssh/handson-cli-ssm-parameter_store

2. 主処理

SSMパラメータの作成

変数の確認:

cat << ETX

  SSM_PARAMETER_NAME:"/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store"
  SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}"
  SSM_PARAMETER_DESC:"SSH Secret Key for handson-cli-ssm-parameter_store"
  SSM_PARAMETER_DESC="${SSM_PARAMETER_DESC}"
  FILE_DATA:"${HOME}/.ssh/handson-cli-ssm-parameter_store"
  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-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store"が存在する。

「SSMパラメータ"/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store"が存在する。」ことを確認します。

コマンド:

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

結果(例):

/handson-cli-ssm-parameter_store/key/ssh/secret/handson-cli-ssm-parameter_store

完了