DokumentationAEM 6.4Implementierungshandbuch

Verwendung des CRX2Oak-Migrations-Tools using-the-crx-oak-migration-tool

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Developer
CAUTION
AEM 6.4 hat das Ende der erweiterten Unterstützung erreicht und diese Dokumentation wird nicht mehr aktualisiert. Weitere Informationen finden Sie in unserer technische Unterstützung. Unterstützte Versionen suchen here.

Einführung introduction

CRX2Oak ist ein Tool, mit dem Daten zwischen verschiedenen Repositorys migriert werden können.

Es kann verwendet werden, um Daten aus älteren CQ-Versionen basierend auf Apache Jackrabbit 2 nach Oak zu migrieren, und es kann auch zum Kopieren von Daten zwischen Oak-Repositorys verwendet werden.

Sie können die neueste Version von crx2oak aus dem Repository der öffentlichen Adobe unter diesem Speicherort herunterladen:
https://repo.adobe.com/nexus/content/groups/public/com/adobe/granite/crx2oak/

Die Liste der Änderungen und Fehlerbehebungen für die neueste Version finden Sie in der Versionshinweise zu CRX2Oak.

NOTE
Weitere Informationen zu Apache Oak und den Schlüsselkonzepten AEM Persistenz finden Sie unter Einführung in die AEM Platform.

Migrationsanwendungsfälle migration-use-cases

Das Tool kann für Folgendes verwendet werden:

  • Migration von älteren CQ 5-Versionen zu AEM 6
  • Kopieren von Daten zwischen mehreren Oak-Repositorys
  • Konvertieren von Daten zwischen verschiedenen Oak MicroKernel-Implementierungen.

Die Unterstützung für die Migration von Repositorys mit externen BLOB-Speichern (allgemein als Datenspeicher bekannt) wird in unterschiedlicher Form bereitgestellt. Ein möglicher Migrationspfad ist von einem CRX2-Repository, das einen externen FileDataStore nutzt, auf ein Oak-Repository, das einen S3DataStore verwendet.

Das nachfolgende Diagramm zeigt alle von CRX2Oak unterstützten Migrationsoptionen:

chlimage_1-151

Funktionen features

CRX2OAK wird bei AEM-Aktualisierungen aufgerufen. Dabei kann der Benutzer ein vordefiniertes Migrationsprofil angeben, das die Rekonfiguration von Persistenzmodi automatisiert. Dies wird als Schnellstartmodus bezeichnet.

Das Tool kann auch separat ausgeführt werden, für den Fall, dass eine umfassendere Anpassung erforderlich ist. Beachten Sie jedoch, dass in diesem Modus Änderungen nur am Repository vorgenommen werden und dass jede weitere Neukonfiguration von AEM manuell durchgeführt werden muss. Dies wird als eigenständiger Modus bezeichnet.

Beachten Sie auch, dass mit den Standardeinstellungen im eigenständigen Modus nur der Knotenspeicher migriert wird und das neue Repository den alten binären Speicher wiederverwendet.

Automatisierter Schnellstartmodus automated-quickstart-mode

Ab AEM 6.3 kann das CRX2OAK-Tool benutzerdefinierte Migrationsprofile verarbeiten. Diese können so konfiguriert werden, dass alle Migrationsoptionen bereits verfügbar sind. Dies ermöglicht sowohl höhere Flexibilität als auch die Möglichkeit, die Konfiguration von AEM zu automatisieren, Funktionen, die nicht verfügbar sind, wenn Sie das Tool im eigenständigen Modus verwenden.

Um CRX2Oak in den Schnellstartmodus zu wechseln, müssen Sie den Pfad zum Ordner crx-quickstart im AEM Installationsverzeichnis über diese Umgebungsvariable des Betriebssystems definieren:

Für UNIX-basierte Systeme und macOS:

export SLING_HOME="/path/to/crx-quickstart"

Für Windows:

SET "SLING_HOME=/path/to/crx-quickstart"

Fortsetzung der Unterstützung resume-support

Die Migration kann jederzeit unterbrochen werden und kann danach wieder aufgenommen werden.

Anpassbare Upgrade-Logik customizable-upgrade-logic

