Updates documentation for plugin architecture
Change-Id: Iab77ae6a3672120ae48dd8b2a84c6fd44e0cd7f2
This commit is contained in:
Tzu-Mainn Chen
parent
c67c54240c
commit
87ded1351c
29
README.rst
29
README.rst
@ -2,8 +2,8 @@ tuskar-ui
|
||||
=========
|
||||
|
||||
**tuskar-ui** is a user interface for
|
||||
`Tuskar <https://github.com/tuskar/tuskar>`__, a management API for
|
||||
OpenStack deployments. It is based on (and forked from) `OpenStack
|
||||
`Tuskar <https://github.com/stackforge/tuskar>`__, a management API for
|
||||
OpenStack deployments. It is a plugin for `OpenStack
|
||||
Horizon <https://wiki.openstack.org/wiki/Horizon>`__.
|
||||
|
||||
High-Level Overview
|
||||
@ -14,10 +14,29 @@ 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.
|
||||
|
||||
Code Repository
|
||||
---------------
|
||||
|
||||
We've moved the code to `stackforge <https://github.com/stackforge>`__
|
||||
to be more familiar to the OpenStack developers. Please go there if you
|
||||
want to check it out:
|
||||
|
||||
git clone https://github.com/stackforge/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:stackforge/tuskar-ui,n,z>`__
|
||||
|
||||
and we follow the `OpenStack Gerrit Workflow <https://wiki.openstack.org/wiki/Gerrit_Workflow>`__.
|
||||
|
||||
Installation Guide
|
||||
------------------
|
||||
|
||||
Use the `Installation Guide <https://github.com/tuskar/tuskar-ui/blob/master/docs/install.rst>`_ to install Tuskar-UI.
|
||||
Use the `Installation Guide <https://github.com/stackforge/tuskar-ui/blob/master/docs/install.rst>`_ to install Tuskar-UI.
|
||||
|
||||
License
|
||||
-------
|
||||
@ -29,7 +48,7 @@ Further Documentation
|
||||
---------------------
|
||||
|
||||
Check out our `docs directory
|
||||
<https://github.com/tuskar/tuskar-ui/blob/master/docs/index.rst>`_
|
||||
<https://github.com/stackforge/tuskar-ui/blob/master/docs/index.rst>`_
|
||||
for expanded documentation.
|
||||
|
||||
Contact Us
|
||||
@ -39,3 +58,5 @@ 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.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
Tuskar-UI
|
||||
=========
|
||||
|
||||
Tuskar-UI is a user interface for `Tuskar <https://github.com/tuskar/tuskar>`_, a management API for OpenStack deployments. It is based on (and forked from) `OpenStack Horizon <https://wiki.openstack.org/wiki/Horizon>`_.
|
||||
Tuskar-UI is a user interface for `Tuskar <https://github.com/stackforge/tuskar>`_, a management API for OpenStack deployments. It is a plugin for `OpenStack Horizon <https://wiki.openstack.org/wiki/Horizon>`_.
|
||||
|
||||
High-Level Overview
|
||||
-------------------
|
||||
@ -18,12 +18,31 @@ Developer Information
|
||||
Installation Guide
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Follow the `Installation Guide <https://github.com/tuskar/tuskar-ui/blob/master/docs/install.rst>`_ to install Tuskar-UI.
|
||||
Follow the `Installation Guide <https://github.com/stackforge/tuskar-ui/blob/master/docs/install.rst>`_ to install Tuskar-UI.
|
||||
|
||||
Contributing
|
||||
~~~~~~~~~~~~
|
||||
|
||||
We've moved the code to `stackforge <https://github.com/stackforge>`__
|
||||
to be more familiar to the OpenStack developers. Please go there if you
|
||||
want to check it out:
|
||||
|
||||
git clone https://github.com/stackforge/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:stackforge/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:
|
||||
|
||||
* `openstack_dashboard/api/tuskar.py <https://github.com/tuskar/tuskar-ui/blob/master/openstack_dashboard/api/tuskar.py>`_ - This file contains all the API calls made to the Tuskar API (through python-tuskarclient).
|
||||
* `openstack_dashboard/dashboards/infrastructure <https://github.com/tuskar/tuskar-ui/tree/master/openstack_dashboard/dashboards/infrastructure>`_ - The Tuskar UI code is contained within this directory. Up to this point, UI development has been focused within the resource_management/ subdirectory.
|
||||
* `tuskar_ui/api.py <https://github.com/stackforge/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/stackforge/tuskar-ui/tree/master/tuskar_ui/infrastructure>`_ - The Tuskar UI code is contained within this directory. Up to this point, UI development has been focused within the resource_management/ subdirectory.
|
||||
|
||||
Future Work
|
||||
-----------
|
||||
@ -35,3 +54,5 @@ 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.
|
||||
|
||||
@ -20,7 +20,7 @@ Installation prerequisites are:
|
||||
machine as tuskar-ui, but it must be network accessible.
|
||||
|
||||
You may find
|
||||
`the Tuskar install guide <https://github.com/tuskar/tuskar/blob/master/INSTALL.rst>`_
|
||||
`the Tuskar install guide <https://github.com/stackforge/tuskar/blob/master/INSTALL.rst>`_
|
||||
helpful.
|
||||
|
||||
For baremetal provisioning, you will want a Nova Baremetal driver
|
||||
@ -70,17 +70,24 @@ On RHEL 6, you'll need to build nodejs from source:
|
||||
Install the management UI
|
||||
-------------------------
|
||||
|
||||
Begin by cloning the tuskar-ui repository:
|
||||
Begin by cloning the horizon and tuskar-ui repositories:
|
||||
|
||||
::
|
||||
|
||||
git clone git://github.com/tuskar/tuskar-ui.git
|
||||
git clone git://github.com/openstack/horizon.git
|
||||
git clone git://github.com/stackforge/tuskar-ui.git
|
||||
|
||||
Go into horizon and create a symlink to the tuskar-ui code:
|
||||
|
||||
::
|
||||
|
||||
cd horizon
|
||||
ln -s ../tuskar-ui/tuskar_ui
|
||||
|
||||
Then, install a virtual environment for your setup:
|
||||
|
||||
::
|
||||
|
||||
cd tuskar-ui
|
||||
python tools/install_venv.py
|
||||
|
||||
Next, run ``run_tests.sh`` to have pip install dependencies:
|
||||
@ -93,7 +100,7 @@ Set up your ``local_settings.py`` file:
|
||||
|
||||
::
|
||||
|
||||
cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py
|
||||
cp ../tuskar-ui/local_settings.py.example openstack_dashboard/local/local_settings.py
|
||||
|
||||
Open up the copied ``local_settings.py`` file in your preferred text
|
||||
editor. You will want to customize several settings:
|
||||
@ -142,7 +149,13 @@ First, activate your virtual environment:
|
||||
|
||||
source .venv/bin/activate
|
||||
|
||||
Then, synchronize your local database:
|
||||
tuskar-ui introduces one additional dependency - python-tuskarclient:
|
||||
|
||||
::
|
||||
|
||||
pip install git+http://github.com/stackforge/python-tuskarclient.git
|
||||
|
||||
Finally, synchronize your local database:
|
||||
|
||||
::
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user