Update the Running Kuryr part doc
Change-Id: Ib7875fe2424829d271a01d4b605bad187fd89384
This commit is contained in:
parent
eac8baa53c
commit
641b9d1333
22
README.rst
22
README.rst
|
@ -37,15 +37,25 @@ Prerequisites
|
||||||
Running Kuryr
|
Running Kuryr
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
Please run the following script, it creates ``/usr/lib/docker/plugins/kuryr``
|
Currently, Kuryr utilizes a bash script to start the service.
|
||||||
and the JSON spec file, ``/usr/lib/docker/plugins/kuryr/kuryr.json``, if they
|
|
||||||
don't exist. Kuryr requires the root privilege for creating and deleting the
|
|
||||||
veth pairs with `pyroute2 <http://docs.pyroute2.org/>`_ to run.
|
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
$ sudo ./scripts/run_kuryr.sh
|
$ sudo ./scripts/run_kuryr.sh
|
||||||
|
|
||||||
|
After the booting, please restart your Docker service, e.g.,
|
||||||
|
|
||||||
|
::
|
||||||
|
$ sudo service docker restart
|
||||||
|
|
||||||
|
The bash script creates the following files if they are missing.
|
||||||
|
|
||||||
|
* ``/usr/lib/docker/plugins/kuryr/kuryr.json``: Json spec file for libnetwork;
|
||||||
|
* ``/etc/kuryr/kuryr.conf``: Configuration file for Kuryr.
|
||||||
|
|
||||||
|
Note the root privilege is required for creating and deleting the veth pairs
|
||||||
|
with `pyroute2 <http://docs.pyroute2.org/>`_ to run.
|
||||||
|
|
||||||
Testing Kuryr
|
Testing Kuryr
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
@ -60,8 +70,8 @@ the *fullstack* test case.
|
||||||
|
|
||||||
$ tox -e fullstack
|
$ tox -e fullstack
|
||||||
|
|
||||||
Generate Documentation
|
Generating Documentation
|
||||||
----------------------
|
------------------------
|
||||||
|
|
||||||
|
|
||||||
We use `Sphinx <https://pypi.python.org/pypi/Sphinx>`_ to maintain the
|
We use `Sphinx <https://pypi.python.org/pypi/Sphinx>`_ to maintain the
|
||||||
|
|
Loading…
Reference in New Issue