summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-31 14:30:19 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-03-31 14:30:19 +0000
commit1989a58cdda62c8f3ecf77c7077a63eed9654854 (patch)
tree89add622726bc3573c77d316dca950ebc25d5e2a
parentd635f6dd96a6cc82ae8380b308eb75eb7d1a7186 (diff)
parent4f6c21642d76a1b64d25e8498003bdd4cab7960e (diff)
Merge "Add guide for exposing api port during docker run"
-rw-r--r--docs/testing/user/configguide/configuration.rst2
-rw-r--r--docs/testing/user/userguide/api.rst3
2 files changed, 2 insertions, 3 deletions
diff --git a/docs/testing/user/configguide/configuration.rst b/docs/testing/user/configguide/configuration.rst
index 0ca7ae8c..f048558e 100644
--- a/docs/testing/user/configguide/configuration.rst
+++ b/docs/testing/user/configguide/configuration.rst
@@ -41,7 +41,7 @@ Run and enter the docker instance
::
envs="INSTALLER_TYPE={INSTALLER_TYPE} -e INSTALLER_IP={INSTALLER_IP}"
- docker run --name qtip -id -e $envs opnfv/qtip
+ docker run -p [HOST_IP:]<HOST_PORT>:5000 --name qtip -id -e $envs opnfv/qtip
docker exec -i -t qtip /bin/bash
``INSTALLER_TYPE`` should be one of OPNFV installer, e.g. apex, compass, daisy, fuel
diff --git a/docs/testing/user/userguide/api.rst b/docs/testing/user/userguide/api.rst
index 7e1d7b1c..05b0e8f2 100644
--- a/docs/testing/user/userguide/api.rst
+++ b/docs/testing/user/userguide/api.rst
@@ -19,8 +19,7 @@ Running
After installing QTIP. API server can be run using command ``qtip-api`` on the local machine.
-All the resources and their corresponding operation details can be seen at ``/v1.0/ui``,
-on hosting server(``0.0.0.0:5000`` for the local machine).
+All the resources and their corresponding operation details can be seen at ``/v1.0/ui``.
The whole API specification in json format can be seen at ``/v1.0/swagger.json``.