diff --git a/doc/content/appendix.rst b/doc/content/appendix.rst new file mode 100644 index 0000000..83be0ce --- /dev/null +++ b/doc/content/appendix.rst @@ -0,0 +1,14 @@ +================== +Appendix +================== + +Links +========================= + +- `Networking SFC repository `_ +- `Murano Networking SFC repository + `_ +- `Networking SFC plugin for Fuel + `_ +- `Murano Networking SFC plugin for Fuel + `_ diff --git a/doc/content/description.rst b/doc/content/description.rst new file mode 100644 index 0000000..1499af7 --- /dev/null +++ b/doc/content/description.rst @@ -0,0 +1,16 @@ +============================================================ +Guide to the Murano Networking SFC Plugin extension for Fuel +============================================================ + +This plugin extends Mirantis OpenStack functionality by adding to Murano +Networking SFC support. It installs all necessary packages and configures +Murano. + +Requirements +============ + +================================== =============== +Requirement Version/Comment +================================== =============== +Fuel 9.0 +================================== =============== diff --git a/doc/content/guide.rst b/doc/content/guide.rst new file mode 100644 index 0000000..c2174d0 --- /dev/null +++ b/doc/content/guide.rst @@ -0,0 +1,52 @@ +========== +User Guide +========== + +Environment configuration +========================= + +#. Create an environment with vxlans support. For more information about + environment creation, see `Fuel User Guide `_. + +#. Plugin reguire installed and enabled Networking SFC plugin for Fuel. Source + code and documentation for this plugin, can be found here: `Networking SFC + plugin for Fuel `_. + +#. In *Environments* tab choose an environment for which you want to install + Murano Networking SFC plugin. + +#. Enable plugin by checking *Fuel plugin for Murano networking sfc support* on + *Settings* tab in *Other* section. + + .. image:: images/enableplugin.png + :width: 50% + +#. Adjust other environment settings to match your needs and deploy the + environment. For more information, see + `Configure your Environment `_. + +#. Plugin reguires `patch `_ which is not delivered in + Murano in Fuel 9.0. So if you are using 9.0 you have to update Murano to the + latest version after sucessfull deployment + + .. image:: images/success.png + :width: 50% + + You need to do:: + + On controller nodes:: + # apt-get install git zip -y + # git clone https://github.com/openstack/murano.git + # cd murano + # git checkout -t origin/stable/mitaka + # python setup.py install + On primary controller also:: + # cd meta/io.murano + # zip -r ~/Core.zip * + # murano package-import ~/Core.zip --exists u + Restart murano services after murano update on all controllers:: + # service murano-api restart + # service murano-engine restart diff --git a/doc/content/installation.rst b/doc/content/installation.rst new file mode 100644 index 0000000..54544f1 --- /dev/null +++ b/doc/content/installation.rst @@ -0,0 +1,43 @@ +================== +Installation Guide +================== + +Murano Networking SFC plugin installation +============================================ + +To install Murano Networking SFC plugin, follow these steps: + +#. Install all needed dependencies:: + + # yum install createrepo rpm rpm-build dpkg-devel git ruby-devel createrepo + dpkg-devel dpkg-dev rpm rpm-build python-pip + # pip install fuel-plugin-builder + # gem install fpm + +#. Download plugin source code from github:: + + # git clone https://github.com/openstack/fuel-plugin-murano-networking-sfc + # cd fuel-plugin-murano-networking-sfc + +#. Build a plugin:: + + # fpb --build ./ + +#. Copy the plugin to already installed Fuel Master node; ssh can be used for + that. If you do not have the Fuel Master node yet, see `Fuel Installation + Guide `_:: + + # scp murano-networking-sfc-.noarch.rpm root@:/tmp + +#. Install the plugin:: + + # cd /tmp + # fuel plugins --install murano-networking-sfc-.noarch.rpm + +#. Check if the plugin was installed successfully:: + + # fuel plugins + id | name | version | package_version | releases + ---+-----------------------+---------+-----------------+----------------- + 1 | murano-networking-sfc | 1.0.0 | 4.0.0 | ubuntu (mitaka diff --git a/doc/content/removal.rst b/doc/content/removal.rst new file mode 100644 index 0000000..63af044 --- /dev/null +++ b/doc/content/removal.rst @@ -0,0 +1,19 @@ +================== +Removal Guide +================== + +Murano Networking SFC plugin removal +============================================ + +To uninstall Murano Networking SFC plugin, follow these steps: + +#. Disable plugin in all environments using it. +#. Uninstall the plugin:: + + # fuel plugins --remove murano-networking-sfc==1.0.0 + +#. Check if the plugin was uninstalled successfully:: + + # fuel plugins --list + id | name | version | package_version + ---|---------------------------|----------|---------------- diff --git a/doc/content/terms.rst b/doc/content/terms.rst new file mode 100644 index 0000000..6d8cdf6 --- /dev/null +++ b/doc/content/terms.rst @@ -0,0 +1,21 @@ +===================================== +Key terms, acronyms and abbreviations +===================================== + +Networking SFC + Service Function Chaining is a mechanism for overriding + the basic destination based forwarding that is typical + of IP networks. It is conceptually related to Policy + Based Routing in physical networks but it is typically + thought of as a Software Defined Networking technology. + It is often used in conjunction with security functions + although it may be used for a broader range of features. + Fundamentally SFC is the ability to cause network packet + flows to route through a network via a path other than + the one that would be chosen by routing table lookups + on the packet's destination IP address. It is most + commonly used in conjunction with Network Function + Virtualization when recreating in a virtual environment + a series of network functions that would have + traditionally been implemented as a collection of + physical network devices connected in series by cables. diff --git a/doc/images/enableplugin.png b/doc/images/enableplugin.png new file mode 100644 index 0000000..571764f Binary files /dev/null and b/doc/images/enableplugin.png differ diff --git a/doc/images/success.png b/doc/images/success.png new file mode 100644 index 0000000..e25231a Binary files /dev/null and b/doc/images/success.png differ diff --git a/doc/user_guide.rst b/doc/user_guide.rst new file mode 100644 index 0000000..66be647 --- /dev/null +++ b/doc/user_guide.rst @@ -0,0 +1,14 @@ +**************************************************************** +User guide to the Murano Networking SFC extension for Fuel +**************************************************************** + +This document provides instructions for installing, configuring and using +Murano Networking SFC plugin for Fuel. + +.. contents:: +.. include:: content/terms.rst +.. include:: content/description.rst +.. include:: content/installation.rst +.. include:: content/removal.rst +.. include:: content/guide.rst +.. include:: content/appendix.rst