CDN キャッシュをパージする方法

AEM as a Cloud Service の CDN からキャッシュされた HTTP 応答をパージまたは削除する方法について説明します。API トークンをパージ ​と呼ばれるセルフサービス機能を使用すると、特定のリソース、リソースのグループおよびキャッシュ全体のキャッシュをパージできます。

このチュートリアルでは、「API トークンをパージ」を設定し、セルフサービス機能を使用してサンプル AEM WKND サイトの CDN キャッシュをパージする方法について説明します。

キャッシュの無効化と明示的なパージ

CDN からキャッシュされたリソースを削除するには、次の 2 つの方法があります。

キャッシュされたリソースを CDN キャッシュから削除すると、同じリソースに対する次のリクエストでは、公開元サーバーから最新バージョンが取得されます。

「API トークンをパージ」の設定

「API トークンをパージ」を設定して、CDN キャッシュをパージする方法について説明します。

CDN ルールの設定

「API トークンをパージ」を作成するには、AEM プロジェクトコードで CDN ルールを設定します。

kind: "CDN"
version: "1"
metadata:
  envTypes: ["dev", "stage", "prod"]
data:
  authentication: # The main authentication configuration
    authenticators: # The list of authenticators
       - name: purge-auth # The name of the authenticator
         type: purge  # The type of the authenticator, must be purge
         purgeKey1: ${{CDN_PURGEKEY_081324}} # The first purge key, must be referenced by the Cloud Manager secret-type environment variable name ${{CDN_EDGEKEY_073124}}
         purgeKey2: ${{CDN_PURGEKEY_111324}} # The second purge key, must be referenced by the Cloud Manager secret-type environment variable name ${{CDN_EDGEKEY_111324}}. It is used for the rotation of secrets without any interruptions.
    rules: # The list of authentication rules
       - name: purge-auth-rule # The name of the rule
         when: { reqProperty: tier, equals: "publish" } # The condition when the rule should be applied
         action: # The action to be taken when the rule is applied
           type: authenticate # The type of the action, must be authenticate
           authenticator: purge-auth # The name of the authenticator to be used, must match the name from the above authenticators list

上記のルールでは、purgeKey1 と purgeKey2 の両方が最初から追加され、中断することなく秘密鍵のローテーションをサポートします。ただし、最初は purgeKey1 のみを使用して、後で秘密鍵をローテーションする際に、purgeKey2 を追加できます。

Cloud Manager 環境変数の作成

次に、Cloud Manager 環境変数を作成して、「API トークンをパージ」の値を保存します。

CDN ルールのデプロイ

最後に、Cloud Manager パイプラインを使用して、設定済みの CDN ルールを AEM as a Cloud Service 環境にデプロイします。

「API トークンをパージ」の使用

CDN キャッシュをパージするには、「API トークンをパージ」を使用して AEM サービス固有のドメイン URL を呼び出します。キャッシュをパージする構文は次のとおりです。

PURGE <URL> HTTP/1.1
Host: <AEM_SERVICE_SPECIFIC_DOMAIN>
X-AEM-Purge-Key: <PURGE_API_TOKEN>
X-AEM-Purge: <PURGE_TYPE>
Surrogate-Key: <SURROGATE_KEY>

場所：

特定のリソースのキャッシュのパージ

この例では、curl コマンドは、AEM as a Cloud Service 環境にデプロイされた WKND サイト上の /us/en.html リソースのキャッシュをパージします。

curl -X PURGE "https://publish-p46652-e1315806.adobeaemcloud.com/us/en.html" \
-H "X-AEM-Purge-Key: 123456789" \
-H "X-AEM-Purge: hard"

パージが成功すると、JSON コンテンツを含む 200 OK 応答が返されます。

{ "status": "ok", "id": "1000098-1722961031-13237063" }

リソースのグループのキャッシュのパージ

この例では、curl コマンドは、代理キー wknd-assets を使用してリソースグループのキャッシュをパージします。Surrogate-Key 応答ヘッダーは、次の例のように wknd.vhost に設定されます。

<VirtualHost *:80>
    ...

    # Core Component Image Component: long-term caching (30 days) for immutable URLs, background refresh to avoid MISS
    <LocationMatch "^/content/.*\.coreimg.*\.(?i:jpe?g|png|gif|svg)$">
        Header set Cache-Control "max-age=2592000,stale-while-revalidate=43200,stale-if-error=43200,public,immutable" "expr=%{REQUEST_STATUS} < 400"
        # Set Surrogate-Key header to group the cache of WKND assets, thus it can be flushed independtly
        Header set Surrogate-Key "wknd-assets"
        Header set Age 0
    </LocationMatch>

    ...
</VirtualHost>

curl -X PURGE "https://publish-p46652-e1315806.adobeaemcloud.com" \
-H "Surrogate-Key: wknd-assets" \
-H "X-AEM-Purge-Key: 123456789" \
-H "X-AEM-Purge: hard"

パージが成功すると、JSON コンテンツを含む 200 OK 応答が返されます。

{ "wknd-assets": "10027-1723478994-2597809-1" }

キャッシュ全体のパージ

この例では、curl コマンドを使用して、AEM as a Cloud Service 環境にデプロイされたサンプル WKND サイトからキャッシュ全体をパージします。

curl -X PURGE "https://publish-p46652-e1315806.adobeaemcloud.com/" \
-H "X-AEM-Purge-Key: 123456789" \
-H "X-AEM-Purge: all"

パージが成功すると、JSON コンテンツを含む 200 OK 応答が返されます。

{"status":"ok"}

キャッシュのパージの確認

キャッシュのパージを確認するには、web ブラウザーでリソース URL にアクセスし、応答ヘッダーを確認します。X-Cache ヘッダー値は、MISS にする必要があります。