##About
###Description Filesystem snapshotting and replication build atop LegionD. CodexD currently implements one persistence type: tar. Future persistence types include btrfs and zfs.
###Author ContainerShip Developers - [email protected]
##Getting Started
###Demos
###Installation
npm install codexd --save
###Examples
####Instantiation Instantiates a new CodexD object. It is important to note that CodexD depends on LegionD.
var CodexD = require("codexd");
var LegionD = require("legiond");
var legiond = new LegionD();
var codexd = new CodexD({
legiond: legiond
});
####Create a Volume Create a new volume to be managed by CodexD.
var uuid = codexd.create_uuid();
codexd.create_volume({
id: uuid
}, function(err){
if(err)
throw err;
});
####Get Volumes Get all volumes.
console.log(codexd.get_volumes());
####Get Volume Get a specific volume.
console.log(codexd.get_volumes(uuid));
####Get Snapshot Searches LegionD cluster for desired volume, creates a snapshot, transfers it to the current legiond node, and restores it.
codexd.get_snapshot(uuid, function(err){
if(err)
throw err;
});
####Remove a Volume
codexd.remove_volume(uuid, function(err){
if(err)
throw err;
});
##Contributing Pull requests and issues are encouraged! Help us make CodexD even more awesome :)