x/vmtp
Code Issues Proposed changes

Small fixes, document enhancements, and cleanups

Browse Source 
1. Remove the Docker-based installation from documents;
2. Clean up the dependencies list;

Change-Id: I748aa2b41302d5d30e5222de04517084aab6bc8f
This commit is contained in:
Yichen Wang 2015-07-30 18:56:50 -07:00
parent b88b14f1f0
commit 10e4fdb830
4 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/conf.py
View File

@ -14,7 +14,6 @@
import datetime import datetime
import os import os
import re
import sys import sys
from pbr import version as pbr_ver from pbr import version as pbr_ver

8
doc/source/installation.rst
View File

@ -10,7 +10,7 @@ There are two ways to install and run VMTP tool. Users of VMTP should use regula
PyPI based Installation PyPI based Installation
----------------------- -----------------------
PyPI (The Python Package Index) is the offical repository for software in Python. It holds lots of packages, and the installation is relatively easy in only 2 steps. PyPI (The Python Package Index) is the official repository for software in Python. It holds lots of packages, and the installation is relatively easy in only 2 steps.
Step 1 Step 1
^^^^^^ ^^^^^^
@ -42,6 +42,12 @@ Create a virtual environment for Python, and install VMTP::
$ pip install vmtp $ pip install vmtp
$ vmtp -h $ vmtp -h
**Note:** "A Virtual Environment is a tool to keep the dependencies required by different projects in separate places, by creating virtual Python environments for them." It is optional but recommended. We could use::
$ sudo pip install vmtp
instead if isolation among multiple Python projects is not needed.
.. _git_installation: .. _git_installation:

4
doc/source/usage.rst
View File

@ -20,9 +20,7 @@ VMTP Usage
[--vnic-type <direct|macvtap|normal>] [-d] [-v] [--vnic-type <direct|macvtap|normal>] [-d] [-v]
[--stop-on-error] [--vm-image-url <url_to_image>] [--stop-on-error] [--vm-image-url <url_to_image>]
[--test-description <test_description>] [--test-description <test_description>]
OpenStack VM Throughput V2.1.4
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
-c <config_file>, --config <config_file> -c <config_file>, --config <config_file>

21
vmtp/vmtp.py
View File

@ -666,7 +666,7 @@ def main():
return dest_config return dest_config
logging.basicConfig() logging.basicConfig()
parser = argparse.ArgumentParser(description='OpenStack VM Throughput ' + __version__) parser = argparse.ArgumentParser()
parser.add_argument('-c', '--config', dest='config', parser.add_argument('-c', '--config', dest='config',
action='store', action='store',
@ -974,14 +974,17 @@ def main():
vmtp_instance = None vmtp_instance = None
cred = credentials.Credentials(opts.rc, opts.pwd, opts.no_env) cred = credentials.Credentials(opts.rc, opts.pwd, opts.no_env)
if cred.rc_auth_url: if not cred.rc_auth_url:
if config.debug: print 'Error: Cannot read the credentials of the cloud. '
print 'Using ' + cred.rc_auth_url sys.exit(1)
vmtp_instance = VmtpTest(config, cred)
for item in native_tp_results: if config.debug:
vmtp_instance.rescol.add_flow_result(item) print 'Using ' + cred.rc_auth_url
vmtp_instance.run() vmtp_instance = VmtpTest(config, cred)
vmtp_net = vmtp_instance.net for item in native_tp_results:
vmtp_instance.rescol.add_flow_result(item)
vmtp_instance.run()
vmtp_net = vmtp_instance.net
# Retrieve controller information if requested # Retrieve controller information if requested
# controller node ssh access to collect metadata for the run. # controller node ssh access to collect metadata for the run.