task: OpsWorksアプリの作成¶
作業の目的 [why]¶
OpsWorksスタック"My Sample Stack (Linux)"にOpsWorksアプリ"Node.js Sample App"を作成します。
作業対象 [what]¶
- OpsWorksスタック
標準時間¶
8分
前提条件¶
作業環境条件 [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アプリの名称です。
- 今回は"Node.js Sample App"とします。
リソース3: OpsWorksアプリのショート名
- 作成するOpsWorksアプリのショート名です。
- 今回は"nodejs_sample_app"とします。
リソース4: OpsWorksアプリのタイプ
- 作成するOpsWorksアプリののタイプです。
- 今回は"other"とします。
リソース5: OpsWorksアプリのソースタイプ
- 作成するOpsWorksアプリのソースのタイプです。
- 今回は"git"とします。
リソース6: OpsWorksアプリのソースURL
- 作成するOpsWorksアプリのソースのURLです。
- 今回は"https://github.com/awslabs/opsworks-windows-demo-nodejs.git"とします。
リソース7: OpsWorksアプリのAUTOBUNDLEONDEPLOY属性
- 作成するOpsWorksアプリのAUTOBUNDLEONDEPLOY属性です。
- 今回は"true"とします。
リソース8: OpsWorksアプリの環境変数の変数名
- 作成するOpsWorksアプリの環境変数の変数名です。
- 今回は"APP_ADMIN_EMAIL"とします。
リソース9: OpsWorksアプリの環境変数の値
- 作成するOpsWorksアプリの環境変数の値です。
- 今回は"admin@example.com"とします。
リソース10: OpsWorksアプリの環境変数のセキュリティ設定
- 作成するOpsWorksアプリの環境変数のセキュリティ設定です。
- 今回は"false"とします。
タスクの実施¶
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_APP_NAME: (0.2) ${OPSW_APP_NAME} OPSW_APP_SHORTNAME: (0.3) ${OPSW_APP_SHORTNAME} OPSW_APP_TYPE: (0.4) ${OPSW_APP_TYPE} OPSW_APP_SOURCE_TYPE: (0.5) ${OPSW_APP_SOURCE_TYPE} OPSW_APP_SOURCE_URL: (0.6) ${OPSW_APP_SOURCE_URL} OPSW_APP_ATTRIBUTES_AUTOBUNDLEONDEPLOY: (0.7) ${OPSW_APP_ATTRIBUTES_AUTOBUNDLEONDEPLOY} OPSW_APP_ENV_KEY: (0.8) ${OPSW_APP_ENV_KEY} OPSW_APP_ENV_VALUE: (0.9) ${OPSW_APP_ENV_VALUE} OPSW_APP_ENV_SECURE: (0.10) ${OPSW_APP_ENV_SECURE} 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_APP_NAME (0.2) Node.js Sample App OPSW_APP_SHORTNAME (0.3) nodejs_sample_app OPSW_APP_TYPE (0.4) other OPSW_APP_SOURCE_TYPE: (0.5) git OPSW_APP_SOURCE_URL: (0.6) https://github.com/awslabs/opsworks-windows-demo-nodejs.git OPSW_APP_ATTRIBUTES_AUTOBUNDLEONDEPLOY: (0.7) true OPSW_APP_ENV_KEY: (0.8) APP_ADMIN_EMAIL OPSW_APP_ENV_VALUE: (0.9) admin@example.com OPSW_APP_ENV_SECURE: (0.10) false
変数が入っていない、適切でない場合は、それぞれの手順番号について作業を行います。
0.a. プロファイルの指定¶
プロファイルの一覧を確認します。
コマンド:
cat ~/.aws/credentials \ | grep '\[' \ | sed 's/\[//g' | sed 's/\]//g'
結果(例):
iamFull-prjz-mbpr13 <OpsWorksのフル権限を許可されたプロファイル>
変数の設定:
export AWS_DEFAULT_PROFILE='<OpsWorksのフル権限を許可されたプロファイル>'
0.6. アプリケーションソースのURLの指定¶
変数の設定:
OPSW_APP_SOURCE_URL='https://github.com/awslabs/opsworks-windows-demo-nodejs.git'
再確認¶
設定されている変数の内容を再確認します。
変数の確認:
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_APP_NAME: (0.2) ${OPSW_APP_NAME} OPSW_APP_SHORTNAME: (0.3) ${OPSW_APP_SHORTNAME} OPSW_APP_TYPE: (0.4) ${OPSW_APP_TYPE} OPSW_APP_SOURCE_TYPE: (0.5) ${OPSW_APP_SOURCE_TYPE} OPSW_APP_SOURCE_URL: (0.6) ${OPSW_APP_SOURCE_URL} OPSW_APP_ATTRIBUTES_AUTOBUNDLEONDEPLOY: (0.7) ${OPSW_APP_ATTRIBUTES_AUTOBUNDLEONDEPLOY} OPSW_APP_ENV_KEY: (0.8) ${OPSW_APP_ENV_KEY} OPSW_APP_ENV_VALUE: (0.9) ${OPSW_APP_ENV_VALUE} OPSW_APP_ENV_SECURE: (0.10) ${OPSW_APP_ENV_SECURE} 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_APP_NAME (0.2) Node.js Sample App OPSW_APP_SHORTNAME (0.3) nodejs_sample_app OPSW_APP_TYPE (0.4) other OPSW_APP_SOURCE_TYPE: (0.5) git OPSW_APP_SOURCE_URL: (0.6) https://github.com/awslabs/opsworks-windows-demo-nodejs.git OPSW_APP_ATTRIBUTES_AUTOBUNDLEONDEPLOY: (0.7) true OPSW_APP_ENV_KEY: (0.8) APP_ADMIN_EMAIL OPSW_APP_ENV_VALUE: (0.9) admin@example.com OPSW_APP_ENV_SECURE: (0.10) false
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 Sample App"が存在しない。
「OpsWorksスタック"My Sample Stack (Linux)"にOpsWorksアプリ"Node.js Sample App"が存在しない。」ことを確認します。
コマンド:
aws opsworks describe-apps \ --stack-id ${OPSW_STACK_ID} \ --query "Apps[?Name == \`${OPSW_APP_NAME}\`].Name"
結果(例):
[]
1.3. 主処理に必要な情報の取得¶
設定文字列の生成
変数の設定:
OPSW_APP_SOURCE_STRING="Type=${OPSW_APP_SOURCE_TYPE},Url=${OPSW_APP_SOURCE_URL}" \ && echo ${OPSW_APP_SOURCE_STRING}
変数の設定:
OPSW_APP_ATTRIBUTES_STRING="AutoBundleOnDeploy=${OPSW_APP_ATTRIBUTES_AUTOBUNDLEONDEPLOY}" \ && echo ${OPSW_APP_ATTRIBUTES_STRING}
変数の設定:
OPSW_APP_ENV_STRING="Key=${OPSW_APP_ENV_KEY},Value=${OPSW_APP_ENV_VALUE},Secure=${OPSW_APP_ENV_SECURE}" \ && echo ${OPSW_APP_ENV_STRING}
2. 主処理¶
OpsWorksアプリの作成¶
変数の確認:
cat << ETX OPSW_STACK_ID: ${OPSW_STACK_ID} OPSW_APP_NAME: ${OPSW_APP_NAME} OPSW_APP_TYPE: ${OPSW_APP_TYPE} OPSW_APP_SHORTNAME: ${OPSW_APP_SHORTNAME} OPSW_APP_SOURCE_STRING: ${OPSW_APP_SOURCE_STRING} OPSW_APP_ATTRIBUTES_STRING: ${OPSW_APP_ATTRIBUTES_STRING} OPSW_APP_ENV_STRING: ${OPSW_APP_ENV_STRING} ETX
コマンド:
aws opsworks create-app \ --stack-id ${OPSW_STACK_ID} \ --name "${OPSW_APP_NAME}" \ --type ${OPSW_APP_TYPE} \ --shortname ${OPSW_APP_SHORTNAME} \ --app-source "${OPSW_APP_SOURCE_STRING}" \ --no-enable-ssl \ --attributes "${OPSW_APP_ATTRIBUTES_STRING}" \ --environment "${OPSW_APP_ENV_STRING}"
結果(例):
{ "AppId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: OpsWorksスタック"My Sample Stack (Linux)"にOpsWorksアプリ"Node.js Sample App"が存在する。
「OpsWorksスタック"My Sample Stack (Linux)"にOpsWorksアプリ"Node.js Sample App"が存在する。」ことを確認します。
コマンド:
aws opsworks describe-apps \ --stack-id ${OPSW_STACK_ID} \ --query "Apps[?Name == \`${OPSW_APP_NAME}\`].Name"
結果(例):
[ "Node.js Sample App" ]