Welcome to Sahara!
===================

Sahara project aims to provide users with simple means to provision a Hadoop
cluster at OpenStack by specifying several parameters like Hadoop version,
cluster topology, nodes hardware details and a few more.

Overview
--------

.. toctree::
    :maxdepth: 1

    overview
    architecture
    Roadmap <https://wiki.openstack.org/wiki/Sahara/Roadmap>


User guide
----------

**Installation**

.. toctree::
   :maxdepth: 1

   userdoc/installation.guide
   userdoc/configuration.guide
   userdoc/dashboard.guide
   userdoc/advanced.configuration.guide
   userdoc/upgrade.guide

**How To**

.. toctree::
   :maxdepth: 1

   userdoc/overview
   horizon/dashboard.user.guide
   userdoc/features
   userdoc/registering_image

**Plugins**

.. toctree::
   :maxdepth: 1

   userdoc/plugins
   userdoc/vanilla_plugin
   userdoc/hdp_plugin
   userdoc/spark_plugin
   userdoc/cdh_plugin
   userdoc/mapr_plugin

**Elastic Data Processing**

.. toctree::
   :maxdepth: 1

   userdoc/edp

**API**

.. toctree::
   :maxdepth: 2

   restapi

**Miscellaneous**

.. toctree::
   :maxdepth: 1

   userdoc/guest-requirements
   userdoc/hadoop-swift
   userdoc/diskimagebuilder
   userdoc/cdh_imagebuilder

Developer Guide
---------------
**Programming HowTos and Tutorials**

.. toctree::
    :maxdepth: 1

    devref/development.guidelines
    devref/development.environment
    devref/devstack
    horizon/dev.environment.guide
    devref/quickstart
    devref/how_to_participate
    devref/how_to_build_oozie
    devref/adding_database_migrations
    devref/testing
    devref/log.guidelines

**Background Concepts for Sahara**

.. toctree::
    :maxdepth: 1

    devref/plugins
    devref/plugin.spi
    devref/edp.spi
    userdoc/statuses


**Other Resources**

.. toctree::
   :maxdepth: 1

   devref/launchpad
   devref/gerrit
   devref/jenkins
