diff --git a/doc/content/appendix.rst b/doc/content/appendix.rst new file mode 100644 index 0000000..4785de5 --- /dev/null +++ b/doc/content/appendix.rst @@ -0,0 +1,8 @@ +================== +Appendix +================== + +Links +========================= + +- `Networking SFC github repository `_ diff --git a/doc/content/description.rst b/doc/content/description.rst new file mode 100644 index 0000000..71eba00 --- /dev/null +++ b/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 +================================== =============== diff --git a/doc/content/guide.rst b/doc/content/guide.rst new file mode 100644 index 0000000..019cdec --- /dev/null +++ b/doc/content/guide.rst @@ -0,0 +1,44 @@ +========== +User Guide +========== + +Environment configuration +========================= + +#. Create an environment with vxlans support. For more information about + environment creation, see `Mirantis OpenStack User Guide + `_. + +#. In *Environments* tab choose an environment for which you want to install + Networking SFC plugin. + +#. Enable plugin by *Service Function Chaining Extension for OpenStack + Networking* on *Settings* tab in section *Other*. + + .. image:: images/enableplugin.png + :width: 50% + +#. Enable L2 Population in *Network* tab in section *Other*. + + .. image:: images/enablel2.png + :width: 50% + +#. Plugin reguire Xenial kernel. Because it is not in Fuel 9.0 by default it's + should be installed by changing LTS kernel stack on *Settings* tab in + section *General*. On the bootom is section *Provision*, 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 the + environment. For more information, see + `Mirantis OpenStack User Guide `_. diff --git a/doc/content/installation.rst b/doc/content/installation.rst new file mode 100644 index 0000000..7befa3b --- /dev/null +++ b/doc/content/installation.rst @@ -0,0 +1,46 @@ +================== +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 chekout 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 `Quick Start Guide + `_:: + + # scp networking-sfc-.noarch.rpm root@:/tmp + +#. Install the plugin:: + + # cd /tmp + # fuel plugins --install networking-sfc-.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) diff --git a/doc/content/removal.rst b/doc/content/removal.rst new file mode 100644 index 0000000..c6688b9 --- /dev/null +++ b/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 when it is used. +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 + ---|---------------------------|----------|---------------- 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/enablel2.png b/doc/images/enablel2.png new file mode 100644 index 0000000..df76475 Binary files /dev/null and b/doc/images/enablel2.png differ diff --git a/doc/images/enableplugin.png b/doc/images/enableplugin.png new file mode 100644 index 0000000..e83dbd4 Binary files /dev/null and b/doc/images/enableplugin.png differ diff --git a/doc/images/xenial.png b/doc/images/xenial.png new file mode 100644 index 0000000..1835251 Binary files /dev/null and b/doc/images/xenial.png differ diff --git a/doc/images/xenial2.png b/doc/images/xenial2.png new file mode 100644 index 0000000..b7873ad Binary files /dev/null and b/doc/images/xenial2.png differ diff --git a/doc/user.html b/doc/user.html new file mode 100644 index 0000000..ad94655 --- /dev/null +++ b/doc/user.html @@ -0,0 +1,512 @@ + + + + + + +User guide to the Networking SFC extension for Fuel + + + +
+

User guide to the Networking SFC extension for Fuel

+ +

This document provides instructions for installing, configuring and using +Networking SFC plugin for Fuel.

+ +
+

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

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

+ ++++ + + + + + + + + + + +
RequirementVersion/Comment
Fuel9.0
+
+
+
+

Installation Guide

+
+

Networking SFC plugin installation

+

To install Networking SFC plugin, follow these steps:

+
    +

  1. 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
+
    +
    2. +

  2. Download plugin source code from github:

    +
    +# git clone https://github.com/openstack/fuel-plugin-networking-sfc
+# cd fuel-plugin-networking-sfc
+
    +
    3. +

  3. 1.0 branch should be used on Fuel 9.0:

    +
    +# git chekout 1.0
+
    +
    4. +

  4. Build a plugin:

    +
    +# fpb --build ./
+
    +
    5. +

  5. 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 Quick Start Guide:

    +
    +# scp networking-sfc-<version>.noarch.rpm root@<Fuel_Master_ip>:/tmp
+
    +
    6. +

  6. Install the plugin:

    +
    +# cd /tmp
+# fuel plugins --install networking-sfc-<version>.noarch.rpm
+
    +
    7. +

  7. 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)
+
    +
    8. +
+
+
+
+

User Guide

+
+

Environment configuration

+
    +

  1. Create an environment with vxlans support. For more information about +environment creation, see Mirantis OpenStack User Guide.

    +
    2. +

  2. In Environments tab choose an environment for which you want to install +Networking SFC plugin.

    +
    3. +

  3. Enable plugin by Service Function Chaining Extension for OpenStack +Networking on Settings tab in section Other.

    +images/enableplugin.png +
    4. +

  4. Enable L2 Population in Network tab in section Other.

    +images/enablel2.png +
    5. +

  5. Plugin reguire Xenial kernel. Because it is not in Fuel 9.0 by default it's +should be installed by changing LTS kernel stack on Settings tab in +section General. On the bootom is section Provision, 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.

    +images/xenial.png +images/xenial2.png +
    6. +

  6. Adjust other environment settings to your requirements and deploy the +environment. For more information, see +Mirantis OpenStack User Guide.

    +
    7. +
+
+
+ +
+ + diff --git a/doc/user_guide.rst b/doc/user_guide.rst new file mode 100644 index 0000000..647768f --- /dev/null +++ b/doc/user_guide.rst @@ -0,0 +1,13 @@ +**************************************************************** +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/guide.rst +.. include:: content/appendix.rst