2.6. S3バケットのCORS設定作成 (AWS ID)¶
作業の目的 [why]¶
S3バケット"handson20170904data-XXXXXXXXXXXX"にWebサイト"http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"をオリジンとするCORS設定を行います。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- S3バケット"handson20170904data-XXXXXXXXXXXX"に"http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"に対するCORS設定が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- 設定ファイル用ディレクトリが存在する。
- 事前条件2
- S3バケット"handson20170904data-XXXXXXXXXXXX"が存在する。
- 事前条件3
- S3バケット"handson20170904data-XXXXXXXXXXXX"に"http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"に対するCORS設定が存在しない。
前提と異なることが判明した場合、直ちに処理を中止します。
課題
(未検証)
作業対象 [what]¶
- S3バケット
標準時間¶
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.144 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.7.2
バージョンが古い場合は最新版に更新しましょう。
コマンド:
sudo -H pip install -U awscli
開始条件¶
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 設定ファイル用ディレクトリ
今回は"${HOME}/tmp/conf-s3"を設定ファイル用ディレクトリとします。
ls ${HOME}/tmp/conf-s3
存在しない場合は作成します。
mkdir -p ${HOME}/tmp/conf-s3
リソース2: S3バケット名
- CORS設定をするS3バケットの名称です。
- 今回は"handson20170904data-XXXXXXXXXXXX"とします。
リソース3: オリジンホスト名
- CORSを許可するオリジンのホスト名です。
- 今回は"http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"とします。
タスクの実施¶
0. パラメータの指定¶
まず変数の確認をします。
変数の確認:
cat << ETX 0.a. AWS_DEFAULT_PROFILE: actual: ${AWS_DEFAULT_PROFILE} expect: <S3のフル権限が許可されているプロファイル> 0.b. AWS_DEFAULT_REGION: actual: ${AWS_DEFAULT_REGION} expect: ap-northeast-1 0.1. DIR_CONF: actual: ${DIR_CONF} expect: ${HOME}/tmp/conf-s3 0.2. S3_BUCKET_NAME: actual: ${S3_BUCKET_NAME} expect: handson20170904data-XXXXXXXXXXXX 0.3. URL_ORIGIN: actual: ${URL_ORIGIN} expect: http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com ETX
変数が入っていない、適切でない場合は、それぞれの手順番号について作業を行います。
0.a. プロファイルの指定¶
プロファイルの一覧を確認します。
コマンド:
cat ~/.aws/credentials \ | grep '\[' \ | sed 's/\[//g' | sed 's/\]//g'
結果(例):
iamFull-prjz-mbpr13 <S3のフル権限が許可されているプロファイル>
変数の設定:
export AWS_DEFAULT_PROFILE='<S3のフル権限が許可されているプロファイル>'
0.2. S3バケット名の指定¶
S3バケット名を指定します。
0.3. バケット名の指定¶
変数の設定:
AWS_ID=$( \ aws sts get-caller-identity \ --query 'Account' \ --output text \ ) && echo ${AWS_ID}
結果(例)
XXXXXXXXXXXX
変数の設定:
S3_BUCKET_NAME="handson20170904data-${AWS_ID}" \ && echo ${S3_BUCKET_NAME}
0.3. オリジンURLの指定¶
オリジンURLを指定します。
変数の設定:
S3_BUCKET_WEBSITE="handson20170904web-${AWS_ID}" \ && echo ${S3_BUCKET_WEBSITE}
変数の設定:
URL_ORIGIN="http://${S3_BUCKET_WEBSITE}.s3-website-${AWS_DEFAULT_REGION}.amazonaws.com" \ && echo ${URL_ORIGIN}
再確認¶
設定されている変数の内容を再確認します。
変数の確認:
cat << ETX 0.a. AWS_DEFAULT_PROFILE: actual: ${AWS_DEFAULT_PROFILE} expect: <S3のフル権限が許可されているプロファイル> 0.b. AWS_DEFAULT_REGION: actual: ${AWS_DEFAULT_REGION} expect: ap-northeast-1 0.1. DIR_CONF: actual: ${DIR_CONF} expect: ${HOME}/tmp/conf-s3 0.2. S3_BUCKET_NAME: actual: ${S3_BUCKET_NAME} expect: handson20170904data-XXXXXXXXXXXX 0.3. URL_ORIGIN: actual: ${URL_ORIGIN} expect: http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com ETX
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 設定ファイル用ディレクトリが存在する。
「設定ファイル用ディレクトリが存在する。」ことを確認します。
コマンド:
ls -d ${DIR_CONF}
結果(例):
${HOME}/tmp/conf-s3
事前条件2: S3バケット"handson20170904data-XXXXXXXXXXXX"が存在する。
「S3バケット"handson20170904data-XXXXXXXXXXXX"が存在する。」ことを確認します。
コマンド:
aws s3api list-buckets \ --query "Buckets[?Name == \`${S3_BUCKET_NAME}\`].Name"
結果(例):
[ "handson20170904data-XXXXXXXXXXXX" ]
事前条件3: S3バケット"handson20170904data-XXXXXXXXXXXX"に"http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"に対するCORS設定が存在しない。
「S3バケット"handson20170904data-XXXXXXXXXXXX"に"http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"に対するCORS設定が存在しない。」ことを確認します。
コマンド:
aws s3api get-bucket-cors \ --bucket ${S3_BUCKET_NAME} \ --query "CORSRules[?contains(AllowedOrigins,\`${URL_ORIGIN}\`)].AllowedOrigins"
結果(例):
A client error (NoSuchCORSConfiguration) occurred when calling the GetBucketCors operation: The CORS configuration does not exist
1.2. 主処理に必要な情報の取得¶
設定ファイルの生成
変数の設定:
FILE_INPUT="${DIR_CONF}/${S3_BUCKET_NAME}-s3-bucket_cors-create-$(date +%Y-%m-%d).json"
変数の確認:
cat << EOF FILE_INPUT: actual: ${FILE_INPUT} expect: ${HOME}/tmp/conf-s3/handson20170904data-XXXXXXXXXXXX-s3-bucket_cors-create-YYYY-MM-DD.json URL_ORIGIN: actual: ${URL_ORIGIN} expect: http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com EOF
コマンド:
cat << EOF > ${FILE_INPUT} { "CORSRules": [ { "AllowedHeaders": [ "*" ], "MaxAgeSeconds": 3000, "AllowedMethods": [ "PUT" ], "AllowedOrigins": [ "${URL_ORIGIN}" ] } ] } EOF cat ${FILE_INPUT}
結果(例):
{ "CORSRules": [ { "AllowedHeaders": [ "*" ], "MaxAgeSeconds": 3000, "AllowedMethods": [ "PUT" ], "AllowedOrigins": [ "http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com" ] } ] }
JSONファイルを作成したら、フォーマットが壊れてないか必ず確認します。
コマンド:
jsonlint -q ${FILE_INPUT}
エラーが出力されなければOKです。
2. 主処理¶
S3バケットのCORS設定作成¶
変数の確認:
cat << ETX S3_BUCKET_NAME: actual: ${S3_BUCKET_NAME} expect: handson20170904data-XXXXXXXXXXXX FILE_INPUT: actual: ${FILE_INPUT} expect: ${HOME}/tmp/conf-s3/handson20170904data-XXXXXXXXXXXX-s3-bucket_cors-create-YYYY-MM-DD.json ETX
コマンド:
aws s3api put-bucket-cors \ --bucket ${S3_BUCKET_NAME} \ --cors-configuration file://${FILE_INPUT}
結果:
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: S3バケット"handson20170904data-XXXXXXXXXXXX"に"http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"に対するCORS設定が存在する。
「S3バケット"handson20170904data-XXXXXXXXXXXX"に"http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com"に対するCORS設定が存在する。」ことを確認します。
コマンド:
aws s3api get-bucket-cors \ --bucket ${S3_BUCKET_NAME} \ --query "CORSRules[?contains(AllowedOrigins,\`${URL_ORIGIN}\`)].AllowedOrigins"
結果(例):
[ [ "http://handson20170904web-XXXXXXXXXXXX.s3-website-ap-northeast-1.amazonaws.com" ] ]