Mithilfe von CommitHooks kann auch eine benutzerdefinierte Java-Logik implementiert werden. Benutzerdefinierte RepositoryInitializer-Klassen können implementiert werden, um das Repository mit benutzerdefinierten Werten zu initialisieren.

Unterstützung für Speicherzuordnungsvorgänge support-for-memory-mapped-operations

CRX2OAK unterstützt standardmäßig auch Speicherzuordnungsvorgänge. Die Speicherzuordnung verbessert die Leistung erheblich und sollte nach Möglichkeit verwendet werden.

CAUTION
Beachten Sie jedoch, dass Speicherzuordnungsvorgänge für Windows-Plattformen nicht unterstützt werden. Es wird deshalb empfohlen, bei einer Migration unter Windows den Parameter –disable-mmap hinzuzufügen.

Selektive Migration von Inhalten selective-migration-of-content

Standardmäßig migriert das Tool das gesamte Repository unter dem Pfad "/". Sie haben jedoch die vollständige Kontrolle darüber, welche Inhalte migriert werden sollen.

Falls ein Teil der Inhalte auf der neuen Instanz nicht benötigt wird, können Sie diesen Teil mithilfe des Parameters --exclude-path ausschließen und den Upgrade-Vorgang so optimieren.

Zusammenführung von Pfaden path-merging

Wenn Daten zwischen zwei Repositorys kopiert werden müssen und der Inhaltspfad auf beiden Instanzen unterschiedlich ist, können Sie diesen im Parameter --merge-path definieren. CRX2OAK kopiert dann nur die neuen Knoten in das Ziel-Repository und behält die alten im anderen Repository bei.

chlimage_1-152

Versionsunterstützung version-support

Standardmäßig erstellt AEM eine Version jedes Knotens oder jeder Seite, der bzw. die geändert wird, und speichert diese/n im Repository. Die Versionen können dann verwendet werden, um die Seite in einem früheren Zustand wiederherzustellen.

Allerdings werden diese Versionen nie bereinigt, auch wenn die Originalseite gelöscht wird. Bei Repositorys, die bereits lange Zeit verwendet werden, muss bei der Migration möglicherweise ein hohes Volumen von redundanten Daten verarbeitet werden. Schuld daran sind verwaiste Versionen.

In Szenarien wie diesen ist das Hinzufügen des Parameters --copy-versions nützlich. Es kann verwendet werden, um Versionsknoten während der Migration oder beim Kopieren eines Repositorys zu überspringen.

Darüber hinaus können Sie festlegen, ob verwaiste Versionen kopiert werden sollen, indem Sie --copy-orphaned-versions=true hinzufügen.

Beide Parameter unterstützen außerdem das Datumsformat YYYY-MM-DD, falls Sie Versionen bis zu einem bestimmten Datum kopieren möchten.

chlimage_1-153

Open Source Version open-source-version

Eine Open-Source-Version von CRX2OAK ist als „Oak-Upgrade“ verfügbar. Es unterstützt alle Funktionen mit Ausnahme von:

  • CRX2-Unterstützung
  • Unterstützung von Migrationsprofilen
  • Unterstützung für automatisierte AEM

Weitere Informationen finden Sie in der Apache-Dokumentation.

Parameter parameters

Knotenspeicheroptionen node-store-options

  • --cache: Die Cache-Größe in MB (der Standardwert beträgt 256)

  • --mmap: Aktivieren des Zugriffs auf die Speicherdatei für die Segmentspeicherung

  • --src-password:: Das Kennwort für die RDB-Quell-Datenbank

  • --src-user:: Der Benutzer für die Quell-RDB

  • --user: Der Benutzer für die Ziel-RDB

  • --password: Das Kennwort für die Ziel-RDB

