summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/testing/user/userguide')
-rw-r--r--docs/testing/user/userguide/04-installation.rst30
-rw-r--r--docs/testing/user/userguide/15-list-of-tcs.rst6
-rw-r--r--docs/testing/user/userguide/index.rst6
-rw-r--r--docs/testing/user/userguide/opnfv_yardstick_tc002.rst4
-rw-r--r--docs/testing/user/userguide/opnfv_yardstick_tc044.rst2
-rw-r--r--docs/testing/user/userguide/opnfv_yardstick_tc078.rst3
-rw-r--r--docs/testing/user/userguide/opnfv_yardstick_tc080.rst117
-rw-r--r--docs/testing/user/userguide/opnfv_yardstick_tc081.rst122
8 files changed, 261 insertions, 29 deletions
diff --git a/docs/testing/user/userguide/04-installation.rst b/docs/testing/user/userguide/04-installation.rst
index cb4f31434..b40e1143e 100644
--- a/docs/testing/user/userguide/04-installation.rst
+++ b/docs/testing/user/userguide/04-installation.rst
@@ -82,7 +82,7 @@ following docker command::
Run the Docker image to get a Yardstick container::
- docker run -itd --privileged -v /var/run/docker.sock:/var/run/docker.sock -p 8888:5000 -e INSTALLER_IP=192.168.200.2 -e INSTALLER_TYPE=compass --name yardstick opnfv/yardstick:stable
+ docker run -itd --privileged -v /var/run/docker.sock:/var/run/docker.sock -p 8888:5000 --name yardstick opnfv/yardstick:stable
Note:
@@ -101,21 +101,6 @@ Note:
| | Yardstick container, this |
| | parameter is needed. |
+----------------------------------------------+------------------------------+
-| -e INSTALLER_IP=192.168.200.2 | If you want to use yardstick |
-| | env prepare command(or |
-| -e INSTALLER_TYPE=compass | related API) to load the |
-| | images that Yardstick needs, |
-| | these parameters should be |
-| | provided. |
-| | The INSTALLER_IP and |
-| | INSTALLER_TYPE are depending |
-| | on your OpenStack installer. |
-| | Currently Apex, Compass, |
-| | Fuel and Joid are supported. |
-| | If you use other installers, |
-| | such as devstack, these |
-| | parameters can be ignores. |
-+----------------------------------------------+------------------------------+
| -p 8888:5000 | If you want to call |
| | Yardstick API out of |
| | Yardstick container, this |
@@ -149,11 +134,11 @@ In the Yardstick container, the Yardstick repository is located in the ``/home/o
yardstick env prepare
-**NOTE**: The above command works for four OPNFV installers -- **Apex**, **Compass**, **Fuel** and **Joid**.
-For Non-OPNFV installer OpenStack environment, the above command can also be used to configure the environment.
-But before running the above command in a Non-OPNFV installer environment, it is necessary to create the /etc/yardstick/openstack.creds file and
-save OpenStack environment variables in it. For details of the required OpenStack environment variables please refer to
-section **Export OpenStack environment variables**
+**NOTE**: Since Euphrates release, the above command will not able to automatically configure the /etc/yardstick/openstack.creds file.
+So before running the above command, it is necessary to create the /etc/yardstick/openstack.creds file and save OpenStack environment variables into it manually.
+If you have the openstack credential file saved outside the Yardstcik Docker container, you can do this easily by mapping the credential file into Yardstick container
+ using '-v /path/to/credential_file:/etc/yardstick/openstack.creds' when running the Yardstick container.
+For details of the required OpenStack environment variables please refer to section **Export OpenStack environment variables**
The env prepare command may take up to 6-8 minutes to finish building
yardstick-image and other environment preparation. Meanwhile if you wish to
@@ -647,4 +632,5 @@ yaml file and add test cases, constraint or task arguments if necessary.
Proxy Support (**Todo**)
---------------------------- \ No newline at end of file
+---------------------------
+
diff --git a/docs/testing/user/userguide/15-list-of-tcs.rst b/docs/testing/user/userguide/15-list-of-tcs.rst
index 1b5806cd9..b62bf6390 100644
--- a/docs/testing/user/userguide/15-list-of-tcs.rst
+++ b/docs/testing/user/userguide/15-list-of-tcs.rst
@@ -50,8 +50,14 @@ Generic NFVI Test Case Descriptions
opnfv_yardstick_tc071.rst
opnfv_yardstick_tc072.rst
opnfv_yardstick_tc073.rst
+ opnfv_yardstick_tc074.rst
opnfv_yardstick_tc075.rst
opnfv_yardstick_tc076.rst
+ opnfv_yardstick_tc078.rst
+ opnfv_yardstick_tc079.rst
+ opnfv_yardstick_tc080.rst
+ opnfv_yardstick_tc081.rst
+ opnfv_yardstick_tc083.rst
OPNFV Feature Test Cases
========================
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index 3b55b7f9b..707e12b56 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -5,9 +5,9 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Ericsson AB and others.
-===========================================
-Performance Testing User Guide (Yardstick)
-===========================================
+********************
+Yardstick User Guide
+********************
.. toctree::
:maxdepth: 4
diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc002.rst b/docs/testing/user/userguide/opnfv_yardstick_tc002.rst
index c98780fd5..bf2466fb2 100644
--- a/docs/testing/user/userguide/opnfv_yardstick_tc002.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc002.rst
@@ -106,8 +106,8 @@ Yardstick Test Case Description TC002
| | |
+--------------+--------------------------------------------------------------+
|step 2 | Yardstick is connected with the server VM by using ssh. |
-| | 'ping_benchmark' bash script is copyied from Jump Host to |
-| | the server VM via the ssh tunnel. |
+| | 'ping_benchmark' bash script is copied from Jump Host to the |
+| | server VM via the ssh tunnel. |
| | |
+--------------+--------------------------------------------------------------+
|step 3 | Ping is invoked. Ping packets are sent from server VM to |
diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc044.rst b/docs/testing/user/userguide/opnfv_yardstick_tc044.rst
index 2be8517a1..8db45e1d4 100644
--- a/docs/testing/user/userguide/opnfv_yardstick_tc044.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc044.rst
@@ -7,7 +7,7 @@
Yardstick Test Case Description TC044
*************************************
-.. _man-pages: http://manpages.ubuntu.com/manpages/trusty/en/man1/free.1.html
+.. _man-pages: http://manpages.ubuntu.com/manpages/xenial/en/man1/free.1.html
+-----------------------------------------------------------------------------+
|Memory Utilization |
diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc078.rst b/docs/testing/user/userguide/opnfv_yardstick_tc078.rst
index 560d55e07..b5a6545ba 100644
--- a/docs/testing/user/userguide/opnfv_yardstick_tc078.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc078.rst
@@ -114,7 +114,8 @@ Yardstick Test Case Description TC078
|step 3 | Yardstick is connected with the target server by using ssh. |
| | If custom runspec config file is used, this file is copyied |
| | from yardstick to the target server via the ssh tunnel. |
---------------+---------------------------------------------------------------+
+| | |
++--------------+--------------------------------------------------------------+
|step 4 | SPEC CPU2006 benchmark is invoked and SPEC CPU 2006 metrics |
| | are generated. |
| | |
diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc080.rst b/docs/testing/user/userguide/opnfv_yardstick_tc080.rst
new file mode 100644
index 000000000..05eca502e
--- /dev/null
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc080.rst
@@ -0,0 +1,117 @@
+.. 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.
+
+*************************************
+Yardstick Test Case Description TC080
+*************************************
+
+.. _Ping: https://linux.die.net/man/8/ping
+
++-----------------------------------------------------------------------------+
+|Network Latency |
+| |
++--------------+--------------------------------------------------------------+
+|test case id | OPNFV_YARDSTICK_TC080_NETWORK_LATENCY_BETWEEN_CONTAINER |
+| | |
++--------------+--------------------------------------------------------------+
+|metric | RTT (Round Trip Time) |
+| | |
++--------------+--------------------------------------------------------------+
+|test purpose | The purpose of TC080 is to do a basic verification that |
+| | network latency is within acceptable boundaries when packets |
+| | travel between containers located in two different |
+| | Kubernetes pods. |
+| | |
+| | The purpose is also to be able to spot the trends. |
+| | Test results, graphs and similar shall be stored for |
+| | comparison reasons and product evolution understanding |
+| | between different OPNFV versions and/or configurations. |
+| | |
++--------------+--------------------------------------------------------------+
+|test tool | ping |
+| | |
+| | Ping is a computer network administration software utility |
+| | used to test the reachability of a host on an Internet |
+| | Protocol (IP) network. It measures the round-trip time for |
+| | packet sent from the originating host to a destination |
+| | computer that are echoed back to the source. |
+| | |
+| | Ping is normally part of any Linux distribution, hence it |
+| | doesn't need to be installed. It is also part of the |
+| | Yardstick Docker image. |
+| | |
++--------------+--------------------------------------------------------------+
+|test topology | Ping packets (ICMP protocol's mandatory ECHO_REQUEST |
+| | datagram) are sent from host container to target container |
+| | to elicit ICMP ECHO_RESPONSE. |
+| | |
++--------------+--------------------------------------------------------------+
+|configuration | file: opnfv_yardstick_tc080.yaml |
+| | |
+| | Packet size 200 bytes. Test duration 60 seconds. |
+| | SLA RTT is set to maximum 10 ms. |
+| | |
++--------------+--------------------------------------------------------------+
+|applicability | This test case can be configured with different: |
+| | |
+| | * packet sizes; |
+| | * burst sizes; |
+| | * ping intervals; |
+| | * test durations; |
+| | * test iterations. |
+| | |
+| | Default values exist. |
+| | |
+| | SLA is optional. The SLA in this test case serves as an |
+| | example. Considerably lower RTT is expected, and also normal |
+| | to achieve in balanced L2 environments. However, to cover |
+| | most configurations, both bare metal and fully virtualized |
+| | ones, this value should be possible to achieve and |
+| | acceptable for black box testing. Many real time |
+| | applications start to suffer badly if the RTT time is higher |
+| | than this. Some may suffer bad also close to this RTT, while |
+| | others may not suffer at all. It is a compromise that may |
+| | have to be tuned for different configuration purposes. |
+| | |
++--------------+--------------------------------------------------------------+
+|usability | This test case should be run in Kunernetes environment. |
+| | |
++--------------+--------------------------------------------------------------+
+|references | Ping_ |
+| | |
+| | ETSI-NFV-TST001 |
+| | |
++--------------+--------------------------------------------------------------+
+|pre-test | The test case Docker image (openretriever/yardstick) needs |
+|conditions | to be pulled into Kubernetes environment. |
+| | |
+| | No further requirements have been identified. |
+| | |
++--------------+--------------------------------------------------------------+
+|test sequence | description and expected result |
+| | |
++--------------+--------------------------------------------------------------+
+|step 1 | Two containers are booted, as server and client. |
+| | |
++--------------+--------------------------------------------------------------+
+|step 2 | Yardstick is connected with the server container by using |
+| | ssh. 'ping_benchmark' bash script is copied from Jump Host |
+| | to the server container via the ssh tunnel. |
+| | |
++--------------+--------------------------------------------------------------+
+|step 3 | Ping is invoked. Ping packets are sent from server container |
+| | to client container. RTT results are calculated and checked |
+| | against the SLA. Logs are produced and stored. |
+| | |
+| | Result: Logs are stored. |
+| | |
++--------------+--------------------------------------------------------------+
+|step 4 | Two containers are deleted. |
+| | |
++--------------+--------------------------------------------------------------+
+|test verdict | Test should not PASS if any RTT is above the optional SLA |
+| | value, or if there is a test case execution problem. |
+| | |
++--------------+--------------------------------------------------------------+
diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc081.rst b/docs/testing/user/userguide/opnfv_yardstick_tc081.rst
new file mode 100644
index 000000000..90af8a382
--- /dev/null
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc081.rst
@@ -0,0 +1,122 @@
+.. 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.
+
+*************************************
+Yardstick Test Case Description TC080
+*************************************
+
+.. _cirros-image: https://download.cirros-cloud.net
+.. _Ping: https://linux.die.net/man/8/ping
+
++-----------------------------------------------------------------------------+
+|Network Latency |
+| |
++--------------+--------------------------------------------------------------+
+|test case id | OPNFV_YARDSTICK_TC081_NETWORK_LATENCY_BETWEEN_CONTAINER_AND_ |
+| | VM |
+| | |
++--------------+--------------------------------------------------------------+
+|metric | RTT (Round Trip Time) |
+| | |
++--------------+--------------------------------------------------------------+
+|test purpose | The purpose of TC080 is to do a basic verification that |
+| | network latency is within acceptable boundaries when packets |
+| | travel between a containers and a VM. |
+| | |
+| | The purpose is also to be able to spot the trends. |
+| | Test results, graphs and similar shall be stored for |
+| | comparison reasons and product evolution understanding |
+| | between different OPNFV versions and/or configurations. |
+| | |
++--------------+--------------------------------------------------------------+
+|test tool | ping |
+| | |
+| | Ping is a computer network administration software utility |
+| | used to test the reachability of a host on an Internet |
+| | Protocol (IP) network. It measures the round-trip time for |
+| | packet sent from the originating host to a destination |
+| | computer that are echoed back to the source. |
+| | |
+| | Ping is normally part of any Linux distribution, hence it |
+| | doesn't need to be installed. It is also part of the |
+| | Yardstick Docker image. (For example also a Cirros image can |
+| | be downloaded from cirros-image_, it includes ping) |
+| | |
++--------------+--------------------------------------------------------------+
+|test topology | Ping packets (ICMP protocol's mandatory ECHO_REQUEST |
+| | datagram) are sent from host container to target vm to |
+| | elicit ICMP ECHO_RESPONSE. |
+| | |
++--------------+--------------------------------------------------------------+
+|configuration | file: opnfv_yardstick_tc081.yaml |
+| | |
+| | Packet size 200 bytes. Test duration 60 seconds. |
+| | SLA RTT is set to maximum 10 ms. |
+| | |
++--------------+--------------------------------------------------------------+
+|applicability | This test case can be configured with different: |
+| | |
+| | * packet sizes; |
+| | * burst sizes; |
+| | * ping intervals; |
+| | * test durations; |
+| | * test iterations. |
+| | |
+| | Default values exist. |
+| | |
+| | SLA is optional. The SLA in this test case serves as an |
+| | example. Considerably lower RTT is expected, and also normal |
+| | to achieve in balanced L2 environments. However, to cover |
+| | most configurations, both bare metal and fully virtualized |
+| | ones, this value should be possible to achieve and |
+| | acceptable for black box testing. Many real time |
+| | applications start to suffer badly if the RTT time is higher |
+| | than this. Some may suffer bad also close to this RTT, while |
+| | others may not suffer at all. It is a compromise that may |
+| | have to be tuned for different configuration purposes. |
+| | |
++--------------+--------------------------------------------------------------+
+|usability | This test case should be run in Kunernetes environment. |
+| | |
++--------------+--------------------------------------------------------------+
+|references | Ping_ |
+| | |
+| | ETSI-NFV-TST001 |
+| | |
++--------------+--------------------------------------------------------------+
+|pre-test | The test case Docker image (openretriever/yardstick) needs |
+|conditions | to be pulled into Kubernetes environment. |
+| | The VM image (cirros-image) needs to be installed into |
+| | Glance with ping included in it. |
+| | |
+| | No further requirements have been identified. |
+| | |
++--------------+--------------------------------------------------------------+
+|test sequence | description and expected result |
+| | |
++--------------+--------------------------------------------------------------+
+|step 1 | A containers is booted, as server and a VM is booted as |
+| | client. |
+| | |
++--------------+--------------------------------------------------------------+
+|step 2 | Yardstick is connected with the server container by using |
+| | ssh. 'ping_benchmark' bash script is copied from Jump Host |
+| | to the server container via the ssh tunnel. |
+| | |
++--------------+--------------------------------------------------------------+
+|step 3 | Ping is invoked. Ping packets are sent from server container |
+| | to client VM. RTT results are calculated and checked against |
+| | the SLA. Logs are produced and stored. |
+| | |
+| | Result: Logs are stored. |
+| | |
++--------------+--------------------------------------------------------------+
+|step 4 | The container and VM are deleted. |
+| | |
++--------------+--------------------------------------------------------------+
+|test verdict | Test should not PASS if any RTT is above the optional SLA |
+| | value, or if there is a test case execution problem. |
+| | |
++--------------+--------------------------------------------------------------+