Commits

Kaspar Schiess committed d8a47d6

storadm description

  • Participants
  • Parent commits f999951

Comments (0)

Files changed (3)

File doc/qemu-toolkit-overview.7.ronn

 target on B) While this configuration is certainly more complex than the
 all-local one above, it is also more flexible to administer.
 
-## BUGS
-
-When using iscsi targets, you have to relaunch the vm twice to get it to 
-start up. We have code in place to work around this, but it is not effective. 
-Work to fix this is underway. 
-
 ## SEE ALSO
 
 qemu-toolkit-overview(7), qemu-toolkit-install(7),

File doc/storadm.1.ronn

 
 # storadm(1) -- Manages VM storage. 
 
+## SYNOPSIS
+
+`storadm` [-h]<br>
+`storadm list`<br>
+`storadm create` [-v] <name><br>
+`storadm clone` [-v] <name> <template> <version><br>
+`storadm export` [-v] <name><br>
+`storadm hide` [-v] <name><br>
+
+## DESCRIPTION
+
+The `storadm` command allows you to manage virtual machine storage all in
+one place. It creates, clones and destroys storage spaces. And if you want
+to separate storage machines from the hosts that run virtual machines (a SAN 
+style setup), you can - `storadm` provides two subcommands for this setup.
+
+Virtual machine storage is based on ZFS and uses the following dataset
+layout: 
+
+    vm_name             # base dataset
+    vm_name/disk1       # first block device (zvol)
+    
+  * `storadm list`: 
+    Lists all virtual machine storage spaces on this machine. For all 
+    storage spaces that have an iSCSI export, it lists the corresponding 
+    IQN. 
+    
+  * `storadm create` [-v] <name>:
+    Creates a new storage space. <name> should be a full zfs path to where
+    you want to create the storage space, something like `pool1/foo`.
+    
+    * `-v`:
+      Prints all commands as they are executed.
+  
+  * `storadm clone` [-v] <name> <template> <version>:
+    Clones a new storage space from a template. <template> refers to a 
+    storage space that has a recursive snapshot called <version>. 
+  
+    * `-v`:
+      Prints all commands as they are executed.
+      
+  * `storadm export` [-v] <name>:
+    Creates an iSCSI export for the storage space. All disks of the storage
+    space are mapped to LUNs in the iSCSI target. 
+
+    * `-v`:
+      Prints all commands as they are executed.
+
+  * `storadm hide` [-v] <name>:
+    Hides a storage space by removing the previously created iSCSI export 
+    from the system. 
+    
+    * `-v`:
+      Prints all commands as they are executed.
+    
+## EXAMPLES
+
+### Example 1 Creating a storage space
+The following command creates an empty virtual machine storage space with one
+disk drive of 10GB.
+
+    # storadm create pool1/foo 10G
+
+### Example 2 Listing all available storage spaces
+
+The following command lists all available storage spaces.
+
+    # storadm list
+    pool1/foo     
+    
+### Example 3 Creating a base version and cloning it
+
+The following commands snapshot an existing storage space called 
+`pool1/template` with the version tag `0.1.0`. A clone is then created based
+on that version of `pool1/template`.
+
+    # zfs snapshot -r pool1/template@0.1.0
+    # storadm clone my_vm pool1/template 0.1.0
+                  
+## BUGS
+
+Only the unknown.
+
 ## SEE ALSO
 
 qemu-toolkit-overview(7), qemu-toolkit-install(7),
 qemu-toolkit-configuration(7), storadm(1), vmadm(1), README(7)
+
+## AUTHORS
+
+Copyright (c) 2012 Kaspar Schiess. 
+
+## COPYRIGHT
+
+This tool is under a MIT license. Please see the LICENSE file in the original
+source.

File doc/vmadm.1.ronn

 
 # vmadm(1) -- Manages VMs. 
 
+## BUGS
+
+When using iscsi targets, you have to relaunch the vm twice to get it to 
+start up. We have code in place to work around this, but it is not effective. 
+Work to fix this is underway. 
+
 ## SEE ALSO
 
 qemu-toolkit-overview(7), qemu-toolkit-install(7),
 qemu-toolkit-configuration(7), storadm(1), vmadm(1), README(7)
+
+## AUTHORS
+
+Copyright (c) 2012 Kaspar Schiess. 
+
+## COPYRIGHT
+
+This tool is under a MIT license. Please see the LICENSE file in the original
+source.