wordpressデプロイ時のcloudfrontキャッシュクリアを自動化する

カテゴリ一ブログ開発

2019-10-23 #AWS #CloudFront #WordPress #shellscript

こんにちは。
cloudfrontのキャッシュクリア、よく忘れます。
デプロイした後にawsにログインしてポチポチやるでもいいですが、自動化しましょう。

ギークフィードではwordpressのデプロイにwordmoveというオープンソースを利用しています。
また、cloudfrontを利用して負荷をかけずに高速化をしています。
詳しくは以下の社長ブログからどうぞ。

WordPressで構築されているウェブサイトにCloudFrontを立てて高速化＆セキュリティ強化①
WordPressで構築されているウェブサイトにCloudFrontを立てて高速化＆セキュリティ強化②

1 環境
2 IAMユーザー、ポリシーの作成
3 スクリプトの作成
- 3.1 ディストリビューションidの取得について
- 3.2 awsコマンドについて
4 実行してみる
5 自動化する
6 おわりに
- 6.1 まとめ
- 6.2 感想

環境

簡単に環境の構成図と今回の完成予想をまとめてみました。

今回はデプロイした際にオレンジ線のキャッシュクリアが実行されるようにしてみます。
図にあるように、ギークのwordpressはバーチャルホストをきって複数サイトを運用しているため、
特定のサイトをデプロイした際にどのcloudfrontディストリビューションのキャッシュをクリアするかを判別する必要があります。

IAMユーザー、ポリシーの作成

wordpress開発環境でawscliを使用するためにIAMユーザーとポリシーを作成します。

IAMユーザー
ユーザー名：cli_wordpress_dev
アクセスキー、シークレットアクセスキーを作成

IAMポリシー

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "cloudfront:ListDistributions",
                "cloudfront:CreateInvalidation"
            ],
            "Resource": "*",
            "Condition": {
                "IpAddress": {
                    "aws:SourceIp": "xxx.xxx.xxx.xxx/32"
                }
            }
        }
    ]
}

