Bereinigen des CDN-Cache

Erfahren Sie, wie Sie die Cache-gespeicherte HTTP-Antwort aus dem CDN von AEM as a Cloud Service löschen oder entfernen. Mithilfe der Self-Service-Funktion namens API-Bereinigungs-Token können Sie den Cache für eine bestimmte Ressource, eine Gruppe von Ressourcen und den gesamten Cache bereinigen.

In diesem Tutorial erfahren Sie, wie Sie das API-Bereinigungs-Token einrichten und verwenden, um den CDN-Cache der Beispiel-Site AEM WKND mithilfe der Self-Service-Funktion zu bereinigen.

Cache-Invalidierung vs. explizite Bereinigung

Es gibt zwei Möglichkeiten, um die Cache-gespeicherten Ressourcen aus dem CDN zu entfernen:

Wenn zwischengespeicherte Ressourcen aus dem CDN-Cache entfernt werden, ruft die nächste Anfrage für dieselbe Ressource die neueste Version vom ursprünglichen Server ab.

Einrichten des API-Bereinigungs-Tokens

Erfahren Sie, wie Sie das API-Bereinigungs-Token einrichten, um den CDN-Cache zu bereinigen.

Konfigurieren der CDN-Regel

Das API-Bereinigungs-Token wird durch Konfigurieren der CDN-Regel in Ihrem AEM-Projekt-Code erstellt.

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

In der Regel oben werden sowohl purgeKey1 als auch purgeKey2 von Anfang an hinzugefügt, um die unterbrechungsfreie Rotation von Geheimnissen zu unterstützen. Sie können jedoch auch mit nur purgeKey1 beginnen und purgeKey2 erst später beim Rotieren der Geheimnisse hinzufügen.

Erstellen einer Cloud Manager-Umgebungsvariable

Erstellen Sie anschließend die Cloud Manager-Umgebungsvariablen, um den Wert des API-Bereinigungs-Tokens zu speichern.

Bereitstellen der CDN-Regel

Stellen Sie schließlich die konfigurierte CDN-Regel mithilfe der Cloud Manager-Pipeline in der AEM as a Cloud Service-Umgebung bereit.

Verwenden des Bereinigungs-API-Tokens

Rufen Sie zum Bereinigen des CDN-Caches die Domain-URL für den jeweiligen AEM-Service mit dem Bereinigungs-API-Token auf. Die Syntax zur Cache-Bereinigung lautet wie folgt:

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>

Dabei gilt:

Bereinigen des Caches für eine bestimmte Ressource

In diesem Beispiel wird mit dem Befehl curl der Cache für die Ressource /us/en.html auf der in einer AEM as a Cloud Service-Umgebung bereitgestellten WKND-Site bereinigt.

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

Nach erfolgreicher Bereinigung wird eine 200 OK-Antwort mit JSON-Inhalt zurückgegeben.

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

Bereinigen des Caches für eine Gruppe von Ressourcen

In diesem Beispiel wird mit dem Befehl curl der Cache für eine Gruppe von Ressourcen mit dem Ersatzschlüssel wknd-assets bereinigt. Der Antwort-Header Surrogate-Key wird in wknd.vhost festgelegt, z. B.:

<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"

Nach erfolgreicher Bereinigung wird eine 200 OK-Antwort mit JSON-Inhalt zurückgegeben.

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

Bereinigen des gesamten Caches

In diesem Beispiel wird mit dem Befehl curl der gesamte Cache aus der in der AEM as a Cloud Service-Umgebung bereitgestellten WKND-Beispiel-Site gelöscht.

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

Nach erfolgreicher Bereinigung wird eine 200 OK-Antwort mit JSON-Inhalt zurückgegeben.

{"status":"ok"}

Überprüfen der Cache-Bereinigung

Um die Cache-Bereinigung zu überprüfen, greifen Sie auf die Ressourcen-URL im Webbrowser zu und überprüfen Sie die Antwort-Header. Der X-Cache-Header-Wert sollte MISS lauten.