diff --git a/.gitignore b/.gitignore index eb139b8..867c7ee 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,6 @@ sys_test.log # IDE settings .idea/* + +# Documentation build files +doc/user_guide/_build diff --git a/doc/user_guide/Makefile b/doc/user_guide/Makefile new file mode 100644 index 0000000..b1890c4 --- /dev/null +++ b/doc/user_guide/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) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.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/FuelVMwareDVSplugin.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FuelVMwareDVSplugin.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/FuelVMwareDVSplugin" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FuelVMwareDVSplugin" + @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/user_guide/appendix.rst b/doc/user_guide/appendix.rst new file mode 100644 index 0000000..9753589 --- /dev/null +++ b/doc/user_guide/appendix.rst @@ -0,0 +1,9 @@ +Useful links +------------ + +For more information about Google Cloud Storage(GCS) Fuel plugin +described in this document, see: + +* `Specification `_ +* `GitHub project `_ +* `Launchpad project `_ diff --git a/doc/user_guide/conf.py b/doc/user_guide/conf.py new file mode 100644 index 0000000..8b9d8fb --- /dev/null +++ b/doc/user_guide/conf.py @@ -0,0 +1,337 @@ +"""Copyright 2016 Mirantis, Inc. + +Licensed under the Apache License, Version 2.0 (the "License"); you may +not use this file except in compliance with the License. You may obtain +copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +License for the specific language governing permissions and limitations +under the License. +""" + +# -*- coding: utf-8 -*- # noqa +# +# Google Cloud Storage(GCS) Fuel plugin documentation build configuration file, created by +# sphinx-quickstart on Fri Aug 14 12:14:29 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. + + +# 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 = [] + +# 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'Google Cloud Storage(GCS) Fuel plugin' +copyright = u'2016, Mirantis Inc.' # noqa + +# 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.0' +# The full version, including alpha/beta/rc tags. +release = '1.0-1.0.0-0' + +# 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 = 'GCSFuelplugindoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + 'classoptions': ',openany,oneside', 'babel': '\\usepackage[english]{babel}' +} + +# 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', 'GCSFuelplugin.tex', u'Google Cloud Storage(GCS) Fuel Plugin\ + Guide', u'Mirantis 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 + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'gcsfuelplugin', u'Google Cloud Storage(GCS) Fuel plugin user\ + guide', [u'Mirantis 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', 'GCSFuelplugin', u'Google Cloud Storage(GCS) Fuel plugin user guide', + u'Mirantis Inc.', 'GCSFuelplugin', + 'One line description of project.', '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'Google Cloud Storage(GCS) Plugin for Fuel' +epub_author = u'Mirantis Inc.' +epub_publisher = u'Mirantis Inc.' +epub_copyright = u'2016, Mirantis Inc.' + +# The basename for the epub file. It defaults to the project name. +#epub_basename = u'fuel-plugin-openbook' + +# 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/user_guide/config.rst b/doc/user_guide/config.rst new file mode 100644 index 0000000..b95270e --- /dev/null +++ b/doc/user_guide/config.rst @@ -0,0 +1,78 @@ +.. _configure: + +Configure an environment with GCS Fuel plugin +--------------------------------------------- + +To create and configure environment with GCS Fuel plugin, +follow the steps below: + +#. `Create a new OpenStack environment `_ + in Fuel web UI. + +#. Use Cinder with LVM backend or CEPH for block storage in + Storage Backends tab. Additional details on storage planning can be found in + `Mirantis OpenStack Planning guide `_. + + .. image:: images/storage.png + +#. Enable the Google Cloud Storage Fuel plugin in `Additional services` tab: + + .. image:: images/plugin.png + +#. Add nodes and assign them roles: + + * in case if LVM backend for Cinder is enabled + + * At least 1 Controller + * Desired number of Compute hosts + * At least 1 Cinder node, the Cinder role can also be added to Compute or + Controller node + + * in case if CEPH backend is enabled for volumes + + * At least 1 Controller + * Desired number of Compute hosts + * At least 3 CEPH OSD hosts, this role can be co-located with other roles + +#. Navigate to the `Settings` tab to configure the Fuel GCS plugin parameters. + All of the plugin settings fields must be filled with correct values, + most of them do not have default values as they are environment-specific. + +Google Cloud Storage(GCS) Fuel plugin settings are logically divided into +two parts: + +* Mandatory settings + + .. image:: images/settings.png + + * The project ID + * The bucket name to store backup data + * The storage class for the bucket, can be selected from drop-down list + * Bucket location, a list of locations can be found in + `Google Cloud storage documentation `_ + + * Credentials related settings such as `GCS Account type`, `Private Key ID`, + `Private Key`, `Client E-mail`, `Client ID`, `Auth URI`, `Token URI`, + `Auth Provider X509 Cert URL`, `Client X509 Cert URL` should be copied from + corresponding fields of credentials JSON file. This file is downloaded from + `Google Cloud Console `_ + on new service account creation at API management page. + +* Advanced settings + + .. image:: images/advanced_settings.png + +This section is visible only when `Show advanced settings` checkbox is enabled. +Changing values here may be required to override the default settings for +Google Cloud Cinder backup driver. +The fields have reasonable default values, which correspond to driver defaults. +Please see `OpenStack documentation `_ +for a list of GCS backup driver configuration options. + +#. Press `Save Settings` button. + +#. Make additional + `configuration adjustments `__. + +#. Proceed to the + `environment deployment `__. diff --git a/doc/user_guide/definitions.rst b/doc/user_guide/definitions.rst new file mode 100644 index 0000000..dca6af1 --- /dev/null +++ b/doc/user_guide/definitions.rst @@ -0,0 +1,22 @@ +.. _definitions: + +Key terms +--------- + +The table below lists the key terms, acronyms, and abbreviations that are used +in this document. + +.. tabularcolumns:: |p{4cm}|p{12.5cm}| + +====================== ======================================================== +**Term/abbreviation** **Definition** +====================== ======================================================== +Cinder `Block Storage service for OpenStack `__ +GCS `Google Cloud Storage `__ +GCS backup driver `Google Cloud Storage backup driver `__ +Mistral `OpenStack workflow service `__ +====================== ======================================================== + +.. raw:: latex + + \pagebreak diff --git a/doc/user_guide/images/advanced_settings.png b/doc/user_guide/images/advanced_settings.png new file mode 100644 index 0000000..36dfadb Binary files /dev/null and b/doc/user_guide/images/advanced_settings.png differ diff --git a/doc/user_guide/images/plugin.png b/doc/user_guide/images/plugin.png new file mode 100644 index 0000000..32c5409 Binary files /dev/null and b/doc/user_guide/images/plugin.png differ diff --git a/doc/user_guide/images/settings.png b/doc/user_guide/images/settings.png new file mode 100644 index 0000000..887eeec Binary files /dev/null and b/doc/user_guide/images/settings.png differ diff --git a/doc/user_guide/images/storage.png b/doc/user_guide/images/storage.png new file mode 100644 index 0000000..52886cd Binary files /dev/null and b/doc/user_guide/images/storage.png differ diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst new file mode 100644 index 0000000..1b7ca12 --- /dev/null +++ b/doc/user_guide/index.rst @@ -0,0 +1,35 @@ +================================================ +Google Cloud Storage(GCS) Fuel Plugin User Guide +================================================ + +Overview +~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + intro + definitions + requirements + prerequisites + limitations + release_notes + license + appendix + +Install and configure GCS Fuel Plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + install + config + +Use GCS Fuel Plugin +~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + troubleshooting diff --git a/doc/user_guide/install.rst b/doc/user_guide/install.rst new file mode 100644 index 0000000..d93f7bf --- /dev/null +++ b/doc/user_guide/install.rst @@ -0,0 +1,39 @@ +Install Google Cloud Storage(GCS) Fuel plugin +--------------------------------------------- + +Before you proceed with Google Cloud Storage(GCS) Fuel plugin installation, please verify next: + +#. You have completed steps from :ref:`prerequisites` section. + +#. All the nodes of your future environment are *DISCOVERED* by the Fuel Master node. + +**To install the Google Cloud Storage(GCS) Fuel plugin:** + +#. Download Google Cloud Storage(GCS) Fuel plugin from the + `Fuel Plugin Catalog `__. + +#. Copy the plugin ``.rpm`` package to the Fuel Master node: + + .. code-block:: console + + $ scp fuel-plugin-cinder-gcs-1.0-1.0.0-1.noarch.rpm :/tmp + +#. Log in to the Fuel Master node CLI as root. + +#. Install the plugin: + + .. code-block:: console + + # fuel plugins --install /tmp/fuel-plugin-cinder-gcs-1.0-1.0.0-1.noarch.rpm + +#. Verify that the plugin was installed successfully: + + .. code-block:: console + + # fuel plugins + + id | name | version | package_version | releases + ---+------------------------+---------+-----------------+-------------------- + 2 | fuel-plugin-cinder-gcs | 1.0.0 | 4.0.0 | ubuntu (mitaka-9.0) + +#. Proceed to :ref:`configure` section. diff --git a/doc/user_guide/intro.rst b/doc/user_guide/intro.rst new file mode 100644 index 0000000..b06dd81 --- /dev/null +++ b/doc/user_guide/intro.rst @@ -0,0 +1,9 @@ +Introduction +------------ + +The purpose of this document is to describe how to install, configure, and use +Google Cloud Storage(GCS) plugin 1.0.0 for Fuel 9.0. + +Since Mitaka OpenStack release, Cinder supports Google Cloud Storage backup +driver. The plugin adds a possibility to Fuel to deploy OpenStack clouds with +Cinder configured for using GCS backup driver. diff --git a/doc/user_guide/license.rst b/doc/user_guide/license.rst new file mode 100644 index 0000000..be43276 --- /dev/null +++ b/doc/user_guide/license.rst @@ -0,0 +1,9 @@ +Licenses +-------- + +===================================== ============ +**Component** **License** +===================================== ============ +Google Cloud Storage(GCS) Fuel plugin Apache 2.0 +google-api-python-client Apache 2.0 +===================================== ============ diff --git a/doc/user_guide/limitations.rst b/doc/user_guide/limitations.rst new file mode 100644 index 0000000..b8558cc --- /dev/null +++ b/doc/user_guide/limitations.rst @@ -0,0 +1,10 @@ +Limitations +----------- + +Google Cloud Storage(GCS) Fuel plugin 1.0.0 has the following limitations: + +* Cinder does not support multiple backup backends at the same time so switching + backup backend for a cloud with some backups already created by another driver + may not be possible without losing access to previously created backups. + +* A single GCS bucket can be used per OpenStack environment. diff --git a/doc/user_guide/make_pdf.sh b/doc/user_guide/make_pdf.sh new file mode 100755 index 0000000..7da8430 --- /dev/null +++ b/doc/user_guide/make_pdf.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +lsb_release -a 2>/dev/null | grep 'Distributor ID:' | grep -q Ubuntu || \ + { echo 'Not an Ubuntu'; exit 1; } + +apt-cache policy texlive-latex-extra | grep 'Installed:' | grep -q '(none)' && \ + { echo 'Please install texlive-latex-extra package'; exit 1; } + +rm -rf _build + +make latexpdf + +echo -e -n '\nCreated pdf : ' + +find _build/ | grep -e '.*\.pdf' + +echo '' diff --git a/doc/user_guide/prerequisites.rst b/doc/user_guide/prerequisites.rst new file mode 100644 index 0000000..604b481 --- /dev/null +++ b/doc/user_guide/prerequisites.rst @@ -0,0 +1,14 @@ +.. _prerequisites: + +Prerequisites +------------- + +Before you install and start using Google Cloud Storage(GCS) Fuel plugin, +complete the following steps: + +#. Install and set up + `Fuel 9.0 `__. + +#. Make sure Internet is available on Cinder nodes + +#. Download JSON credentials file for service account from `Google Cloud Console `_. diff --git a/doc/user_guide/release_notes.rst b/doc/user_guide/release_notes.rst new file mode 100644 index 0000000..cc108e6 --- /dev/null +++ b/doc/user_guide/release_notes.rst @@ -0,0 +1,8 @@ +Release notes +------------- + +The Google Cloud Storage(GCS) Fuel plugin 1.0.0 provides: + +* A possibility of using Google Cloud Storage as a backup storage for Cinder backups. + +* A sample Mistral workbook for backup process automation. diff --git a/doc/user_guide/requirements.rst b/doc/user_guide/requirements.rst new file mode 100644 index 0000000..b79b5a0 --- /dev/null +++ b/doc/user_guide/requirements.rst @@ -0,0 +1,12 @@ +Requirements +------------ + +Google Cloud Storage(GCS) Fuel plugin 1.0.0 has the following requirements: + +* Fuel 9.0 with Mitaka support +* Internet connection to Cinder nodes +* Valid credentials for GCS service account + +Check `Planning Guide `__ +and `Planning hardware for your OpenStack cluster: the answers to your questions `__ +for additional requirements to consider. diff --git a/doc/user_guide/troubleshooting.rst b/doc/user_guide/troubleshooting.rst new file mode 100644 index 0000000..d8457b5 --- /dev/null +++ b/doc/user_guide/troubleshooting.rst @@ -0,0 +1,51 @@ +Troubleshooting +--------------- + +This section contains a guidance on how to verify Cinder is configured for using +Google Cloud Storage backup driver and where to look for logs. + +Finding logs +^^^^^^^^^^^^ + +LVM as backend for Cinder volumes +""""""""""""""""""""""""""""""""" + +Backup-related Cinder logs can be found in ``/var/log/cinder/cinder-backup.log`` +on nodes with *cinder* role. + +Ceph as backend for Cinder volumes +"""""""""""""""""""""""""""""""""" + +Backup-related Cinder logs can be found in ``/var/log/cinder/cinder-backup.log`` +on nodes with *controller* role. + +Finding configuration files +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +LVM as backend for Cinder volumes +""""""""""""""""""""""""""""""""" + +Backup-related Cinder parameters are stored in /etc/cinder/cinder.conf on +*cinder* nodes. + +Ceph as backend for Cinder volumes +"""""""""""""""""""""""""""""""""" + +Backup-related Cinder parameters are stored in /etc/cinder/cinder.conf on +*controller* nodes. + +Verifying GCS Cinder backup driver is enabled +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If GCS Cinder backup driver is enabled *[DEFAULT]* section of *cinder.conf* +should contain + +``backup_driver = cinder.backup.drivers.google`` + +and + +``backup_gcs_credential_file = /var/lib/cinder/credentials.json`` + +The file ``/var/lib/cinder/credentials.json`` should contain the same information as +the credentials file downloaded from Google Cloud Storage UI. +