From 641b9d1333d4dbf6c31dab32ea4a41d726ee7987 Mon Sep 17 00:00:00 2001 From: Baohua Yang Date: Thu, 25 Feb 2016 10:22:10 +0800 Subject: [PATCH] Update the Running Kuryr part doc Change-Id: Ib7875fe2424829d271a01d4b605bad187fd89384 --- README.rst | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index dd5dfd5e..6186ccd6 100644 --- a/README.rst +++ b/README.rst @@ -37,15 +37,25 @@ Prerequisites Running Kuryr ------------- -Please run the following script, it creates ``/usr/lib/docker/plugins/kuryr`` -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 `_ to run. +Currently, Kuryr utilizes a bash script to start the service. :: $ 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 `_ to run. + Testing Kuryr ------------- @@ -60,8 +70,8 @@ the *fullstack* test case. $ tox -e fullstack -Generate Documentation ----------------------- +Generating Documentation +------------------------ We use `Sphinx `_ to maintain the