Add Playground RST Userguide

This is a first iteration of converting the user guide to RST.

Generated html is available via the checkbuild target as usual.

Change-Id: I32f133e27b80bd6ff1555d48aeb29b3e505342fe

doc/playground-user-guide/source/ch_dashboard.rst

@@ -0,0 +1,14 @@
+===================
+OpenStack dashboard
+===================
+
+As a cloud end user, you can use the OpenStack dashboard to provision
+your own resources within the limits set by administrators. You can
+modify the examples provided in this section to create other types and
+sizes of server instances.
+
+.. toctree::
+   :maxdepth: 2
+
+   section_dashboard_access_and_security.rst
+

doc/playground-user-guide/source/conf.py

@@ -0,0 +1,256 @@
+# -*- coding: utf-8 -*-
+#
+# 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 = ['oslosphinx']
+
+# 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'User Guide'
+copyright = u'2015, OpenStack contributors'
+
+# 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 = '0.0.1'
+# The full version, including alpha/beta/rc tags.
+release = '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
+# "<project> v<release> 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 <link> 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 = 'user-guide'
+
+
+# -- 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', 'UserGuide.tex', u'User Guide',
+   u'OpenStack contributors', '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', 'userguide', u'User Guide',
+     [u'OpenStack contributors'], 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', 'UserGuide', u'User Guide',
+   u'OpenStack contributors', 'UserGuide',
+   'This guide shows OpenStack end users how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands.',
+   '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

doc/playground-user-guide/source/index.rst

@@ -0,0 +1,17 @@
+Welcome to the end user documentation for OpenStack
+===================================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   ch_dashboard.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+

doc/playground-user-guide/source/section_dashboard_access_and_security.rst

