README.md in vagrant-snap-0.01 vs README.md in vagrant-snap-0.02
- old
+ new
@@ -1,25 +1,73 @@
What's this?
==================================
vagrant snapshot management plugin
+can handle multi-vm envirnment.
-## install
+## Install
gem install vagrant-snap
-## following commands are added
+## Following commands are added
Tasks:
- vagrant snap back # back to current snapshot
- vagrant snap delete SNAP_NAME # delete snapshot
- vagrant snap go SNAP_NAME # go to specified snapshot
- vagrant snap help [COMMAND] # Describe subcommands or one specific subcommand
- vagrant snap list # list snapshot
- vagrant snap take [desc] # take snapshot
+ vagrant snap back # back to current snapshot
+ vagrant snap delete SNAP_NAME # delete snapshot
+ vagrant snap go SNAP_NAME # go to specified snapshot
+ vagrant snap help [COMMAND] # Describe subcommands or one specific subcommand
+ vagrant snap list # list snapshot
+ vagrant snap take [NAME] [-d DESC] # take snapshot
-## limitation
+## Example
-Currently multi-vm environment is not supported
+In actual example, current snapshot is highlighted with yellow ANSI color.
-## Similar project
+ t510 dev/vagtest02% vagrant snap take
+ [db]
+ 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+ [web]
+ 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+ t510 dev/vagtest02%
+ t510 [1] dev/vagtest02% vagrant snap list
+ [db]
+ +-db-01 [ 16 seconds ]
+ [web]
+ +-web-01 [ 14 seconds ]
+ t510 dev/vagtest02% vagrant snap take -d "2nd snap"
+ [db]
+ 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+ [web]
+ 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+ t510 dev/vagtest02% vagrant snap list
+ [db]
+ +-db-01 [ 48 seconds ]
+ +-db-02 [ 10 seconds ] 2nd snap
+ [web]
+ +-web-01 [ 47 seconds ]
+ +-web-02 [ 8 seconds ] 2nd snap
+ t510 dev/vagtest02% vagrant snap go web-01 web
+ [web]
+ 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+ Restoring snapshot 283d90aa-ef75-4316-a847-e04961c2ec26
+ 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+ Waiting for the VM to power on...
+ VM has been successfully started.
+ t510 dev/vagtest02% vagrant snap list
+ [db]
+ +-db-01 [ 1 minute ]
+ +-db-02 [ 40 seconds ] 2nd snap
+ [web]
+ +-web-01 [ 1 minute ]
+ +-web-02 [ 38 seconds ] 2nd snap
+ t510 dev/vagtest02%
+
+## Similar project
[sahara](https://github.com/jedi4ever/sahara)
+
+## Other
+I intentionally avoided naming this plugin as 'vagrant-snapshot', because I believe Vagrant author
+implement snap shot management feature and want to use 'snapshot' as command name.
+
+## VM configuration
+In my experience, to avoid `VERR_SSM_LOAD_CONFIG_MISMATCH` error when restoreing snaphot,
+disable `USB controller` and `absolte pointing device`.