task: OpsWorksレイヤーの作成¶

作業の目的 [why]¶

OpsWorksスタック"My Sample Stack (Linux)"にレイヤー"Node.js App Server"を作成します。

作業対象 [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: OpsWorksスタック名

作成するOpsWorksレイヤーが属するOpsWorksスタックの名称です。
今回は"My Sample Stack (Linux)"とします。

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

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

リソース3: OpsWorksレイヤーのショート名

作成するOpsWorksレイヤーのショート名です。
今回は"nodejs-server"とします。

リソース4: OpsWorksレイヤーのタイプ

作成するOpsWorksレイヤーのタイプです。
今回は"custom"とします。

リソース5: OpsWorksレイヤーのカスタムレシピ名

作成するOpsWorksレイヤーののカスタムレシピ名です。
今回は"nodejs_demo"とします。

リソース6: OpsWorksレイヤーのライフサイクルタイムアウト

作成するOpsWorksレイヤーのライフサイクルタイムアウトです。
今回は"120"とします。

リソース7: OpsWorksレイヤーのライフサイクルにおけるELBのドレイン設定

作成するOpsWorksレイヤーのライフサイクルにおけるELBのドレイン設定です。
今回は"false"とします。

リソース8: VPCのCIDR

OpsWorksレイヤーで利用するVPCのCIDR
今回は"10.192.0.0/16"とします。

リソース9: カスタムセキュリティグループの名称

OpsWorksレイヤーで利用するカスタムセキュリティグループの名称
今回は"AWS-OpsWorks-WebApp"とします。

作業開始 [when]¶

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

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

タスクの実施¶

0. パラメータの指定¶

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

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE:             (0.a) ${AWS_DEFAULT_PROFILE}
  AWS_DEFAULT_REGION:              (0.b) ${AWS_DEFAULT_REGION}
  OPSW_STACK_NAME:                 (0.1) ${OPSW_STACK_NAME}
  OPSW_LAYER_NAME                  (0.2) ${OPSW_LAYER_NAME}
  OPSW_LAYER_SHORTNAME             (0.3) ${OPSW_LAYER_SHORTNAME}
  OPSW_LAYER_TYPE                  (0.4) ${OPSW_LAYER_TYPE}
  OPSW_LAYER_CUSTOM_RECIPES_DEPLOY (0.5) ${OPSW_LAYER_CUSTOM_RECIPES_DEPLOY}
  OPSW_LAYER_LIFECYCLE_TIMEOUT     (0.6) ${OPSW_LAYER_LIFECYCLE_TIMEOUT}
  OPSW_LAYER_LIFECYCLE_ELB_DRAINED (0.7) ${OPSW_LAYER_LIFECYCLE_ELB_DRAINED}
  VPC_CIDR:                        (0.8) ${VPC_CIDR}
  VPC_SG_NAME                      (0.9) ${VPC_SG_NAME}

ETX

結果(例):

AWS_DEFAULT_PROFILE:             (0.a) <OpsWorksのフル権限を許可されたプロファイル>
AWS_DEFAULT_REGION:              (0.b) ap-northeast-1
OPSW_STACK_NAME:                 (0.1) My Sample Stack (Linux)
OPSW_LAYER_NAME                  (0.2) Node.js App Server
OPSW_LAYER_SHORTNAME             (0.3) nodejs-server
OPSW_LAYER_TYPE                  (0.4) custom
OPSW_LAYER_CUSTOM_RECIPES_DEPLOY (0.5) nodejs_demo
OPSW_LAYER_LIFECYCLE_TIMEOUT     (0.6) 120
OPSW_LAYER_LIFECYCLE_ELB_DRAINED (0.7) false
VPC_CIDR:                        (0.8) 10.192.0.0/16
VPC_SG_NAME                      (0.9) AWS-OpsWorks-WebApp

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

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. OpsWorksスタック名の指定¶

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

変数の設定:

OPSW_STACK_NAME='My Sample Stack (Linux)'

0.2. VPCのCIDRの指定¶

変数の設定:

VPC_CIDR='10.192.0.0/16'

0.3. セキュリティグループ名の指定¶

変数の設定:

VPC_SG_NAME='AWS-OpsWorks-WebApp'

0.4. OpsWorksレイヤー名の決定¶

OpsWorksレイヤー名を決めます。

変数の設定:

OPSW_LAYER_NAME='Node.js App Server'

0.5. OpsWorksレイヤー名のショート名の指定¶

変数の設定:

OPSW_LAYER_SHORTNAME='nodejs-server'

0.6. レイヤタイプの指定¶

変数の設定:

OPSW_LAYER_TYPE='custom'

0.7. カスタムレシピの指定¶

変数の設定:

OPSW_LAYER_CUSTOM_RECIPES_DEPLOY='nodejs_demo'

0.8. ライフサイクルイベントの指定¶

変数の設定:

OPSW_LAYER_LIFECYCLE_TIMEOUT='120'

0.9. ライフサイクルイベントの指定¶

変数の設定:

OPSW_LAYER_LIFECYCLE_ELB_DRAINED='false'

再確認¶

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

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE:             (0.a) ${AWS_DEFAULT_PROFILE}
  AWS_DEFAULT_REGION:              (0.b) ${AWS_DEFAULT_REGION}
  OPSW_STACK_NAME:                 (0.1) ${OPSW_STACK_NAME}
  OPSW_LAYER_NAME                  (0.2) ${OPSW_LAYER_NAME}
  OPSW_LAYER_SHORTNAME             (0.3) ${OPSW_LAYER_SHORTNAME}
  OPSW_LAYER_TYPE                  (0.4) ${OPSW_LAYER_TYPE}
  OPSW_LAYER_CUSTOM_RECIPES_DEPLOY (0.5) ${OPSW_LAYER_CUSTOM_RECIPES_DEPLOY}
  OPSW_LAYER_LIFECYCLE_TIMEOUT     (0.6) ${OPSW_LAYER_LIFECYCLE_TIMEOUT}
  OPSW_LAYER_LIFECYCLE_ELB_DRAINED (0.7) ${OPSW_LAYER_LIFECYCLE_ELB_DRAINED}
  VPC_CIDR:                        (0.8) ${VPC_CIDR}
  VPC_SG_NAME                      (0.9) ${VPC_SG_NAME}

ETX

結果(例):

AWS_DEFAULT_PROFILE:             (0.a) <OpsWorksのフル権限を許可されたプロファイル>
AWS_DEFAULT_REGION:              (0.b) ap-northeast-1
OPSW_STACK_NAME:                 (0.1) My Sample Stack (Linux)
OPSW_LAYER_NAME                  (0.2) Node.js App Server
OPSW_LAYER_SHORTNAME             (0.3) nodejs-server
OPSW_LAYER_TYPE                  (0.4) custom
OPSW_LAYER_CUSTOM_RECIPES_DEPLOY (0.5) nodejs_demo
OPSW_LAYER_LIFECYCLE_TIMEOUT     (0.6) 120
OPSW_LAYER_LIFECYCLE_ELB_DRAINED (0.7) false
VPC_CIDR:                        (0.8) 10.192.0.0/16
VPC_SG_NAME                      (0.9) AWS-OpsWorks-WebApp

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

1.2. 処理対象の状態確認¶

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

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

事前条件1: 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)"
}

