diff --git a/.gitignore b/.gitignore index fabbcee..9c0a96c 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,4 @@ .build *.pyc *.rpm -.build +doc/build diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..7cd3d6b --- /dev/null +++ b/doc/Makefile @@ -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 ' where 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-fortinet.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/fuel-plugin-fortinet.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-fortinet" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/fuel-plugin-fortinet" + @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." diff --git a/doc/source/_static/create_env1.png b/doc/source/_static/create_env1.png new file mode 100644 index 0000000..3c8f23c Binary files /dev/null and b/doc/source/_static/create_env1.png differ diff --git a/doc/source/_static/create_env2.png b/doc/source/_static/create_env2.png new file mode 100644 index 0000000..2f4b616 Binary files /dev/null and b/doc/source/_static/create_env2.png differ diff --git a/doc/source/_static/create_env3.png b/doc/source/_static/create_env3.png new file mode 100644 index 0000000..aedccbf Binary files /dev/null and b/doc/source/_static/create_env3.png differ diff --git a/doc/source/_static/deployment_success.png b/doc/source/_static/deployment_success.png new file mode 100644 index 0000000..65f8795 Binary files /dev/null and b/doc/source/_static/deployment_success.png differ diff --git a/doc/source/_static/fortigate.png b/doc/source/_static/fortigate.png new file mode 100644 index 0000000..7297ace Binary files /dev/null and b/doc/source/_static/fortigate.png differ diff --git a/doc/source/_static/horizon.png b/doc/source/_static/horizon.png new file mode 100644 index 0000000..d583df8 Binary files /dev/null and b/doc/source/_static/horizon.png differ diff --git a/doc/source/_static/networking_default.png b/doc/source/_static/networking_default.png new file mode 100644 index 0000000..bf84e35 Binary files /dev/null and b/doc/source/_static/networking_default.png differ diff --git a/doc/source/_static/networking_fortinet.png b/doc/source/_static/networking_fortinet.png new file mode 100644 index 0000000..1b4ac11 Binary files /dev/null and b/doc/source/_static/networking_fortinet.png differ diff --git a/doc/source/_static/networking_l3.png b/doc/source/_static/networking_l3.png new file mode 100644 index 0000000..d6947b6 Binary files /dev/null and b/doc/source/_static/networking_l3.png differ diff --git a/doc/source/_static/networking_ml2.png b/doc/source/_static/networking_ml2.png new file mode 100644 index 0000000..23d2488 Binary files /dev/null and b/doc/source/_static/networking_ml2.png differ diff --git a/doc/source/_static/nodes_interface1.png b/doc/source/_static/nodes_interface1.png new file mode 100644 index 0000000..2354fc5 Binary files /dev/null and b/doc/source/_static/nodes_interface1.png differ diff --git a/doc/source/_static/nodes_interface2.png b/doc/source/_static/nodes_interface2.png new file mode 100644 index 0000000..fcc14c5 Binary files /dev/null and b/doc/source/_static/nodes_interface2.png differ diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..5eb18f1 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,340 @@ +# -*- coding: utf-8 -*- +# +# fuel-plugin-fortinet documentation build configuration file, created by +# sphinx-quickstart on Tue June 7 12:48:35 2016. +# +# 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 Fortinet plugin for Fuel' +copyright = u'2016, Fortinet Inc.' + +# 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 = '1.0' +# The full version, including alpha/beta/rc tags. +release = '1.0-1.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 +# " v 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 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-fortinet' + + +# -- 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-fortinet.tex', u'The Fortinet Plugin for Fuel Documentation', + u'Fortinet Inc.', '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-fortinet', u'Guide to the Fortinet Plugin ver. 1.1-1.0.0-1 for Fuel', + [u'Fortinet Inc.'], 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-fortinet', u'The Fortinet Plugin for Fuel Documentation', + u'Fortinet Inc.', 'fuel-plugin-fortinet', 'The Fortinet 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 Fortinet Plugin for Fuel' +epub_author = u'Fortinet Inc.' +epub_publisher = u'Fortinet Inc.' +epub_copyright = u'2016, Fortinet Inc.' + +# The basename for the epub file. It defaults to the project name. +#epub_basename = u'fuel-plugin-fortinet' + +# 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 diff --git a/doc/source/guide.rst b/doc/source/guide.rst new file mode 100644 index 0000000..3e88359 --- /dev/null +++ b/doc/source/guide.rst @@ -0,0 +1,91 @@ +.. _user_guide: + +User Guide +========== + +.. _plugin_configuration: + +Plugin configuration +-------------------- + +#. `Create a new environment with the Fuel UI wizard. `_ + At the moment only the Ubuntu distribution is supported. + + .. image:: _static/create_env1.png + :alt: Create a liberty OpenStack environment + + + .. image:: _static/create_env2.png + :alt: Select qemu-kvm as hypervisor + + + .. image:: _static/create_env3.png + :alt: Select VLAN segmentation for tenant network + + + Select the desired storage backends and additional services. + +#. `Add nodes to the environment and assign roles. `_ + +#. `Modify networking configurations. `_ + + .. image:: _static/networking_default.png + :alt: Modify public/storage/management network settings in default network group. + + + .. image:: _static/networking_ml2.png + :alt: Modify ml2 vlan related configuration. + + + .. image:: _static/networking_l3.png + :alt: Modify floating IP pool. + +#. Configure FortiGate Connector settings. + Click on Other on navigation bar and scroll down to "Fuel plugin to deploy FortiGate ML2 plugin on OpenStack". + Click on the checkbox for the Fortinet fuel plugin and change related settings. + + .. image:: _static/networking_fortinet.png + :alt: Modify FortiGate related settings. + +#. Click *Save Settings* at the bottom of the page to save the configuration parameters. + +#. Switch to the *Nodes* tab and assign different networks to the interfaces. + + .. image:: _static/nodes_interface1.png + + + .. image:: _static/nodes_interface2.png + + +#. Select the *Networks* tab, scroll to the bottom, and `Verify Networks `_. + +#. Then finally, `Deploy Changes `_. + +.. _plugin_install_verification: + +Plugin Install Verification +--------------------------- + +Once the deployment is finished, the Dashboard tab will display the "Success" notification, stating that +the plugin is deployed and a link with name HTTP will be displayed. + +.. image:: _static/deployment_success.png + :alt: A screenshot of the Dashboard Success notification + :scale: 90% + +Click on *HTTP* and it will lead you to OpenStack dashboard. + +.. image:: _static/horizon.png + :alt: The link to the OpenStack Horizon dashboard. + +When Neutron service starts, it will use the FortiGate Connector to initialize the FortiGate and create a VDOM called osvdmext. +You can log onto FortiGate to check whether the VDOM has been created. + +.. image:: _static/fortigate.png + :alt: Auto created VDOM osvdmext. + +Using FortiGate Connector +------------------------- + +For instructions on using the FortiGate Connector, please refer to the official admin guide on `Fortinet support site `_. +The operations are transparent to the OpenStack users and the FortiGate connector will configure the FortiGate via RestFul API when networks, subnets, routers and firewalls are created on OpenStack. diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..8bff558 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,18 @@ +.. fuel-plugin-fortinet documentation master file, created by + sphinx-quickstart on Tue June 7 12:48:35 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +================================================ +Guide to the Fortinet Plugin ver. 1.0.0 for Fuel +================================================ + +User documentation +================== + +.. toctree:: + :maxdepth: 2 + + overview + installation + guide diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 0000000..caeb2ec --- /dev/null +++ b/doc/source/installation.rst @@ -0,0 +1,31 @@ +Installation Guide +================== + +How to install Fuel Master +-------------------------- + +Please refer to `Mirantis official documentation for Fuel 8.0 `_ for the installation of Fuel master node. + +How to install the plugin +------------------------- + +#. Build the fuel plugin on Fuel Master. + + .. code:: bash + git clone https://github.com/jerryz1982/fuel-plugin-fortinet.git + cd fuel-plugin-fortinet + fpb --build ./ + +#. Install the plugin using the fuel command line: + + .. code:: bash + fuel plugins --install fuel-plugin-fortinet*.rpm + +#. Verify that the plugin is installed correctly: + + .. code:: bash + + [root@fuel ~]# fuel plugins + id | name | version | package_version + ---|----------------------|---------|---------------- + 1 | fuel-plugin-fortinet | 1.0.0 | 4.0.0 diff --git a/doc/source/overview.rst b/doc/source/overview.rst new file mode 100644 index 0000000..4514cff --- /dev/null +++ b/doc/source/overview.rst @@ -0,0 +1,51 @@ +.. _user_overview: + +Overview +======== + +OpenStack Neutron provides networking-as-a-service between interface devices +(e.g., vNICs) managed by other OpenStack services such as Nova (compute). +The FortiGate Connector for OpenStack Neutron enables a FortiGate physical +or virtual appliance to operate as an OpenStack Neutron network node and delivers +the best of both worlds in advanced security and network performance. The combined +solution enables FortiGate, particularly when leveraging high-speed hardware ASIC’s +in physical models, to boost Neutron performance and eliminate security chokepoints, +by leveraging the Modular Layer 2 (ML2) plug-in interface. + +Additional Neutron FWaaS (Firewall-as-a-Service) integration further enables +orchestration of FortiGate security policy through OpenStack, in addition to network +and firewall service insertion. The Horizon dashboard provides a single pane-of-glass +to automatically provision security profiles seamlessly with tenant network and firewall +deployment, allowing clouds and data centers to scale elastically without protection gaps. +Firewall rules can further be customized within the Horizon dashboard, and as well as +delegated when empowering tenant self-service. + +This Fuel plugin will enable the installation and configuration of FortiGate connector for +OpenStack with Fuel. + +.. _plugin_requirements: + +Requirements +------------ + ++----------------------------------+-----------------------------------------------------------------------+ +| **Requirement** | **Version/Comment** | ++==================================+=======================================================================+ +| Mirantis OpenStack compatility | 8.0 | ++----------------------------------+-----------------------------------------------------------------------+ +| Distribution Supported | Ubuntu | ++----------------------------------+-----------------------------------------------------------------------+ +| Hardware Minimum Recommendations | FortiGate: Physical or Virtual appliances with FOS 5.2.3 and up. | +| | Fuel Server: 4 CPU, 4G RAM, 100GB Disk, 2 NICs(1 mgmt, 1 pxe) | +| | OpenStack Controller: 8CPU, 8G RAM, 2 NICs(1 mgmt,pxe, 1 public) | +| | OpenStack Compute: 8CPU, 16G RAM, 1 NIC(1 mgmt,pxe) | ++----------------------------------+-----------------------------------------------------------------------+ + +.. _plugin_limitations: + +Limitations +----------- + +At the moment, only vlan segmentation is supported for tenant networks in the +FortiGate Connector, so this fuel plugin will only be available when vlan is chosen +as the tenant network type.