Add details to README.

ianshward · Jul 10, 2012 · 5e8b41b · 5e8b41b
1 parent 500b6de
commit 5e8b41b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,10 @@ Take rotating Amazon AWS EBS snapshots with this small node.js script.
 * Put the script on an EC2 and use 'self' as one of the "jobs" keys to refer to that instance itself.
 * Handles multiple devices at a time on various instances.
 
-See setting.json for sample definitions.
+See setting.json for sample definitions. Options include:
+
+pool - the number of snapshots to maintain before destroying old ones.
+devices - a comma separated list of devices that should be snapshotted.
+description - used as the description for the snapshot along with the device name and the instance ID.
 
 `node index.js --config=settings.json` ... throw that in a hourly, daily, etc. cronjob and set the 'pool' size and you've got rotating snapshots.
diff --git a/settings.json b/settings.json
@@ -4,15 +4,13 @@
     "jobs": {
         "i-XXXXXXXX": {
             "pool": 3,
-            "devices": "/dev/sdf1,/dev/sdf2, /dev/sdf3, /dev/sdf4",
-            "description": "file cluster RAID",
-            "freeze": true
+            "devices": "/dev/sdf1, /dev/sdf2, /dev/sdf3, /dev/sdf4",
+            "description": "file cluster RAID"
         },
         "self": {
             "pool": 4,
             "devices": "/dev/sdg",
-            "description": "storage for logs",
-            "freeze": false
+            "description": "storage for logs"
         }
     }
 }