diff --git a/README.rst b/README.rst index c8e1a23..222c680 100644 --- a/README.rst +++ b/README.rst @@ -88,346 +88,3 @@ VMTP will display the results to stdout with the following data: | | | 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. - - -Installation -============ - -For people who wants to do development for VMTP, it is recommended to set up the develop environments as below. However, for people who just wants to run the tool, or without root access, please refer to the "How to Run VMTP Tool" section and use VMTP Docker Image instead. - -Here is an example for Ubuntu developers, and similar packages can be found and installed on RPM-based distro as well. - -.. code:: - - $ sudo apt-get install python-dev python-virtualenv git git-review - $ sudo apt-get install libxml2-dev libxslt-dev libffi-dev libz-dev libyaml-dev libssl-dev - $ virtualenv vmtpenv - $ source vmtpenv/bin/activate - $ git clone git://git.openstack.org/stackforge/vmtp - $ cd vmtp - $ pip install -r requirements-dev.txt - $ python vmtp.py -h - - -How to Run VMTP Tool -==================== - - -VMTP Docker Image ------------------ - -In its Docker image form, VMTP is located under the /vmtp directory in the container and can either take arguments from the host shell, or can be executed from inside the Docker image shell. - -To run VMTP directly from the host shell (may require "sudo" up front if not root) - -.. code:: - - docker run python /vmtp/vmtp.py - -To run VMTP from the Docker image shell: - -.. code:: - - docker run /bin/bash - cd /vmtp.py - python vmtp.py - -(then type exit to exit and terminate the container instance) - - -Docker Shared Volume to Share Files with the Container ------------------------------------------------------- - -VMTP can accept files as input (e.g. configuration and openrc file) and can generate json results into a file. - -It is possible to use the VMTP Docker image with files persisted on the host by using Docker shared volumes. - -For example, one can decide to mount the current host directory as /vmtp/shared in the container in read-write mode. - -To get a copy of the VMTP default configuration file from the container: - -.. code:: - - docker run -v $PWD:/vmtp/shared:rw cp /vmtp/cfg.default.yaml /vmtp/shared/mycfg.yaml - -Assume you have edited the configuration file "mycfg.yaml" and retrieved an openrc file "admin-openrc.sh" from Horizon on the local directory and would like to get results back in the "res.json" file, you can export the current directory ($PWD), map it to /vmtp/shared in the container in read/write mode, then run the script in the container by using files from the shared directory: - -.. code:: - - docker run -v $PWD:/vmtp/shared:rw -t python /vmtp/vmtp.py -c shared/mycfg.yaml -r shared/admin-openrc.sh -p admin --json shared/res.json - cat res.json - - -Print VMTP Usage ----------------- - -.. code:: - - usage: vmtp.py [-h] [-c ] [-r ] - [-m [:]] [-p ] [-t