diff options
Diffstat (limited to 'docs/testing/user/userguide/03-installation.rst')
| -rw-r--r-- | docs/testing/user/userguide/03-installation.rst | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/testing/user/userguide/03-installation.rst b/docs/testing/user/userguide/03-installation.rst index 661fc7ad..8fb89744 100644 --- a/docs/testing/user/userguide/03-installation.rst +++ b/docs/testing/user/userguide/03-installation.rst @@ -5,6 +5,8 @@ SampleVNF Installation ====================== +.. _RapidScripting: https://wiki.opnfv.org/display/SAM/Rapid+scripting +.. _XtestingDocumentation: https://xtesting.readthedocs.io/en/latest/ Abstract -------- @@ -72,13 +74,13 @@ Installation Steps 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 +This machine will need enough resources to install the Xtesting framework and needs to be enabled for containers. 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 -execute the OpenStack API. Alternatively, the creation of the VMs can be executed on another machine, but +to execute the OpenStack API. Alternatively, the creation of the VMs can be executed on another machine, but this will involve some manual file copying. Step 2: Clone the samplevnf project on that machine @@ -103,16 +105,16 @@ First, a PROX qcow2 image needs to be downloaded. wget http://artifacts.opnfv.org/samplevnf/jerma/prox_jerma.qcow2 -This image can also be created mannualy by following instructions in https://wiki.opnfv.org/display/SAM/Rapid+scripting, +This image can also be created mannualy by following instructions in RapidScripting_, 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 + 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" +RapidScripting_, in the section "Deploying the VMs" .. code-block:: console @@ -122,7 +124,7 @@ At the end of this step, VMs should be running and the rapid.env and rapid_key.p Step 4: Deploy your own Xtesting toolchain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Install Xtesting as described in https://xtesting.readthedocs.io/en/latest/ +Install Xtesting as described in XtestingDocumentation_. First goto the xtesting directory in samplevnf/VNFs/DPPD-PROX/helper-scripts/rapid/xtesting (this was cloned in step 2) @@ -142,8 +144,7 @@ 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. -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. +The 3rd file that will be copied is testcases.yaml. .. code-block:: console |