updated to include examples and more usage

drbd/README.md

@@ -2,13 +2,13 @@ Description
 ===========
 Installs and configures the Distributed Replicated Block Device (DRBD) service for mirroring block devices between a pair of hosts. Right now it simply works in pairs, multiple hosts could be supported with a few small changes.
 
-The `drbd` cookbook does not partition drives. It will format partitions given a filesystem type, but it does not explicitly depend on the `xfs` cookbook if you want that type of filesystem, but you can put it in your run list and set the node['drbd']['fs_type'] to 'xfs'.
+The `drbd` cookbook does not partition drives. It will format partitions given a filesystem type, but it does not explicitly depend on the `xfs` cookbook if you want that type of filesystem, but you can put it in your run list and set the node['drbd']['fs_type'] to 'xfs' or 'ext4' or whatever.
 
 Requirements
 ============
 Platform
 --------
-Tested with Ubuntu 10.04 - 11.04. You must have the 'linux-server' package and 'linux-headers-server' kernel installed to properly support the drbd module. 
+Tested with Ubuntu 10.10. You must have the 'linux-server' package and 'linux-headers-server' kernel installed to properly support the drbd module. 
 
 Recipes
 =======
@@ -18,18 +18,20 @@ Installs drbd but does no configuration.
 
 default
 -------
-Given a filesystem and a partner host, configures block replication between the hosts. The master will claim the primary, format the filesystem and mount the partition. The slave will simply mirror without mounting.
+Given a filesystem and a partner host, configures block replication between the hosts. The master will claim the primary, format the filesystem and mount the partition. The slave will simply mirror without mounting. It currently takes 2 chef-client runs to ensure the pair is synced properly.
 
 Attributes
 ==========
-* `node['drbd]['remote_host']` - Partner to mirror with.
-* `node['drbd]['remote_ip']` - Partner IP to mirror with.
+The primary attributes of interest are
+
 * `node['drbd]['disk']` - Disk partition to mirror.
 * `node['drbd]['fs_type']` - Disk format for the mirrored disk.
 * `node['drbd]['mount']` - Mount point to mirror.
-* `node['drbd]['dev']` - Device name for the drbd device, defaults to `/dev/drbd1`.
 * `node['drbd]['master']` - Whether this node is master between the pair, defaults to `false`.
-* `node['drbd]['port']` - Port to use for TCP connections, defaults to `7789`.
+
+Roles
+=====
+There are a pair of example roles `drbd-pair.rb` and `drbd-pair-master.rb` with the cookbook source.
 
 License and Author
 ==================