@@ -0,0 +1,179 @@
+Configure access and security for instances
+===========================================
+
+Before you launch an instance, you should add security group rules to
+enable users to ping and use SSH to connect to the instance. Security
+groups are sets of IP filter rules that define networking access and
+are applied to all instances within a project. To do so, you either
+`add rules to the default security group
+<#add-a-rule-to-the-default-security-group>`__ or add a new security
+group with rules.
+
+Key pairs are SSH credentials that are injected into an instance when it
+is launched. To use key pair injection, the image that the instance is
+based on must contain the ``cloud-init`` package. Each project should
+have at least one key pair. For more information, see ? (TODO!).
+
+If you have generated a key pair with an external tool, you can import
+it into OpenStack. The key pair can be used for multiple instances that
+belong to a project. For more information, see ?  (TODO!).
+
+When an instance is created in OpenStack, it is automatically assigned a
+fixed IP address in the network to which the instance is assigned. This
+IP address is permanently associated with the instance until the
+instance is terminated. However, in addition to the fixed IP address, a
+floating IP address can also be attached to an instance. Unlike fixed IP
+addresses, floating IP addresses are able to have their associations
+modified at any time, regardless of the state of the instances involved.
+
+Add a rule to the default security group
+----------------------------------------
+
+This procedure enables SSH and ICMP (ping) access to instances. The
+rules apply to all instances within a given project, and should be set
+for every project unless there is a reason to prohibit SSH or ICMP
+access to the instances.
+
+This procedure can be adjusted as necessary to add additional security
+group rules to a project, if your cloud requires them.
+
+.. note::
+
+    When adding a rule, you must specify the protocol used with the
+    destination port or source port.
+
+#. Log in to the dashboard, choose a project, and click :guilabel:`Access &
+   Security`.  The :guilabel:`Security Groups` tab shows the security
+   groups that are available for this project.
+
+#. Select the default security group and click :guilabel:`Edit Rules`.
+
+#. To allow SSH access, click :guilabel:`Add Rule`.
+
+#. In the :guilabel:`Add Rule` dialog box, enter the following values:
+
+   +----------+-----------------+
+   | Rule     | ``SSH``         |
+   +----------+-----------------+
+   | Remote   | ``CIDR``        |
+   +----------+-----------------+
+   | CIDR     | ``0.0.0.0/0``   |
+   +----------+-----------------+
+
+   .. note::
+
+       To accept requests from a particular range of IP addresses, specify
+       the IP address block in the CIDR box.
+
+#. Click :guilabel:`Add`.
+
+   Instances will now have SSH port 22 open for requests from any IP
+   address.
+
+#. To add an ICMP rule, click :guilabel:`Add Rule`.
+
+#. In the :guilabel:`Add Rule` dialog box, enter the following values:
+
+   +-------------+-----------------+
+   | Rule        | ``All ICMP``    |
+   +-------------+-----------------+
+   | Direction   | ``Ingress``     |
+   +-------------+-----------------+
+   | Remote      | ``CIDR``        |
+   +-------------+-----------------+
+   | CIDR        | ``0.0.0.0/0``   |
+   +-------------+-----------------+
+
+#. Click :guilabel:`Add`.
+
+   Instances will now accept all incoming ICMP packets.
+
+Add a key pair
+--------------
+
+Create at least one key pair for each project.
+
+#. Log in to the dashboard, choose a project, and click
+   :guilabel:`Access & Security`.
+#. Click the :guilabel:`Keypairs` tab, which shows the key pairs
+   that are available for this project.
+#. Click :guilabel:`Create Keypair`.
+#. In the :guilabel:`Create Keypair` dialog box, enter a name for your
+   key pair, and click :guilabel:`Create Keypair`.
+#. Respond to the prompt to download the key pair.
+
+Import a key pair
+-----------------
+
+#. Log in to the dashboard, choose a project, and click
+   :guilabel:`Access & Security`.
+#. Click the :guilabel:`Keypairs` tab, which shows the key pairs that
+   are available for this project.
+#. Click :guilabel:`Import Keypair`.
+#. In the :guilabel:`Import Keypair` dialog box, enter the name of
+   your  key pair, copy the public key into the :guilabel:`Public Key`
+   box, and then click :guilabel:`Import Keypair`.
+#. Save the ``*.pem`` file locally.
+#. To change its permissions so that only you can read and write to the
+   file, run the following command::
+
+     $ chmod 0600 yourPrivateKey.pem
+
+   .. note::
+
+    If you are using the dashboard from a Windows computer, use PuTTYgen
+    to load the ``*.pem`` file and convert and save it as ``*.ppk``. For
+    more information see the `WinSCP web page for
+    PuTTYgen <http://winscp.net/eng/docs/ui_puttygen>`__.
+
+#. To make the key pair known to SSH, run the ``ssh-add`` command::
+
+   $ ssh-add yourPrivateKey.pem
+
+The Compute database registers the public key of the key pair.
+
+The dashboard lists the key pair on the :guilabel:`Access & Security` tab.
+
+Allocate a floating IP address to an instance
+---------------------------------------------
+
+When an instance is created in OpenStack, it is automatically assigned a
+fixed IP address in the network to which the instance is assigned. This
+IP address is permanently associated with the instance until the
+instance is terminated.
+
+However, in addition to the fixed IP address, a floating IP address can
+also be attached to an instance. Unlike fixed IP addresses, floating IP
+addresses can have their associations modified at any time, regardless
+of the state of the instances involved. This procedure details the
+reservation of a floating IP address from an existing pool of addresses
+and the association of that address with a specific instance.
+
+#. Log in to the dashboard, choose a project, and click :guilabel:`Access
+   & Security`.
+#. Click the :guilabel:`Floating IPs` tab, which shows the floating IP
+   addresses allocated to instances.
+#. Click :guilabel:`Allocate IP to Project`.
+#. Choose the pool from which to pick the IP address.
+#. Click :guilabel:`Allocate IP`.
+#. In the :guilabel:`Floating IPs` list, click :guilabel:`Associate`.
+#. In the :guilabel:`Manage Floating IP Associations` dialog box,
+   choose the following options:
+
+   * The :guilabel:`IP Address field` is filled automatically, but you
+     can add a new IP address by clicking the :guilabel:`+` button.
+   * In the :guilabel:`Ports to be associated` field, select a port
+     from the list.
+     The list shows all the instances with their fixed
+     IP addresses.
+
+#. Click :guilabel:`Associate`.
+
+   .. note::
+
+    To disassociate an IP address from an instance, click the
+    :guilabel:`Disassociate` button.
+
+    To release the floating IP address back into the pool of
+    addresses, click the :guilabel:`More` button and select the
+    :guilabel:`Release Floating IP` option.

tox.ini

@@ -44,6 +44,9 @@ commands =
   python tools/www-generator.py --source-directory www/ --output-directory publish-docs/www/
   cp www/www-index.html publish-docs/
   rsync -a www/static/ publish-docs/www/
+  sphinx-build doc/playground-user-guide/source/ doc/playground-user-guide/build/html
+  mkdir -p publish-docs/playground-user-guide/content/
+  rsync -a doc/playground-user-guide/build/html/ publish-docs/playground-user-guide/content/
   openstack-doc-test --check-build {posargs}
 
 [testenv:publishdocs]