Docs for fuel-plugin-murano-networking-sfc
Change-Id: Iab082279c90b7e1527bb2ebff3a589b214962f32
(cherry picked from commit d169a2d53f
)
This commit is contained in:
parent
e54ebbc156
commit
9e04ea5407
14
doc/content/appendix.rst
Normal file
14
doc/content/appendix.rst
Normal file
@ -0,0 +1,14 @@
|
||||
==================
|
||||
Appendix
|
||||
==================
|
||||
|
||||
Links
|
||||
=========================
|
||||
|
||||
- `Networking SFC repository <https://github.com/openstack/networking-sfc>`_
|
||||
- `Murano Networking SFC repository
|
||||
<https://github.com/openstack/murano-plugin-networking-sfc>`_
|
||||
- `Networking SFC plugin for Fuel
|
||||
<https://github.com/openstack/fuel-plugin-networking-sfc>`_
|
||||
- `Murano Networking SFC plugin for Fuel
|
||||
<https://github.com/openstack/fuel-plugin-murano-networking-sfc>`_
|
16
doc/content/description.rst
Normal file
16
doc/content/description.rst
Normal file
@ -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
|
||||
================================== ===============
|
52
doc/content/guide.rst
Normal file
52
doc/content/guide.rst
Normal file
@ -0,0 +1,52 @@
|
||||
==========
|
||||
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>`_.
|
||||
|
||||
#. 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 <https://github.com/openstack/fuel-plugin-networking-sfc>`_.
|
||||
|
||||
#. 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 <http://docs.openstack.org/developer/fuel-docs
|
||||
/userdocs/fuel-user-guide/configure-environment.html>`_.
|
||||
|
||||
#. Plugin reguires `patch <https://github.com/openstack/murano/commit
|
||||
/b12f7c9973b6154d4f4ed13c27dd6019581c6ee6>`_ 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
|
43
doc/content/installation.rst
Normal file
43
doc/content/installation.rst
Normal file
@ -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 <http://docs.openstack.org/developer/fuel-docs/userdocs
|
||||
/fuel-install-guide.html>`_::
|
||||
|
||||
# scp murano-networking-sfc-<version>.noarch.rpm root@<Fuel_Master_ip>:/tmp
|
||||
|
||||
#. Install the plugin::
|
||||
|
||||
# cd /tmp
|
||||
# fuel plugins --install murano-networking-sfc-<version>.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
|
19
doc/content/removal.rst
Normal file
19
doc/content/removal.rst
Normal file
@ -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
|
||||
---|---------------------------|----------|----------------
|
21
doc/content/terms.rst
Normal file
21
doc/content/terms.rst
Normal file
@ -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.
|
BIN
doc/images/enableplugin.png
Normal file
BIN
doc/images/enableplugin.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 380 KiB |
BIN
doc/images/success.png
Normal file
BIN
doc/images/success.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 147 KiB |
14
doc/user_guide.rst
Normal file
14
doc/user_guide.rst
Normal file
@ -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
|
Loading…
Reference in New Issue
Block a user