From 43e6ae267cf4b61de9d7040e1585d3c9e59fcd11 Mon Sep 17 00:00:00 2001 From: vikaschoudhary16 Date: Thu, 9 Jun 2016 21:50:52 +0530 Subject: [PATCH] Fix ReadMe for config file generation info Change-Id: I5f49572aa324bf752766ed98e71ed3ff83e58f0e Closes-bug: #1590873 --- README.rst | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 779262f2..0ed5b6f5 100644 --- a/README.rst +++ b/README.rst @@ -45,6 +45,20 @@ Running the following will grab the requirements and install kuryr Configuring Kuryr ----------------- +Generate sample config, `etc/kuryr.conf.sample`, running the following + +:: + + $ tox -e genconfig + + +Rename and copy config file at required path + +:: + + $ cp etc/kuryr.conf.sample /etc/kuryr/kuryr.conf + + Edit keystone section in `/etc/kuryr/kuryr.conf`, replace ADMIN_PASSWORD: :: @@ -79,10 +93,9 @@ 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. +The bash script creates the following file if it is missing. -* ``/usr/lib/docker/plugins/kuryr/kuryr.json``: Json spec file for libnetwork; -* ``/etc/kuryr/kuryr.conf``: Configuration file for Kuryr. +* ``/usr/lib/docker/plugins/kuryr/kuryr.json``: Json spec file for libnetwork. Note the root privilege is required for creating and deleting the veth pairs with `pyroute2 `_ to run.