7.1. S3ライフサイクルドキュメントの作成¶
作業の目的 [why]¶
S3バケットライフサイクルドキュメント"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
ライフサイクルキュメントファイル"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
S3バケット"handson-cli-s3-XXXXXXXXXXXX-log"が存在する。
- 事前条件2
ライフサイクルドキュメントファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli-s3"が存在する。
- 事前条件3
ライフサイクルキュメントファイル"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json"が存在する。
作業対象 [what]¶
S3サービス
標準時間(合計)¶
8分
パラメータ設定¶
- パラメータ設定の標準時間
2分
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 設定ファイル用ディレクトリ
今回は"<設定ファイル用ディレクトリ>"を設定ファイル用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d <設定ファイル用ディレクトリ>
結果(例:存在する場合):
<設定ファイル用ディレクトリ>
存在しない場合は作成します。
コマンド:
mkdir -p <設定ファイル用ディレクトリ>
リソース2: S3バケット名
作成するS3バケットの名称です。
今回は"handson-cli-s3-XXXXXXXXXXXX-log"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. S3バケット名の指定¶
変数の設定:
S3_BUCKET_PREFIX='handson-cli-s3'
コマンド:
AWS_ID=$( \ aws sts get-caller-identity \ --query 'Account' \ --output text \ ) \ && echo ${AWS_ID}
結果(例):
XXXXXXXXXXXX
変数の設定:
S3_BUCKET_SUFFIX='log'
変数の設定:
S3_BUCKET_NAME="${S3_BUCKET_PREFIX}-${AWS_ID}-${S3_BUCKET_SUFFIX}" \ && echo ${S3_BUCKET_NAME}
結果(例):
handson-cli-s3-XXXXXXXXXXXX-log
0.3. ファイル名の指定¶
変数の設定:
FILE_S3_BUCKET_LIFECYCLE_DOC="${DIR_S3_BUCKET_LIFECYCLE_DOC}/${S3_BUCKET_NAME}-s3-bucket-lifecycle.json" \ && echo ${FILE_S3_BUCKET_LIFECYCLE_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-s3" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-s3-bucket_lifecycle_document-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-s3/2019-09-23-s3-bucket_lifecycle_document-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.1. DIR_S3_BUCKET_LIFECYCLE_DOC:"${HOME}/tmp/conf-handson-cli-s3" DIR_S3_BUCKET_LIFECYCLE_DOC="${DIR_S3_BUCKET_LIFECYCLE_DOC}" # 0.2. S3_BUCKET_NAME:"handson-cli-s3-XXXXXXXXXXXX-log" S3_BUCKET_NAME="${S3_BUCKET_NAME}" # 0.3. FILE_S3_BUCKET_LIFECYCLE_DOC:"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json" FILE_S3_BUCKET_LIFECYCLE_DOC="${FILE_S3_BUCKET_LIFECYCLE_DOC}" # 0.4. S3_BUCKET_LIFECYCLE_TRANSITION_DAYS:"14" S3_BUCKET_LIFECYCLE_TRANSITION_DAYS="${S3_BUCKET_LIFECYCLE_TRANSITION_DAYS}" # 0.5. S3_BUCKET_LIFECYCLE_EXPIRE_DAYS:"32" S3_BUCKET_LIFECYCLE_EXPIRE_DAYS="${S3_BUCKET_LIFECYCLE_EXPIRE_DAYS}" # 0.6. S3_BUCKET_LIFECYCLE_ID:"handson-cli-s3-log-archive" S3_BUCKET_LIFECYCLE_ID="${S3_BUCKET_LIFECYCLE_ID}" # 0.7. S3_BUCKET_LIFECYCLE_PREFIX:"Logs" S3_BUCKET_LIFECYCLE_PREFIX="${S3_BUCKET_LIFECYCLE_PREFIX}" # 0.8. S3_BUCKET_LIFECYCLE_STORAGE_CLASS:"GLACIER" S3_BUCKET_LIFECYCLE_STORAGE_CLASS="${S3_BUCKET_LIFECYCLE_STORAGE_CLASS}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
- タスク標準時間
6分
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: S3バケット"handson-cli-s3-XXXXXXXXXXXX-log"が存在する。
「S3バケット"handson-cli-s3-XXXXXXXXXXXX-log"が存在する。」ことを確認します。
コマンド:
aws s3api list-buckets \ --query "Buckets[?Name == \`${S3_BUCKET_NAME}\`].Name" \ --output text
結果(例):
handson-cli-s3-XXXXXXXXXXXX-log
事前条件2: ライフサイクルドキュメントファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli-s3"が存在する。
「ライフサイクルドキュメントファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli-s3"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_S3_BUCKET_LIFECYCLE_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-s3
事前条件3: ライフサイクルキュメントファイル"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json"が存在する。
「ライフサイクルキュメントファイル"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json"が存在する。」ことを確認します。
コマンド:
! ls ${FILE_S3_BUCKET_LIFECYCLE_DOC}
結果(例):
ls: ${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json No such file or directory
2. 主処理¶
S3ライフサイクルドキュメントの作成¶
変数の確認:
cat << ETX # FILE_S3_BUCKET_LIFECYCLE_DOC:"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json" FILE_S3_BUCKET_LIFECYCLE_DOC="${FILE_S3_BUCKET_LIFECYCLE_DOC}" # S3_BUCKET_LIFECYCLE_EXPIRE_DAYS:"32" S3_BUCKET_LIFECYCLE_EXPIRE_DAYS="${S3_BUCKET_LIFECYCLE_EXPIRE_DAYS}" # S3_BUCKET_LIFECYCLE_ID:"handson-cli-s3-log-archive" S3_BUCKET_LIFECYCLE_ID="${S3_BUCKET_LIFECYCLE_ID}" # S3_BUCKET_LIFECYCLE_PREFIX:"Logs" S3_BUCKET_LIFECYCLE_PREFIX="${S3_BUCKET_LIFECYCLE_PREFIX}" # S3_BUCKET_LIFECYCLE_TRANSITION_DAYS:"14" S3_BUCKET_LIFECYCLE_TRANSITION_DAYS="${S3_BUCKET_LIFECYCLE_TRANSITION_DAYS}" # S3_BUCKET_LIFECYCLE_STORAGE_CLASS:"GLACIER" S3_BUCKET_LIFECYCLE_STORAGE_CLASS="${S3_BUCKET_LIFECYCLE_STORAGE_CLASS}" ETX
コマンド:
cat << EOF > ${FILE_S3_BUCKET_LIFECYCLE_DOC} { "Rules": [ { "Expiration": { "Days": ${S3_BUCKET_LIFECYCLE_EXPIRE_DAYS} }, "ID": "${S3_BUCKET_LIFECYCLE_ID}", "Prefix": "${S3_BUCKET_LIFECYCLE_PREFIX}/", "Status": "Enabled", "Transitions": [ { "Days": ${S3_BUCKET_LIFECYCLE_TRANSITION_DAYS}, "StorageClass": "${S3_BUCKET_LIFECYCLE_STORAGE_CLASS}" } ] } ] } EOF cat ${FILE_S3_BUCKET_LIFECYCLE_DOC}
結果(例):
{ "Rules": [ { "Expiration": { "Days": 32 }, "ID": "handson-cli-s3-log-archive", "Prefix": "Logs/", "Status": "Enabled", "Transition": { "Days": 14, "StorageClass": "GLACIER" } } ] }
コマンド:
jsonlint -q ${FILE_S3_BUCKET_LIFECYCLE_DOC}
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: ライフサイクルキュメントファイル"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json"が存在する。
「ライフサイクルキュメントファイル"${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json"が存在する。」ことを確認します。
コマンド:
ls ${FILE_S3_BUCKET_LIFECYCLE_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-s3/handson-cli-s3-XXXXXXXXXXXX-log-s3-bucket-lifecycle.json