Add usage information and examples to README
authorBryn M. Reeves <bmr@redhat.com>
Wed, 31 Oct 2012 19:22:59 +0000 (19:22 +0000)
committerBryn M. Reeves <bmr@redhat.com>
Wed, 31 Oct 2012 19:22:59 +0000 (19:22 +0000)
README

diff --git a/README b/README
index cdd5a0c..44dbe8b 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,70 @@
 blkdevalias is a tool to manage persistent storage device aliases and permissions
+
+The blkdevalias stuff is currently organised like this:
+
+/sbin/blkdevalias:
+Main script. Manages adding/removing/displaying mappings and maintains a
+persistent table used to direct the udev rules.
+
+/etc/blkdevalias/map:
+The persistent mapping table; currently just "<WWID> <ALIAS> <TYPE>".
+
+/etc/blkdevalias/conf:
+Configuration of user/group, symlink/node directory etc.
+
+/etc/udev/rules.d/99-blkdevalias.rules:
+Rules to manage naming and permissions based on the persistent
+configuration stored in the table.
+
+Feedback and testing very much welcome.
+
+[root@rhel6-vm1 ~]# blkdevalias
+Usage: /sbin/blkdevalias
+{configure|createdisk|deletedisk|scandisks|querydisk|map}
+[root@rhel6-vm1 ~]# blkdevalias configure
+Configuring the udev wwid map.
+
+This will configure persistent mappings and permissions for storage
+devices. The current values will be shown in brackets ('[]'). Hitting
+<ENTER> without typing an answer will keep the current value. Ctrl-C
+will abort.
+
+Default user to own device nodes [oracle]:
+Default group to own device nodes [oracle]:
+Default device directory [oracleasm/disks]:
+Writing wwid map configuration: done
+
+[root@rhel6-vm1 ~]# blkdevalias listdisks
+[root@rhel6-vm1 ~]# blkdevalias createdisk DSK1 /dev/sda
+[root@rhel6-vm1 ~]# blkdevalias createdisk DSK2 /dev/sdb
+[root@rhel6-vm1 ~]# blkdevalias createdisk DSK3 /dev/sdc
+[root@rhel6-vm1 ~]# blkdevalias createdisk DSK4 /dev/sdd
+[root@rhel6-vm1 ~]# blkdevalias listdisks
+DSK1
+DSK2
+DSK3
+DSK4
+[root@rhel6-vm1 ~]# blkdevalias querydisk DSK1
+DSK1 is a valid blkdevalias disk
+[root@rhel6-vm1 ~]# blkdevalias querydisk -d DSK4
+DSK4 is a valid blkdevalias diskon device [8, 31]
+[root@rhel6-vm1 ~]#
+[root@rhel6-vm1 ~]# blkdevalias deletedisk DSK4
+Removing wwid map disk "DSK4":                                  [  OK  ]
+[root@rhel6-vm1 ~]# blkdevalias listdisks
+DSK1
+DSK2
+DSK3
+[root@rhel6-vm1 ~]# ls -l /dev/oracleasm/disks/
+total 0
+lrwxrwxrwx. 1 root root 10 Oct 30 11:01 DSK1 -> ../../sda1
+lrwxrwxrwx. 1 root root 10 Oct 30 11:01 DSK2 -> ../../sdb1
+lrwxrwxrwx. 1 root root 10 Oct 30 11:01 DSK3 -> ../../sdc1
+lrwxrwxrwx. 1 root root 10 Oct 30 11:01 DSK4 -> ../../sdd1
+[root@rhel6-vm1 ~]# ls -lL /dev/oracleasm/disks/
+total 0
+brw-rw----. 1 root oracle 8,  1 Oct 30 11:01 DSK1
+brw-rw----. 1 root oracle 8, 17 Oct 30 11:01 DSK2
+brw-rw----. 1 root oracle 8, 33 Oct 30 11:01 DSK3
+brw-rw----. 1 root oracle 8, 49 Oct 30 11:01 DSK4
+