おまけ3. SSMセッション用SSH設定ファイルの作成 (${HOME}/.ssh/conf.d/hosts/ssm-session-manager)

手順の目的 [why]

SSMセッション用SSH設定ファイル"${HOME}/.ssh/conf.d/hosts/ssm-session-manager"を作成します。

設定値の指定

設定値の指定

手順に必要な設定値を変数に格納をします。

0. リージョンの指定

リージョンを指定します。

環境変数の設定:

export AWS_DEFAULT_REGION='ap-northeast-1'

1. SSMセッション用SSH設定ファイル名

SSMセッション用SSH設定ファイル名を指定します。

変数の設定:

FILE_SSH_CONFIG_HOST="${HOME}/.ssh/conf.d/hosts/ssm-session-manager"

2. SSH秘密鍵ファイル名

SSH鍵ファイルディレクトリを指定します。

変数の設定:

DIR_KEY="${HOME}/.ssh"

EC2キーペア名を指定します。

変数の設定:

EC2_KEY_PAIR_NAME="handson-cli-ssm-session-manager-keypair"

AWS IDを取得します。

コマンド:

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

結果(例):

XXXXXXXXXXXX

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

変数の設定:

FILE_KEY_PAIR_SECRET="${DIR_KEY}/${EC2_KEY_PAIR_NAME}-${AWS_ID}-${AWS_DEFAULT_REGION}-ec2.pem" \
  && echo ${FILE_KEY_PAIR_SECRET}

結果(例):

${HOME}/.ssh/handson-cli-ssm-session-manager-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem

設定値の確認

各変数に正しい設定値が格納されていることを確認しながら保存します。

変数の確認:

cat << END

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

  # 1. FILE_SSH_CONFIG_HOST:"${HOME}/.ssh/conf.d/hosts/ssm-session-manager"
       FILE_SSH_CONFIG_HOST="${FILE_SSH_CONFIG_HOST}"
  # 2. FILE_KEY_PAIR_SECRET:"${HOME}/.ssh/handson-cli-ssm-session-manager-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem"
       FILE_KEY_PAIR_SECRET="${FILE_KEY_PAIR_SECRET}"

END

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

処理の実行

SSMセッション用SSH設定ファイルを作成します。

変数の確認:

cat << END

  # FILE_SSH_CONFIG_HOST:"${HOME}/.ssh/conf.d/hosts/ssm-session-manager"
    FILE_SSH_CONFIG_HOST="${FILE_SSH_CONFIG_HOST}"
  # FILE_KEY_PAIR_SECRET:"${HOME}/.ssh/handson-cli-ssm-session-manager-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem"
    FILE_KEY_PAIR_SECRET="${FILE_KEY_PAIR_SECRET}"

END

変数の設定:

cat << EOF > ${FILE_SSH_CONFIG_HOST}
host i-*
  ProxyCommand sh -c "aws ssm start-session --target %h --document-name AWS-StartSSHSession --parameters 'portNumber=%p'"
  IdentityFile ${FILE_KEY_PAIR_SECRET}
  User ec2-user
EOF

cat ${FILE_SSH_CONFIG_HOST} \
  && chmod 600 ${FILE_SSH_CONFIG_HOST}

結果(例):

host i-*
  ProxyCommand sh -c "aws ssm start-session --target %h --document-name AWS-StartSSHSession --parameters 'portNumber=%p'"
  IdentityFile ${HOME}/.ssh/handson-cli-ssm-session-manager-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem
  User ec2-user

完了確認

「SSMセッション用SSH設定ファイル"${HOME}/.ssh/conf.d/hosts/ssm-session-manager"が存在する。」ことを確認します。

コマンド:

ls ${FILE_SSH_CONFIG_HOST}

結果(例):

${HOME}/.ssh/conf.d/hosts/ssm-session-manager

手順の完了