diff options
| author |   MatthewLi <matthew.lijun@huawei.com> | 2016-05-19 08:08:42 -0400 |
|---|---|---|
| committer | MatthewLi <matthew.lijun@huawei.com> | 2016-05-19 23:27:46 -0400 |
| commit | 1d20e865921d98243bc1fc400e692e0a9d056c50 (patch) | |
| tree | 2688e8b157fb178a9113e5b3be03678dcbdfa715 /docs/userguide | |
| parent | 29e463d40cc96396e3a158f6adb1ebcfaf3d29ba (diff) | |
CI docker image usage document improvement
JIRA: YARDSTICK-264
Change-Id: Ib330d134c81c793d1008e6c0d564640232793cbf
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/03-installation.rst | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/docs/userguide/03-installation.rst b/docs/userguide/03-installation.rst index f68c1d9d7..1a7495547 100644 --- a/docs/userguide/03-installation.rst +++ b/docs/userguide/03-installation.rst @@ -1,7 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International .. License. .. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. +.. (c) OPNFV, Ericsson AB, Huawei Technologies Co.,Ltd and others. Yardstick Installation ====================== @@ -155,7 +155,10 @@ Pull the Yardstick-CI Docker image from Docker hub: :: - docker pull opnfv/yardstick-ci + docker pull opnfv/yardstick:$DOCKER_TAG + +Where ``$DOCKER_TAG`` is latest for master branch, as for the release branches, +this coincides with its release name, such as brahmaputra.1.0. Run the Docker image: @@ -167,11 +170,15 @@ Run the Docker image: -t \ -e "INSTALLER_TYPE=${INSTALLER_TYPE}" \ -e "INSTALLER_IP=${INSTALLER_IP}" \ - opnfv/yardstick-ci \ - run_benchmarks - -Where ``${INSTALLER_TYPE}`` can be fuel, foreman or compass and ``${INSTALLER_IP}`` -is the installer master node IP address (i.e. 10.20.0.2 is default for fuel). + opnfv/yardstick \ + run_tests.sh ${YARDSTICK_DB_BACKEND} ${YARDSTICK_SUITE_NAME} + +Where ``${INSTALLER_TYPE}`` can be apex, compass, fuel or joid, ``${INSTALLER_IP}`` +is the installer master node IP address (i.e. 10.20.0.2 is default for fuel). ``${YARDSTICK_DB_BACKEND}`` +is the IP and port number of DB, ``${YARDSTICK_SUITE_NAME}`` is the test suite you want to run. +For more details, please refer to the Jenkins job defined in Releng project, labconfig information +and sshkey are required. See the link +https://git.opnfv.org/cgit/releng/tree/jjb/yardstick/yardstick-ci-jobs.yml. Basic steps performed by the **Yardstick-CI** container: |