task: OpsWorksインスタンスの作成

作業の目的 [why]

OpsWorksインスタンス"nodejs-server1"を作成します。

作業対象 [what]

  • OpsWorksレイヤー

標準時間

8分

前提条件

作業権限条件 [who]

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

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

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

作業環境条件 [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.11.117

コマンド:

aws --version

結果(例):

aws-cli/1.11.122 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.5.85

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

コマンド:

sudo -H pip install -U awscli

開始条件

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

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

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

  • 今回は"${HOME}/tmp/conf-opsworks"を設定ファイルディレクトリとします。

    ls ${HOME}/tmp/conf-opsworks

  • 存在しない場合は作成します。

    mkdir -p ${HOME}/tmp/conf-opsworks

リソース2: OpsWorksスタック名

  • OpsWorksインスタンスを作成するOpsWorksスタックの名称です。
  • 今回は"My Sample Stack (Linux)"とします。

リソース3: OpsWorksレイヤー名

  • OpsWorksインスタンスを作成するOpsWorksレイヤーの名称です。
  • 今回は"Node.js App Server"とします。

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

  • 作成するOpsWorksOpsWorksインスタンスの名称です。
  • 今回は"nodejs-server1"とします。

リソース5: OpsWorksインスタンスのインスタンスタイプ

  • 作成するOpsWorksOpsWorksインスタンスのインスタンスタイプです。
  • 今回は"t2.micro"とします。

リソース6: OpsWorksインスタンスのデバイス名

  • 作成するOpsWorksOpsWorksインスタンスのデバイス名
  • 今回は"ROOT_DEVICE"とします。

リソース7: OpsWorksインスタンスのデバイスのボリュームタイプ

  • 作成するOpsWorksOpsWorksインスタンスのデバイスのボリュームタイプです。
  • 今回は"gp2"とします。

作業開始 [when]

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

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

タスクの実施

0. パラメータの指定

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

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE:     (0.a) ${AWS_DEFAULT_PROFILE}
  AWS_DEFAULT_REGION:      (0.b) ${AWS_DEFAULT_REGION}
  DIR_CONF:                (0.1) ${DIR_CONF}
  OPSW_STACK_NAME:         (0.2) ${OPSW_STACK_NAME}
  OPSW_LAYER_NAME:         (0.3) ${OPSW_LAYER_NAME}
  OPSW_HOSTNAME:           (0.4) ${OPSW_HOSTNAME}
  OPSW_INSTANCE_TYPE:      (0.5) ${OPSW_INSTANCE_TYPE}
  OPSW_DEVICE_NAME:        (0.8) ${OPSW_DEVICE_NAME}
  OPSW_DEVICE_VOLUME_TYPE: (0.7) ${OPSW_DEVICE_VOLUME_TYPE}

ETX

結果(例):

AWS_DEFAULT_PROFILE:     (0.a) <OpsWorksのフル権限を許可されたプロファイル>
AWS_DEFAULT_REGION:      (0.b) ap-northeast-1
DIR_CONF:                (0.1) ${HOME}/tmp/conf-opsworks
OPSW_STACK_NAME:         (0.2) My Sample Stack (Linux)
OPSW_LAYER_NAME:         (0.3) Node.js App Server
OPSW_HOSTNAME:           (0.4) nodejs-server1
OPSW_INSTANCE_TYPE:      (0.5) t2.micro
OPSW_DEVICE_NAME:        (0.6) ROOT_DEVICE
OPSW_DEVICE_VOLUME_TYPE: (0.7) gp2

変数が入っていない、適切でない場合は、それぞれの手順番号について作業を行います。

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

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

コマンド:

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

結果(例):

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

変数の設定:

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

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

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

変数の設定:

DIR_CONF="${HOME}/tmp/conf-opsworks"

0.2. OpsWorksスタック名の指定

OpsWorksスタック名を指定します。

変数の設定:

OPSW_STACK_NAME='My Sample Stack (Linux)'

0.3. OpsWorksレイヤー名の指定

OpsWorksレイヤー名を指定します。

変数の設定:

OPSW_LAYER_NAME='Node.js App Server'

0.4. OpsWorksインスタンスのホスト名の指定

変数の設定:

OPSW_HOSTNAME="nodejs-server1"

0.5. OpsWorksインスタンスのインスタンスタイプの指定

変数の設定:

OPSW_INSTANCE_TYPE='t2.micro'

0.6. OpsWorksインスタンスのデバイス名の指定

変数の設定:

OPSW_DEVICE_NAME='ROOT_DEVICE'

0.7. OpsWorksインスタンスのボリュームタイプの指定

変数の設定:

OPSW_DEVICE_VOLUME_TYPE='gp2'

再確認

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

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE:     (0.a) ${AWS_DEFAULT_PROFILE}
  AWS_DEFAULT_REGION:      (0.b) ${AWS_DEFAULT_REGION}
  DIR_CONF:                (0.1) ${DIR_CONF}
  OPSW_STACK_NAME:         (0.2) ${OPSW_STACK_NAME}
  OPSW_LAYER_NAME:         (0.3) ${OPSW_LAYER_NAME}
  OPSW_HOSTNAME:           (0.4) ${OPSW_HOSTNAME}
  OPSW_INSTANCE_TYPE:      (0.5) ${OPSW_INSTANCE_TYPE}
  OPSW_DEVICE_NAME:        (0.8) ${OPSW_DEVICE_NAME}
  OPSW_DEVICE_VOLUME_TYPE: (0.7) ${OPSW_DEVICE_VOLUME_TYPE}

ETX

結果(例):

AWS_DEFAULT_PROFILE:     (0.a) <OpsWorksのフル権限を許可されたプロファイル>
AWS_DEFAULT_REGION:      (0.b) ap-northeast-1
DIR_CONF:                (0.1) ${HOME}/tmp/conf-opsworks
OPSW_STACK_NAME:         (0.2) My Sample Stack (Linux)
OPSW_LAYER_NAME:         (0.3) Node.js App Server
OPSW_HOSTNAME:           (0.4) nodejs-server1
OPSW_INSTANCE_TYPE:      (0.5) t2.micro
OPSW_DEVICE_NAME:        (0.6) ROOT_DEVICE
OPSW_DEVICE_VOLUME_TYPE: (0.7) gp2

1. 前処理

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

OpsWorksスタックIDの取得

コマンド:

OPSW_STACK_ID=$( \
  aws opsworks describe-stacks \
    --query "Stacks[?Name ==\`${OPSW_STACK_NAME}\`].StackId" \
    --output text \
) \
  && echo ${OPSW_STACK_ID}

結果(例):

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

OpsWorksレイヤーIDの取得

コマンド:

OPSW_LAYER_ID=$( \
  aws opsworks describe-layers \
    --stack-id ${OPSW_STACK_ID} \
    --query "Layers[?Name ==\`${OPSW_LAYER_NAME}\`].LayerId" \
    --output text \
) \
  && echo ${OPSW_LAYER_ID}

結果(例):

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

配列に格納します。

1.2. 処理対象の状態確認

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

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

事前条件1: 設定ファイル用ディレクトリが存在する。

「設定ファイル用ディレクトリが存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CONF}

