浏览代码

Update README for new config syntax

Jakob Borg 12 年之前
父节点
当前提交
82ba10a47e
共有 1 个文件被更改,包括 11 次插入17 次删除
  1. 11 17
      README.md

+ 11 - 17
README.md

@@ -52,27 +52,20 @@ Copy the config file `zsnapper.json.sample` (probably installed in
 It's a JSON file of the format:
 It's a JSON file of the format:
 
 
     {
     {
-        <dataset name>: {
-            <snapshot name>: {
-                "when": <cron string>,
-                "count": <number of snapshots>,
-                "exclude": [ <dataset to be excluded>, ... ]
-            },
-            <snapshot name>: {
-                "when": <cron string>,
-                "count": <number of snapshots>,
-                "exclude": [ <dataset to be excluded>, ... ]
-            }
+        <snapshot name>: {
+            "when": <cron string>,
+            "count": <number of snapshots>,
+            "datasets": [ <dataset wildcard>, ... ]
         },
         },
-        <dataset name>: {
-            ...
+        <snapshot name>: {
+            "when": <cron string>,
+            "count": <number of snapshots>,
+            "datasets": [ <dataset wildcard>, ... ]
         }
         }
     }
     }
 
 
 Where:
 Where:
 
 
-  - *dataset name* is a name of a dataset to snapshot. Example: `zones`.
-
   - *snapshot name* is a base to build snapshot names of. The current date and
   - *snapshot name* is a base to build snapshot names of. The current date and
     time will be appended. Example: `daily` which will result in snapshot names
     time will be appended. Example: `daily` which will result in snapshot names
     of the type `daily-20120515T1314900Z`.
     of the type `daily-20120515T1314900Z`.
@@ -84,8 +77,9 @@ Where:
   - *number of snapshots* is the number of snapshots that should be kept
   - *number of snapshots* is the number of snapshots that should be kept
     historically before being destroyed.
     historically before being destroyed.
 
 
-  - *exclude* is a list of dataset names (under the main *dataset name*) that
-    should not be snapshotted. Example: `[ "zones/swap", "zones/dump" ]`.
+  - *dataset wildcard* is a wildcard matching datasets to snapshot.
+    Example: `zones/*-*-*-*` to match datasets under `zones` that might
+    look like uuids.
 
 
 Start
 Start
 -----
 -----