Skip to content

Robots for creating/updating Moabs for SDR objects, adding Moabs to the preservation_catalog, etc.

License

Notifications You must be signed in to change notification settings

sul-dlss/preservation_robots

Repository files navigation

CircleCI Code Climate Code Climate Test Coverage GitHub version

preservation_robots

Robots for creating/updating preservation artifacts (Moabs) for DOR objects, adding Moabs to the preservation_catalog, etc.

Restarting Robots

cap <deploy_stage> deploy:restart # restarts all the robots on servers defined in deploy stage file.

Dependencies

External dependencies are surfaced in config/settings.yml and shared_configs (preservation_robots_xxx branches).

Overview of workflow

The workflow is defined by: https://github.com/sul-dlss/workflow-server-rails/blob/master/config/workflows/sdr/preservationIngestWF.xml

There are 5 robots:

  1. transfer-object: copies the BagIt bag containing files for a new Moab version (or new Moab), which was created by common-accessioning sdr-ingest-transfer robot, to the deposit location for the Moab.

  2. validate-bag: validates the BagIt/Moab deposit bag structure and version

  3. update-moab: create/add a version to Moab object from deposit bag

  4. validate-moab: verify the Moab on local disk passes validation, including checksums for latest content

  5. update-catalog: create/update Preservation Catalog entry for this Moab

  6. complete-ingest: removes deposit bag created by transfer-object robot, then transfers control back to accessioning

Testing

See https://docs.google.com/document/d/1d1GmSkam5_mR8NkbUQIf-Ztneu82zWChSqVSo6yUDVY

Resetting preservation robots

This only makes sense as part of a reset of the preservation environment and its associated SDR environment as a whole. See the preservation_catalog README for detailed instructions.