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

What is 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.

For additional information, take a look at the `Tuskar
documentation <http://git.openstack.org/cgit/openstack/tuskar/tree/docs/index.rst>`_.

Installation Information
------------------------

Please see
`INSTALL.rst <doc/source/INSTALL.rst>`_
for an installation guide.

Building the Docs
-----------------

From the root directory::

 python setup.py build_sphinx


Contributing
------------

Interested in contributing?  Take a look at
`CONTRIBUTING.rst <doc/source/CONTRIBUTING.rst>`_
for details on how to do so.

Contact Us
----------

Join us on IRC (Internet Relay Chat)::

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