From 9f636b7645a69b8d50678a55f2dc311b5df4cbef Mon Sep 17 00:00:00 2001 From: YAMAMOTO Takashi Date: Wed, 30 Sep 2015 14:31:36 +0900 Subject: [PATCH] Misc documentation improvements Change-Id: Icb792961171385572436f6977df02eaa35d2c633 --- API_REFERENCE.rst | 4 ++-- INSTALL.rst | 6 +++--- doc/source/api_reference.rst | 1 + doc/source/index.rst | 2 +- doc/source/installation.rst | 13 +------------ doc/source/usage.rst | 7 ------- 6 files changed, 8 insertions(+), 25 deletions(-) create mode 100644 doc/source/api_reference.rst delete mode 100644 doc/source/usage.rst diff --git a/API_REFERENCE.rst b/API_REFERENCE.rst index ad70c1c1..2135d135 100644 --- a/API_REFERENCE.rst +++ b/API_REFERENCE.rst @@ -242,7 +242,7 @@ In this section we describe a simple sequence of steps to use TaaS. 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). 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 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. diff --git a/INSTALL.rst b/INSTALL.rst index df10ab3d..96e5085a 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -14,7 +14,7 @@ Dependencies ============ 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 'Port Security' extension @@ -29,7 +29,7 @@ Adding the folowing section to 'local.conf' while installing devstack will enabl 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 @@ -75,7 +75,7 @@ Running TaaS 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 the installation process easier. diff --git a/doc/source/api_reference.rst b/doc/source/api_reference.rst new file mode 100644 index 00000000..19f6e6d4 --- /dev/null +++ b/doc/source/api_reference.rst @@ -0,0 +1 @@ +.. include:: ../../API_REFERENCE.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 05af15e8..f62271f8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,7 +13,7 @@ Contents: readme installation - usage + api_reference contributing Indices and tables diff --git a/doc/source/installation.rst b/doc/source/installation.rst index c567e7b3..545ae4fa 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -1,12 +1 @@ -============ -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 +.. include:: ../../INSTALL.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index 31f0a5f7..00000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,7 +0,0 @@ -======== -Usage -======== - -To use tap-as-a-service in a project:: - - import neutron_taas