=========
Tuskar UI
=========

**Tuskar UI** is a user interface for
`Tuskar <https://github.com/openstack/tuskar>`__, a management API for
OpenStack deployments. It is a plugin for `OpenStack
Horizon <https://wiki.openstack.org/wiki/Horizon>`__.

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

Tuskar UI endeavours to be a stateless UI, relying on Tuskar API calls
as much as possible. We use existing Horizon libraries and components
where possible. If added libraries and components are needed, we will
work with the OpenStack community to push those changes back into Horizon.

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

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

The code repository is located at `OpenStack <https://github.com/openstack>`__.
Please go there if you want to check it out:

    git clone https://github.com/openstack/tuskar-ui.git

The list of bugs and blueprints is on Launchpad:

`<https://launchpad.net/tuskar-ui>`__

We use OpenStack's Gerrit for the code contributions:

`<https://review.openstack.org/#/q/status:open+project:openstack/tuskar-ui,n,z>`__

and we follow the `OpenStack Gerrit Workflow <https://wiki.openstack.org/wiki/Gerrit_Workflow>`__.

If you're interested in the code, here are some key places to start:

* `tuskar_ui/api.py <https://github.com/openstack/tuskar-ui/blob/master/tuskar_ui/api.py>`_
  - This file contains all the API calls made to the Tuskar API
  (through python-tuskarclient).
* `tuskar_ui/infrastructure <https://github.com/openstack/tuskar-ui/tree/master/tuskar_ui/infrastructure>`_
  - The Tuskar UI code is contained within this directory.

Installation Guide
------------------

Use the `Installation Guide <https://github.com/openstack/tuskar-ui/blob/master/docs/install.rst>`_ to install Tuskar UI.

License
-------

This project is licensed under the Apache License, version 2. More
information can be found in the LICENSE file.

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

Join us on IRC (Internet Relay Chat)::

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

Or send an email to openstack-dev@lists.openstack.org.