事前条件2: OpsWorksスタック"My Sample Stack (Linux)"にOpsWorksレイヤー"Node.js App Server"が存在しない。

「OpsWorksスタック"My Sample Stack (Linux)"にOpsWorksレイヤー"Node.js App Server"が存在しない。」ことを確認します。

コマンド:

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

結果(例):

[]

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

VPC IDの取得

コマンド:

VPC_ID=$( \
  aws ec2 describe-vpcs \
    --filters Name=cidr,Values=${VPC_CIDR} \
    --query 'Vpcs[].VpcId' \
    --output text \
) \
  && echo ${VPC_ID}

結果(例):

vpc-xxxxxxxx

セキュリティグループIDの取得

コマンド:

VPC_SG_ID=$( \
  aws ec2 describe-security-groups \
    --filter Name=group-name,Values=${VPC_SG_NAME} \
    --query "SecurityGroups[?VpcId == \` ${VPC_ID}\`].GroupId" \
    --output text \
) \
  && echo ${VPC_SG_ID}

結果(例):

sg-xxxxxxxx

変数の設定:

OPSW_CUSTOM_SG_GROUP_IDS="${VPC_SG_ID}" \
  && echo ${OPSW_CUSTOM_SG_GROUP_IDS}

設定文字列の生成

変数の設定:

