Update readme

Change-Id: Id4e46a951e95a7df6a4dd44a1fd168d82acb0d20
This commit is contained in:
Bartosz Kupidura 2016-06-21 11:50:33 +02:00
parent 287bbec41e
commit 7a3e46edea
1 changed files with 21 additions and 8 deletions

View File

@ -1,5 +1,5 @@
Networking SFC plugin for Fuel Networking SFC plugin for Fuel
======================= ==============================
Networking SFC Networking SFC
-------------- --------------
@ -19,30 +19,37 @@ Requirements
|:---------------------------------|:--------| |:---------------------------------|:--------|
| Mirantis OpenStack compatibility | 9.0 | | Mirantis OpenStack compatibility | 9.0 |
It is required to install this on vxlans enabled environment. Will not work otherwise. It is required to install this on vxlans/gre enabled environment. Will not work otherwise.
Neutron L2 population setting should be also enabled.
Installation Guide Installation Guide
================== ==================
Networking SFC plugin installation Networking SFC plugin installation
--------------------------- ----------------------------------
To install Networking SFC plugin, follow these steps: To install Networking SFC plugin, follow these steps:
1. Build a plugin `fpb --build dir` #. Install all needed dependencies
2. Copy the plugin on already installed Fuel Master node; ssh can be used for # apt-get install git ruby-dev
# gem install fpm
#. Build a plugin `fpb --build dir`
#. Copy the plugin on already installed Fuel Master node; ssh can be used for
that. If you do not have the Fuel Master node yet, see that. If you do not have the Fuel Master node yet, see
[Quick Start Guide](https://software.mirantis.com/quick-start/) : [Quick Start Guide](https://software.mirantis.com/quick-start/) :
# scp networking-sfc-<version>.noarch.rpm root@<Fuel_Master_ip>:/tmp # scp networking-sfc-<version>.noarch.rpm root@<Fuel_Master_ip>:/tmp
3. Install the plugin: #. Install the plugin:
# cd /tmp # cd /tmp
# fuel plugins --install networking-sfc-<version>.noarch.rpm # fuel plugins --install networking-sfc-<version>.noarch.rpm
4. Check if the plugin was installed successfully: #. Check if the plugin was installed successfully:
# [root@nailgun ~]# fuel plugins # [root@nailgun ~]# fuel plugins
id | name | version | package_version | releases id | name | version | package_version | releases
@ -50,13 +57,19 @@ To install Networking SFC plugin, follow these steps:
1 | networking-sfc | 1.0.0 | 4.0.0 | ubuntu (mitaka-9.0) 1 | networking-sfc | 1.0.0 | 4.0.0 | ubuntu (mitaka-9.0)
Networking SFC plugin configuration Networking SFC plugin configuration
---------------------------- -----------------------------------
1. Create an environment. 1. Create an environment.
2. Enable L2 Population in network tab. 2. Enable L2 Population in network tab.
3. Enable the plugin on the Settings tab of the Fuel web UI. 3. Enable the plugin on the Settings tab of the Fuel web UI.
4. Deploy the environment. 4. Deploy the environment.
Known issues
------------
#. Fuel plugin should be build on Ubuntu system (https://bugs.launchpad.net/networking-sfc/+bug/1593693).
#. Networking-SFC is very dynamic project, because of that we stick to last known working commit.
Contributors Contributors
------------ ------------