118 lines
4.6 KiB
ReStructuredText
118 lines
4.6 KiB
ReStructuredText
========
|
|
Overview
|
|
========
|
|
|
|
VMTP is a data path performance tool for OpenStack clouds.
|
|
|
|
|
|
Features
|
|
--------
|
|
|
|
If you need a quick and simple way to get VM level or host level single-flow throughput and latency numbers from any OpenStack cloud, and take into account various Neutron topologies, this is the tool to use. VMTP is a python application that will automatically perform ping connectivity, ping round trip time measurement (latency) and TCP/UDP throughput measurement for the following flows on any OpenStack deployment:
|
|
|
|
* VM to VM same network (private fixed IP)
|
|
* VM to VM different network same tenant (intra-tenant L3 fixed IP)
|
|
* VM to VM different network and tenant (floating IP inter-tenant L3)
|
|
|
|
Optionally, when an external Linux host is available:
|
|
|
|
* External host/VM download and upload throughput/latency (L3/floating IP)
|
|
|
|
Optionally, when SSH login to any Linux host (native or virtual) is available:
|
|
|
|
* Host to host throughput (intra-node and inter-node)
|
|
|
|
Optionally, VMTP can extract automatically CPU usage from all native hosts in the cloud during the throughput tests, provided the Ganglia monitoring service (gmond) is installed and enabled on those hosts.
|
|
|
|
For VM-related flows, VMTP will automatically create the necessary OpenStack resources (router, networks, subnets, key pairs, security groups, test VMs), perform the throughput measurements then cleanup all related resources before exiting.
|
|
|
|
See the usage page for the description of all the command line arguments supported by VMTP.
|
|
|
|
Pre-requisite
|
|
-------------
|
|
|
|
VMTP runs on any Python 2.X envirnment (validated on Linux and MacOSX).
|
|
|
|
For VM related performance measurements
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
* Access to the cloud Horizon Dashboard (to retrieve the openrc file)
|
|
* 1 working external network pre-configured on the cloud (VMTP will pick the first one found)
|
|
* At least 2 floating IP if an external router is configured or 3 floating IP if there is no external router configured
|
|
* 1 Linux image available in OpenStack (any distribution)
|
|
* A configuration file that is properly set for the cloud to test (see "Configuration File" section below)
|
|
|
|
For native/external host throughputs
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
* A public key must be installed on the target hosts (see ssh password-less access below)
|
|
|
|
For pre-existing native host throughputs
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
* Firewalls must be configured to allow TCP/UDP ports 5001 and TCP port 5002
|
|
|
|
For running VMTP Docker Image
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
* Docker is installed. See `here <https://docs.docker.com/installation/#installation/>`_ for instructions.
|
|
|
|
Sample Results Output
|
|
---------------------
|
|
|
|
VMTP will display the results to stdout with the following data:
|
|
|
|
.. code::
|
|
|
|
- Session general information (date, auth_url, OpenStack encaps, VMTP version, OpenStack release, Agent type, CPU...)
|
|
- List of results per flow, for each flow:
|
|
| flow name
|
|
| to and from IP addresses
|
|
| to and from availability zones (if VM)
|
|
| - results:
|
|
| | -TCP
|
|
| | | packet size
|
|
| | | throughput value
|
|
| | | number of retransmissions
|
|
| | | round trip time in ms
|
|
| | | - CPU usage (if enabled), for each host in the openstack cluster
|
|
| | | | baseline (before test starts)
|
|
| | | | 1 or more readings during test
|
|
| | -UDP
|
|
| | | - for each packet size
|
|
| | | | throughput value
|
|
| | | | loss rate
|
|
| | | | CPU usage (if enabled)
|
|
| | - ICMP
|
|
| | | average, min, max and stddev round trip time in ms
|
|
|
|
Detailed results can also be stored in a file in JSON format using the *--json* command line argument and/or stored directly into a MongoDB server.
|
|
|
|
|
|
Limitations and Caveats
|
|
-----------------------
|
|
|
|
VMTP only measures performance for single-flows at the socket/TCP/UDP level (in a VM or natively). Measured numbers therefore reflect what most applications will see.
|
|
|
|
It is not designed to measure driver level data path performance from inside a VM (such as bypassing the kernel TCP stack and write directly to virtio), there are better tools that can address this type of mesurement.
|
|
|
|
|
|
License
|
|
-------
|
|
|
|
VMTP is licensed under Apache License 2.0.
|
|
|
|
Below are the benchmark tools that are used in VMTP, and you must accept the license of each tool before using VMTP.
|
|
|
|
* iperf: BSD License (https://iperf.fr/license.html)
|
|
* nuttcp: GPL v2 License (http://nuttcp.net/nuttcp/beta/LICENSE)
|
|
|
|
|
|
Links
|
|
-----
|
|
|
|
* Documentation: http://vmtp.readthedocs.org/en/latest
|
|
* Source: http://git.openstack.org/cgit/stackforge/vmtp
|
|
* Bugs: http://bugs.launchpad.net/vmtp
|
|
|