Migrationsoptionen migration-options

  • --early-shutdown: Fährt das JCR2-Quell-Repository nach dem Kopieren der Knoten herunter, bevor die CommitHooks angewendet werden

  • --fail-on-error: Erzwingt ein Fehlschlagen der Migration, wenn die Knoten nicht aus dem Quell-Repository gelesen werden können.

  • --ldap: Migriert LDAP-Benutzer von einer CQ 5.x-Instanz auf eine Oak-basierte Instanz. Dies funktioniert jedoch nur, wenn der Identitätsanbieter in der Oak-Konfiguration als „ldap“ angegeben ist. Weitere Informationen finden Sie unter LDAP-Dokumentation.

  • --ldap-config:: Verwenden Sie diese Option zusammen mit dem Parameter --ldap für CQ 5.x-Repositorys, die mehrere LDAP-Server für die Authentifizierung verwendet haben. Sie können damit auf die CQ 5.x-Konfigurationsdateien ldap_login.conf oder jaas.conf verweisen. Das Format lautet --ldapconfig=path/to/ldap_login.conf.

Optionen für die Versionsspeicherung version-store-options

  • --copy-orphaned-versions: Überspringt das Kopieren von verwaisten Versionen. Folgende Parameter werden unterstützt: true, false und yyyy-mm-dd. Standardwert ist true.

  • --copy-versions:: Kopiert den Versionsspeicher. Parameter: true, false, yyyy-mm-dd. Standardwert ist true.

Pfadoptionen path-options

  • --include-paths:: Eine kommagetrennte Liste der beim Kopieren einzuschließenden Pfade.
  • --merge-paths: Eine kommagetrennte Liste der beim Kopieren zusammenzuführenden Pfade.
  • --exclude-paths:: Eine kommagetrennte Liste der beim Kopieren auszuschließenden Pfade.

Quell BLOB-Speicheroptionen source-blob-store-options

  • --src-datastore:: Das als Quell-FileDataStore zu verwendende Datenspeicherverzeichnis.

  • --src-fileblobstore: Das als Quell-FileBlobStore zu verwendende Datenspeicherverzeichnis.

  • --src-s3datastore: Das für den Quell-S3DataStore zu verwendende Datenspeicherverzeichnis.

  • --src-s3config: Die Konfigurationsdatei für den Quell-S3DataStore.

Ziel BLOB-Speicheroptionen destination-blobstore-options

  • --datastore:: Das als Ziel-FileDataStore zu verwendende Datenspeicherverzeichnis.

  • --fileblobstore:: Das als Ziel-FileBlobStore zu verwendende Datenspeicherverzeichnis.

  • --s3datastore: Das für den Ziel-S3DataStore zu verwendende Datenspeicherverzeichnis.

  • --s3config: Die Konfigurationsdatei für das Ziel-S3DataStore.

Hilfeoptionen help-options

  • -?, -h, --help: Zeigt Hilfeinformationen an.

Debugging debugging

Sie können für den Migrationsvorgang auch Informationen zur Fehlerbehebung aktivieren, sodass potenziell auftretende Fehler behoben werden können. Hierzu gibt es verschiedene Optionen, je nachdem, in welchem Modus das Tool ausgeführt werden soll:

CRX2Oak-Modus
Aktion
Quickstart-Modus
Sie können die Optionen --log-level TRACE  oder --log-level DEBUG zur Befehlszeile hinzufügen, wenn Sie CRX2Oak ausführen. In diesem Modus werden Protokolle automatisch an die Datei upgrade.log umgeleitet.
Standalone-Modus
Fügen Sie die --trace-Optionen zur CRX2Oak-Befehlszeile hinzu, um TRACE-Ereignisse in der Standardausgabe zu verfolgen (Sie müssen die Protokolle selbst mit Umleitungszeichen umleiten: '>' oder 'tee'-Befehl zur späteren Überprüfung).

Weitere Überlegungen other-considerations

Bei der Migration auf eine MongoDB-Replikatgruppe muss der Parameter WriteConcern für alle Verbindungen mit der Mongo-Datenbank auf 2 gesetzt werden.

Hierzu können Sie den Parameter w=2 wie nachfolgend gezeigt am Ende der Verbindungszeichenfolge hinzufügen:

java -Xmx4092m -XX:MaxPermSize=1024m -jar crx2oak.jar crx-quickstart/repository/ mongodb://localhost:27017/aem-author?replicaset=replica1&w=2
NOTE
Weitere Informationen finden Sie in der Dokumentation zur MongoDB-Verbindungszeichenfolge unter WriteConcerns.
recommendation-more-help
6a71a83d-c2e0-4ce7-a6aa-899aa3885b56