4.1. EC2インスタンスへのSSHログイン (handson-cli-instance-stateless-loadaverage-admin-instance)

作業の目的 [why]

EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"にSSHログインします。

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

完了条件 [after]

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

完了条件1

EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"にログインしている。

事前条件 [before]

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

事前条件1

EC2キーペア"handson-cli-instance-stateless-loadaverage-keypair"が存在する。

事前条件2

EC2キーペア"handson-cli-instance-stateless-loadaverage-keypair"の秘密鍵が作業マシン上に存在する。

事前条件3

EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"が存在する。

作業対象 [what]

  • EC2インスタンス

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

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

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

リソース2: EC2キーペア名

  • EC2インスタンスへのSSHログインに利用するEC2キーペアの名称です。

  • 今回は"handson-cli-instance-stateless-loadaverage-keypair"とします。

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

  • EC2インスタンスへのSSHログインに利用するSSH秘密鍵のファイル名です。

  • 今回は"${HOME}/.ssh/handson-cli-instance-stateless-loadaverage-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem"とします。

リソース4: EC2インスタンス名

  • SSHログインするEC2インスタンスの名称です。

  • 今回は"handson-cli-instance-stateless-loadaverage-admin-instance"とします。

リソース5: SSHポート番号

  • SSHログインするポート番号です。

  • 今回は"22022"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

変数の設定:

DIR_KEY="${HOME}/.ssh"

0.2. EC2キーペア名の指定

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

変数の設定:

EC2_KEY_PAIR_NAME='handson-cli-instance-stateless-loadaverage-keypair'

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

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

AWS IDを取得します。

コマンド:

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

結果(例):

XXXXXXXXXXXX

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-instance-stateless-loadaverage-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem

0.4. EC2インスタンス名の指定

EC2インスタンス名を指定します。

変数の設定:

EC2_INSTANCE_TAG_NAME='handson-cli-instance-stateless-loadaverage-admin-instance'

0.5. SSHポート番号の指定

EC2インスタンスへのSSHログインで利用するポート番号を指定します。

変数の設定:

PORT_SSHD='22022'

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-instance-stateless-loadaverage"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-instance_login_public-read.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-instance-stateless-loadaverage/2020-01-13-ec2-instance_login_public-read.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. EC2_KEY_PAIR_NAME:"handson-cli-instance-stateless-loadaverage-keypair"
         EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}"
  # 0.3. FILE_SSH_KEY:"${HOME}/.ssh/handson-cli-instance-stateless-loadaverage-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem"
         FILE_SSH_KEY="${FILE_SSH_KEY}"
  # 0.4. EC2_INSTANCE_TAG_NAME:"handson-cli-instance-stateless-loadaverage-admin-instance"
         EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}"
  # 0.5. PORT_SSHD:"22022"
         PORT_SSHD="${PORT_SSHD}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: EC2キーペア"handson-cli-instance-stateless-loadaverage-keypair"が存在する。

「EC2キーペア"handson-cli-instance-stateless-loadaverage-keypair"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-key-pairs \
  --query "KeyPairs[?KeyName == \`${EC2_KEY_PAIR_NAME}\`].KeyName" \
  --output text

結果(例):

handson-cli-instance-stateless-loadaverage-keypair

事前条件2: EC2キーペア"handson-cli-instance-stateless-loadaverage-keypair"の秘密鍵が作業マシン上に存在する。

「EC2キーペア"handson-cli-instance-stateless-loadaverage-keypair"の秘密鍵が作業マシン上に存在する。」ことを確認します。

コマンド:

ls ${FILE_SSH_KEY}

結果:

${HOME}/.ssh/handson-cli-instance-stateless-loadaverage-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem

事前条件3: EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"が存在する。

「EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-instances \
  --filters Name=tag-key,Values=Name \
            Name=tag-value,Values=${EC2_INSTANCE_TAG_NAME} \
            Name=instance-state-name,Values=running \
  --query Reservations[].Instances[].Tags[].Value \
  --output text

結果(例):

handson-cli-instance-stateless-loadaverage-admin-instance

1.2. 主処理に必要な情報の取得

EC2インスタンスのインスタンスIDの取得

コマンド:

ARRAY_EC2_INSTANCE_IDS=$( \
  aws ec2 describe-instances \
    --filters Name=tag-key,Values=Name \
              Name=tag-value,Values=${EC2_INSTANCE_TAG_NAME} \
              Name=instance-state-name,Values=running \
    --query Reservations[].Instances[].InstanceId \
    --output text \
) \
  && echo ${ARRAY_EC2_INSTANCE_IDS}

結果(例):

i-xxxxxxxxxxxxxxxxx

EC2インスタンスのグローバルIPアドレスの取得

コマンド:

EC2_PUBLIC_IP=$( \
  aws ec2 describe-instances \
    --instance-ids ${ARRAY_EC2_INSTANCE_IDS} \
    --query "Reservations[].Instances[].PublicIpAddress" \
    --output text \
) \
  && echo ${EC2_PUBLIC_IP}

結果(例):

xxx.xxx.xxx.xxx

2. 主処理

EC2インスタンスへのログイン

変数の確認

cat << ETX

  # FILE_SSH_KEY: ${HOME}/.ssh/handson-cli-instance-stateless-loadaverage-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem
    FILE_SSH_KEY="${FILE_SSH_KEY}"
  # EC2_PUBLIC_IP: xxx.xxx.xxx.xxx
    EC2_PUBLIC_IP="${EC2_PUBLIC_IP}"
  # PORT_SSHD:"22022"
    PORT_SSHD="${PORT_SSHD}"

ETX

コマンド:

ssh ${EC2_PUBLIC_IP} \
  -i ${FILE_SSH_KEY} \
  -l ec2-user \
  -p ${PORT_SSHD}

注釈

以下が表示された場合は、'yes'と入力して、エンターキーを押します。

The authenticity of host 'xxx.xxx.xxx.xxx(xxx.xxx.xxx.xxx)' can't be established.
ECDSA key fingerprint is SHA256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.
ECDSA key fingerprint is MD5:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx.
Are you sure you want to continue connecting (yes/no)?

結果(例):

Warning: Permanently added 'xxx.xxx.xxx.xxx' (RSA) to the list of known hosts.

       __|  __|_  )
       _|  (     /   Amazon Linux AMI
      ___|___|___|

https://aws.amazon.com/amazon-linux-ami/2018.03-release-notes/
24 package(s) needed for security, out of 53 available
Run "sudo yum update" to apply all updates.

3. 後処理

完了条件の確認

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

完了条件1: EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"にログインしている。

「EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"にログインしている。」ことを確認します。

EC2インスタンスのメタデータからグローバルIPアドレスを取得します。

コマンド:

curl -q http://169.254.169.254/latest/meta-data/public-ipv4

結果:

xxx.xxx.xxx.xxx

完了