diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2015-09-11 15:45:39 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2015-09-11 15:45:39 -0400 |
| commit | 081ace7342b175f8e06d8aa9848e2aa4557f65c8 (patch) | |
| tree | d04866bd42a73bbe58faa873b72121476b8c31f2 /docs/installation.rst | |
| parent | 72a6363bacadab1a0565ce71144471ba6f6d64ae (diff) | |
Move documentation to new sphinx build
TODO: Reorganize documentation into properly named subfolders
TODO: Add logos to documentation (see index.rst for example)
Note you can see the results of this change via a link in the gerrit
comments below
NOTE: The merge job for your project has not been enabled, this code
will not go to the artifacts page upon a merge. you can merge it and
work on it in your own time, please contact me to enable the merge
(the merge job will make this documentation avaliable to the public on
artifacts.opnfv.org)
JIRA:RELENG-15
Change-Id: I3f3d8c9d7fceae90e0ed824b66bdaf7a8ea66328
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs/installation.rst')
| -rw-r--r-- | docs/installation.rst | 81 |
1 files changed, 0 insertions, 81 deletions
diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index 90de7a0a..00000000 --- a/docs/installation.rst +++ /dev/null @@ -1,81 +0,0 @@ -Installing vswitchperf -====================== - -The test suite requires Python 3.3 and relies on a number of other -packages. These need to be installed for the test suite to function. To -install Python 3.3 in CentOS 7, an additional repository, Software -Collections (see -https://www.softwarecollections.org/en/scls/rhscl/python33) should be -enabled. - -Install the requirements as specified below. - -Enable Software Collections (SCL) ---------------------------------- - - .. code-block:: console - - yum -y install scl-utils - yum -y install https://www.softwarecollections.org/en/scls/rhscl/python33/epel-7-x86_64/download/rhscl-python33-epel-7-x86_64.noarch.rpm - -(Optional) Enable Repoforge (for stress) ----------------------------------------- -Allows optional installation of stress tool, which is required by load tests. - - .. code-block:: console - - yum -y install http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.3-1.el7.rf.x86_64.rpm - -System packages ------------------ -There are a number of packages that must be installed using `yum`. These can be installed like so: - - .. code-block:: console - - yum -y --exclude=python33-mod_wsgi* install python33-* pciutils - -Optional installation of stress tool - - .. code-block:: console - - yum -y install stress - -Python 3 Packages ------------------ - -To avoid file permission errors and Python version issues, use -virtualenv to create an isolated environment with Python3. The required -Python 3 packages can be found in the ``requirements.txt`` file in the -root of the test suite. They can be installed in your virtual -environment like so: - - .. code-block:: bash - - scl enable python33 bash - # Create virtual environment - virtualenv vsperfenv - cd vsperfenv - source bin/activate - pip install -r requirements.txt - -You need to activate the virtual environment every time you start a new -shell session. To activate, simple run: - -.. code:: bash - - scl enable python33 bash - cd vsperfenv - source bin/activate - --------------- - -Working Behind a Proxy -====================== - -If you're behind a proxy, you'll likely want to configure this before -running any of the above. For example: - - .. code:: bash - - export http_proxy=proxy.mycompany.com:123 - export https_proxy=proxy.mycompany.com:123 |