Doc enhancements, test the doc auto build hook
Change-Id: I3910eee39486aba25086d9309c24b34bcd10a934
This commit is contained in:
Yichen Wang
parent
5282156bc3
commit
a47447a3f6
20
README.rst
20
README.rst
@ -1,9 +1,6 @@
|
||||
===============================
|
||||
VMTP
|
||||
===============================
|
||||
|
||||
What is VMTP
|
||||
============
|
||||
========
|
||||
Overview
|
||||
========
|
||||
|
||||
VMTP is a data path performance tool for OpenStack clouds.
|
||||
|
||||
@ -88,6 +85,11 @@ VMTP will display the results to stdout with the following data:
|
||||
|
||||
Detailed results can also be stored in a file in JSON format using the *--json* command line argument.
|
||||
|
||||
Documentation
|
||||
^^^^^^^^^^^^^
|
||||
For more information, see the `VMTP online documentation <http://vmtp.readthedocs.org>`_
|
||||
=====
|
||||
Links
|
||||
=====
|
||||
|
||||
* Documentation: http://vmtp.readthedocs.org/en/latest
|
||||
* Source: http://git.openstack.org/cgit/stackforge/vmtp
|
||||
* Bugs: http://bugs.launchpad.net/vmtp
|
||||
|
||||
|
||||
@ -16,10 +16,10 @@ Contents:
|
||||
usage
|
||||
contributing
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
.. Indices and tables
|
||||
.. ==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
.. * :ref:`genindex`
|
||||
.. * :ref:`modindex`
|
||||
.. * :ref:`search`
|
||||
|
||||
|
||||
@ -47,10 +47,10 @@ VMTP Usage
|
||||
usage: vmtp.py [-h] [-c <config_file>] [-r <openrc_file>]
|
||||
[-m <gmond_ip>[:<port>]] [-p <password>] [-t <time>]
|
||||
[--host <user>@<host_ssh_ip>[:<server-listen-if-name>]]
|
||||
[--external-host <user>@<ext_host_ssh_ip>]
|
||||
[--access_info '{"host":"<hostip>", "user":"<user>", "password":"<pass>"}']
|
||||
[--external-host <user>@<host_ssh_ip>[:password>]]
|
||||
[--controller-node <user>@<host_ssh_ip>[:<password>]]
|
||||
[--mongod_server <server ip>] [--json <file>]
|
||||
[--tp-tool nuttcp|iperf] [--hypervisor name]
|
||||
[--tp-tool nuttcp|iperf] [--hypervisor [<az>:] <hostname>]
|
||||
[--inter-node-only] [--protocols T|U|I]
|
||||
[--bandwidth <bandwidth>] [--tcpbuf <tcp_pkt_size1,...>]
|
||||
[--udpbuf <udp_pkt_size1,...>] [--no-env] [-d] [-v]
|
||||
@ -83,8 +83,8 @@ VMTP Usage
|
||||
--json <file> store results in json format file
|
||||
--tp-tool nuttcp|iperf
|
||||
transport perf tool to use (default=nuttcp)
|
||||
--hypervisor name hypervisor to use in the avail zone (1 per arg, up to
|
||||
2 args)
|
||||
--hypervisor [<az>:] <hostname>
|
||||
hypervisor to use (1 per arg, up to 2 args)
|
||||
--inter-node-only only measure inter-node
|
||||
--protocols T|U|I protocols T(TCP), U(UDP), I(ICMP) - default=TUI (all)
|
||||
--bandwidth <bandwidth>
|
||||
@ -163,16 +163,14 @@ There are multiple ways to specify the placement of test VMs to VMTP. By default
|
||||
|
||||
It is possible to limit the host selection to a specific availability zone by specifying its name in the yaml configuration file ('availability_name' parameter).
|
||||
|
||||
The *--hypervisor* argument can also be used to specify explicitly on which hosts to run the test VMs.
|
||||
The first *--hypervisor* argument specifies on which host to run the test server VM. The second *--hypervisor* argument (in the command line) specifies on which host to run the test client VMs.
|
||||
The syntax to use for the argument value is either availability_zone and host name separated by a column (e.g. "--hypervisor nova:host26") or host name (e.g. "--hypervisor host12").
|
||||
In the latter case, VMTP will automaticaly pick the availability zone of the host.
|
||||
The *--hypervisor* argument can also be used to specify explicitly on which hosts to run the test VMs. The first *--hypervisor* argument specifies on which host to run the test server VM. The second *--hypervisor* argument (in the command line) specifies on which host to run the test client VMs.
|
||||
|
||||
The syntax to use for the argument value is either availability_zone and host name separated by a column (e.g. "--hypervisor nova:host26") or host name (e.g. "--hypervisor host12"). In the latter case, VMTP will automaticaly pick the availability zone of the host.
|
||||
|
||||
Picking a particular host can be handy for example when exact VM placement can impact the data path performance (for example rack based placement).
|
||||
|
||||
The first --hypervisor argument specifies on which host to run the test server VM. The second --hypervisor argument specifies on which host to run the test client VMs.
|
||||
|
||||
The value of the argument must match the hypervisor host name as known by OpenStack (or as displayed using "nova hypervisor-list").
|
||||
|
||||
If an availability zone is provided, VMTP will check that the host name exists in that availability zone.
|
||||
|
||||
|
||||
@ -241,7 +239,7 @@ Example 3: Store the OpenStack deployment details
|
||||
|
||||
Run VMTP on an OpenStack cloud, fetch the defails of the deployment and store it to JSON file. Assume the controlloer node is on 192.168.12.34 with admin/admin::
|
||||
|
||||
pythn vmtp.py -r admin-openrc.sh -p admin --json res.json --access_info '{"host":"192.168.12.34", "user":"admin", "password":"admin"}'
|
||||
python vmtp.py -r admin-openrc.sh -p admin --json res.json --controller-node root@192.168.12.34:admin
|
||||
|
||||
|
||||
Example 4: Specify which availability zone to spawn VMs
|
||||
@ -322,12 +320,3 @@ Caveats and Known Issues
|
||||
|
||||
* If VMTP hangs for native hosts throughputs, check firewall rules on the hosts to allow TCP/UDP ports 5001 and TCP port 5002
|
||||
|
||||
|
||||
=====
|
||||
Links
|
||||
=====
|
||||
|
||||
* Documentation: http://vmtp.readthedocs.org/en/latest
|
||||
* Source: http://git.openstack.org/cgit/stackforge/vmtp
|
||||
* Bugs: http://bugs.launchpad.net/vmtp
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user