======
Tuskar
======

Tuskar gives administrators the ability to control how and where
OpenStack services are deployed across the datacenter. Using Tuskar,
administrators divide hardware into "resource classes" that allow
predictable elastic scaling as cloud demands grow. This resource
orchestration allows Tuskar users to ensure SLAs, improve performance,
and maximize utilization across the datacenter.

Tuskar services are available via a RESTful API and management console
through which administrators are able to classify their hardware and
define their datacenters. In addition, Tuskar components provide
administrators with performance monitoring, health statistics, and
usage metrics, aiding in capacity planning and hardware procurement
decisions.

High-Level Overview
===================

*TODO* Add project overview

Interested in seeing Tuskar in action? `Watch a
demo! <https://www.youtube.com/watch?v=VEY035-Lyzo>`_

-  *TODO* feature examples
-  *TODO* link to high-level portion of FAQ
-  `Recommended reading <docs/recommended-reading.rst>`_

Related Projects
----------------

-  `tuskar-ui <http://git.openstack.org/cgit/openstack/tuskar-ui>`_ - Built on top
   of Horizon, tuskar-ui provides dashboard access to Tuskar functionality.
-  `python-tuskarclient <http://git.openstack.org/cgit/openstack/python-tuskarclient>`_
   - A Python client for the Tuskar API, python-tuskarclient is utilized
   by tuskar-ui.

Developer Information
=====================

Install and Contribute
----------------------

.. toctree::
  :maxdepth: 1

  INSTALL
  CONTRIBUTING
  debugging-with-ipython
  demo-data-script
  recommended-reading

API
---

.. toctree::
  :maxdepth: 1

  api/curl
  resource-class-demo-script

HEAT Integration
----------------

-  *TODO* How HEAT update works
-  *TODO* Generation of the HEAT template

Other
-----

-  *TODO* link to developer portion of FAQ

Contact Us
==========

Join us on IRC (Internet Relay Chat)::

    Network: Freenode (irc.freenode.net/tuskar)
    Channel: #tuskar