結果(例):

${HOME}/tmp/conf-opsworks

事前条件2: OpsWorksスタック"My Sample Stack (Linux)"が存在する。

「OpsWorksスタック"My Sample Stack (Linux)"が存在する。」ことを確認します。

コマンド:

aws opsworks describe-stacks \
  --query "Stacks[?Name ==\`${OPSW_STACK_NAME}\`].Name"

結果(例):

{
    "My Sample Stack (Linux)"
}

事前条件3: OpsWorksレイヤー"Node.js App Server"が存在する。

「OpsWorksレイヤー"Node.js App Server"が存在する。」ことを確認します。

コマンド:

aws opsworks describe-layers \
  --stack-id ${OPSW_STACK_ID} \
  --query "Layers[?Name ==\`${OPSW_LAYER_NAME}\`].Name"

結果(例):

[
  "Node.js App Server"
]

事前条件4: OpsWorksインスタンス"nodejs-server1"が存在しない。

「OpsWorksインスタンス"nodejs-server1"が存在しない。」ことを確認します。

コマンド:

aws opsworks describe-instances \
  --layer-id ${OPSW_LAYER_ID} \
  --query "Instances[?Hostname == \`${OPSW_HOSTNAME}\`].Hostname"

結果(例):

[]

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

設定文字列の生成

変数の設定:

STRING_OPSW_BLOCK_DEVICE_MAPPING="DeviceName=${OPSW_DEVICE_NAME},Ebs={VolumeType=${OPSW_DEVICE_VOLUME_TYPE}}" \
  && echo ${STRING_OPSW_BLOCK_DEVICE_MAPPING}

変数の設定:

ARRAY_OPSW_LAYER_IDS="${OPSW_LAYER_ID}" \
  && echo "${ARRAY_OPSW_LAYER_IDS}"

2. 主処理

OpsWorksインスタンスの作成

変数の設定:

FILE_OUTPUT="${DIR_CONF}/opsworks-instance-${OPSW_INSTANCE_TYPE}-$(date +%Y%m%d.json)" \
  && echo ${FILE_OUTPUT}

変数の確認:

cat << ETX

  OPSW_STACK_ID:                     ${OPSW_STACK_ID}
  ARRAY_OPSW_LAYER_IDS:              ${ARRAY_OPSW_LAYER_IDS}
  OPSW_INSTANCE_TYPE:                ${OPSW_INSTANCE_TYPE}
  STRING_OPSW_BLOCK_DEVICE_MAPPING: "${STRING_OPSW_BLOCK_DEVICE_MAPPING}"
  FILE_OUTPUT:                       ${FILE_OUTPUT}

ETX

コマンド:

aws opsworks create-instance \
  --stack-id ${OPSW_STACK_ID} \
  --layer-ids ${ARRAY_OPSW_LAYER_IDS} \
  --instance-type ${OPSW_INSTANCE_TYPE} \
  --block-device-mappings "${STRING_OPSW_BLOCK_DEVICE_MAPPING}" \
  > ${FILE_OUTPUT} \
&& cat ${FILE_OUTPUT}

結果(例):

{
  "InstanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

3. 後処理

完了条件の確認

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

完了条件1: 作成したOpsWorksインスタンス"nodejs-server1"が存在する。

「作成したOpsWorksインスタンス"nodejs-server1"が存在する。」ことを確認します。

コマンド:

aws opsworks describe-instances \
  --layer-id ${OPSW_LAYER_ID} \
  --query "Instances[?Hostname == \`${OPSW_HOSTNAME}\`].Hostname"

結果(例):

[
    "nodejs-server1"
]

完了