1. EC2インスタンスへのログイン (handson-cli)

作業の目的 [why]

EC2インスタンス"handson-cli"にログインします。

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

完了条件 [after]

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

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

事前条件 [before]

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

事前条件1
EC2インスタンス"handson-cli"が存在する。
事前条件2
EC2キーペア"<キーペア名>"が存在する。
事前条件3
EC2キーペア"<キーペア名>"の秘密鍵が作業マシン上に存在する。

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

課題

(未検証)

作業対象 [what]

  • EC2サービス

標準時間

8分

前提条件

作業権限条件 [who]

本作業は、以下の作業権限を有する人が行います。

作業権限条件: EC2への権限

EC2に対してフル権限があること。

作業環境条件 [where]

本作業は、以下の作業環境で行います。

作業環境条件1: OSとバージョン

Amazon Linuxの以下のバージョンで動作確認済

コマンド:

cat /etc/issue | head -1

結果(例):

Amazon Linux AMI release 2016.09

作業環境条件2: シェルとバージョン

bashの以下のバージョンで動作確認済

コマンド:

bash --version -v | head -1

結果(例):

GNU bash, バージョン 4.2.46(1)-release (x86_64-redhat-linux-gnu)

作業環境条件3: AWS CLIのバージョン

以下のバージョンで動作確認済

  • AWS CLI 1.14.18

コマンド:

aws --version

結果(例):

aws-cli/1.14.19 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.8.23

バージョンが古い場合は最新版に更新しましょう。

コマンド:

sudo -H pip install -U awscli

開始条件

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

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

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

  • SSHログインするEC2インスタンスの名称です。
  • 今回は"handson-cli"とします。

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

  • EC2インスタンスへのSSHログインに利用するEC2キーペアの名称です。
  • 今回は"<キーペア名>"とします。

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

  • EC2インスタンスへのSSHログインに利用するSSH秘密鍵のファイル名です。
  • 今回は"${HOME}/.ssh/<キーペア秘密鍵のファイル名>"とします。

作業開始 [when]

以下を全て満たしているとき、作業を開始します。

  • 開始の指示があった場合。

タスクの実施

0. パラメータの指定

まず変数の確認をします。

変数の確認:

cat << ETX

  # 0.a. AWS_DEFAULT_PROFILE: <EC2のフル権限を許可されたプロファイル>
         AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}"
  # 0.b. AWS_DEFAULT_REGION: ap-northeast-1
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. EC2_INSTANCE_TAG_NAME: handson-cli
         EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}"
  # 0.2. EC2_KEY_PAIR_NAME: <キーペア名>
         EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}"
  # 0.3. FILE_SSH_KEY: ${HOME}/.ssh/<キーペア秘密鍵のファイル名>
         FILE_SSH_KEY="${FILE_SSH_KEY}"

ETX

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

0.a. プロファイルの指定

プロファイルの一覧を確認します。

コマンド:

cat ~/.aws/credentials \
 | grep '\[' \
 | sed 's/\[//g' | sed 's/\]//g'

結果(例):

iamFull-prjz-mbpr13
<EC2のフル権限を許可されたプロファイル>

変数の設定:

export AWS_DEFAULT_PROFILE='<EC2のフル権限を許可されたプロファイル>'

0.b. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

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

変数の設定:

EC2_INSTANCE_TAG_NAME='handson-cli'

0.2. EC2キーペア名の指定

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

変数の設定:

EC2_KEY_PAIR_NAME='<キーペア名>'

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

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

変数の設定:

FILE_SSH_KEY="${HOME}/.ssh/<キーペア秘密鍵のファイル名>"

再確認

設定されている変数の内容を再確認します。

変数の確認:

cat << ETX

  # 0.a. AWS_DEFAULT_PROFILE: <EC2のフル権限を許可されたプロファイル>
         AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}"
  # 0.b. AWS_DEFAULT_REGION: ap-northeast-1
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. EC2_INSTANCE_TAG_NAME: handson-cli
         EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}"
  # 0.2. EC2_KEY_PAIR_NAME: <キーペア名>
         EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}"
  # 0.3. FILE_SSH_KEY: ${HOME}/.ssh/<キーペア秘密鍵のファイル名>
         FILE_SSH_KEY="${FILE_SSH_KEY}"

ETX

1. 前処理

1.1. 状態確認に必要な情報の取得

sample

1.2. 処理対象の状態確認

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

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

事前条件1: EC2インスタンス"handson-cli"が存在する。

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

コマンド:

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

結果(例):

[
  "i-xxxxxxxxxxxxxxxxx"
]

事前条件2: EC2キーペア"<キーペア名>"が存在する。

「EC2キーペア"<キーペア名>"が存在する。」ことを確認します。

コマンド:

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

結果(例):

[
    "<キーペア名>"
]

結果(例):

[]

事前条件3: EC2キーペア"<キーペア名>"の秘密鍵が作業マシン上に存在する。

「EC2キーペア"<キーペア名>"の秘密鍵が作業マシン上に存在する。」ことを確認します。

コマンド:

ls ${FILE_SSH_KEY}

結果:

${HOME}/.ssh/<キーペア秘密鍵のファイル名>

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

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

コマンド:

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

結果(例):

i-xxxxxxxxxxxxxxxxx

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

コマンド:

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

結果(例):

xxx.xxx.xxx.xxx

2. 主処理

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

変数の確認

cat << ETX

  # FILE_SSH_KEY: ${HOME}/.ssh/<キーペア秘密鍵のファイル名>
    FILE_SSH_KEY="${FILE_SSH_KEY}"
  # EC2_PUBLIC_IP: xxx.xxx.xxx.xxx
    EC2_PUBLIC_IP="${EC2_PUBLIC_IP}"

ETX

コマンド:

ssh -i ${FILE_SSH_KEY} ec2-user@${EC2_PUBLIC_IP}

結果(例):

The authenticity of host 'xxx.xxx.xxx.xxx (xxx.xxx.xxx.xxx)' can't be established.
RSA key fingerprint is 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)?

入力:

yes

結果(例):

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

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

https://aws.amazon.com/amazon-linux-ami/2017.09-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"にログインしている。

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

完了