migrate README and example

1 files changed, 55 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b8d0c81
--- /dev/null
+++ b/README
@@ -0,0 +1,55 @@
+Tests for SPICE
+===============
+
+Migration test quick startup
+============================
+
+What it does: repeatedly migrates qemu-kvm instances with a single client attached.
+
+use test_vdagent_in_win7_client_edit_to_taste.sh
+
+Slightly less quick
+===================
+./migrate.py --qemu <full path to qemu-kvm executable> --image <image to test> --client spicec
+
+Will default to looking for 'which qemu-system-x86_64' and using no image (so just bios,
+not really testing qxl, but yes testing the switch host functionality)
+
+defaults to a very small subset of the actual command line used by libvirt:
+vdagent (virtio-serial)
+usbtablet
+qxl
+
+defaults to spicy client, hence --client spicec required to test current client.
+
+no virtio-net (so the default slirp based network with rtl8139), no virtio-block.
+
+if supplied with --image will run it in -snapshot.
+
+
+Full migrate.py --help
+======================
+
+usage: migrate.py [-h] [--qmp1 QMP1] [--qmp2 QMP2] [--spice_port1 SPICE_PORT1]
+                  [--spice_port2 SPICE_PORT2] [--migrate_port MIGRATE_PORT]
+                  [--client_count CLIENT_COUNT] [--qemu QEMU]
+                  [--log_filename LOG_FILENAME] [--image IMAGE]
+                  [--client {spicec,spicy}] [--vdagent {on,off}]
+                  [--usbtablet {on,off}]
+
+Process some integers.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --qmp1 QMP1
+  --qmp2 QMP2
+  --spice_port1 SPICE_PORT1
+  --spice_port2 SPICE_PORT2
+  --migrate_port MIGRATE_PORT
+  --client_count CLIENT_COUNT
+  --qemu QEMU
+  --log_filename LOG_FILENAME
+  --image IMAGE
+  --client {spicec,spicy}
+  --vdagent {on,off}
+  --usbtablet {on,off}