OPSW_LAYER_CUSTOM_RECIPES_STRING="Deploy=${OPSW_LAYER_CUSTOM_RECIPES_DEPLOY}" \
  && echo ${OPSW_LAYER_CUSTOM_RECIPES_STRING}

変数の設定:

OPSW_LAYER_LIFECYCLE_STRING="Shutdown={ExecutionTimeout=120,DelayUntilElbConnectionsDrained=false}" \
  && echo ${OPSW_LAYER_LIFECYCLE_STRING}

2. 主処理¶

OpsWorksレイヤーの作成¶

変数の確認:

cat << ETX

  AWS_DEFAULT_REGION:               ${AWS_DEFAULT_REGION}
  OPSW_STACK_DI:                    ${OPSW_STACK_ID}
  OPSW_LAYER_NAME:                  ${OPSW_LAYER_NAME}
  OPSW_LAYER_TYPE:                  ${OPSW_LAYER_TYPE}
  OPSW_LAYER_SHORTNAME:             ${OPSW_LAYER_SHORTNAME}
  OPSW_CUSTOM_SG_GROUP_IDS:         ${OPSW_CUSTOM_SG_GROUP_IDS}
  OPSW_LAYER_CUSTOM_RECIPES_STRING: ${OPSW_LAYER_CUSTOM_RECIPES_STRING}
  OPSW_LAYER_LIFECYCLE_STRING:      ${OPSW_LAYER_LIFECYCLE_STRING}

ETX

コマンド:

aws opsworks create-layer \
  --stack-id ${OPSW_STACK_ID} \
  --type ${OPSW_LAYER_TYPE} \
  --name "${OPSW_LAYER_NAME}" \
  --shortname ${OPSW_LAYER_SHORTNAME} \
  --auto-assign-public-ips \
  --no-auto-assign-elastic-ips \
  --no-use-ebs-optimized-instances \
  --custom-security-group-ids ${OPSW_CUSTOM_SG_GROUP_IDS} \
  --enable-auto-healing \
  --custom-recipes ${OPSW_LAYER_CUSTOM_RECIPES_STRING} \
  --lifecycle-event-configuration ${OPSW_LAYER_LIFECYCLE_STRING}

結果(例):

{
  "LayerId": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxxx"
}

3. 後処理¶

完了条件の確認¶

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

完了条件1: OpsWorksスタック"My Sample Stack (Linux)"にOpsWorksレイヤー"Node.js App Server"が存在する。

「OpsWorksスタック"My Sample Stack (Linux)"に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"
]

handson: opsworks (aws: intro)

task: OpsWorksレイヤーの作成¶

作業の目的 [why]¶

作業対象 [what]¶

標準時間¶

前提条件¶

作業権限条件 [who]¶

作業環境条件 [where]¶

開始条件¶

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

作業開始 [when]¶

タスクの実施¶

0. パラメータの指定¶

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

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

0.1. OpsWorksスタック名の指定¶

0.2. VPCのCIDRの指定¶

0.3. セキュリティグループ名の指定¶

0.4. OpsWorksレイヤー名の決定¶

0.5. OpsWorksレイヤー名のショート名の指定¶

0.6. レイヤタイプの指定¶

0.7. カスタムレシピの指定¶

0.8. ライフサイクルイベントの指定¶

0.9. ライフサイクルイベントの指定¶

再確認¶

1. 前処理¶

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

1.2. 処理対象の状態確認¶

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

2. 主処理¶

OpsWorksレイヤーの作成¶

3. 後処理¶

完了条件の確認¶

完了¶