Skip to content

VTDLP Fixity Service: Regularly scheduled fixity checks and comparisons to the files stored in the AWS S3

Notifications You must be signed in to change notification settings

vt-digital-libraries-platform/FixityService

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

FixityService

Overview Fixity workflow

Overview

  • On ingest, system upload file to S3 bucket for preservation, verify the object's integrity during the upload. See Check the integrity of an object uploaded to Amazon S3.
    • Fixity Service performs the initial fixity check on each uploaded file.
  • Everyday Fixity service checks file's last fixity check date on or before 90 days and performs fixity check on these files
  • Fixity service sends a daily email with a summary report only when there is a "MISMATCHED" event occurred. (e.g. Today, fixity check, there are # mismatched, the location of files, filename, etc).

Deploy Fixity Service application using CloudFormation stack

Step 1: Launch CloudFormation stack

Launch Stack

Click Next to continue

Step 2: Specify stack details

Name Description
Stack name any valid name
Access-Control-Allow-Origin If you plan to use the api for web development, specify the origin here. Default uses wildard (*)
Anonymous Usage Select 'Yes' to opt-in to help us to improve the solution. The solution collects and sends the following data anonymously: Algorithm used for the fixity process, FileSize of the object, Elapsed time of the fixity process, and the ComparedResult status (matched, notmatched, or skipped)

Step 3: Configure stack options

Leave it as is and click Next

Step 4: Review

Make sure all checkboxes under Capabilities section are CHECKED

Click Create stack

Usage

  • Example task json file
{"Bucket": "preservation-bucket", "Key": "filename.tif", "OutputBucket": "fixity-output-bucket"}
  • Execuate Lambda function
aws stepfunctions start-execution --state-machine-arn arn:aws:states:us-east-1:youraccountnumber:stateMachine:SO0081-StackName-serverless-fixity --input file://taskfile.json

Special thanks to

About

VTDLP Fixity Service: Regularly scheduled fixity checks and comparisons to the files stored in the AWS S3

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published