Restructured project documentation.

Partially implements: blueprint docs-for-v0.2

Change-Id: I851d42911cc56cc62d454ecef700249e61380e38
This commit is contained in:
Ruslan Kamaldinov 2013-07-05 16:09:30 +04:00
parent fc15381d40
commit fa594fab5e
12 changed files with 82 additions and 92 deletions

View File

@ -1,5 +1,5 @@
Savanna Architecture (draft) Architecture
============================ ============
.. image:: images/savanna-architecture.png .. image:: images/savanna-architecture.png
:width: 800 px :width: 800 px

View File

@ -1,31 +0,0 @@
Developer Guide
===============
Programming HowTos and Tutorials
--------------------------------
.. toctree::
:maxdepth: 3
development.guidelines
development.environment
unit_tests
how_to_participate
Background Concepts for Savanna
-------------------------------
.. toctree::
:maxdepth: 3
plugins
templates
Other Resources
---------------
.. toctree::
:maxdepth: 3
launchpad
gerrit
jenkins

View File

@ -0,0 +1,2 @@
Plugin SPI
==========

View File

@ -1,50 +1,65 @@
Welcome to Savanna! Welcome to Savanna!
=================== ===================
Useful links Savanna project aims to provide users with simple means to provision a Hadoop
------------ cluster at OpenStack by specifying several parameters like Hadoop version,
.. toctree:: cluster topology, nodes hardware details and a few more.
:maxdepth: 1
overview
architecture
devref/index
quickstart
* `Savanna wiki <https://wiki.openstack.org/wiki/Savanna>`_
* `Savanna roadmap <https://wiki.openstack.org/wiki/Savanna/Roadmap>`_
.. include:: introduction.rst.inc
Project overview
----------------
Overview
========
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
overview overview
architecture architecture
Developer Docs Links
-------------- =====
.. toctree:: * `Roadmap <https://wiki.openstack.org/wiki/Savanna/Roadmap>`_
:maxdepth: 3 * `Savanna on OpenStack Wiki <https://wiki.openstack.org/wiki/Savanna>`_
* `Savanna on Launchpad <https://launchpad.net/savanna>`_
devref/index Developer Guide
===============
Programming HowTos and Tutorials
--------------------------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
restapi/v02 devref/development.guidelines
hadoop-swift/hadoop-swift devref/development.environment
horizon/dev.environment.guide
Installation guides devref/quickstart
------------------- devref/unit_tests
devref/how_to_participate
Background Concepts for Savanna
-------------------------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
installation.guide devref/plugins
horizon/installation.guide devref/templates
horizon/dev.environment.guide devref/plugin.spi
Other Resources
---------------
.. toctree::
:maxdepth: 1
devref/launchpad
devref/gerrit
devref/jenkins
User guide
==========
.. toctree::
:maxdepth: 1
userdoc/installation.guide
horizon/installation.guide
userdoc/rest_api_v1.0
userdoc/features
userdoc/hadoop-swift.rst

View File

@ -1,26 +0,0 @@
Introduction
------------
Apache Hadoop is an industry standard and widely adopted MapReduce implementation.
The aim of this project is to enable users to easily provision and manage Hadoop clusters on OpenStack.
It is worth mentioning that Amazon provides Hadoop for several years as Amazon Elastic MapReduce (EMR) service.
Savanna aims to provide users with simple means to provision Hadoop clusters
by specifying several parameters like Hadoop version, cluster topology, nodes hardware details
and a few more. After user fills in all the parameters, Savanna deploys the cluster in a few minutes.
Also Savanna provides means to scale already provisioned cluster by adding/removing worker nodes on demand.
The solution will address following use cases:
* fast provisioning of Hadoop clusters on OpenStack for Dev and QA;
* utilization of unused compute power from general purpose OpenStack IaaS cloud;
* "Analytics as a Service" for ad-hoc or bursty analytic workloads (similar to AWS EMR).
Key features are:
* designed as an OpenStack component;
* managed through REST API with UI available as part of OpenStack Dashboard;
* support for different Hadoop distributions:
* pluggable system of Hadoop installation engines;
* integration with vendor specific management tools, such as Apache Ambari or Cloudera Management Console;
* predefined templates of Hadoop configurations with ability to modify parameters.

View File

@ -1,7 +1,32 @@
Savanna Overview Overview
================ ========
.. include:: introduction.rst.inc Introduction
------------
Apache Hadoop is an industry standard and widely adopted MapReduce implementation.
The aim of this project is to enable users to easily provision and manage Hadoop clusters on OpenStack.
It is worth mentioning that Amazon provides Hadoop for several years as Amazon Elastic MapReduce (EMR) service.
Savanna aims to provide users with simple means to provision Hadoop clusters
by specifying several parameters like Hadoop version, cluster topology, nodes hardware details
and a few more. After user fills in all the parameters, Savanna deploys the cluster in a few minutes.
Also Savanna provides means to scale already provisioned cluster by adding/removing worker nodes on demand.
The solution will address following use cases:
* fast provisioning of Hadoop clusters on OpenStack for Dev and QA;
* utilization of unused compute power from general purpose OpenStack IaaS cloud;
* "Analytics as a Service" for ad-hoc or bursty analytic workloads (similar to AWS EMR).
Key features are:
* designed as an OpenStack component;
* managed through REST API with UI available as part of OpenStack Dashboard;
* support for different Hadoop distributions:
* pluggable system of Hadoop installation engines;
* integration with vendor specific management tools, such as Apache Ambari or Cloudera Management Console;
* predefined templates of Hadoop configurations with ability to modify parameters.
Details Details
------- -------

View File

@ -0,0 +1,2 @@
Savanna Features
================

View File

@ -0,0 +1,3 @@
*********************
Savanna REST API v1.0
*********************