Fixing User Guide
Added changes and enhancements to user guide documentation Change-Id: I7fe9ca125c04228a04ebb8f265bf18265d49a91d
This commit is contained in:
Rawan Herzallah
Aviram Bar-Haim
parent
1a52c1fd5f
commit
2c92680186
|
|
@ -1,3 +1,7 @@
|
|||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Appendix
|
||||
========
|
||||
|
||||
|
|
|
|||
|
|
@ -31,6 +31,7 @@ import os
|
|||
extensions = [
|
||||
# 'sphinx.ext.todo',
|
||||
# 'sphinx.ext.coverage',
|
||||
'sphinx.ext.autodoc','rst2pdf.pdfbuilder',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
|
@ -46,17 +47,17 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'The Mellanox plugin for Fuel'
|
||||
copyright = u'2015, mellanox'
|
||||
project = u'The Mellanox ConnectX-3 pro plugin for Fuel'
|
||||
copyright = u'2016, 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'
|
||||
version = '3.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '2.0-2.0.0-1'
|
||||
release = '3.0-3.0.0-1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
@ -199,7 +200,11 @@ latex_elements = {
|
|||
# (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',
|
||||
('index', 'fuel-plugin-mellanox.tex', u'The Mellanox ConnectX-3 pro Plugin for Fuel Documentation',
|
||||
u'Mellanox', 'manual'),
|
||||
]
|
||||
|
||||
pdf_documents = [ ('index', 'fuel-plugin-mellanox', u'The Mellanox Plugin for Fuel Documentation',
|
||||
u'Mellanox', 'manual'),
|
||||
]
|
||||
|
||||
|
|
@ -233,7 +238,7 @@ latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[e
|
|||
# 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',
|
||||
('index', 'fuel-plugin-mellanox', u'Guide to the Mellanox ConnectX-3 pro plugin ver. 3.0-3.0.0-1 for Fuel 8',
|
||||
[u'Mellanox'], 1)
|
||||
]
|
||||
|
||||
|
|
@ -247,8 +252,8 @@ man_pages = [
|
|||
# (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',
|
||||
('index', 'fuel-plugin-mellanox', u'The Mellanox ConnectX-3 pro Plugin for Fuel Documentation',
|
||||
u'Mellanox', 'fuel-plugin-mellanox', 'The Mellanox ConnectX-3 pro Plugin for Fuel Documentation',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
|
@ -273,10 +278,10 @@ pdf_inline_footnotes = True
|
|||
# -- Options for Epub output ----------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = u'The Mellanox Plugin for Fuel'
|
||||
epub_title = u'The Mellanox ConnectX-3 pro plugin'
|
||||
epub_author = u'mellanox'
|
||||
epub_publisher = u'Mellanox'
|
||||
epub_copyright = u'2015, Mellanox'
|
||||
epub_copyright = u'2016, Mellanox'
|
||||
|
||||
# The basename for the epub file. It defaults to the project name.
|
||||
#epub_basename = u'fuel-plugin-mellanox'
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Contact Support
|
||||
===============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Mellanox plugin configuration
|
||||
=============================
|
||||
|
||||
|
|
@ -34,7 +38,7 @@ If you plan to enable VM to VM RDMA and to use iSER storage transport you need t
|
|||
|
||||
switch (config) # configuration write
|
||||
|
||||
.. note:: When using an untagged storage network for iSER over Ethernet - please add the following commands for Mellanox switches:
|
||||
.. note:: When using an untagged storage network for iSER over Ethernet - please add the following commands for Mellanox switches or use trunk mode instead of hybrid.
|
||||
|
||||
::
|
||||
|
||||
|
|
@ -42,7 +46,6 @@ If you plan to enable VM to VM RDMA and to use iSER storage transport you need t
|
|||
interface ethernet 1/2 switchport hybrid allowed-vlan add 1
|
||||
...
|
||||
|
||||
or use trunk mode instead of hybrid.
|
||||
|
||||
**Infiniband network:**
|
||||
If you use OpenSM you need to enable virtualization and allow all PKeys:
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@
|
|||
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. 3.0-3.0.0-1 for Fuel
|
||||
======================================================
|
||||
=====================================================================
|
||||
Guide to the Mellanox ConnectX-3 pro Plugin ver. 3.0-3.0.0-1 for Fuel
|
||||
=====================================================================
|
||||
|
||||
User documentation
|
||||
==================
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Installation Guide
|
||||
==================
|
||||
|
||||
|
|
@ -11,7 +15,7 @@ To install Mellanox plugin, follow these steps:
|
|||
#. Install the plugin::
|
||||
|
||||
# cd /tmp
|
||||
# fuel plugins --install mellanox-plugin-2.0-2.0.0-1.noarch.rpm
|
||||
# fuel plugins --install mellanox-plugin-3.0-3.0.0-1.noarch.rpm
|
||||
|
||||
#. Verify the plugin was installed successfully by having it listed using ``fuel plugins`` command::
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Known issues
|
||||
============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Mellanox plugin
|
||||
===============
|
||||
|
||||
|
|
@ -32,6 +36,12 @@ Developer's specification
|
|||
Requirements
|
||||
------------
|
||||
|
||||
+-----------------------------------+-----------------+
|
||||
| Requirement | Version/Comment |
|
||||
+===================================+=================+
|
||||
| Mirantis OpenStack compatibility | 8.0 |
|
||||
+-----------------------------------+-----------------+
|
||||
|
||||
| The Mellanox ConnectX-3 Pro adapters family supports up to 40/56 Gb. To reach 56 Gb speed in
|
||||
your network with ConnectX-3 Pro adapters, you must use Mellanox Ethernet / Infiniband switches
|
||||
supporting 56 Gb (e.g. SX1710, SX6710). The switch ports should be configured specifically to use
|
||||
|
|
@ -42,7 +52,7 @@ Requirements
|
|||
Limitations
|
||||
-----------
|
||||
|
||||
- Mellanox SR-IOV and iSER are supported only when choosing Neutron with VLAN segmentation.
|
||||
- Mellanox SR-IOV is supported only when choosing Neutron with VLAN segmentation.
|
||||
- ConnectX-3 Pro adapters are required in order to enable VXLAN HW offload over Ethernet networks.
|
||||
- QoS feature is implemented only for Ethernet VLAN SR-IOV ports using ConnectX-3 Pro adapters.
|
||||
- Infiniband is configured by using OpenSM only.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Post-deployment SR-IOV test scripts
|
||||
===================================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Supported images
|
||||
----------------
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Troubleshooting notes
|
||||
=====================
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue