summaryrefslogtreecommitdiffstats
path: root/docs/installationprocedure/installation.instruction.rst
diff options
context:
space:
mode:
authorMatthewLi <matthew.lijun@huawei.com>2016-10-19 23:14:09 -0400
committerMatthewLi <matthew.lijun@huawei.com>2016-10-26 05:28:44 -0400
commit3203d94f6fafd051eb648c618502aeecdd723224 (patch)
treee85554e22e4480f4d4ac7788e88c5ef46faf37a5 /docs/installationprocedure/installation.instruction.rst
parent031045275eb6a05b9be05bee14456d0ca92ab5fb (diff)
dovetail tool: developer userguide document
JIRA: DOVETAIL-28 1) documents are reorganized, all dovetail tool related documents are moved to /docs/dovetailtool 2) some sections are rewritten to make it more clear Change-Id: Ib0c23b8c1771eb6de7d6cc264c101e8e26ed3d1f Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
Diffstat (limited to 'docs/installationprocedure/installation.instruction.rst')
-rw-r--r--docs/installationprocedure/installation.instruction.rst142
1 files changed, 0 insertions, 142 deletions
diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst
deleted file mode 100644
index aa1b436a..00000000
--- a/docs/installationprocedure/installation.instruction.rst
+++ /dev/null
@@ -1,142 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International
-.. License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
-
-=====================
-Dovetail Installation
-=====================
-
-Abstract
-========
-
-Dovetail currently supports installation on Ubuntu 14.04 or by using a docker image.
-Detailed steps about installing dovetail can be found below.
-
-To use dovetail you should have access to an OpenStack environment,
-with at least Nova, Neutron, Glance, Keystone and Heat installed.
-
-
-Run dovetail on local machine
-=============================
-
-The steps needed to run dovetail on Ubuntu are:
-
-1. Download source code and prepare environment.
-2. Create certification configuration file.
-3. Run certification.
-
-
-Download dovetail and prepare environment
------------------------------------------
-
-The source code of dovetail can be got from Gerrit:
-
-::
-
- git clone https://gerrit.opnfv.org/gerrit/dovetail
-
-After that you need to prepare the environment which means install some tools,
-modules and anything else dovetail needs. A file named ``prepare_env.py`` can
-do all of these for you.
-
-::
-
- cd dovetail/dovetail/
- python prepare_env.py
-
-Now the environment should be prepared for running the certification.
-
-Besides, you may want to install it in a python virtualenv, that is beyond the scope
-of this installation instruction.
-
-Create certification configuration file
----------------------------------------
-
-You can wirte a certification configuration file with the format of yaml,
-which can be defined to meet your own requirements. The yaml file should
-be located in the folder ``dovetail/dovetail/cert``. There provide a sample
-file named ``basic.yml``.
-
-::
-
- certification_basic:
- name: certification_basic
- testcase_list:
- - dovetail.ipv6.tc001
-
-As you can see, the configuration file combines the testcases you want to run
-together, and all of them should already been defined in ``dovetail/dovetail/testcase``.
-The name of the configuration file should be certification_%s, where %s (here is basic)
-can be used to run this certification.
-
-
-Run the certification
----------------------
-
-When you get the dovetail source code, prepare the environment and define the
-certification configuration file, you can then run the certification. Take
-certification_basic as the example. You can run it using the file ``run.py`` with
-basic (scenario name) as its argument.
-
-::
-
- python run.py --scenario basic
-
-If you did not give an argument, it will be default set as basic.
-
-
-Run dovetail on Docker container
-================================
-
-steps:
-1. pull image
-2. run container
-3. config
-4. run testcase
-
-pull image
-----------
-
-Get the latest docker image from docker hub.
-
-::
- sudo docker pull opnfv/dovetail:latest
-
-run container
--------------
-
-Start a container from the image that you just pulled.
-
-::
- sudo docker run -it --privileged=true -v /home/opnfv/dovetail/results:/home/opnfv/dovetail/results
- -v /var/run/docker.sock:/var/run/docker.sock opnfv/dovetail:latest "/bin/bash"
-
-config
-------
-
-For now, we need only change value of ``INSTALLER_TYPE`` and ``INSTALLER_IP``
-of the variable ``envs`` to your own environment.
-
-::
- sudo docker exec -it $(CONTAINER_ID) "/bin/bash"
- vi /home/opnfv/dovetail/dovetail/conf/functest_config.yml
- vi /home/opnfv/dovetail/dovetail/conf/yardstick_config.yml
-
-run testcase
-------------
-
-In docker, you just run following cmds to execute the testcase.
-
-::
- cd /home/opnfv/dovetail/dovetail
- python run.py
-
-
-
-
-Output
-======
-
-The running log is stored in ``/home/opnfv/dovetail/results/dovetail.log``.
-The report of certification is stored in ``/home/opnfv/dovetail/results/dovetail_report.txt``.