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.
Die aktuelle CRX2OAK-Version kann unter der folgenden Adresse vom öffentlichen Adobe-Repository heruntergeladen werden:https://repo1.maven.org/maven2/com/adobe/granite/crx2oak/
Weitere Informationen zu Apache Oak und den Schlüsselkonzepten AEM Persistenz finden Sie unter Einführung in die AEM Platform.
Das Tool kann für Folgendes verwendet werden:
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:
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.
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"
Die Migration kann jederzeit unterbrochen werden und kann danach wieder aufgenommen werden.
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.
CRX2OAK unterstützt standardmäßig auch Speicherzuordnungsvorgänge. Die Speicherzuordnung verbessert die Leistung erheblich und sollte nach Möglichkeit verwendet werden.
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.
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.
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.
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.
Eine Open-Source-Version von CRX2OAK ist als „Oak-Upgrade“ verfügbar. Es unterstützt alle Funktionen mit Ausnahme von:
Weitere Informationen finden Sie in der Apache-Dokumentation.
--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
--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
.
--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
.
--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.--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
.
--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
.
-?, -h, --help:
Zeigt Hilfeinformationen an.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). |
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 -jar crx2oak.jar crx-quickstart/repository/ mongodb://localhost:27017/aem-author?replicaset=replica1&w=2
Weitere Informationen finden Sie in der Dokumentation zur MongoDB-Verbindungszeichenfolge unter WriteConcerns.