x/tap-as-a-service-tempest-plugin
Code Issues Proposed changes

Misc documentation improvements

Browse Source 
Change-Id: Icb792961171385572436f6977df02eaa35d2c633
This commit is contained in:
YAMAMOTO Takashi 2015-09-30 14:31:36 +09:00
parent 65af458446
commit 9f636b7645
6 changed files with 8 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
API_REFERENCE.rst
View File

@ -242,7 +242,7 @@ In this section we describe a simple sequence of steps to use TaaS.
Work Flow Sequence Work Flow Sequence
------------------ ------------------
1. Create a Neutron port with 'port_security' set to 'disabled'. 1. Create a Neutron port with 'port_security_enabled' set to 'false'.
2. Launch a VM (VM on which you want to monitor/receive the mirroed data). 2. Launch a VM (VM on which you want to monitor/receive the mirroed data).
Assoiciate the Neutron port created in step 1 while creating the VM. Assoiciate the Neutron port created in step 1 while creating the VM.
@ -254,7 +254,7 @@ Work Flow Sequence
the Neutron port from which the traffic needs to be monitored already the Neutron port from which the traffic needs to be monitored already
exists) exists)
5. Observer the mirroed traffic on the monitoring VM by running tools such as 5. Observe the mirrored traffic on the monitoring VM by running tools such as
tcpdump. tcpdump.

6
INSTALL.rst
View File

@ -14,7 +14,7 @@ Dependencies
============ ============
TaaS requires the 'Port Security' Neutron ML2 extension. Please make sure that TaaS requires the 'Port Security' Neutron ML2 extension. Please make sure that
this extension has been enabled in the ‘local.conf’ file during DevStack setup. this extension has been enabled in the `local.conf` file during DevStack setup.
Adding the folowing section to 'local.conf' while installing devstack will enable Adding the folowing section to 'local.conf' while installing devstack will enable
'Port Security' extension 'Port Security' extension
@ -29,7 +29,7 @@ Adding the folowing section to 'local.conf' while installing devstack will enabl
Installation Installation
============ ============
1. Install DevStack (remember to have 'port security' option enabled) 1. Install DevStack (remember to have 'port security' extension enabled)
2. Clone the TaaS git repository from git://git.openstack.org/stackforge/tap-as-a-service 2. Clone the TaaS git repository from git://git.openstack.org/stackforge/tap-as-a-service
@ -75,7 +75,7 @@ Running TaaS
Note Note
==== ====
When you restack the devstak, make sure to run the TaaS installation process again When you restack the devstack, make sure to run the TaaS installation process again
We are working towards making TaaS more seemlessly integrated with devstack and make We are working towards making TaaS more seemlessly integrated with devstack and make
the installation process easier. the installation process easier.

1
doc/source/api_reference.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../../API_REFERENCE.rst

2
doc/source/index.rst
View File

@ -13,7 +13,7 @@ Contents:
readme readme
installation installation
usage api_reference
contributing contributing
Indices and tables Indices and tables

13
doc/source/installation.rst
View File

@ -1,12 +1 @@
============ .. include:: ../../INSTALL.rst
Installation
============
At the command line::
$ pip install tap-as-a-service
Or, if you have virtualenvwrapper installed::
$ mkvirtualenv tap-as-a-service
$ pip install tap-as-a-service

7
doc/source/usage.rst
View File

@ -1,7 +0,0 @@
========
Usage
========
To use tap-as-a-service in a project::
import neutron_taas