Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • A host machine with filesystem access to both the Fedora 3 disk storage (or exported FOXML files) and the target OCFL disk storage.
    The target allocated disk space should be roughly four times the size of your Fedora 3 repository occupied disk space.
  • Java 11 installed on the host machine.
  • Knowledge of the Fedora 3 filesystem layout (legacy or Akubra), if migrating directly from Fedora 3 data on disk.
  • Familiarity with the command line:  examining files and directories, running commands, redirecting output of commands to files, the grep utility, etc.

Running

  1. Download the latest version of the  migration-utils utility: https://github.com/fcrepo-exts/migration-utils/releases

  2. Follow the instructions in the migration-utils README: https://github.com/fcrepo-exts/migration-utils
  3. Start up Fedora on top of your newly created Fedora 6 OCFL-compliant repository using the -Dfcrepo.home configuration property.

...

  • We recommend that you shut down Fedora 3 repository or put it into read-only mode, if you plan on migrating directly from Fedora 3 data on disk, to avoid issues of changes occurring while data is being written.
  • When performing a sizable migration, run the utility in a screen or tmux session that you can detach from.  Try not to shut down or reboot the host while the tool is running.
  • If the migration is interrupted, you can pick up where the migration left off by relaunching the tool with the --resume flag (keeping the all the other parameters the same).
  • Redirect the output of the utility to a log file that you can analyze at your leisure during and after the migration.

      Example:

    Code Block
    languagebash
    titleRedirect to log file
    java -jar migration-utils-6.0.0-driver.jar --source-type=legacy--target-dir=my-fcrepo-6/data --objects-dir=my-fcrepo-3/objects --datastreams-dir=my-fcrepo-3/datastreams > log.txt 2>&1


  • Errors:  the migration tool may encounter problems copying some objects or datastreams.  The tool by default will halt at the first error;  if you wish to migrate as much as possible then go back and address errors, run the tool with the --continue-on-error flag.  Objects or datastreams with errors will not be written to the OCFL repository;  they will be skipped, and the next object in the list will be processed.
    Objects that could not be migrated will provoke a stack dump in the log, marked with the string ERROR.  They can be extracted from the log at a later date and fixed, then migrated individually.
    Example:

    Code Block
    languagebash
    titleGrep ERROR
    $ grep ERROR log.txtERROR 01:09:09.801 (Migrator) MIGRATION_FAILURE: pid="test:BadPID1", message="Unable to resolve internal ID "test:BadPID1+MYDS+MYDS.2"!"
    ERROR 01:29:54.878 (Migrator) MIGRATION_FAILURE: pid="test:BadPID23", message="Unable to resolve internal ID "test:BadPID23+MYDS+MYDS.0"!"
    ERROR 02:11:50.644 (Migrator) MIGRATION_FAILURE: pid="test:BadPID617", message="Unable to resolve internal ID "test:BadPID617+MYDS+MYDS.1"!"
    ..
    Errors:  the migration tool may encounter problems copying some objects or datastreams.  The tool by default will halt at the first error;  if you wish to migrate as much as possible then go back and address errors, run the tool with the --continue-on-error flag.  Objects or datastreams with errors will not be written to the OCFL repository;  they will be skipped, and the next object in the list will be processed.
    Objects that could not be migrated will provoke a stack dump in the log, marked with the string ERROR.  They can be extracted from the log at a later date and fixed, then migrated individually
    .


  • Warning:  the migration utility is not idempotent!  This means that if you run the utility twice over the same content to the same target, you will wind up with an OCFL repository with duplicate versions of datastreams.  For the purposes of testing, delete or move out of the way previous migration attempts before running a new migration.
    However, you can migrate new objects to an already-existing OCFL repository, which means you can plan your migration in stages, if you desire.  Note that you will need to rebuild your Fedora 6 index after the new additions.
  • When adding new or fixed objects to the OCFL repository, make sure to regenerate a fresh datastream index.
  • As many files are created per object and per datastream version, make sure to allocate enough inodes on your system to allow for all the files (note:  this should only be necessary for

    extremely large repositories, more than 4 million objects, for example).
  • See Fedora 3 to 6 Migration Community Updates for examples of medium- and large-scale migrations performed with the migrations tool, with benchmark data and detailed notes.

...