-Installation
-============
-
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-.. these two pipes are to seperate the logo from the first title
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
+
-|
+Qtip configuration
+==================
-QTIP currently supports by using a Docker image or by pulling the repo from the upstream
-repository found at https://git.opnfv.org/qtip. Detailed steps about setting up QTIP using both of these options
-can be found below.
+QTIP currently supports by using a Docker image or by pulling the repo from
+the upstream repository found at https://git.opnfv.org/qtip. Detailed steps
+about setting up QTIP using both of these options can be found below.
-To use QTIP you should have access to an OpenStack environment,
-with at least Nova, Neutron, Glance, Keystone and Heat installed.
+To use QTIP you should have access to an OpenStack environment, with at least
+Nova, Neutron, Glance, Keystone and Heat installed. Add a brief introduction
+to configure OPNFV with this specific installer
-The steps needed to run QTIP are:
-Running QTIP by pulling the upstream code
------------------------------------------
+Pre-configuration activities
+----------------------------
-.. _install-dependencies:
Setting QTIP framework on Ubuntu 14.04
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
Install dependencies:
::
git clone https://git.opnfv.org/qtip
cd qtip
+
Installing QTIP using Docker
----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-QTIP has a Docker images on the docker hub which can be pull after docker has been installed.
+QTIP has a Docker images on the docker hub. Pulling opnfv/qtip docker image
+from docker hub:
+::
-Installing Docker
-^^^^^^^^^^^^^^^^^
-The first step is to install docker:
+ sudo docker pull opnfv/qtip
+
+Verify that opnfv/qtip has been downloaded. It should be listed as an image by
+running the following command.
::
- sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
+ sudo docker images
+
+Run the Docker instance:
+::
+ docker run opnfv/qtip -i -t bash
-Add an entry for your Ubuntu operating system
+Now you are in the container and QTIP can be found in the /repos/qtip and can
+be navigated to using the following command.
::
- Open the /etc/apt/sources.list.d/docker.list file in your favorite editor.
+ cd repos/qtip
-If the file doesn’t exist, create it.
-Remove any existing entries.
+OpenStack parameters and credentials
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Add an entry for your Ubuntu operating system.
-On Ubuntu Trusty 14.04 (LTS)
+Environment variables
+"""""""""""""""""""""
+
+Before running QTIP it is necessary to export OpenStack environment variables
+from the OpenStack *openrc* file. This can be done by running the following
+command.
::
- deb https://apt.dockerproject.org/repo ubuntu-trusty main
+ source get_env_info.sh -n {INSTALLER_TYPE} -i {INSTALLER_IP}
+ source opnfv-creds.sh
-Update the package manager
+This provides a ``opnfv-creds.sh`` file which can be sources to get the
+environment variables. For running QTIP manually, it is also necessary to
+export the installer type.
::
- sudo apt-get update
+ export INSTALLER_TYPE="{installer-type}"
-Install Docker:
-::
- sudo apt-get install docker-engine
+QTIP default key pair
+""""""""""""""""""""""
-Starting Docker Daemon:
-::
+QTIP uses a SSH key pair to connect to the guest image. This key pair can
+be found in the ``data/`` directory.
- sudo service docker start
-Pulling opnfv/qtip docker image from docker hub:
-::
+Hardware configuration
+----------------------
- sudo docker pull opnfv/qtip
+Qtip does not have specific hardware requriements, and it can runs over any
+OPNFV installer.
-Verify that opnfv/qtip has been downloaded. It should be listed as an image by running the following command.
-::
- sudo docker images
+Jumphost configuration
+----------------------
-Run the Docker instance:
+Installer Docker on Jumphost, which is used for running Qtip image.
+
+The first step is to install docker:
::
- docker run opnfv/qtip -i -t bash
+ sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80
+ --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
-Now you are in the container and QTIP can be found in the /repos/qtip and can be navigated to using the following command.
+Add an entry for your Ubuntu operating system:
::
- cd repos/qtip
+ Open the /etc/apt/sources.list.d/docker.list file in your favorite editor.
+If the file doesn’t exist, create it.
-OpenStack parameters and credentials
-------------------------------------
+Remove any existing entries.
+Add an entry for your Ubuntu operating system.
-Environment variables
-^^^^^^^^^^^^^^^^^^^^^
-Before running QTIP it is necessary to export OpenStack environment variables
-from the OpenStack *openrc* file. This can be done by running the following command.
+On Ubuntu Trusty 14.04 (LTS)
::
- source get_env_info.sh -n {INSTALLER_TYPE} -i {INSTALLER_IP}
- source opnfv-creds.sh
+ deb https://apt.dockerproject.org/repo ubuntu-trusty main
-This provides a ``opnfv-creds.sh`` file which can be sources to get the environment variables.
-For running QTIP manually, it is also necessary to export the installer type. ::
+Update the package manager
+::
- export INSTALLER_TYPE="{installer-type}"
+ sudo apt-get update
-QTIP default key pair
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-QTIP uses a SSH key pair to connect to the guest image. This key pair can
-be found in the ``data/`` directory.
+Install Docker:
+::
-Examples
---------
-QTIP Has been made with the intention of requiring minimal interaction from the user.
+ sudo apt-get install docker-engine
+
+Starting Docker Daemon:
+::
+
+ sudo service docker start
+
+
+Platform components configuration
+---------------------------------
+Describe the configuration of each component in the installer
+++ /dev/null
-Introduction
-============
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-.. these two pipes are to seperate the logo from the first title
-
-|
-
-**Welcome to QTIP's documentation !**
-
-.. _QTIP: https://wiki.opnfv.org/platform_performance_benchmarking
-
-QTIP_ is an OPNFV Project.
-
-QTIP aims to benchmark OPNFV platforms through a "Bottom up" approach, testing bare-metal components first.
-
-The overall problem this project tries to solve is the general characterization of an OPNFV platform.
-It will focus on general performance questions that are common to the platform itself, or applicable to multiple OPNFV use cases.
-QTIP will provide the capability to quantify a platform's performance behavior in a standardized, rigorous, and open way.
-
-The *QTIP* framework is deployed in the Dell OPNFV community lab. It is
-infrastructure and application independent.
-
-.. _Pharos: https://wiki.opnfv.org/pharos
-.. seealso:: Pharos_ for information on OPNFV community labs.
-
-**Contact QTIP**
-
-Feedback? `Contact us`_
-
-.. _Contact us: opnfv-users@lists.opnfv.org
-
Code Review / qtip.git / commitdiff