diff --git a/README.rst b/README.rst index af6ee368..fb182dfe 100644 --- a/README.rst +++ b/README.rst @@ -40,9 +40,7 @@ Prerequisites Installing Kuryr's libnetwork driver ------------------------------------ -Running the following will grab the requirements and install kuryr - -:: +Running the following will grab the requirements and install kuryr:: $ sudo pip install . @@ -50,23 +48,17 @@ Running the following will grab the requirements and install kuryr Configuring Kuryr ----------------- -Generate sample config, `etc/kuryr.conf.sample`, running the following - -:: +Generate sample config, `etc/kuryr.conf.sample`, running the following:: $ tox -e genconfig -Rename and copy config file at required path - -:: +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: - -:: +Edit keystone section in `/etc/kuryr/kuryr.conf`, replace ADMIN_PASSWORD:: auth_uri = http://127.0.0.1:35357/v2.0 admin_user = admin @@ -75,9 +67,7 @@ Edit keystone section in `/etc/kuryr/kuryr.conf`, replace ADMIN_PASSWORD: In the same file uncomment the `bindir` parameter with the path for the Kuryr -vif binding executables: - -:: +vif binding executables:: bindir = /usr/local/libexec/kuryr @@ -86,19 +76,15 @@ Running Kuryr ------------- Currently, Kuryr utilizes a bash script to start the service. Make sure that -you have installed `tox` before the execution of the below command. - -:: +you have installed `tox` before the execution of the command below:: $ sudo ./scripts/run_kuryr.sh -After the booting, please restart your Docker service, e.g., - -:: +After Kuryr starts, please restart your Docker service, e.g.:: $ sudo service docker restart -The bash script creates the following file if it is missing. +The bash script creates the following file if it is missing: * ``/usr/lib/docker/plugins/kuryr/kuryr.json``: Json spec file for libnetwork. @@ -108,9 +94,7 @@ with `pyroute2 `_ to run. Testing Kuryr ------------- -For a quick check that Kuryr is working create a network: - -:: +For a quick check that Kuryr is working, create a network:: $ docker network create --driver kuryr test_net 785f8c1b5ae480c4ebcb54c1c48ab875754e4680d915b270279e4f6a1aa52283 @@ -118,16 +102,12 @@ For a quick check that Kuryr is working create a network: NETWORK ID NAME DRIVER 785f8c1b5ae4 test_net kuryr -To test it with tox: - -:: +To test it with tox:: $ tox You can also run specific test cases using the ``-e`` flag, e.g., to only run -the *fullstack* test case. - -:: +the *fullstack* test case:: $ tox -e fullstack @@ -136,9 +116,7 @@ Generating Documentation We use `Sphinx `_ to maintain the -documentation. You can install Sphinx using pip. - -:: +documentation. You can install Sphinx using pip:: $ pip install -U Sphinx @@ -149,17 +127,13 @@ In addition to Sphinx you will also need the following requirements The source code of the documentation are under *doc*, you can generate the html files using the following command. If the generation succeeds,a -*build/html* dir will be created under *doc*. - -:: +*build/html* dir will be created under *doc*:: $ cd doc $ make html Now you can serve the documentation at http://localhost:8080 as a simple -website. - -:: +website:: $ cd build/html $ python -m SimpleHTTPServer 8080 @@ -170,9 +144,7 @@ Limitations To create Docker networks with subnets having same/overlapping cidr, it is expected to pass unique pool name for each such network creation Docker command. Docker cli options -o and --ipam-opt should be used to pass pool -names as shown below: - -:: +names as shown below:: $ sudo docker network create --driver=kuryr --ipam-driver=kuryr \ --subnet 10.0.0.0/16 --ip-range 10.0.0.0/24 \ @@ -182,9 +154,7 @@ names as shown below: eddb51ebca09339cb17aaec05e48ffe60659ced6f3fc41b020b0eb506d364 Now Docker user creates another network with same cidr as the previous one, -i.e 10.0.0.0/16, but with different pool name, neutron_pool2: - -:: +i.e 10.0.0.0/16, but with different pool name, neutron_pool2:: $ sudo docker network create --driver=kuryr --ipam-driver=kuryr \ --subnet 10.0.0.0/16 --ip-range 10.0.0.0/24 \