{

"Version": "2012-10-17",

"Statement": [

{

"Sid": "VisualEditor0",

"Effect": "Allow",

"Action": [

"cloudfront:ListDistributions",

"cloudfront:CreateInvalidation"

"Resource": "*",

"Condition": {

"IpAddress": {

"aws:SourceIp": "xxx.xxx.xxx.xxx/32"

}

]

}

必要最低限のポリシーを設定し、一応リソース制限としてwordpress開発サーバーのIPを指定しています。

スクリプトの作成

作成したスクリプトは以下です。
wordmove実行時のpathから対象のwordpressプロファイルを特定し、プロファイル名を含むCNAMEを持つディストリビューションのキャッシュをすべてクリアします。

#!/bin/bash

# pathからプロファイル名を取得
path=$(pwd)
path_list=(${path//\// })
profile=${path_list[-2]}

# ディストリビューションidを取得
distributions=$(aws cloudfront list-distributions)
items=$(echo $distributions | jq '.DistributionList.Items')
len=$(echo $items | jq length)
for i in $( seq 0 $(($len - 1)) );
do
    row=$(echo $items | jq .[$i])
    # 有効になっていないディストリビューションは無視
    is_enabled=$(echo $row | jq -r '.Enabled')
    if [ $is_enabled == 'false' ]; then
        continue
    fi

    # CNAMEにプロファイル名が含まれているか
    cname=$(echo $row | jq -r '.AliasICPRecordals[].CNAME')
    if [ ! $(echo $cname | grep $profile) ]; then
        continue
    fi
    distribution_id=$(echo $row | jq -r '.Id')
done

# invalidation実行
aws cloudfront create-invalidation --distribution-id $distribution_id \
--paths '/*'

#!/bin/bash

# pathからプロファイル名を取得

path=$(pwd)

path_list=(${path//\// })

profile=${path_list[-2]}

# ディストリビューションidを取得

distributions=$(aws cloudfront list-distributions)

items=$(echo $distributions | jq '.DistributionList.Items')

len=$(echo $items | jq length)

for i in $( seq 0 $(($len - 1)) );

row=$(echo $items | jq .[$i])

# 有効になっていないディストリビューションは無視

is_enabled=$(echo $row | jq -r '.Enabled')

if [ $is_enabled == 'false' ]; then

continue

# CNAMEにプロファイル名が含まれているか

cname=$(echo $row | jq -r '.AliasICPRecordals[].CNAME')

if [ ! $(echo $cname | grep $profile) ]; then

continue

distribution_id=$(echo $row | jq -r '.Id')

done

# invalidation実行

aws cloudfront create-invalidation --distribution-id $distribution_id \

--paths '/*'

ディストリビューションidの取得について

aws cloudfront list-distributions
を実行すると、結果は以下のようなjsonで返ってきます。（本当はもっと大量に出てきますが不要な情報はすべて消しています）

{   
    "DistributionList": {
        "Items": [
            {   
                "Enabled": true, 
                "AliasICPRecordals": [
                    {   
                        "CNAME": "www.youwire.jp", 
                        "ICPRecordalStatus": "APPROVED"
                    }   
                ], 
                "Id": "E12O08XXXXXXXX"
            },  
            {   
                "Enabled": true, 
                "AliasICPRecordals": [
                    {   
                        "CNAME": "www.geekfeed.co.jp", 
                        "ICPRecordalStatus": "APPROVED"
                    }   
                ], 
                "Id": "E24846XXXXXXXX"
            },  
            {   
                "Enabled": false, 
                "AliasICPRecordals": [
                    {   
                        "CNAME": "cfgeekfeed.geekdev.tokyo",
                        "ICPRecordalStatus": "APPROVED"
                    }
                ], 
                "Id": "E319WEXXXXXXXX"
            }
        ]
    }
}

{

"DistributionList": {

"Items": [

{

"Enabled": true,

"AliasICPRecordals": [

{

"CNAME": "www.youwire.jp",

"ICPRecordalStatus": "APPROVED"

}

"Id": "E12O08XXXXXXXX"

{

"Enabled": true,

"AliasICPRecordals": [

{

"CNAME": "www.geekfeed.co.jp",

"ICPRecordalStatus": "APPROVED"

}

"Id": "E24846XXXXXXXX"

{

"Enabled": false,

"AliasICPRecordals": [

{

"CNAME": "cfgeekfeed.geekdev.tokyo",

"ICPRecordalStatus": "APPROVED"

}

"Id": "E319WEXXXXXXXX"

}

]

}

Items以下のjson配列をループしています。
Enabledはそのディストリビューションが有効かどうかを表しており、有効になっていないものはid検索から除外しています。
jqコマンドで値を取得するとき、「-r」オプションをつけることでダブルクオーテーションを排除することができます。

awsコマンドについて

今回はすべてのキャッシュをクリアするので、この部分は簡単です。’/*’で全指定できます。
サイトごとに異なるpathのキャッシュを削除したい場合は、それぞれ専用のjsonオブジェクトを作成し、
「–invalidation-batch」オプションを使用すると実現できます。

【awscliドキュメント】create-invalidation

実行してみる

実行してみるとアウトプットは以下のような感じです。

[kusanagi@kusanagi71 DocumentRoot]$ ./create_invalidation.sh 
{
    "Invalidation": {
        "Status": "InProgress", 
        "InvalidationBatch": {
            "Paths": {
                "Items": [
                    "/*"
                ], 
                "Quantity": 1
            }, 
            "CallerReference": "cli-1571728991-843434"
        }, 
        "Id": "IYZJ7HO0UNVU7", 
        "CreateTime": "2019-10-22T07:23:12.570Z"
    }, 
    "Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/E24846XXXXXXXX/invalidation/IYZJ7HO0UNVU7"
}

[kusanagi@kusanagi71 DocumentRoot]$ ./create_invalidation.sh

{

"Invalidation": {

"Status": "InProgress",

"InvalidationBatch": {

"Paths": {

"Items": [

"/*"

"Quantity": 1

"CallerReference": "cli-1571728991-843434"

"Id": "IYZJ7HO0UNVU7",

"CreateTime": "2019-10-22T07:23:12.570Z"

"Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/E24846XXXXXXXX/invalidation/IYZJ7HO0UNVU7"

}

実行後にAWSのコンソールで確認してみるとこんな感じです。

キャッシュクリアが行われていることがわかります。

自動化する

あとはwordmove実行をトリガーとして上記スクリプトを実行すればOKです。
今回はaliasを使って行うことにしました。
~/.bash_profileに以下を追記します。

alias wordmove_push='wordmove push --all && ~/create_invalidation.sh'

1	alias wordmove_push='wordmove push --all && ~/create_invalidation.sh'

以前とは若干コマンドが変わってしまいますが、wordmoveを実行する際にpushとpullの間違いがたまーに発生していたので、それも防げるということでOKでしょう。

おわりに

まとめ

・忘れやすいキャッシュクリアは自動化しよう
・ディストリビューションidの特定はjqコマンドでがんばろう
・すべてのキャッシュクリアをする場合は’/*’で指定できるよ

感想

こういったちょっとした作業も自動化できると、ミスも減りますし楽できていいですね。
次回はもうちょっと面白い内容の記事をかけたらいいっすね。

この記事を書いた人
最近の記事

西山一平

ギークフィード9年生です。

西山一平 (全て見る)

組織内のIPv4アドレス（EIP）を自動通知してコスト削減する - 2024-12-03
組織内のAWSコスト最適化のためにやっている7つのこと - 2024-12-01
Amazon Connect Contact Lens + iPaaSで生成AI活用＆他サービス連携を簡単に実現！– Amazon Connect アドベントカレンダー 2024 - 2024-12-01
AWS Step Functionsの基本を再学習しました - 2024-09-23
Amazon SESでバウンスメールを管理する - 2024-07-07

【採用情報】一緒に働く仲間を募集しています

2019-10-23 #AWS #CloudFront #WordPress #shellscript

wordpressデプロイ時のcloudfrontキャッシュクリアを自動化する

環境

IAMユーザー、ポリシーの作成

スクリプトの作成

ディストリビューションidの取得について

awsコマンドについて

実行してみる

自動化する

おわりに

まとめ

感想

【採用情報】一緒に働く仲間を募集しています

エンジニア募集

Asterisk13CLI_チートシート

CentOS7_チートシート

カテゴリー

月別で見る

投稿者から見る

サイト内検索

wordpressデプロイ時のcloudfrontキャッシュクリアを自動化する

環境

IAMユーザー、ポリシーの作成

スクリプトの作成

ディストリビューションidの取得について

awsコマンドについて

実行してみる

自動化する

おわりに

まとめ

感想

【採用情報】一緒に働く仲間を募集しています

関連投稿

オフィスにかかってきた電話の内容を生成AIにかませて議事録作成を自動化する

AWS Partner Central API for Sellingを使うための準備と疎通確認してみた

NAT GatawayからNAT インスタンスに乗り換えて約95％のコスト削減をしてみた

Amazon Connectで同じ電話番号から何回かかってきたかをカウントしてみた

中級figma教室

Twilio Flex v2.x.x系でLINE連携を実装する方法

エンジニア募集

Asterisk13CLI_チートシート

CentOS7_チートシート

カテゴリー

月別で見る

投稿者から見る

サイト内検索

スクリプトの作成