...
On success
- HTTP/1.1 204 No Content
Configurations
The following configurations have been successfully tested with the Backup and Restore functionality
- Non-clustered Fedora, using Infinispan cache backed by LevelDB (config)
Backup Format
Regardless of the repository configuration, the output of the backup process creates resources of the same format. Further details on backup contents and the underlying implementation can be found in ModeShape's documentation.
...
By default, files larger than 4KB are stored on disk named after their SHA1 digest, in the directory fcrepo.binary.directory
. (4KB is the default, but can be changed by updating the minimumBinarySizeInBytes
property in repository.json). That is, a file with the SHA1 "a1b2c369563c0465ab82cdb2789d45ce1c3585b1" would be stored on disk in /path/to/fcrepo4-data/fcrepo.binary.directory/a1/b2/c3/a1b2c369563c0465ab82cdb2789d45ce1c3585b1
. So files in the repository can be backed up backing up the directory fcrepo.binary.directory
.
LevelDB Backup
LevelDB stores it's data as flat files in the directory fcrepo.ispn.repo.cache
of the fcrepo home. The fcrepo home directory can be backed up as a whole to create a snapshot of the repository with both the binaries and the metadata. Though, the fcrepo.binary.directory and fcrepo.ispn.repo.cache
are the only directories necessary for backup. (See ModeShape Artifacts Layout). The backup can be created on a live repository without having to shutdown or restricting ingests to the repository. Though, it would be good idea to schedule the backups after any batch ingests, so that the newly ingested data is also included in the backup.
Backup Strategies
Here are a few strategies for backup:
WITH SHUTTING DOWN FEDORA (CONSISTENTLY RELIABLE BACKUPS)
STEPS:
- Shutdown Fedora
- Backup of FCREPO HOME (or just fcrepo.binary.directory and fcrepo.ispn.repo.cache)
- Restart Fedora
WITH PAUSING WRITES TO FEDORA
STEPS:
- Pause all updates to the repository.
- Do not create, delete, or update OBJECTS or DATASTREAMS.
- Wait for all previous update requests to be processed.
- For serialization of newly created objects to complete.
- And, for leveldb background compaction to complete (usually in seconds), if the previous updates triggered a compaction.
- Backup of FCREPO HOME (or just fcrepo.binary.directory and fcrepo.ispn.repo.cache)
- Verify successful backup.
- Continue with the updates.
HOT BACKUPS (LESS RELIABLE UNLESS VERFIED)
...
.binary.directory
...
.
...
- Verify successful backup.
Verifying Backups:
...
- Verify the leveldb opens.
- Verify by iterating through the keys. (To expose any corruption)
Based on the flow of the background compaction process in the leveldb implementation ([1] and [2]), the manifest file is updated at the end of compaction, which is followed by the deletion of obsolete files. To verify successful backups, we can begin the backup with copying the manifest file followed by the rest of the files. And, at the end of the backup, the backed up manifest file can be compared with the current manifest. An unchanged manifest can be considered as a successful backup, and vice versa.
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
#!/bin/bash
# Location of the fcrepo home directory
FCREPO_HOME=/var/lib/tomcat7/fcrepo4-data
# Destination Directory
BACKUP_TO=/home/vagrant/backup
# Backup exact (without the structural changes introduces by Python verfication script).
# (Additional temporary storage is used, if true)
BACKUP_EXACT=true
# Max Backup Attempts on failure
ATTEMPTS=10
echo `date`" $0: fcrepo home dir: $FCREPO_HOME"
echo `date`" $0: backup dir: $BACKUP_TO"
echo `date`" $0: max attempts on failure: $ATTEMPTS"
if [ ! -d $BACKUP_TO ]; then
mkdir $BACKUP_TO
fi
LEVELDB_DIR=fcrepo.ispn.repo.cache
DATA_DIR=dataFedoraRepository
backup_succeeded=false
attempts=$ATTEMPTS
echo `date`" $0: Backing up leveldb."
while [ $attempts -gt 0 ]; do
MANIFEST_FILE=`ls $FCREPO_HOME/$LEVELDB_DIR/$DATA_DIR/MANIFEST-*`
MANIFEST_MD5=`md5sum $MANIFEST_FILE`
rm -rf $BACKUP_TO/$LEVELDB_DIR"-tmp"
cp -r $FCREPO_HOME/$LEVELDB_DIR $BACKUP_TO/$LEVELDB_DIR"-tmp"
copy_success=$?
MANIFEST_FILE_POST_BACKUP=`ls $FCREPO_HOME/$LEVELDB_DIR/$DATA_DIR/MANIFEST-*`
MANIFEST_MD5_POST_BACKUP=`md5sum $MANIFEST_FILE_POST_BACKUP`
if [ "$MANIFEST_MD5" = "$MANIFEST_MD5_POST_BACKUP" ] && [ "$copy_success" = "0" ]; then
backup_succeeded=true
break;
fi
attempts=$((attempts - 1))
echo `date`" $0: leveldb manifest changed during backup process! $attempts attempts remaining."
done
if [ "$backup_succeeded" = false ]; then
echo `date`" $0: Failed to backup with a consistent leveldb manifest!"
else
echo `date`" $0: Backup created and verified leveldb manifest consistency!"
fi
if [ "$BACKUP_EXACT" = true ]; then
rm -rf $BACKUP_TO/$LEVELDB_DIR"-unchanged"
cp -r $BACKUP_TO/$LEVELDB_DIR"-tmp" $BACKUP_TO/$LEVELDB_DIR"-unchanged"
fi
backup_repaired=false
# Verify and repair using python script
python verify_leveldb.py $BACKUP_TO/$LEVELDB_DIR"-tmp"/$DATA_DIR
if [ "$?" != "0" ]; then
echo `date`" $0: Discovered backup corruption! Attempting to repair!"
python repair_leveldb.py $BACKUP_TO/$LEVELDB_DIR"-tmp"/$DATA_DIR
if [ "$?" != "0" ]; then
echo `date`" $0: Backup repair failed!"
else
python verify_leveldb.py $BACKUP_TO/$LEVELDB_DIR"-tmp"/$DATA_DIR
if [ "$?" != "0" ]; then
echo `date`" $0: Backup repair failed!"
else
echo `date`" $0: Backup repair succeeded!"
backup_repaired=true
backup_succeeded=true
fi
fi
else
echo `date`" $0: Backup passed corruption verification!"
fi
if [ "$backup_succeeded" = true ]; then
rm -rf $BACKUP_TO/$LEVELDB_DIR
if [ "$BACKUP_EXACT" = true ] && [ "$backup_repaired" = false ]; then
mv $BACKUP_TO/$LEVELDB_DIR"-unchanged" $BACKUP_TO/$LEVELDB_DIR
else
mv $BACKUP_TO/$LEVELDB_DIR"-tmp" $BACKUP_TO/$LEVELDB_DIR
fi
fi |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
#!/usr/bin/python
import sys
import leveldb
from datetime import datetime
import subprocess
if (len(sys.argv) != 2) :
print 'Usage:'
print 'python verify_leveldb.py /path/to/leveldb/cache/'
sys.exit(1)
dbpath = sys.argv[1]
try:
startTime = datetime.now()
print sys.argv[0], ": Inspecting db: ", dbpath
db = leveldb.LevelDB(dbpath, create_if_missing=False, paranoid_checks=True)
it = db.RangeIter(None, None, True, True, True)
records = 0;
for key, value in it:
records = records + 1
print sys.argv[0], ": Backup verfiication successful!"
print sys.argv[0], ": Total records: ", records
print sys.argv[0], ": Time taken:", datetime.now() - startTime
except:
print sys.argv[0], ": Backup verfication failed!"
print sys.argv[0], ": Unexpected error:", sys.exc_info()[0]
raise
exit(1)
# Rename ldb files to sst (Python API uses ldb extension, whereas infinispan expects sst)
script = 'for f in ' + dbpath + '/*.ldb; do mv $f "${f%.ldb}.sst"; done'
subprocess.call(['/bin/bash', '-c', script]) |
...
Repairing Corrupt LevelDB
When the LevelDB database becomes corrupted, the RepairDB option provided by the LevelDB API can be used to recover as much as data as possible. In LevelDB, the manifest file holds account of all files and their corresponding key ranges. The recovery process inspects each file in the leveldb directory and updates the manifest accordingly. This implies that even with a successful repair missing-files could lead to loss of data, which in turn can prevent a successful restoration of the repository.
The below script can be used to repair corrupt leveldb cache:
...
language | py |
---|---|
title | repair_leveldb.py |
collapse | true |
...