Fuel 7.0 README.rst

New readme file that has basic notes and changes related to new mellanox
plugin with installation guide in rst format.

Change-Id: Iea8d527691e5bc6c87ac92e0fc4ca1bcc7aa5a76
This commit is contained in:
Rawan Herzallah 2015-11-20 15:11:14 +00:00 committed by Irina Povolotskaya
parent 6af0e147ae
commit 28d514eb56
17 changed files with 775 additions and 88 deletions

View File

@ -1,87 +0,0 @@
Mellanox Plugin for Fuel
=======================
Mellanox plugin
--------------
Beginning with version 5.1, Fuel can configure Mellanox ConnectX-3 Pro network
adapters to accelerate the performance of compute and storage traffic.
This implements the following performance enhancements:
- Compute nodes use SR-IOV based networking.
- Cinder nodes use iSER block storage as the iSCSI transport rather than the
default iSCSI over TCP.
These features reduce CPU overhead, boost throughput, reduce latency, and
enable network traffic to bypass the software switch layer (e.g. Open vSwitch).
Starting with version 6.1, Mellanox plugin can deploy those features over
Infiniband network as well.
Requirements
------------
| Requirement | Version/Comment |
|:---------------------------------|:----------------|
| Mirantis OpenStack compatibility | >= 6.1 |
The Mellanox ConnectX-3 Pro adapters family supports up to 40/56GbE.
To reach 56 GbE speed in your network with ConnectX-3 Pro adapters, you must
use Mellanox Ethernet / Infiniband switches (e.g. SX1036) with the additional
56GbE license. The switch ports should be configured specifically to use 56GbE
speed. No additional configuration is required on the adapter side.
For additional information about how to run in 56GbE speed, see [HowTo
Configure 56GbE Link on Mellanox Adapters and Switches](http://community.mellanox.com/docs/DOC-1460).
For detailed setup configuration and BOM (Bill of Material) requirements please see
[Fuel Ethernet cloud details](https://community.mellanox.com/docs/DOC-1474) or
[Fuel Infiniband cloud details](https://community.mellanox.com/docs/DOC-2036).
Installation Guide
==================
Mellanox plugin installation
---------------------------
To install Mellanox plugin, follow these steps:
1. Download the plugin from
[Fuel Plugins Catalog](https://software.mirantis.com/fuel-plugins)
2. 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
[Quick Start Guide](https://software.mirantis.com/quick-start/) :
# scp mellanox-plugin-1.0-1.0.0-0.noarch.rpm root@<Fuel_Master_ip>:/tmp
3. Install the plugin:
# cd /tmp
# fuel plugins --install mellanox-plugin-1.0-1.0.0-0.noarch.rpm
NOTE: Mellanox plugin installation replaces your bootstrap image.
The original image is backed up in /opt/old_bootstrap_image/.
4. Check if the plugin was installed successfully:
# fuel plugins
id | name | version | package_version
---|-------------------|---------|----------------
1 | mellanox-plugin | 1.0.0 | 2.0.0
Mellanox plugin configuration
----------------------------
For instructions, more information and release notes, see the Mellanox Plugin Installation Guide
in the
[Fuel Plugins Catalog](https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/)
Contributors
------------
David Slama <dudus@mellanox.com> (PM)
Aviram Bar-Haim <aviramb@mellanox.com> (Release manager)
Andrey Yevsyukov <andreyy@mellanox.com> (Developer)
Gil Meir <gmeir11@gmail.com> (Developer)
Amichay Polishuk <amichayp@mellanox.com> (QA engineer)
Noam Angel <amichayp@mellanox.com> (QA engineer)
Lenny Verkhovsky <lennyb@mellanox.com> (Verification engineer)
Rawan Herzallah <rherzallah@asaltech.com> (Verification engineer)
Murad Awawdeh <mawawdeh@asaltech.com> (Verification engineer)

177
doc/Makefile Normal file
View File

@ -0,0 +1,177 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/fuel-plugin-openbook.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/fuel-plugin-openbook.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/fuel-plugin-openbook"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/fuel-plugin-openbook"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

10
doc/source/appendix.rst Normal file
View File

@ -0,0 +1,10 @@
.. _appendix:
Appendix
========
Mellanox site where users can read about possible configurations:
- `Mellanox ConnectX-3 pro <http://www.mellanox.com/page/products_dyn?product_family=119&mtag=connectx_3_vpi>`_
- `HowTo Install Mirantis Fuel OpenStack with Mellanox <https://community.mellanox.com/docs/DOC-1474>`_
- `Mellanox InfiniBand Switches <https://community.mellanox.com/docs/DOC-1164>`_

340
doc/source/conf.py Normal file
View File

@ -0,0 +1,340 @@
# -*- coding: utf-8 -*-
#
# fuel-plugin-mellanox documentation build configuration file, created by
# sphinx-quickstart on Wed Oct 7 12:48:35 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
# 'sphinx.ext.todo',
# 'sphinx.ext.coverage',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'The Mellanox plugin for Fuel'
copyright = u'2015, mellanox'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '2.0'
# The full version, including alpha/beta/rc tags.
release = '2.0-2.0.0-1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'fuel-plugin-mellanoxdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'fuel-plugin-mellanox.tex', u'The Mellanox Plugin for Fuel Documentation',
u'Mellanox', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# make latex stop printing blank pages between sections
# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'fuel-plugin-mellanox', u'Guide to the Mellanox Plugin ver. 2.0-2.0.0-2 for Fuel',
[u'Mellanox'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'fuel-plugin-mellanox', u'The Mellanox Plugin for Fuel Documentation',
u'Mellanox', 'fuel-plugin-mellanox', 'The Mellanox Plugin for Fuel Documentation',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# Insert footnotes where they are defined instead of
# at the end.
pdf_inline_footnotes = True
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'The Mellanox Plugin for Fuel'
epub_author = u'mellanox'
epub_publisher = u'Mellanox'
epub_copyright = u'2015, Mellanox'
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'fuel-plugin-mellanox'
# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to 'epub', a theme designed to save visual
# space.
#epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
# Choose between 'default' and 'includehidden'.
#epub_tocscope = 'default'
# Fix unsupported image types using the PIL.
#epub_fix_images = False
# Scale large images.
#epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#epub_show_urls = 'inline'
# If false, no index is generated.
#epub_use_index = True

View File

@ -0,0 +1,19 @@
.. _def:
Definitions, Acronyms and abbreviations
=======================================
SR-IOV
SR-IOV stands for "Single Root I/O Virtualization". It is a specification that allows a PCI device to appear virtually in multiple virtual machines (VMs), each of which has its own virtual function. The specification defines virtual functions (VFs) for the VMs and a physical function for the hypervisor. Using SR-IOV in a cloud infrastructure helps reaching higher performance since traffic bypasses the TCP/IP stack in the kernel.
iSER
iSER stands for "iSCSI Extensions for RDMA". It is an extension of the data transfer model of iSCSI, a storage networking standard for TCP/IP. iSER enables the iSCSI protocol to take advantage of the RDMA protocol suite to supply higher bandwidth for block storage transfers (zero time copy behavior). To that fact, it eliminates the TCP/IP processing overhead while preserving the compatibility with iSCSI protocol.
RDMA
RDMA stands for "Remote Direct Memory Access". It is a technology that enables to read and write data from remote server without involving the CPU. It reduces latency and increases throughput. In addition, the CPU is free to perform other tasks.
ConnectX-3 Pro
`ConnectX-3 Pro <http://www.mellanox.com/page/products_dyn?product_family=119&mtag=connectx_3_vpi>`_ adapter cards with Virtual Protocol Interconnect (VPI) supporting InfiniBand and Ethernet connectivity provide the highest performing and most flexible interconnect solution for PCI Express Gen3 servers used in Enterprise Data Centers, High-Performance Computing, and Embedded environments.
Infiniband
A computer-networking communications standard used in high-performance computing, features very high throughput and very low latency. It is used for data interconnect both among and within computers. InfiniBand is also utilized as either a direct, or switched interconnect between servers and storage systems, as well as an interconnect between storage systems.

58
doc/source/guide.rst Normal file
View File

@ -0,0 +1,58 @@
.. _configuration:
Mellanox plugin configuration
=============================
To configure Mellanox backend, follow these steps:
**Ethernet network:**
* Configure the required VLANs and enable flow control on the Ethernet switch ports.
All related VLANs should be enabled on the 40/56GbE switch (Private, Management, Storage networks).
* On Mellanox switches, use the commands in Mellanox `reference configuration <https://community.mellanox.com/docs/DOC-1460>`_
flow to enable VLANs (e.g. VLAN 1-100 on all ports).
* An example of configuring the switch for Ethernet deployment can be found in
the `Mirantis Planning Guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html#planning-guide>`_.
Environment creation and configuration
--------------------------------------
#. `Create an environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
#. Open the Settings tab of the Fuel web UI and scroll down the page.
In Mellanox OpenStack features section, select the required features:
.. image:: ./_static/mellanox_features_section.png
.. :alt: A screenshot of mellanox features section
* The SR-IOV feature supports only KVM hypervisor and Neutron with VLAN segmentation (the latter should be enabled
at `environment creation step <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_:
.. image:: ./_static/hypervisor_type.png
.. :alt: A screenshot of hypervisors type
.. image:: ./_static/network_type.png
.. :alt: A screenshot network type
* The iSER feature requires “Cinder LVM over iSCSI for volumes” enabled in the “Storage” section:
.. image:: ./_static/storage_backends.png
.. :alt: A screenshot of storage backends
.. note:: When configuring Mellanox plugin, please mind the following:
#. You *cannot* install a plugin at the already existing environment.
That means, the plugin will appear in the certain environment only if the plugin was installed before creating the environment.
#. Enabling the “Mellanox Openstack features” section enables Mellanox
hardware support on your environment, regardless of the iSER & SR-IOV features.
#. In Ethernet cloud, when using SR-IOV & iSER, one of the virtual NICs for SR-IOV will be reserved to the storage network.
#. When using SR-IOV you can set the number of virtual NICs (virtual functions) to up to 64
if your hardware and system capabilities like memory and BIOSsupport it).
In any case of SR-IOV hardware limitation, the installation will try to fallback the VF number to the default of 16 VFs.

23
doc/source/index.rst Normal file
View File

@ -0,0 +1,23 @@
.. fuel-plugin-mellanox documentation master file, created by
sphinx-quickstart on Wed Oct 7 12:48:35 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
======================================================
Guide to the Mellanox Plugin ver. 2.0-2.0.0-2 for Fuel
======================================================
User documentation
==================
.. toctree::
:maxdepth: 2
definitions
overview
supported_images
installation
guide
known_issues
appendix

View File

@ -0,0 +1,52 @@
.. _installation:
Installation Guide
==================
Mellanox plugin installation
----------------------------
To install Mellanox plugin, follow these steps:
#. Download the plugin from `Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
#. Copy the plugin on already installed Fuel Master node.
If you do not have the Fuel Master node yet, see `Quick Start Guide <https://software.mirantis.com/quick-start/>`_ ::
# scp mellanox-plugin-2.0-2.0.0-1.noarch.rpm root@<Fuel_Master_ip>:/tmp
#. Install the plugin::
# cd /tmp
# fuel plugins --install mellanox-plugin-2.0-2.0.0-1.noarch.rpm
.. note:: Mellanox plugin installation replaces your bootstrap image only in Fuel 6.1 at this stage.
The original image is backed up in `/opt/old_bootstrap_image/`.
#. Verify the plugin was installed successfully by having it listed using ``fuel plugins`` command::
# fuel plugins
id | name | version | package_version
---|-------------------|---------|----------------
1 | mellanox-plugin | 2.0.0 | 2.0.0
#. You must boot your target nodes with the new bootstrap image (installed by the plugin)
**after** the plugin is installed. (In Fuel 7.0, the plugin doesnt replace bootstrap images and uses Mirantis bootstrap images)
Check your Fuels node status by running ``fuel node`` command:
* If you already have nodes in `discover` status (with the original bootstrap image) like in the screenshot below:
.. image:: ./_static/list_fuel_nodes.png
:alt: A screenshot of the nodes list
:scale: 90%
use the ``reboot_bootstrap_nodes`` script to reboot your nodes with the new image.
.. note:: For more info about using the script, run `reboot_bootstrap_nodes --help`.
* If ``fuel node`` command doesnt show any nodes, you can boot your nodes only once after the plugin is installed.

View File

@ -0,0 +1,32 @@
.. _known_issues:
Known issues
============
Issue 1
- Description: This release supports Mellanox ConnectX®-3 family adapters only.
- Workaround: NA
Issue 2
- Description: For custom (OEM) adapter cards based on Mellanox ConnectX-3 / ConnectX-3 Pro ICs, adapter firmware must be manually burnt prior to the installation with SR-IOV support
- Workaround: See `the firmware installation instructions <http://www.mellanox.com/page/oem_firmware_download>`_.
Issue 3
- Description: The number of SR-IOV virtual functions supported by Mellanox adapters is 16 on ConnectX-3 adapters and 128 on ConnectX-3 Pro adapters.
- Workaround: NA
Issue 4
- Description: Deploying more than 10 nodes at a time over a slow PXE network can cause timeouts during the OFED installation
- Workaround: Deploy chunks of up to 10 nodes or increase the delay-before-timeout in the plugins tasks.yaml file on the Fuel master node. If timeout occurs, click **Deploy Changes** button again.
Issue 5
- Description: Using an untagged storage network on the same interface with a private network over Ethernet is not supported when using iSER.
- Workaround: Use a separate interface for untagged storage networks for iSER over Ethernet or use a tagged storage network instead.
Issue 6
- Description: Recovering of a Cinder target might take more than 10 minutes in tagged storage network.
- Workaround: Ping from the Cinder target after the reboot to another machine in the cluster over the storage network. The VLAN storage network will be over vlan<vlan#> interface.

47
doc/source/overview.rst Normal file
View File

@ -0,0 +1,47 @@
.. _overview:
Mellanox plugin
===============
The Mellanox Fuel plugin is a bundle of scripts, packages and metadata that will extend Fuel and add Mellanox features such as SR-IOV for networking and iSER protocol for storage.
Beginning with version 5.1, Fuel can configure `Mellanox ConnectX-3 Pro <http://www.mellanox.com/page/products_dyn?product_family=119&mtag=connectx_3_vpi>`_ network adapters to accelerate the performance of compute and storage traffic.This implements the following performance enhancements:
- Compute nodes use SR-IOV based networking.
- Cinder nodes use iSER block storage as the iSCSI transport rather than the default iSCSI over TCP.
These features reduce CPU overhead, boost throughput, reduce latency, and enable network traffic to bypass the software switch layer (e.g. Open vSwitch).
Starting with version 6.1, Mellanox plugin can deploy those features over Infiniband network as well. However, for Fuel version 7.0, plugin uses Mirantis bootstrap images and therefore only Ethernet Network is supported.
Developers specification
-------------------------
Please refer to: `HowTo Install Mellanox OpenStack Plugin for Mirantis Fuel 7.0 <https://community.mellanox.com/docs/DOC-2374>`_
Requirements
------------
+-----------------------------------+-----------------+
| Requirement | Version/Comment |
+===================================+=================+
| Mirantis OpenStack compatibility | 7.0 |
+-----------------------------------+-----------------+
The Mellanox ConnectX-3 Pro adapters family supports up to 40/56GbE.
To reach 56 GbE speed in your network with ConnectX-3 Pro adapters, you must use Mellanox Ethernet / Infiniband switches (e.g. SX1036)
with the additional 56GbE license.
The switch ports should be configured specifically to use 56GbE speed. No additional configuration is required on the adapter side.
For additional information about how to run in 56GbE speed, see
`HowTo Configure 56GbE Link on Mellanox Adapters and Switches <http://community.mellanox.com/docs/DOC-1460>`_.
For detailed setup configuration and BOM (Bill of Material) requirements please see
`Fuel Ethernet cloud details <https://community.mellanox.com/docs/DOC-2077>`_ or
`Fuel Infiniband cloud details <https://community.mellanox.com/docs/DOC-2304>`_.
Limitations
-----------
- Mellanox SR-IOV and iSER are supported only when choosing Neutron with VLAN.
- OVS bonding and Mellanox SR-IOV based networking over the Mellanox ConnectX-3 Pro adapter family are not supported.
- In order to use the SR-IOV feature, one should choose KVM hypervisor and “Neutron with Vlan segmentation” in the Network settings tab.

View File

@ -0,0 +1,16 @@
.. _supported_images:
Supported images
----------------
+-------+--------------------+---------------------------------+
| Issue | Supported OS | Tested kernel |
+=======+====================+=================================+
| 1 | CentOS6.5 | 2.6.32-431.el6.x86_64 |
+-------+--------------------+---------------------------------+
| 2 | ubuntu14.04.3 | 3.19.0-25-generic |
+-------+--------------------+---------------------------------+
| 3 | Cirros Mellanox | 3.2.0-80-virtual Ubuntu 3_amd64 |
+-------+--------------------+---------------------------------+
This Fuel Mellanox plugin ver. 2.0-2.0.0-1 is using MLNX_OFED version 2.3-2.0.8.

View File

@ -5,7 +5,7 @@ name: mellanox-plugin
title: Mellanox Openstack features
# Plugin version
version: 1.0.12
version: 2.0.0
# Description
description: Enable features over Mellanox hardware