Minor docs restructurization

* restructured index page
 * replaced Mirantis copyright with OpenStack Foundation one
 * added usernames for images in HDP plugin

Change-Id: I9927128151817c995a206d7b2aa6c545f1409994

doc/source/conf.py

@@ -56,7 +56,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Savanna'
-copyright = u'2013, Mirantis Inc'
+copyright = u'2013, OpenStack Foundation'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -209,7 +209,7 @@ latex_elements = {
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
     ('index', 'savannadoc.tex', u'Savanna',
-     u'Mirantis Inc.', 'manual'),
+     u'OpenStack Foundation', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -239,7 +239,7 @@ latex_documents = [
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'savanna', u'Savanna',
-     [u'Mirantis Inc.'], 1)
+     [u'OpenStack Foundation'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -253,7 +253,7 @@ man_pages = [
 #  dir menu entry, description, category)
 texinfo_documents = [
     ('index', 'Savanna', u'Savanna',
-     u'Mirantis Inc.', 'Savanna', 'Savanna',
+     u'OpenStack Foundation', 'Savanna', 'Savanna',
      'Miscellaneous'),
 ]
 

doc/source/index.rst

@@ -15,21 +15,56 @@ Overview
 
 User guide
 ----------
+
+**Installation**
+
 .. toctree::
    :maxdepth: 1
 
    userdoc/installation.guide
    horizon/installation.guide
-   horizon/dashboard.user.guide
+
+**How To**
+
+.. toctree::
+   :maxdepth: 1
+
    userdoc/overview
+   horizon/dashboard.user.guide
    userdoc/features
-   userdoc/plugins
-   userdoc/edp
    userdoc/registering_image
-   userdoc/hadoop-swift
+
+**Plugins**
+
+.. toctree::
+   :maxdepth: 1
+
+   userdoc/plugins
+   userdoc/vanilla_plugin
+   userdoc/hdp_plugin
+
+**Elastic Data Processing**
+
+.. toctree::
+   :maxdepth: 1
+
+   userdoc/edp
+
+**APIs**
+
+.. toctree::
+   :maxdepth: 1
+
    userdoc/python_client
    userdoc/rest_api_v1.0
    userdoc/rest_api_v1.1_EDP
+
+**Miscellaneous**
+
+.. toctree::
+   :maxdepth: 1
+
+   userdoc/hadoop-swift
    userdoc/diskimagebuilder
 
 
@@ -66,4 +101,3 @@ Developer Guide
    devref/launchpad
    devref/gerrit
    devref/jenkins
-

doc/source/overview.rst

@@ -1,5 +1,5 @@
-Overview
+Rationale
-========
+=========
 
 Introduction
 ------------

doc/source/userdoc/diskimagebuilder.rst

@@ -1,5 +1,5 @@
-Disk Image Builder
+Building Images for Vanilla Plugin
-==================
+==================================
 
 As of now vanilla plugin works with images with pre-installed Apache Hadoop. To
 simplify task of building such images we use

doc/source/userdoc/hadoop-swift.rst

@@ -1,4 +1,4 @@
-Swift integration
+Swift Integration
 =================
 Hadoop and Swift integration is the essential continuation of Hadoop&OpenStack
 marriage. There were two steps to achieve this:

doc/source/userdoc/hdp_plugin.rst

@@ -11,13 +11,13 @@ The Hortonworks Data Platform (HDP) Savanna plugin provides a way to provision H
 The HDP plugin uses Ambari Blueprints aka templates for cluster provisioning.
 
 Apache Ambari Blueprints (aka Cluster templates)
-================================================
+------------------------------------------------
 Apache Ambari Blueprints is a portable document definition, which provides a complete definition for an Apache Hadoop cluster, including cluster topology, components, services and their configurations. Ambari Blueprints can be consumed by the HDP plugin to instantiate a Hadoop cluster on OpenStack. The benefits of this approach is that it allows for Hadoop clusters to be configured and deployed using an Ambari native format that can be used with as well as outside of OpenStack allowing for clusters to be re-instantiated in a variety of environments.
  
 For more information about Apache Ambari Blueprints, refer to: https://issues.apache.org/jira/browse/AMBARI-1783. Note that Apache Ambari Blueprints are not yet finalized.
 
 Operation
-=========
+---------
 The HDP Plugin performs the following four primary functions during cluster creation:
 
 1. Software deployment - the plugin orchestrates the deployment of the required software to the target VMs
@@ -26,7 +26,7 @@ The HDP Plugin performs the following four primary functions during cluster crea
 4. Services Start - the plugin invokes the appropriate APIs to indicate to the Ambari Server that the cluster services should be started
 
 Images
-======
+------
 The Savanna HDP plugin can make use of either minimal (operating system only) images or pre-populated HDP images. The base requirement for both is that the image is cloud-init enabled and contains a supported operating system (see http://docs.hortonworks.com/HDPDocuments/HDP1/HDP-1.2.4/bk_hdp1-system-admin-guide/content/sysadminguides_ha_chap2_3.html).
  
 The advantage of a pre-populated image is that provisioning time is accelerated, as packages do not need to be downloaded and installed which make up the majority of the time spent in the provisioning cycle.
@@ -62,10 +62,16 @@ There are two VM images provided for use with the HDP Plugin:
 1. `centos-6_64-hdp-1.3.qcow2 <http://public-repo-1.hortonworks.com/savanna/images/centos-6_4-64-hdp-1.3.qcow2>`_: This image contains most of the requisite packages necessary for HDP deployment. The packages contained herein correspond to the HDP 1.3 release. The operating system is a minimal CentOS 6.4 cloud-init enabled install. This image can only be used to provision HDP 1.3 hadoop clusters.
 2. `centos-6-64-hdp-vanilla.qcow2 <http://public-repo-1.hortonworks.com/savanna/images/centos-6_4-64-vanilla.qcow2>`_: This image provides only a minimal install of CentOS 6.4  and is cloud-init enabled. This image can be used to provision any versions of HDP supported by Savanna.
 
+HDP plugin requires an image to be tagged in Savanna Image Registry with
+two tags: 'hdp' and '<hdp version>' (e.g. '1.3.2').
+
+Also in the Image Registry you will need to specify username for an image.
+It should be 'root' for both images.
+ 
 Please refer to the reference VM image provided for specific details.
 
 Limitations
-===========
+-----------
 The HDP plugin currently has the following limitations:
 
 * Currently, the HDP plugin provides support for HDP 1.3. Once HDP2 is released, support for this version will be provided.
@@ -81,7 +87,7 @@ The HDP plugin currently has the following limitations:
 Note: Other services may be added using Ambari after initial cluster creation.
 
 Cluster Validation
-==================
+------------------
 Prior to Hadoop cluster creation, the HDP plugin will perform the following validation checks to ensure a successful Hadoop deployment:
 
 * Ensure the existence of a NAMENODE process in the cluster
@@ -90,5 +96,5 @@ Prior to Hadoop cluster creation, the HDP plugin will perform the following vali
 * Ensure that each defined node group had an associated Ambari Agent configured
 
 The HDP Plugin and Savanna Support
-==================================
+----------------------------------
 A Hortonworks supported version of HDP OpenStack plugin will become available at a future date. For more information, please contact Hortonworks. 

doc/source/userdoc/registering_image.rst

@@ -1,5 +1,5 @@
-Registering Image
+Registering an Image
-=================
+====================
 
 Savanna deploys cluster of machines based on images stored in Glance.
 Each plugin has its own requirements on image contents, see specific plugin
@@ -7,7 +7,10 @@ documentation for details. A general requirement for an image is to have
 cloud-init package installed.
 
 Savanna requires image to be registered in Savanna Image Registry order to work with it.
-A registered image must have two properties:
+A registered image must have two properties set:
 
-* username - a name of the default cloud-init user
+* username - a name of the default cloud-init user.
-* tags - certain tags mark image to be suitable for certain plugins. See plugins documentation for details.
+* tags - certain tags mark image to be suitable for certain plugins.
+
+Username depends on image used. Tags depend on the plugin used
+You can find both in the respective plugin's documentation.