Make corrections to the docker install documentation

A few typos were fixed in the documentation about how to run Dragonflow
in a docker, while not running the controller service.

Change-Id: I38076f0b3cbcc151c718a3f81d5837644a3d869c
Co-Authored-By: Omer Anson <omer.anson@toganetworks.com>
Partially-Implements: blueprint add-dragonflow-api
This commit is contained in:
Shachar Snapiri 2018-11-12 09:02:02 +02:00 committed by Shachar Snapiri
parent 56c7d93ef1
commit 20bf8ae88d
1 changed files with 22 additions and 18 deletions

View File

@ -80,28 +80,32 @@ these files using e.g.
`-v local-dragonflow-conf.ini:/etc/dragonflow/dragonflow.ini`.
Running the container without the controller service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The docker entrypoint accepts verbs. To start the container without the
controller service, use the verb `bash`.
.. code-block:: bash
docker run --name dragonflow --net $DRAGONFLOW_NET_NAME --ip ${DRAGONFLOW_ADDRESS} -i -t dragonflow:latest --dragonflow_address ${DRAGONFLOW_ADDRESS} --db_address ${NODE1}:2379 bash
This enables you to run the container without running the container service.
This is useful in order to create a standalone node for Dragonflow API,
separated from the controller node.
Running a REST API Service
~~~~~~~~~~~~~~~~~~~~~~~~~~
To start a REST API service, running on HTTP port 8080, use the verb `rest`.
The docker entrypoint accepts verbs. To start the container with the REST API
service, running on HTTP port 8080, use the verb `rest`.
.. code-block:: bash
docker run --name dragonflow --net $DRAGONFLOW_NET_NAME --ip ${DRAGONFLOW_ADDRESS} -i -t dragonflow:latest --dragonflow_address ${DRAGONFLOW_ADDRESS} --db_address ${NODE1}:2379 rest
export DRAGONFLOW_IP=172.18.0.4 # Any free IP in the subnet
docker run --name dragonflow-rest --net $DRAGONFLOW_NET_NAME --ip ${DRAGONFLOW_IP} -i -t dragonflow:latest --dragonflow_ip ${DRAGONFLOW_IP} --db_ip ${NODE1}:2379 rest
The schema would be available on `http://$DRAGONFLOW_IP:8080/schema.json`.
Running the container without the any service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The docker entrypoint accepts verbs. To start the container without any
service, use the verb `bash`.
.. code-block:: bash
export DRAGONFLOW_IP=172.18.0.5 # Any free IP in the subnet
docker run --name dragonflow-bash --net $DRAGONFLOW_NET_NAME --ip ${DRAGONFLOW_IP} -i -t dragonflow:latest --dragonflow_ip ${DRAGONFLOW_IP} --db_ip ${NODE1}:2379 bash
This will start the container with the Dragonflow installed, but no service.
This is useful in order to test any standalone binaries or code that should
use the Dragonflow as a library, separated from the controller node.
The schema would be available on `http://$DRAGONFLOW_ADDRESS:8080/schema.json`.