Verwendung des CRX2OAK-Migrationstools

Einführung

CRX2Oak ist ein Tool für die Migration von Daten zwischen verschiedenen Repositorys.

Es kann zur Migration von Daten aus älteren CQ-Versionen, die auf Apache Jackrabbit 2 basieren, nach Oak verwendet werden, sowie zum Kopieren von Daten zwischen Oak-Repositorys.

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

Die Liste der Änderungen und Fehlerbehebungen für die aktuelle Version finden Sie in den Versionshinweisen zu CRX2OAK.

Anwendungsfälle zu Migration

Dieses Tool kann für folgende Anwendungsfälle verwendet werden:

• Migration von älteren CQ 5-Versionen nach AEM 6
• Kopieren von Daten zwischen mehreren Oak-Repositorys
• Konvertieren von Daten zwischen unterschiedlichen Oak-Mikrokernel-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:

Funktionen

CRX2OAK wird bei AEM-Aktualisierungen aufgerufen. Dabei kann der Benutzer ein vordefiniertes Migrationsprofil angeben, das die Rekonfiguration von Persistenzmodi automatisiert. Dies wird als Quickstart-Modus 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 Standalone-Modus bezeichnet.

Eine weitere Besonderheit besteht darin, dass mit den Standardeinstellungen des Standalone-Modus nur der Knotenspeicher migriert wird und dass das neue Repository den alten Binärspeicher wiederverwendet.

Automatisierter Quickstart-Modus

Ab AEM 6.3 kann das CRX2OAK-Tool benutzerdefinierte Migrationsprofile verarbeiten. Diese können so konfiguriert werden, dass alle Migrationsoptionen bereits verfügbar sind. Damit wird die Flexibilität gesteigert und eine Automatisierung der AEM-Konfiguration ermöglicht. Funktionen wie diese stehen nicht zur Verfügung, wenn Sie das Tool im Standalone-Modus verwenden.

Um CRX2OAK in den Quickstart-Modus zu schalten, müssen Sie den Pfad zum Ordner „crx-quickstart“ im AEM-Installationsverzeichnis mithilfe der folgenden Betriebssystemvariablen definieren:

Für UNIX-basierte Systeme und Mac OS:

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

Für Windows:

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

Unterstützung für die Fortsetzung der Migration

Die Migration kann jederzeit unterbrochen und anschließend wieder fortgesetzt werden.

Anpassbare Aktualisierungslogik

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

CRX2OAK unterstützt standardmäßig auch Speicherzuordnungsvorgänge. Durch die Speicherzuordnung wird die Leistung erheblich verbessert. Diese Funktion sollte deshalb nach Möglichkeit verwendet werden.

Selektive Migration von Inhalten

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.

Wenn für die neue Instanz ein Teil des Inhalts nicht erforderlich ist, können Sie den Parameter --exclude-path verwenden, um den Inhalt auszuschließen und den Aktualisierungsvorgang zu optimieren.

Zusammenführung von Pfaden

Wenn Daten zwischen zwei Repositorys kopiert werden müssen und Sie über einen Content-Pfad verfügen, der in beiden Instanzen unterschiedlich ist, können Sie sie 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.

Versionsunterstützung

Standardmäßig erstellt AEM eine Version jedes Knotens oder jeder Seite, der bzw. die geändert wird, und speichert diese/n im Repository. Diese Versionen können dann zum Wiederherstellen eines früheren Status der Seite verwendet werden.

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.

Eine nützliche Funktion für diese Arten von Situationen ist das Hinzufügen des Parameters --copy-versions. Sie kann zum Überspringen der Versionsknoten während der Migration oder zum Kopieren eines Repositorys verwendet werden.

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

Beide Parameter unterstützen auch das Datumsformat YYYY-MM-DD, falls Sie Versionen spätestens zu einem bestimmten Datum kopieren möchten.

Open-Source-Version

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

• CRX2-Unterstützung
• Unterstützung für Migrationsprofilen
• Unterstützung für die automatisierte AEM-Neukonfiguration

Weitere Informationen finden Sie in der Apache-Dokumentation.

Parameter

Knotenspeicheroptionen

• --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: Kennwort für die Zielgruppe RDB.

Migrationsoptionen

• --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 zu einer Oak-basierten Instanz. Dies funktioniert jedoch nur, wenn der Identitätsanbieter in der Oak-Konfiguration als „ldap“ angegeben ist. Weitere Informationen finden Sie in der LDAP-Dokumentation.

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

Optionen für die Versionsspeicherung

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

• --copy-versions: Kopiert die Datenspeicherung der Version. Parameter: true, false, yyyy-mm-dd. Standardwert ist true.

Pfadoptionen

• --include-paths: Kommagetrennte Liste von Pfaden, die beim Kopieren einbezogen werden sollen
• --merge-paths: Durch Kommas getrennte Liste von Pfaden, die beim Kopieren zusammengeführt werden sollen
• --exclude-paths: Eine kommagetrennte Liste der beim Kopieren auszuschließenden Pfade.

Quell BLOB-Speicheroptionen

• --src-datastore: Der als Quelle zu verwendende Datenspeicher-Ordner FileDataStore

• --src-fileblobstore: Der als Quelle zu verwendende Datenspeicher-Ordner FileBlobStore

• --src-s3datastore: Der für die Quelle zu verwendende Datenspeicher-Ordner S3DataStore

• --src-s3config: Die Konfigurationsdatei für die Quelle S3DataStore.

Ziel BLOB-Speicheroptionen

• --datastore: Der als Zielgruppe zu verwendende Datenspeicherordner FileDataStore

• --fileblobstore: Der als Zielgruppe zu verwendende Datenspeicherordner FileBlobStore

• --s3datastore: Der für die Zielgruppe zu verwendende Datenspeicherordner S3DataStore

• --s3config: Die Konfigurationsdatei für die Zielgruppe S3DataStore.

Hilfeoptionen

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

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 CRX2Oak ausgeführt wird. In diesem Modus werden Protokolle automatisch zur Datei upgrade.log umgeleitet.
Standalone-Modus	hinzufügen Sie die Optionen —trace in die CRX2Oak-Befehlszeile, um TRACE-Ereignis in der Standardausgabe anzuzeigen (Sie müssen die Protokolle selbst mithilfe des Umleitungszeichens umleiten: '>' oder 'tee' Befehl für spätere Überprüfung).

Weitere Überlegungen

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