summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorakhilbatra898 <akhil.batra@research.iiit.ac.in>2017-03-31 16:10:21 +0530
committerakhilbatra898 <akhil.batra@research.iiit.ac.in>2017-03-31 16:17:50 +0530
commit4f6c21642d76a1b64d25e8498003bdd4cab7960e (patch)
treeb86f9a3c064c918a79a38ba9132634e8a57e08bf
parent6fec5a5cc7fbaf115c59ac5b3b3f3fabfe940e4c (diff)
Add guide for exposing api port during docker run
Change-Id: I5dcc98ac02051f509c4714c6ea849f642dcae9d5 Signed-off-by: akhilbatra898 <akhil.batra@research.iiit.ac.in>
-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``.