task: OpsWorksスタックの作成

作業の目的 [why]

OpsWorksスタック"My Sample Stack (Linux)"を作成します。

作業対象 [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スタックの名称です。
  • 今回は"My Sample Stack (Linux)"とします。

リソース2: OpsWorksスタック属性

  • OpsWorksスタックの属性です。
  • 今回は"{ "Color": "rgb(45, 114, 184)" }"とします。

リソース3: OpsWorks設定マネージャ名

  • OpsWorks設定マネージャ名です。
  • 今回は"Chef"とします。

リソース4: OpsWorks設定マネージャのバージョン

  • OpsWorks設定マネージャのバージョンです。
  • 今回は"12"とします。

リソース5: カスタムクックブックのタイプ

  • カスタムクックブックのタイプです。
  • 今回は"archive"とします。

リソース6: カスタムクックブックのURL

リソース7: OpsWorksインスタンスのルートデバイスのタイプ

  • OpsWorksスタックから起動するOpsWorksインスタンスのルートデバイスのタイプです。
  • 今回は"ebs"とします。

リソース8: OpsWorksインスタンスのデフォルトOS

  • OpsWorksスタックから起動するOpsWorksインスタンスのデフォルトOSです。
  • 今回は"Amazon Linux 2017.03"とします。

リソース9: OpsWorksスタックが利用するIAMロール名

  • OpsWorksスタックが利用するIAMロールの名称です。
  • 今回は"aws-opsworks-service-role"とします。

リソース10: OpsWorksインスタンスが利用するIAMインスタンスプロファイル名

  • OpsWorksインスタンスが利用するIAMインスタンスプロファイルの名称です。
  • 今回は"aws-opsworks-ec2-role"とします。

リソース11: OpsWorksインスタンスが起動するVPCのCIDR

  • OpsWorksインスタンスが起動するVPCのCIDRです。
  • 今回は"10.192.0.0/16"とします。

リソース12: OpsWorksインスタンスが起動するサブネットのCIDR

  • OpsWorksインスタンスが起動するサブネットのCIDRです。
  • 今回は"10.192.16.0/24"とします。

作業開始 [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_ATTRIBUTE                   (0.2) ${OPSW_ATTRIBUTE}
  OPSW_CONF_MANAGER_NAME           (0.3) ${OPSW_CONF_MANAGER_NAME}
  OPSW_CONF_MANAGER_VERSION        (0.4) ${OPSW_CONF_MANAGER_VERSION}
  OPSW_CUSTOM_COOKBOOK_SOURCE_TYPE (0.5) ${OPSW_CUSTOM_COOKBOOK_SOURCE_TYPE}
  OPSW_CUSTOM_COOKBOOK_SOURCE_URL  (0.6) ${OPSW_CUSTOM_COOKBOOK_SOURCE_URL}
  OPSW_DEFAULT_ROOT_DEVICE_TYPE    (0.7) ${OPSW_DEFAULT_ROOT_DEVICE_TYPE}
  OPSW_DEFAULT_OS                  (0.8) ${OPSW_DEFAULT_OS}
  IAM_ROLE_NAME                    (0.9) ${IAM_ROLE_NAME}
  IAM_INSTANCE_PROFILE_NAME        (0.10) ${IAM_INSTANCE_PROFILE_NAME}
  VPC_CIDR                         (0.11) ${VPC_CIDR}
  VPC_SUBNET_CIDR                  (0.12) ${VPC_SUBNET_CIDR}

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_ATTRIBUTE                   (0.2) { "Color": "rgb(45, 114, 184)" }
OPSW_CONF_MANAGER_NAME           (0.3) Chef
OPSW_CONF_MANAGER_VERSION        (0.4) 12
OPSW_CUSTOM_COOKBOOK_SOURCE_TYPE (0.5) archive
OPSW_CUSTOM_COOKBOOK_SOURCE_URL  (0.6) https://s3.amazonaws.com/opsworks-demo-assets/opsworks-linux-demo-cookbooks-nodejs.tar.gz
OPSW_DEFAULT_ROOT_DEVICE_TYPE    (0.7) ebs
OPSW_DEFAULT_OS                  (0.8) Amazon Linux 2017.03
IAM_ROLE_NAME                    (0.9) aws-opsworks-service-role
IAM_INSTANCE_PROFILE_NAME        (0.10) aws-opsworks-ec2-role
VPC_CIDR                         (0.11) XXXXXXXXXXXX
VPC_SUBNET_CIDR                  (0.12) 10.192.16.0/24

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

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

変数の設定:

OPSW_STACK_NAME='My Sample Stack (Linux)'

0.2. スタックのアトリビュートの指定

変数の設定:

OPSW_ATTRIBUTE='{ "Color": "rgb(45, 114, 184)" }'

0.3. 設定マネージャの指定

変数の設定:

OPSW_CONF_MANAGER_NAME='Chef'

0.4. 設定マネージャのバージョン指定

変数の設定:

OPSW_CONF_MANAGER_VERSION='12'

0.5. カスタムクックブックのタイプ指定

変数の設定:

OPSW_CUSTOM_COOKBOOK_SOURCE_TYPE='archive'

0.6. カスタムクックブックのURL指定

変数の設定:

0.7. インスタンスのルートデバイスの指定

変数の設定:

OPSW_DEFAULT_ROOT_DEVICE_TYPE='ebs'

0.8. デフォルトOSの指定

変数の設定:

OPSW_DEFAULT_OS='Amazon Linux 2017.03'

0.9. IAMロールの指定

変数の設定:

IAM_ROLE_NAME='aws-opsworks-service-role'

0.10. インスタンスプロファイルの指定

変数の設定:

IAM_INSTANCE_PROFILE_NAME='aws-opsworks-ec2-role'

0.11. VPC CIDRの指定

変数の設定:

VPC_CIDR='10.192.0.0/16'

0.12. デフォルトサブネットCIDRの指定

変数の設定:

VPC_SUBNET_CIDR='10.192.16.0/24'

再確認

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

変数の確認:

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_ATTRIBUTE                   (0.2) ${OPSW_ATTRIBUTE}
  OPSW_CONF_MANAGER_NAME           (0.3) ${OPSW_CONF_MANAGER_NAME}
  OPSW_CONF_MANAGER_VERSION        (0.4) ${OPSW_CONF_MANAGER_VERSION}
  OPSW_CUSTOM_COOKBOOK_SOURCE_TYPE (0.5) ${OPSW_CUSTOM_COOKBOOK_SOURCE_TYPE}
  OPSW_CUSTOM_COOKBOOK_SOURCE_URL  (0.6) ${OPSW_CUSTOM_COOKBOOK_SOURCE_URL}
  OPSW_DEFAULT_ROOT_DEVICE_TYPE    (0.7) ${OPSW_DEFAULT_ROOT_DEVICE_TYPE}
  OPSW_DEFAULT_OS                  (0.8) ${OPSW_DEFAULT_OS}
  IAM_ROLE_NAME                    (0.9) ${IAM_ROLE_NAME}
  IAM_INSTANCE_PROFILE_NAME        (0.10) ${IAM_INSTANCE_PROFILE_NAME}
  VPC_CIDR                         (0.11) ${VPC_CIDR}
  VPC_SUBNET_CIDR                  (0.12) ${VPC_SUBNET_CIDR}

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_ATTRIBUTE                   (0.2) { "Color": "rgb(45, 114, 184)" }
OPSW_CONF_MANAGER_NAME           (0.3) Chef
OPSW_CONF_MANAGER_VERSION        (0.4) 12
OPSW_CUSTOM_COOKBOOK_SOURCE_TYPE (0.5) archive
OPSW_CUSTOM_COOKBOOK_SOURCE_URL  (0.6) https://s3.amazonaws.com/opsworks-demo-assets/opsworks-linux-demo-cookbooks-nodejs.tar.gz
OPSW_DEFAULT_ROOT_DEVICE_TYPE    (0.7) ebs
OPSW_DEFAULT_OS                  (0.8) Amazon Linux 2017.03
IAM_ROLE_NAME                    (0.9) aws-opsworks-service-role
IAM_INSTANCE_PROFILE_NAME        (0.10) aws-opsworks-ec2-role
VPC_CIDR                         (0.11) XXXXXXXXXXXX
VPC_SUBNET_CIDR                  (0.12) 10.192.16.0/24

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: OpsWorksスタック"My Sample Stack (Linux)"が存在しない。

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

コマンド:

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

結果(例):

[]

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

IAMロールのARN取得

コマンド:

IAM_ROLE_ARN=$( \
  aws iam get-role \
    --role-name ${IAM_ROLE_NAME} \
    --query 'Role.Arn' \
    --output text \
) \
  && echo ${IAM_ROLE_ARN}

結果(例):

arn:aws:iam::XXXXXXXXXXXX:role/aws-opsworks-service-role

インスタンスプロファイルのARN取得

コマンド:

IAM_INSTANCE_PROFILE_ARN=$( \
  aws iam get-instance-profile \
    --instance-profile-name ${IAM_INSTANCE_PROFILE_NAME} \
    --query 'InstanceProfile.Arn' \
    --output text \
) \
  && echo ${IAM_INSTANCE_PROFILE_ARN}

結果(例):

arn:aws:iam::XXXXXXXXXXXX:instance-profile/aws-opsworks-ec2-role

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_SUBNET_ID=$( \
  aws ec2 describe-subnets \
    --filters Name=cidrBlock,Values=${VPC_SUBNET_CIDR} \
    --query 'Subnets[].SubnetId' \
    --output text \
) \
  && echo ${VPC_SUBNET_ID}

結果(例):

subnet-xxxxxxxx

設定文字列の生成

変数の設定:

OPSW_CONF_MANAGER_STRING="Name=${OPSW_CONF_MANAGER_NAME},Version=${OPSW_CONF_MANAGER_VERSION}" \
  && echo ${OPSW_CONF_MANAGER_STRING}

変数の設定:

OPSW_CUSTOM_COOKBOOK_SOURECE_STRING="Type=${OPSW_CUSTOM_COOKBOOK_SOURCE_TYPE},Url=${OPSW_CUSTOM_COOKBOOK_SOURCE_URL}" \
  && echo ${OPSW_CUSTOM_COOKBOOK_SOURECE_STRING}

2. 主処理

OpsWorksスタックの作成

変数の確認:

cat << ETX

  AWS_DEFAULT_REGION:                  ${AWS_DEFAULT_REGION}
  IAM_ROLE_ARN:                        ${IAM_ROLE_ARN}
  IAM_INSTANCE_PROFILE_ARN:            ${IAM_INSTANCE_PROFILE_ARN}
  OPSW_ATTRIBUTE:                      ${OPSW_ATTRIBUTE}
  OPSW_CONF_MANAGER_STRING             ${OPSW_CONF_MANAGER_STRING}
  OPSW_CUSTOM_COOKBOOK_SOURECE_STRING: ${OPSW_CUSTOM_COOKBOOK_SOURECE_STRING}
  OPSW_DEFAULT_OS:                     ${OPSW_DEFAULT_OS}
  OPSW_DEFAULT_ROOT_DEVICE_TYPE:       ${OPSW_DEFAULT_ROOT_DEVICE_TYPE}
  OPSW_STACK_NAME:                     ${OPSW_STACK_NAME}
  VPC_ID:                              ${VPC_ID}
  VPC_SUBNET_ID:                       ${VPC_SUBNET_ID}

ETX

コマンド:

aws opsworks create-stack \
  --name "${OPSW_STACK_NAME}" \
  --service-role-arn ${IAM_ROLE_ARN} \
  --default-instance-profile-arn ${IAM_INSTANCE_PROFILE_ARN} \
  --stack-region ${AWS_DEFAULT_REGION} \
  --vpc-id ${VPC_ID} \
  --default-subnet-id ${VPC_SUBNET_ID} \
  --use-opsworks-security-groups \
  --configuration-manager ${OPSW_CONF_MANAGER_STRING} \
  --use-custom-cookbooks \
  --custom-cookbooks-source ${OPSW_CUSTOM_COOKBOOK_SOURECE_STRING} \
  --default-os "${OPSW_DEFAULT_OS}" \
  --default-root-device-type ${OPSW_DEFAULT_ROOT_DEVICE_TYPE} \
  --attributes "${OPSW_ATTRIBUTE}"

結果(例):

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

3. 後処理

完了条件の確認

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

完了条件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)"
}

完了