Merge "Docs for fuel-plugin-networking-sfc" into 1.0

doc/content/appendix.rst

@@ -0,0 +1,8 @@
+==================
+Appendix
+==================
+
+Links
+=========================
+
+- `Networking SFC github repository <https://github.com/openstack/networking-sfc>`_

doc/content/description.rst

@@ -0,0 +1,15 @@
+=====================================================
+Guide to the Networking SFC Plugin extension for Fuel
+=====================================================
+
+This plugin extends Mirantis OpenStack functionality by adding Networking SFC
+support. It installs all necessary packages and configures Neutron.
+
+Requirements
+============
+
+================================== ===============
+Requirement                        Version/Comment
+================================== ===============
+Fuel                               9.0
+================================== ===============

doc/content/guide.rst

@@ -0,0 +1,42 @@
+==========
+User Guide
+==========
+
+Environment configuration
+=========================
+
+#. Create an environment with vxlans support. For more information about
+   environment creation, see `Fuel User Guide <http://docs.openstack.org
+   /developer/fuel-docs/userdocs/fuel-user-guide/create-environment.html>`_.
+
+#. In *Environments* tab choose an environment for which you want to install
+   Networking SFC plugin.
+
+#. Enable L2 Population in *Network* tab in *Other* section.
+
+   .. image:: images/enablel2.png
+      :width: 50%
+
+#. Enable plugin by  *Service Function Chaining Extension for OpenStack
+   Networking* on *Settings* tab in *Other* section.
+
+   .. image:: images/enableplugin.png
+      :width: 50%
+
+#. Plugin reguire Xenial kernel. Because it is not available in Fuel 9.0 by
+   default, it should be installed by changing LTS kernel stack on *Settings*
+   tab in *General* section. On the bootom is *Provision* section, in text box
+   named *Initial packages* change packages from
+   linux-headers-generic-lts-trusty and linux-image-generic-lts-trusty to
+   linux-headers-generic-lts-xenial and linux-image-generic-lts-xenial.
+
+
+   .. image:: images/xenial.png
+      :width: 50%
+
+   .. image:: images/xenial2.png
+      :width: 50%
+
+#. Adjust other environment settings to your requirements and deploy it. For
+   more information, see `Configure your Environment <http://docs.openstack.org
+   /developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`_.

doc/content/installation.rst

@@ -0,0 +1,47 @@
+==================
+Installation Guide
+==================
+
+Networking SFC plugin installation
+============================================
+
+To install 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-networking-sfc
+     # cd fuel-plugin-networking-sfc
+
+#. 1.0 branch should be used on Fuel 9.0::
+
+     # git checkout 1.0
+
+#. 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 <http://docs.openstack.org/developer/fuel-docs/userdocs
+   /fuel-install-guide.html>`_::
+
+     # scp networking-sfc-<version>.noarch.rpm root@<Fuel_Master_ip>:/tmp
+
+#. Install the plugin::
+
+     # cd /tmp
+     # fuel plugins --install networking-sfc-<version>.noarch.rpm
+
+#. Check if the plugin was installed successfully::
+
+     # fuel plugins
+     id | name           | version | package_version | releases
+     ---|----------------|---------|-----------------|--------------------
+     1  | networking-sfc | 1.0.0   | 4.0.0           | ubuntu (mitaka-9.0)

doc/content/removal.rst

@@ -0,0 +1,19 @@
+==================
+Removal Guide
+==================
+
+Networking SFC plugin removal
+============================================
+
+To uninstall Networking SFC plugin, follow these steps:
+
+1. Disable plugin in all environments which are using it.
+2. Uninstall the plugin:
+
+   # fuel plugins --remove networking-sfc==1.0.0
+
+3. Check if the plugin was uninstalled successfully:
+
+   # fuel plugins
+    id | name                      | version  | package_version
+    ---|---------------------------|----------|----------------

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
+    for 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.

doc/user_guide.rst

@@ -0,0 +1,14 @@
+****************************************************************
+User guide to the Networking SFC extension for Fuel
+****************************************************************
+
+This document provides instructions for installing, configuring and using
+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