summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/03-installation.rst
diff options
context:
space:
mode:
authorLuc Provoost <luc.provoost@intel.com>2020-12-02 12:33:58 +0100
committerLuc Provoost <luc.provoost@intel.com>2020-12-02 12:33:58 +0100
commit9239a15e4ae0a2aaa29f3bb726f3ac196347c962 (patch)
treea431574d0352617452c8659747dc00c76c72cbff /docs/testing/user/userguide/03-installation.rst
parentb62841c716325a984bb412bf66880d9b5b2b7958 (diff)
More documentation updates
Added 04-running_the_test.rst describing how to change the default test. This section is describing the parameters the parameters you can use and how to change the Dockerfile and the testcases.yaml file. Change-Id: Ieaa173ebc61dd320659ca6be3d2ce31684298d42 Signed-off-by: Luc Provoost <luc.provoost@intel.com>
Diffstat (limited to 'docs/testing/user/userguide/03-installation.rst')
-rw-r--r--docs/testing/user/userguide/03-installation.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/testing/user/userguide/03-installation.rst b/docs/testing/user/userguide/03-installation.rst
index 87bd9a9d..661fc7ad 100644
--- a/docs/testing/user/userguide/03-installation.rst
+++ b/docs/testing/user/userguide/03-installation.rst
@@ -74,7 +74,7 @@ Step 1: Identify a machine on which you will install the containers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This machine will needs enough resource to install the Xtesting framework and needs to be enabled
for containers.
-Form a network point of view, it will need to have access to the PROX instances: That means it will need
+From a network point of view, it will need to have access to the PROX instances: That means it will need
to be able to ssh into these machines and that the network also needs to allow for TCP port 8474 traffic.
When using the automation to create the VM through the Heat Stack API, this machine also needs to be able
@@ -83,6 +83,7 @@ this will involve some manual file copying.
Step 2: Clone the samplevnf project on that machine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
.. code-block:: console
git clone https://git.opnfv.org/samplevnf
@@ -97,6 +98,7 @@ will have all information needed to run the actual test. You can do this step ma
platforms (OpenStack, VMWare, K8s, bare metal, ...), but the automation tools described in the rest of this
paragraph will using OpenStack Heat yaml files.
First, a PROX qcow2 image needs to be downloaded.
+
.. code-block:: console
wget http://artifacts.opnfv.org/samplevnf/jerma/prox_jerma.qcow2
@@ -104,12 +106,14 @@ First, a PROX qcow2 image needs to be downloaded.
This image can also be created mannualy by following instructions in https://wiki.opnfv.org/display/SAM/Rapid+scripting,
in the section "Creating an image"
Now upload this image to Openstack:
+
.. code-block:: console
openstack image` create --disk-format qcow2 --container-format bare --file prox_jerma.qcow2 rapidVM
Now run createrapid.sh to create the stack. This process takes the config_file as input. Details can be found in
https://wiki.opnfv.org/display/SAM/Rapid+scripting, in the section "Deploying the VMs"
+
.. code-block:: console
./createrapid.sh
@@ -121,6 +125,7 @@ Step 4: Deploy your own Xtesting toolchain
Install Xtesting as described in https://xtesting.readthedocs.io/en/latest/
First goto the xtesting directory in samplevnf/VNFs/DPPD-PROX/helper-scripts/rapid/xtesting (this was cloned
in step 2)
+
.. code-block:: console
virtualenv xtesting
@@ -136,15 +141,17 @@ Step 5: Build the test container that will drive the TST009 testing
Go to the directory samplevnf/VNFs/DPPD-PROX/helper-scripts/rapid/xtesting
While building this container, some files will be copied into the container image. Two of these files
are generated by Step 3: rapid.env and rapid_key.pem and reside in the samplevnf/VNFs/DPPD-PROX/helper-scripts/rapid/.
-PLease copy them into the xtesting directory.
+Please copy them into the xtesting directory.
The 3rd file that will be copied is testcases.yaml. You might want to modify this file according to the testing you would
like to execute.
+
.. code-block:: console
docker build -t 127.0.0.1:5000/rapidxt .
Step 6: Publish your container on your local repository
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
.. code-block:: console
docker push 127.0.0.1:5000/rapidxt