diff --git a/doc/source/appendix.rst b/doc/source/appendix.rst index 6dd8584..5eb50f6 100644 --- a/doc/source/appendix.rst +++ b/doc/source/appendix.rst @@ -1,3 +1,7 @@ +.. raw:: pdf + + PageBreak + Appendix ======== diff --git a/doc/source/conf.py b/doc/source/conf.py index 34dce03..a2fee16 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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' diff --git a/doc/source/contact_support.rst b/doc/source/contact_support.rst index 7d529cf..be8b7d5 100644 --- a/doc/source/contact_support.rst +++ b/doc/source/contact_support.rst @@ -1,3 +1,7 @@ +.. raw:: pdf + + PageBreak + Contact Support =============== diff --git a/doc/source/guide.rst b/doc/source/guide.rst index 3c6e173..9ceea46 100644 --- a/doc/source/guide.rst +++ b/doc/source/guide.rst @@ -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: diff --git a/doc/source/index.rst b/doc/source/index.rst index 11d89e2..c8f547c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ================== diff --git a/doc/source/installation.rst b/doc/source/installation.rst index ae1e01f..c98ea52 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -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:: diff --git a/doc/source/known_issues.rst b/doc/source/known_issues.rst index 6d5cf7f..f861d27 100644 --- a/doc/source/known_issues.rst +++ b/doc/source/known_issues.rst @@ -1,3 +1,7 @@ +.. raw:: pdf + + PageBreak + Known issues ============ diff --git a/doc/source/overview.rst b/doc/source/overview.rst index 844c49e..56faec1 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -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. diff --git a/doc/source/post_deployment.rst b/doc/source/post_deployment.rst index 9992a97..da470ed 100644 --- a/doc/source/post_deployment.rst +++ b/doc/source/post_deployment.rst @@ -1,3 +1,7 @@ +.. raw:: pdf + + PageBreak + Post-deployment SR-IOV test scripts =================================== diff --git a/doc/source/supported_images.rst b/doc/source/supported_images.rst index f302b18..bc07319 100644 --- a/doc/source/supported_images.rst +++ b/doc/source/supported_images.rst @@ -1,3 +1,7 @@ +.. raw:: pdf + + PageBreak + Supported images ---------------- diff --git a/doc/source/troubleshooting_notes.rst b/doc/source/troubleshooting_notes.rst index 480d73f..53f3864 100644 --- a/doc/source/troubleshooting_notes.rst +++ b/doc/source/troubleshooting_notes.rst @@ -1,3 +1,7 @@ +.. raw:: pdf + + PageBreak + Troubleshooting notes =====================