From 03211a2f055cb0aa92c5d2966b489f6da34649a9 Mon Sep 17 00:00:00 2001 From: Kamil Renczewski Date: Thu, 22 Jun 2017 15:10:03 +0200 Subject: [PATCH] Update documentation for Contrail installation Change-Id: I9b959d1bf468a1d0fd7ce06e4e55f1e903c30fea --- CONTRAIL.md | 27 ------- doc/source/installation/install_contrail.rst | 76 +++++++++++--------- 2 files changed, 44 insertions(+), 59 deletions(-) delete mode 100644 CONTRAIL.md diff --git a/CONTRAIL.md b/CONTRAIL.md deleted file mode 100644 index ddc4a38..0000000 --- a/CONTRAIL.md +++ /dev/null @@ -1,27 +0,0 @@ -Installation -============ - -Deploy Contrail Mechanism Driver --------------------------------- -Contrail Mechanism Driver code is available here: https://github.com/codilime/ContrailMechanismDriver. -Please follow the instructions there to deploy Contrail Mechanism Driver. - -Install Dependencies --------------------- -* https://github.com/Juniper/contrail-python-api -```bash -git clone https://github.com/Juniper/contrail-python-api -cd contrail-python-api -sudo python setup.py install -``` - -Configure Contrail Mechanism Driver ------------------------------------ -* In file `/etc/neutron/plugins/ml2/ml2_conf.ini` - * Make sure that in section *ml2* key *mechanism_drivers* have value **contrail_driver** in list -* In file `/opt/stack/neutron/neutron.egg-info/entry_points.txt` - * In section *neutron.ml2.mechanism_drivers* set key *contrail_driver* to **neutron.plugins.ml2.drivers.contrail_driver:ContrailMechanismDriver** - -Running -======= -Neutron service need to be restarted diff --git a/doc/source/installation/install_contrail.rst b/doc/source/installation/install_contrail.rst index 77218f9..f8d4425 100644 --- a/doc/source/installation/install_contrail.rst +++ b/doc/source/installation/install_contrail.rst @@ -21,42 +21,54 @@ ''''''' Heading 4 (Avoid deeper levels because they do not render well.) -============ -Installation -============ +===================== +Contrail Installation +===================== -Deploy Contrail Mechanism Driver --------------------------------- +Recommended way of having Contrail working with gluon is to install Contrail +on a separate node and configure it to use Keystone from Gluon's OpenStack. +Then deploy ContrailMechanismDriver on Gluon node. -Contrail Mechanism Driver code is available here: +This documment is instruction of how to configure ContrailMechanismDriver and +a summary of Contrail installation. Whole instruction is available here: +https://github.com/codilime/ContrailMechanismDriver. -.. code-block:: bash +#. Deploy Contrail Mechanism Driver + Contrail Mechanism Driver code is available here: + https://github.com/codilime/ContrailMechanismDriver. Clone repository - https://github.com/codilime/ContrailMechanismDriver. + .. code-block:: bash + + git clone https://github.com/codilime/ContrailMechanismDriver + + .. end + + then copy directory ``ContrailMechanismDriver/neutron`` into + ``/usr/lib/python2.7/dist-packages/``. +#. Install Dependencies -Please follow the instructions there to deploy Contrail Mechanism Driver. + * https://github.com/Juniper/contrail-python-api +#. Configure Contrail Mechanism Driver -Install Dependencies --------------------- + * In file ``/etc/neutron/plugins/ml2/ml2_conf.ini`` + - Make sure that in section ``[ml2]`` key ``mechanism_drivers`` have + value **contrail_driver** in list + - Add section ``[ml2_driver_contrail]`` and point to contrail controller + node + - In section ``[ml2_driver_contrail]`` key *controller* should contain + Contrail controller address (default is 127.0.0.1) + - In section ``[ml2_driver_contrail]`` key *port* should point to + Contrail controller listen port (default is 8082) + * Make sure that neutron-server reads ``ml2_conf.ini`` file during startup + (this might require to modify ``/etc/init.d/neutron-server`` file and + add ``--config-file=/etc/neutron/plugins/ml2/ml2_conf.ini`` to + :samp:`{DAEMON_ARGS}` variable + * In file ``entry_points.txt`` (location depends on neutron version and + OpenStack installation method) in section + *neutron.ml2.mechanism_drivers* + set key *contrail_driver* to + **neutron.plugins.ml2.drivers.contrail_driver:ContrailMechanismDriver** + * For Fuel based installations: ``/usr/lib/python2.7/dist-packages/neutron-.egg-info/entry_points.txt`` + * For devstack based installations: ``/opt/stack/neutron/neutron.egg-info/entry_points.txt`` +#. Neutron service need to be restarted. -Contrail dependency is required: ``https://github.com/Juniper/contrail-python-api`` - -.. code-block:: bash - - git clone https://github.com/Juniper/contrail-python-api - cd contrail-python-api - sudo python setup.py install - -Configure Contrail Mechanism Driver ------------------------------------ - -* In file ``/etc/neutron/plugins/ml2/ml2_conf.ini``: - * Make sure that in section **ml2** key ``mechanism_drivers`` have value **contrail_driver** in list - -* In file ``/opt/stack/neutron/neutron.egg-info/entry_points.txt`` - * In section **neutron.ml2.mechanism_drivers** set key ``contrail_driver`` to **neutron.plugins.ml2.drivers.contrail_driver:ContrailMechanismDriver** - -Running -------- - -Neutron service need to be restarted