参考1.2. SSMパラメータの取得 (SSH秘密鍵: /handson-cli-conf/key/ssh/secret/handson-cli-conf)¶
作業の目的 [why]¶
暗号化されたSSMパラメータ"/handson-cli-conf/key/ssh/secret/handson-cli-conf"を取得して、SSH秘密鍵を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- SSM秘密鍵ファイル"${HOME}/.ssh/handson-cli-conf.pub"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- SSMパラメータ"/handson-cli-conf/key/ssh/secret/handson-cli-conf"が存在する。
- 事前条件2
- OpenSSH用ディレクトリ"${HOME}/.ssh"が存在する。
- 事前条件3
- SSM秘密鍵"${HOME}/.ssh/handson-cli-conf.pub"が存在しない。
作業対象 [what]¶
- SSMサービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: SSMパラメータ名
- 取得するSSMパラメータの名称です。
- 今回は"/handson-cli-conf/key/ssh/secret/handson-cli-conf"とします。
リソース2: OpenSSH用ディレクトリ
OpenSSH用ディレクトリ"${HOME}/.ssh"です。
リソース3: SSH鍵名
- 保存するSSH鍵の名称です。
- 今回は"handson-cli-conf"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. SSMパラメータ名の指定¶
SSMパラメータ名を指定します。
変数の設定:
SSM_PARAMETER_NAME='/handson-cli-conf/key/ssh/secret/handson-cli-conf'
0.3. SSH秘密鍵ファイル名の指定¶
SSH鍵名を指定します。
変数の設定:
OPENSSH_KEY_NAME='handson-cli-conf'
SSH秘密鍵ファイルを指定します。
変数の設定:
FILE_SSH_KEY_SECRET="${DIR_SSH}/${OPENSSH_KEY_NAME}" \ && echo ${FILE_SSH_KEY_SECRET}
結果(例):
${HOME}/.ssh/handson-cli-conf
変数の設定:
FILE_DATA="${FILE_SSH_KEY_SECRET}" \ && echo ${FILE_DATA}
結果(例):
${HOME}/.ssh/handson-cli-conf
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-conf-codecommit" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ssm-parameter-read-expand-ssh_key_secret.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-conf-codecommit/2019-07-09-ssm-parameter-read-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. SSM_PARAMETER_NAME:"/handson-cli-conf/key/ssh/secret/handson-cli-conf" SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}" # 0.2. DIR_SSH:"${HOME}/.ssh" DIR_SSH="${DIR_SSH}" # 0.3. FILE_DATA:"${HOME}/.ssh/handson-cli-conf" FILE_DATA="${FILE_DATA}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: SSMパラメータ"/handson-cli-conf/key/ssh/secret/handson-cli-conf"が存在する。
「SSMパラメータ"/handson-cli-conf/key/ssh/secret/handson-cli-conf"が存在する。」ことを確認します。
コマンド:
aws ssm describe-parameters \ --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \ --query 'Parameters[].Name' \ --output text
結果(例):
/handson-cli-conf/key/ssh/secret/handson-cli-conf
事前条件2: OpenSSH用ディレクトリ"${HOME}/.ssh"が存在する。
「OpenSSH用ディレクトリ"${HOME}/.ssh"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_SSH}
結果(例):
${HOME}/.ssh
事前条件3: SSM秘密鍵"${HOME}/.ssh/handson-cli-conf.pub"が存在しない。
「SSM秘密鍵"${HOME}/.ssh/handson-cli-conf.pub"が存在しない。」ことを確認します。
コマンド:
! ls ${FILE_DATA}
結果(例):
ls: ${HOME}/.ssh/handson-cli-conf No such file or directory
2. 主処理¶
SSMパラメータの取得¶
変数の確認:
cat << ETX SSM_PARAMETER_NAME:"/handson-cli-conf/key/ssh/secret/handson-cli-conf" SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}" FILE_DATA:"${HOME}/.ssh/handson-cli-conf" FILE_DATA="${FILE_DATA}" ETX
コマンド:
aws ssm get-parameter \ --name ${SSM_PARAMETER_NAME} \ --with-decryption \ --query 'Parameter.Value' \ --output text \ > ${FILE_DATA}
結果(例):
(出力なし)