4.1. EC2インスタンスへのSSHログイン (EIP: handson-cli-instance-stateful-ssh-address)¶
作業の目的 [why]¶
EIP"handson-cli-instance-stateful-ssh-address"の付与されているEC2インスタンスにSSHログインします。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
EIP"handson-cli-instance-stateful-ssh-address"が関連付けられているEC2インスタンスにログインしている。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
EC2キーペア"handson-cli-instance-stateful-ssh-key"が存在する。
- 事前条件2
EC2キーペア"handson-cli-instance-stateful-ssh-key"の秘密鍵が作業マシン上に存在する。
- 事前条件3
EIP"handson-cli-instance-stateful-ssh-address"が存在する。
- 事前条件4
EIP"handson-cli-instance-stateful-ssh-address"がEC2インスタンスに関連付けられている。
作業対象 [what]¶
EC2サービス
標準時間(合計)¶
8分
タスク実施の前提条件¶
作業環境条件 [where]¶
本作業は、以下の作業環境で行います。
作業環境条件1: OSとバージョン
本手順は、Amazon Linux "Amazon Linux AMI release 2018.03"以降のOS環境での実施を前提としています。
コマンド:
cat /etc/issue | head -1
結果(例):
Amazon Linux AMI release 2018.03
作業環境条件2: シェルとバージョン
本手順は、bash "4.2.46(2)-release"以降のシェル環境での実施を前提としています。
コマンド:
bash --version -v | head -1
結果(例):
GNU bash, バージョン 4.2.46(2)-release (x86_64-redhat-linux-gnu)
作業環境条件3: AWS CLIのバージョン
本手順は、AWS CLIの最新バージョンでの実施を前提としています。
コマンド:
aws --version
結果(例):
aws-cli/1.16.2 Python/3.6.5 Linux/4.14.59-64.43.amzn1.x86_64 botocore/1.11.2
バージョンが古い場合は最新版に更新しましょう。
コマンド:
sudo -H pip install -U awscli
パラメータ設定¶
- パラメータ設定の標準時間
2分
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 鍵ファイル用ディレクトリ
鍵ファイルが存在するディレクトリ"${HOME}/.ssh"です。
リソース2: EC2キーペア名
EC2インスタンスへのSSHログインに利用するEC2キーペアの名称です。
今回は"handson-cli-instance-stateful-ssh-key"とします。
リソース3: SSH秘密鍵ファイル名
EC2インスタンスへのSSHログインに利用するSSH秘密鍵のファイル名です。
今回は"${HOME}/.ssh/handson-cli-instance-stateful-ssh-key-XXXXXXXXXXXX-ap-northeast-1-ec2.pem"とします。
リソース4: EIPタグ名
EC2インスタンスに関連付けられているEIPタグ名です。
今回は"handson-cli-instance-stateful-ssh-address"とします。
リソース5: SSHポート番号
EC2インスタンスのSSHポート番号です。
今回は"22022"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
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-stateful-ssh-key-XXXXXXXXXXXX-ap-northeast-1-ec2.pem
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-instance-stateful-ssh" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-instance_login_public-read-expand-eip.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-instance-stateful-ssh/2019-09-16-ec2-instance_login_public-read-expand-eip.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-stateful-ssh-key" EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}" # 0.3. FILE_SSH_KEY:"${HOME}/.ssh/handson-cli-instance-stateful-ssh-key-XXXXXXXXXXXX-ap-northeast-1-ec2.pem" FILE_SSH_KEY="${FILE_SSH_KEY}" # 0.4. EC2_EIP_TAG_NAME:"handson-cli-instance-stateful-ssh-address" EC2_EIP_TAG_NAME="${EC2_EIP_TAG_NAME}" # 0.5. PORT_SSHD:"22022" PORT_SSHD="${PORT_SSHD}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
- タスク標準時間
6分
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: EC2キーペア"handson-cli-instance-stateful-ssh-key"が存在する。
「EC2キーペア"handson-cli-instance-stateful-ssh-key"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-key-pairs \ --query "KeyPairs[?KeyName == \`${EC2_KEY_PAIR_NAME}\`].KeyName" \ --output text
結果(例):
handson-cli-instance-stateful-ssh-key
事前条件2: EC2キーペア"handson-cli-instance-stateful-ssh-key"の秘密鍵が作業マシン上に存在する。
「EC2キーペア"handson-cli-instance-stateful-ssh-key"の秘密鍵が作業マシン上に存在する。」ことを確認します。
コマンド:
ls ${FILE_SSH_KEY}
結果:
${HOME}/.ssh/handson-cli-instance-stateful-ssh-key-XXXXXXXXXXXX-ap-northeast-1-ec2.pem
事前条件3: EIP"handson-cli-instance-stateful-ssh-address"が存在する。
「EIP"handson-cli-instance-stateful-ssh-address"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-addresses \ --filters Name=tag:Name,Values=${EC2_EIP_TAG_NAME} \ --query "Addresses[].Tags[].Value" \ --output text
結果(例):
handson-cli-instance-stateful-ssh-address
事前条件4: EIP"handson-cli-instance-stateful-ssh-address"がEC2インスタンスに関連付けられている。
「EIP"handson-cli-instance-stateful-ssh-address"がEC2インスタンスに関連付けられている。」ことを確認します。
コマンド:
aws ec2 describe-addresses \ --filters Name=tag:Name,Values=${EC2_EIP_TAG_NAME} \ --query "Addresses[].InstanceId" \ --output text
結果(例):
i-xxxxxxxxxxxxxxxxx
1.2. 主処理に必要な情報の取得¶
EIPのIPアドレス取得
コマンド:
EC2_PUBLIC_IP=$( \ aws ec2 describe-addresses \ --filters Name=tag:Name,Values=${EC2_EIP_TAG_NAME} \ --query "Addresses[].PublicIp" \ --output text \ ) \ && echo ${EC2_PUBLIC_IP}
結果(例):
xxx.xxx.xxx.xxx
2. 主処理¶
EC2インスタンスへのログイン¶
変数の確認
cat << ETX # FILE_SSH_KEY: ${HOME}/.ssh/handson-cli-instance-stateful-ssh-key-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}" 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: EIP"handson-cli-instance-stateful-ssh-address"が関連付けられているEC2インスタンスにログインしている。
「EIP"handson-cli-instance-stateful-ssh-address"が関連付けられているEC2インスタンスにログインしている。」ことを確認します。
EC2インスタンスのメタデータからグローバルIPアドレスを取得します。
コマンド:
curl -q http://169.254.169.254/latest/meta-data/public-ipv4
結果:
xxx.xxx.xxx.xxx