summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJerry Zhao <xyzjerry@gmail.com>2016-06-07 17:59:48 -0700
committerJerry Zhao <xyzjerry@gmail.com>2016-06-07 17:59:48 -0700
commit6d5e6a2aae180f7ed97ec4b33b2c9189681e46a6 (patch)
tree10c8f91a9d833d3f21fe172ba38d42a6cee963cd
parente4f07beb3e9a680d9d7c1d2469f59bd010089340 (diff)
add documentation for fortinet plugin for fuel
-rw-r--r--.gitignore2
-rw-r--r--doc/Makefile177
-rw-r--r--doc/source/_static/create_env1.pngbin0 -> 168656 bytes
-rw-r--r--doc/source/_static/create_env2.pngbin0 -> 133260 bytes
-rw-r--r--doc/source/_static/create_env3.pngbin0 -> 146755 bytes
-rw-r--r--doc/source/_static/deployment_success.pngbin0 -> 111857 bytes
-rw-r--r--doc/source/_static/fortigate.pngbin0 -> 141368 bytes
-rw-r--r--doc/source/_static/horizon.pngbin0 -> 125871 bytes
-rw-r--r--doc/source/_static/networking_default.pngbin0 -> 119525 bytes
-rw-r--r--doc/source/_static/networking_fortinet.pngbin0 -> 113380 bytes
-rw-r--r--doc/source/_static/networking_l3.pngbin0 -> 132551 bytes
-rw-r--r--doc/source/_static/networking_ml2.pngbin0 -> 108058 bytes
-rw-r--r--doc/source/_static/nodes_interface1.pngbin0 -> 141031 bytes
-rw-r--r--doc/source/_static/nodes_interface2.pngbin0 -> 113965 bytes
-rw-r--r--doc/source/conf.py340
-rw-r--r--doc/source/guide.rst91
-rw-r--r--doc/source/index.rst18
-rw-r--r--doc/source/installation.rst31
-rw-r--r--doc/source/overview.rst51
19 files changed, 709 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index fabbcee..9c0a96c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,4 +2,4 @@
2.build 2.build
3*.pyc 3*.pyc
4*.rpm 4*.rpm
5.build 5doc/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 @@
1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS =
6SPHINXBUILD = sphinx-build
7PAPER =
8BUILDDIR = build
9
10# User-friendly check for sphinx-build
11ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12$(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/)
13endif
14
15# Internal variables.
16PAPEROPT_a4 = -D latex_paper_size=a4
17PAPEROPT_letter = -D latex_paper_size=letter
18ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19# the i18n builder cannot share the environment and doctrees with the others
20I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21
22.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23
24help:
25 @echo "Please use \`make <target>' where <target> is one of"
26 @echo " html to make standalone HTML files"
27 @echo " dirhtml to make HTML files named index.html in directories"
28 @echo " singlehtml to make a single large HTML file"
29 @echo " pickle to make pickle files"
30 @echo " json to make JSON files"
31 @echo " htmlhelp to make HTML files and a HTML help project"
32 @echo " qthelp to make HTML files and a qthelp project"
33 @echo " devhelp to make HTML files and a Devhelp project"
34 @echo " epub to make an epub"
35 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36 @echo " latexpdf to make LaTeX files and run them through pdflatex"
37 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38 @echo " text to make text files"
39 @echo " man to make manual pages"
40 @echo " texinfo to make Texinfo files"
41 @echo " info to make Texinfo files and run them through makeinfo"
42 @echo " gettext to make PO message catalogs"
43 @echo " changes to make an overview of all changed/added/deprecated items"
44 @echo " xml to make Docutils-native XML files"
45 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
46 @echo " linkcheck to check all external links for integrity"
47 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
48
49clean:
50 rm -rf $(BUILDDIR)/*
51
52html:
53 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54 @echo
55 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56
57dirhtml:
58 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59 @echo
60 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61
62singlehtml:
63 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64 @echo
65 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66
67pickle:
68 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69 @echo
70 @echo "Build finished; now you can process the pickle files."
71
72json:
73 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74 @echo
75 @echo "Build finished; now you can process the JSON files."
76
77htmlhelp:
78 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79 @echo
80 @echo "Build finished; now you can run HTML Help Workshop with the" \
81 ".hhp project file in $(BUILDDIR)/htmlhelp."
82
83qthelp:
84 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85 @echo
86 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
87 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/fuel-plugin-fortinet.qhcp"
89 @echo "To view the help file:"
90 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/fuel-plugin-fortinet.qhc"
91
92devhelp:
93 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94 @echo
95 @echo "Build finished."
96 @echo "To view the help file:"
97 @echo "# mkdir -p $$HOME/.local/share/devhelp/fuel-plugin-fortinet"
98 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/fuel-plugin-fortinet"
99 @echo "# devhelp"
100
101epub:
102 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103 @echo
104 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105
106latex:
107 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108 @echo
109 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110 @echo "Run \`make' in that directory to run these through (pdf)latex" \
111 "(use \`make latexpdf' here to do that automatically)."
112
113latexpdf:
114 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115 @echo "Running LaTeX files through pdflatex..."
116 $(MAKE) -C $(BUILDDIR)/latex all-pdf
117 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118
119latexpdfja:
120 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121 @echo "Running LaTeX files through platex and dvipdfmx..."
122 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124
125text:
126 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127 @echo
128 @echo "Build finished. The text files are in $(BUILDDIR)/text."
129
130man:
131 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132 @echo
133 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134
135texinfo:
136 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137 @echo
138 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139 @echo "Run \`make' in that directory to run these through makeinfo" \
140 "(use \`make info' here to do that automatically)."
141
142info:
143 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144 @echo "Running Texinfo files through makeinfo..."
145 make -C $(BUILDDIR)/texinfo info
146 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147
148gettext:
149 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150 @echo
151 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152
153changes:
154 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155 @echo
156 @echo "The overview file is in $(BUILDDIR)/changes."
157
158linkcheck:
159 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160 @echo
161 @echo "Link check complete; look for any errors in the above output " \
162 "or in $(BUILDDIR)/linkcheck/output.txt."
163
164doctest:
165 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166 @echo "Testing of doctests in the sources finished, look at the " \
167 "results in $(BUILDDIR)/doctest/output.txt."
168
169xml:
170 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171 @echo
172 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173
174pseudoxml:
175 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176 @echo
177 @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
--- /dev/null
+++ b/doc/source/_static/create_env1.png
Binary files differ
diff --git a/doc/source/_static/create_env2.png b/doc/source/_static/create_env2.png
new file mode 100644
index 0000000..2f4b616
--- /dev/null
+++ b/doc/source/_static/create_env2.png
Binary files differ
diff --git a/doc/source/_static/create_env3.png b/doc/source/_static/create_env3.png
new file mode 100644
index 0000000..aedccbf
--- /dev/null
+++ b/doc/source/_static/create_env3.png
Binary files differ
diff --git a/doc/source/_static/deployment_success.png b/doc/source/_static/deployment_success.png
new file mode 100644
index 0000000..65f8795
--- /dev/null
+++ b/doc/source/_static/deployment_success.png
Binary files differ
diff --git a/doc/source/_static/fortigate.png b/doc/source/_static/fortigate.png
new file mode 100644
index 0000000..7297ace
--- /dev/null
+++ b/doc/source/_static/fortigate.png
Binary files differ
diff --git a/doc/source/_static/horizon.png b/doc/source/_static/horizon.png
new file mode 100644
index 0000000..d583df8
--- /dev/null
+++ b/doc/source/_static/horizon.png
Binary files differ
diff --git a/doc/source/_static/networking_default.png b/doc/source/_static/networking_default.png
new file mode 100644
index 0000000..bf84e35
--- /dev/null
+++ b/doc/source/_static/networking_default.png
Binary files differ
diff --git a/doc/source/_static/networking_fortinet.png b/doc/source/_static/networking_fortinet.png
new file mode 100644
index 0000000..1b4ac11
--- /dev/null
+++ b/doc/source/_static/networking_fortinet.png
Binary files differ
diff --git a/doc/source/_static/networking_l3.png b/doc/source/_static/networking_l3.png
new file mode 100644
index 0000000..d6947b6
--- /dev/null
+++ b/doc/source/_static/networking_l3.png
Binary files differ
diff --git a/doc/source/_static/networking_ml2.png b/doc/source/_static/networking_ml2.png
new file mode 100644
index 0000000..23d2488
--- /dev/null
+++ b/doc/source/_static/networking_ml2.png
Binary files differ
diff --git a/doc/source/_static/nodes_interface1.png b/doc/source/_static/nodes_interface1.png
new file mode 100644
index 0000000..2354fc5
--- /dev/null
+++ b/doc/source/_static/nodes_interface1.png
Binary files differ
diff --git a/doc/source/_static/nodes_interface2.png b/doc/source/_static/nodes_interface2.png
new file mode 100644
index 0000000..fcc14c5
--- /dev/null
+++ b/doc/source/_static/nodes_interface2.png
Binary files 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 @@
1# -*- coding: utf-8 -*-
2#
3# fuel-plugin-fortinet documentation build configuration file, created by
4# sphinx-quickstart on Tue June 7 12:48:35 2016.
5#
6# This file is execfile()d with the current directory set to its
7# containing dir.
8#
9# Note that not all possible configuration values are present in this
10# autogenerated file.
11#
12# All configuration values have a default; values that are commented out
13# serve to show the default.
14
15import sys
16import os
17
18# If extensions (or modules to document with autodoc) are in another directory,
19# add these directories to sys.path here. If the directory is relative to the
20# documentation root, use os.path.abspath to make it absolute, like shown here.
21#sys.path.insert(0, os.path.abspath('.'))
22
23# -- General configuration ------------------------------------------------
24
25# If your documentation needs a minimal Sphinx version, state it here.
26#needs_sphinx = '1.0'
27
28# Add any Sphinx extension module names here, as strings. They can be
29# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30# ones.
31extensions = [
32# 'sphinx.ext.todo',
33# 'sphinx.ext.coverage',
34]
35
36# Add any paths that contain templates here, relative to this directory.
37templates_path = ['_templates']
38
39# The suffix of source filenames.
40source_suffix = '.rst'
41
42# The encoding of source files.
43#source_encoding = 'utf-8-sig'
44
45# The master toctree document.
46master_doc = 'index'
47
48# General information about the project.
49project = u'The Fortinet plugin for Fuel'
50copyright = u'2016, Fortinet Inc.'
51
52# The version info for the project you're documenting, acts as replacement for
53# |version| and |release|, also used in various other places throughout the
54# built documents.
55#
56# The short X.Y version.
57version = '1.0'
58# The full version, including alpha/beta/rc tags.
59release = '1.0-1.0.0-1'
60
61# The language for content autogenerated by Sphinx. Refer to documentation
62# for a list of supported languages.
63#language = None
64
65# There are two options for replacing |today|: either, you set today to some
66# non-false value, then it is used:
67#today = ''
68# Else, today_fmt is used as the format for a strftime call.
69#today_fmt = '%B %d, %Y'
70
71# List of patterns, relative to source directory, that match files and
72# directories to ignore when looking for source files.
73exclude_patterns = []
74
75# The reST default role (used for this markup: `text`) to use for all
76# documents.
77#default_role = None
78
79# If true, '()' will be appended to :func: etc. cross-reference text.
80#add_function_parentheses = True
81
82# If true, the current module name will be prepended to all description
83# unit titles (such as .. function::).
84#add_module_names = True
85
86# If true, sectionauthor and moduleauthor directives will be shown in the
87# output. They are ignored by default.
88#show_authors = False
89
90# The name of the Pygments (syntax highlighting) style to use.
91pygments_style = 'sphinx'
92
93# A list of ignored prefixes for module index sorting.
94#modindex_common_prefix = []
95
96# If true, keep warnings as "system message" paragraphs in the built documents.
97#keep_warnings = False
98
99
100# -- Options for HTML output ----------------------------------------------
101
102# The theme to use for HTML and HTML Help pages. See the documentation for
103# a list of builtin themes.
104html_theme = 'default'
105
106# Theme options are theme-specific and customize the look and feel of a theme
107# further. For a list of options available for each theme, see the
108# documentation.
109#html_theme_options = {}
110
111# Add any paths that contain custom themes here, relative to this directory.
112#html_theme_path = []
113
114# The name for this set of Sphinx documents. If None, it defaults to
115# "<project> v<release> documentation".
116#html_title = None
117
118# A shorter title for the navigation bar. Default is the same as html_title.
119#html_short_title = None
120
121# The name of an image file (relative to this directory) to place at the top
122# of the sidebar.
123#html_logo = None
124
125# The name of an image file (within the static path) to use as favicon of the
126# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
127# pixels large.
128#html_favicon = None
129
130# Add any paths that contain custom static files (such as style sheets) here,
131# relative to this directory. They are copied after the builtin static files,
132# so a file named "default.css" will overwrite the builtin "default.css".
133html_static_path = ['_static']
134
135# Add any extra paths that contain custom files (such as robots.txt or
136# .htaccess) here, relative to this directory. These files are copied
137# directly to the root of the documentation.
138#html_extra_path = []
139
140# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
141# using the given strftime format.
142#html_last_updated_fmt = '%b %d, %Y'
143
144# If true, SmartyPants will be used to convert quotes and dashes to
145# typographically correct entities.
146#html_use_smartypants = True
147
148# Custom sidebar templates, maps document names to template names.
149#html_sidebars = {}
150
151# Additional templates that should be rendered to pages, maps page names to
152# template names.
153#html_additional_pages = {}
154
155# If false, no module index is generated.
156#html_domain_indices = True
157
158# If false, no index is generated.
159#html_use_index = True
160
161# If true, the index is split into individual pages for each letter.
162#html_split_index = False
163
164# If true, links to the reST sources are added to the pages.
165#html_show_sourcelink = True
166
167# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
168#html_show_sphinx = True
169
170# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
171#html_show_copyright = True
172
173# If true, an OpenSearch description file will be output, and all pages will
174# contain a <link> tag referring to it. The value of this option must be the
175# base URL from which the finished HTML is served.
176#html_use_opensearch = ''
177
178# This is the file name suffix for HTML files (e.g. ".xhtml").
179#html_file_suffix = None
180
181# Output file base name for HTML help builder.
182htmlhelp_basename = 'fuel-plugin-fortinet'
183
184
185# -- Options for LaTeX output ---------------------------------------------
186
187latex_elements = {
188# The paper size ('letterpaper' or 'a4paper').
189#'papersize': 'letterpaper',
190
191# The font size ('10pt', '11pt' or '12pt').
192#'pointsize': '10pt',
193
194# Additional stuff for the LaTeX preamble.
195#'preamble': '',
196}
197
198# Grouping the document tree into LaTeX files. List of tuples
199# (source start file, target name, title,
200# author, documentclass [howto, manual, or own class]).
201latex_documents = [
202 ('index', 'fuel-plugin-fortinet.tex', u'The Fortinet Plugin for Fuel Documentation',
203 u'Fortinet Inc.', 'manual'),
204]
205
206# The name of an image file (relative to this directory) to place at the top of
207# the title page.
208#latex_logo = None
209
210# For "manual" documents, if this is true, then toplevel headings are parts,
211# not chapters.
212#latex_use_parts = False
213
214# If true, show page references after internal links.
215#latex_show_pagerefs = False
216
217# If true, show URL addresses after external links.
218#latex_show_urls = False
219
220# Documents to append as an appendix to all manuals.
221#latex_appendices = []
222
223# If false, no module index is generated.
224#latex_domain_indices = True
225
226# make latex stop printing blank pages between sections
227# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
228latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
229
230
231# -- Options for manual page output ---------------------------------------
232
233# One entry per manual page. List of tuples
234# (source start file, name, description, authors, manual section).
235man_pages = [
236 ('index', 'fuel-plugin-fortinet', u'Guide to the Fortinet Plugin ver. 1.1-1.0.0-1 for Fuel',
237 [u'Fortinet Inc.'], 1)
238]
239
240# If true, show URL addresses after external links.
241#man_show_urls = False
242
243
244# -- Options for Texinfo output -------------------------------------------
245
246# Grouping the document tree into Texinfo files. List of tuples
247# (source start file, target name, title, author,
248# dir menu entry, description, category)
249texinfo_documents = [
250 ('index', 'fuel-plugin-fortinet', u'The Fortinet Plugin for Fuel Documentation',
251 u'Fortinet Inc.', 'fuel-plugin-fortinet', 'The Fortinet Plugin for Fuel Documentation',
252 'Miscellaneous'),
253]
254
255# Documents to append as an appendix to all manuals.
256#texinfo_appendices = []
257
258# If false, no module index is generated.
259#texinfo_domain_indices = True
260
261# How to display URL addresses: 'footnote', 'no', or 'inline'.
262#texinfo_show_urls = 'footnote'
263
264# If true, do not generate a @detailmenu in the "Top" node's menu.
265#texinfo_no_detailmenu = False
266
267# Insert footnotes where they are defined instead of
268# at the end.
269pdf_inline_footnotes = True
270
271
272
273# -- Options for Epub output ----------------------------------------------
274
275# Bibliographic Dublin Core info.
276epub_title = u'The Fortinet Plugin for Fuel'
277epub_author = u'Fortinet Inc.'
278epub_publisher = u'Fortinet Inc.'
279epub_copyright = u'2016, Fortinet Inc.'
280
281# The basename for the epub file. It defaults to the project name.
282#epub_basename = u'fuel-plugin-fortinet'
283
284# The HTML theme for the epub output. Since the default themes are not optimized
285# for small screen space, using the same theme for HTML and epub output is
286# usually not wise. This defaults to 'epub', a theme designed to save visual
287# space.
288#epub_theme = 'epub'
289
290# The language of the text. It defaults to the language option
291# or en if the language is not set.
292#epub_language = ''
293
294# The scheme of the identifier. Typical schemes are ISBN or URL.
295#epub_scheme = ''
296
297# The unique identifier of the text. This can be a ISBN number
298# or the project homepage.
299#epub_identifier = ''
300
301# A unique identification for the text.
302#epub_uid = ''
303
304# A tuple containing the cover image and cover page html template filenames.
305#epub_cover = ()
306
307# A sequence of (type, uri, title) tuples for the guide element of content.opf.
308#epub_guide = ()
309
310# HTML files that should be inserted before the pages created by sphinx.
311# The format is a list of tuples containing the path and title.
312#epub_pre_files = []
313
314# HTML files shat should be inserted after the pages created by sphinx.
315# The format is a list of tuples containing the path and title.
316#epub_post_files = []
317
318# A list of files that should not be packed into the epub file.
319epub_exclude_files = ['search.html']
320
321# The depth of the table of contents in toc.ncx.
322#epub_tocdepth = 3
323
324# Allow duplicate toc entries.
325#epub_tocdup = True
326
327# Choose between 'default' and 'includehidden'.
328#epub_tocscope = 'default'
329
330# Fix unsupported image types using the PIL.
331#epub_fix_images = False
332
333# Scale large images.
334#epub_max_image_width = 0
335
336# How to display URL addresses: 'footnote', 'no', or 'inline'.
337#epub_show_urls = 'inline'
338
339# If false, no index is generated.
340#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 @@
1.. _user_guide:
2
3User Guide
4==========
5
6.. _plugin_configuration:
7
8Plugin configuration
9--------------------
10
11#. `Create a new environment with the Fuel UI wizard. <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_
12 At the moment only the Ubuntu distribution is supported.
13
14 .. image:: _static/create_env1.png
15 :alt: Create a liberty OpenStack environment
16
17
18 .. image:: _static/create_env2.png
19 :alt: Select qemu-kvm as hypervisor
20
21
22 .. image:: _static/create_env3.png
23 :alt: Select VLAN segmentation for tenant network
24
25
26 Select the desired storage backends and additional services.
27
28#. `Add nodes to the environment and assign roles. <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/add-nodes.html>`_
29
30#. `Modify networking configurations. <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/network-settings.html>`_
31
32 .. image:: _static/networking_default.png
33 :alt: Modify public/storage/management network settings in default network group.
34
35
36 .. image:: _static/networking_ml2.png
37 :alt: Modify ml2 vlan related configuration.
38
39
40 .. image:: _static/networking_l3.png
41 :alt: Modify floating IP pool.
42
43#. Configure FortiGate Connector settings.
44 Click on Other on navigation bar and scroll down to "Fuel plugin to deploy FortiGate ML2 plugin on OpenStack".
45 Click on the checkbox for the Fortinet fuel plugin and change related settings.
46
47 .. image:: _static/networking_fortinet.png
48 :alt: Modify FortiGate related settings.
49
50#. Click *Save Settings* at the bottom of the page to save the configuration parameters.
51
52#. Switch to the *Nodes* tab and assign different networks to the interfaces.
53
54 .. image:: _static/nodes_interface1.png
55
56
57 .. image:: _static/nodes_interface2.png
58
59
60#. Select the *Networks* tab, scroll to the bottom, and `Verify Networks <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/verify-networks.html>`_.
61
62#. Then finally, `Deploy Changes <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.
63
64.. _plugin_install_verification:
65
66Plugin Install Verification
67---------------------------
68
69Once the deployment is finished, the Dashboard tab will display the "Success" notification, stating that
70the plugin is deployed and a link with name HTTP will be displayed.
71
72.. image:: _static/deployment_success.png
73 :alt: A screenshot of the Dashboard Success notification
74 :scale: 90%
75
76Click on *HTTP* and it will lead you to OpenStack dashboard.
77
78.. image:: _static/horizon.png
79 :alt: The link to the OpenStack Horizon dashboard.
80
81When Neutron service starts, it will use the FortiGate Connector to initialize the FortiGate and create a VDOM called osvdmext.
82You can log onto FortiGate to check whether the VDOM has been created.
83
84.. image:: _static/fortigate.png
85 :alt: Auto created VDOM osvdmext.
86
87Using FortiGate Connector
88-------------------------
89
90For instructions on using the FortiGate Connector, please refer to the official admin guide on `Fortinet support site <http://support.fortinet.com>`_.
91The 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 @@
1.. fuel-plugin-fortinet documentation master file, created by
2 sphinx-quickstart on Tue June 7 12:48:35 2016.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6================================================
7Guide to the Fortinet Plugin ver. 1.0.0 for Fuel
8================================================
9
10User documentation
11==================
12
13.. toctree::
14 :maxdepth: 2
15
16 overview
17 installation
18 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 @@
1Installation Guide
2==================
3
4How to install Fuel Master
5--------------------------
6
7Please refer to `Mirantis official documentation for Fuel 8.0 <https://docs.mirantis.com/openstack/fuel/fuel-8.0/pdfs.html>`_ for the installation of Fuel master node.
8
9How to install the plugin
10-------------------------
11
12#. Build the fuel plugin on Fuel Master.
13
14 .. code:: bash
15 git clone https://github.com/jerryz1982/fuel-plugin-fortinet.git
16 cd fuel-plugin-fortinet
17 fpb --build ./
18
19#. Install the plugin using the fuel command line:
20
21 .. code:: bash
22 fuel plugins --install fuel-plugin-fortinet*.rpm
23
24#. Verify that the plugin is installed correctly:
25
26 .. code:: bash
27
28 [root@fuel ~]# fuel plugins
29 id | name | version | package_version
30 ---|----------------------|---------|----------------
31 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 @@
1.. _user_overview:
2
3Overview
4========
5
6OpenStack Neutron provides networking-as-a-service between interface devices
7(e.g., vNICs) managed by other OpenStack services such as Nova (compute).
8The FortiGate Connector for OpenStack Neutron enables a FortiGate physical
9or virtual appliance to operate as an OpenStack Neutron network node and delivers
10the best of both worlds in advanced security and network performance. The combined
11solution enables FortiGate, particularly when leveraging high-speed hardware ASIC’s
12in physical models, to boost Neutron performance and eliminate security chokepoints,
13by leveraging the Modular Layer 2 (ML2) plug-in interface.
14
15Additional Neutron FWaaS (Firewall-as-a-Service) integration further enables
16orchestration of FortiGate security policy through OpenStack, in addition to network
17and firewall service insertion. The Horizon dashboard provides a single pane-of-glass
18to automatically provision security profiles seamlessly with tenant network and firewall
19deployment, allowing clouds and data centers to scale elastically without protection gaps.
20Firewall rules can further be customized within the Horizon dashboard, and as well as
21delegated when empowering tenant self-service.
22
23This Fuel plugin will enable the installation and configuration of FortiGate connector for
24OpenStack with Fuel.
25
26.. _plugin_requirements:
27
28Requirements
29------------
30
31+----------------------------------+-----------------------------------------------------------------------+
32| **Requirement** | **Version/Comment** |
33+==================================+=======================================================================+
34| Mirantis OpenStack compatility | 8.0 |
35+----------------------------------+-----------------------------------------------------------------------+
36| Distribution Supported | Ubuntu |
37+----------------------------------+-----------------------------------------------------------------------+
38| Hardware Minimum Recommendations | FortiGate: Physical or Virtual appliances with FOS 5.2.3 and up. |
39| | Fuel Server: 4 CPU, 4G RAM, 100GB Disk, 2 NICs(1 mgmt, 1 pxe) |
40| | OpenStack Controller: 8CPU, 8G RAM, 2 NICs(1 mgmt,pxe, 1 public) |
41| | OpenStack Compute: 8CPU, 16G RAM, 1 NIC(1 mgmt,pxe) |
42+----------------------------------+-----------------------------------------------------------------------+
43
44.. _plugin_limitations:
45
46Limitations
47-----------
48
49At the moment, only vlan segmentation is supported for tenant networks in the
50FortiGate Connector, so this fuel plugin will only be available when vlan is chosen
51as the tenant network type.