Improve developer documentation
* Merge docs/index.rst into README.rst * Leave only a short introduction and links to other doc pages in docs/index.rst * Add a link to https://wiki.openstack.org/wiki/Tuskar/Devtest * Fix 404 links * Fix inconsistencies in the spelling of 'Tuskar UI' * Fix typos Change-Id: Iafa76efdb22043434cf3879d722d9ddcccd807d4
This commit is contained in:
Ana Krivokapic
parent
c33f8d8f89
commit
288a6ee498
@ -5,10 +5,6 @@ OpenStack Style Commandments
|
||||
- Step 2: Read http://www.python.org/dev/peps/pep-0008/ again
|
||||
- Step 3: Read https://github.com/openstack-dev/hacking/blob/master/HACKING.rst
|
||||
|
||||
The OpenStack Style Commandments live here:
|
||||
|
||||
https://github.com/openstack-dev/hacking/blob/master/HACKING.rst
|
||||
|
||||
local-checks
|
||||
------------
|
||||
|
||||
|
||||
33
README.rst
33
README.rst
@ -1,7 +1,8 @@
|
||||
tuskar-ui
|
||||
=========
|
||||
Tuskar UI
|
||||
=========
|
||||
|
||||
**tuskar-ui** is a user interface for
|
||||
**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>`__.
|
||||
@ -9,15 +10,18 @@ Horizon <https://wiki.openstack.org/wiki/Horizon>`__.
|
||||
High-Level Overview
|
||||
-------------------
|
||||
|
||||
Tuskar-UI endeavours to be a stateless UI, relying on Tuskar API calls
|
||||
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.
|
||||
|
||||
Code Repository
|
||||
---------------
|
||||
Interested in seeing Tuskar and Tuskar UI in action?
|
||||
`Watch a demo! <https://www.youtube.com/watch?v=-6whFIqCqLU>`_
|
||||
|
||||
We've moved the code to `OpenStack <https://github.com/openstack>`__.
|
||||
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
|
||||
@ -32,10 +36,18 @@ We use OpenStack's Gerrit for the code contributions:
|
||||
|
||||
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.
|
||||
Use the `Installation Guide <https://github.com/openstack/tuskar-ui/blob/master/docs/install.rst>`_ to install Tuskar UI.
|
||||
|
||||
License
|
||||
-------
|
||||
@ -43,13 +55,6 @@ License
|
||||
This project is licensed under the Apache License, version 2. More
|
||||
information can be found in the LICENSE file.
|
||||
|
||||
Further Documentation
|
||||
---------------------
|
||||
|
||||
Check out our `docs directory
|
||||
<https://github.com/openstack/tuskar-ui/blob/master/docs/index.rst>`_
|
||||
for expanded documentation.
|
||||
|
||||
Contact Us
|
||||
----------
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ To enable Bare Metal driver in DevStack you need to:
|
||||
|
||||
2. Update ``./lib/baremetal``::
|
||||
|
||||
- BM_DNSMASQ_FROM_NOVA_NETWORK=`trueorfalse Flase $BM_DNSMASQ_FROM_NOVA_NETWORK`
|
||||
- BM_DNSMASQ_FROM_NOVA_NETWORK=`trueorfalse False $BM_DNSMASQ_FROM_NOVA_NETWORK`
|
||||
+ BM_DNSMASQ_FROM_NOVA_NETWORK=`trueorfalse True $BM_DNSMASQ_FROM_NOVA_NETWORK`
|
||||
|
||||
See `Bare Metal DevStack documentation <http://devstack.org/lib/baremetal.html>`_
|
||||
|
||||
@ -1,63 +1,20 @@
|
||||
=========
|
||||
Tuskar-UI
|
||||
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>`_.
|
||||
**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
|
||||
-------------------
|
||||
Installation
|
||||
------------
|
||||
|
||||
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=VEY035-Lyzo>`_
|
||||
|
||||
|
||||
Developer Information
|
||||
---------------------
|
||||
|
||||
Installation Guide
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Follow the `Installation Guide <https://github.com/openstack/tuskar-ui/blob/master/docs/install.rst>`_ to install Tuskar-UI.
|
||||
Use the `Installation Guide <https://github.com/openstack/tuskar-ui/blob/master/docs/install.rst>`_ to install Tuskar UI.
|
||||
|
||||
Contributing
|
||||
~~~~~~~~~~~~
|
||||
------------
|
||||
|
||||
We've moved the code to `openstack <https://github.com/openstack>`__
|
||||
to be more familiar to the OpenStack developers. Please go there if you
|
||||
want to check it out:
|
||||
For more information about how to contribute to Tuskar UI, see
|
||||
`README <https://github.com/openstack/tuskar-ui/blob/master/README.rst>`_.
|
||||
|
||||
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. Up to this point, UI development has been focused within the resource_management/ subdirectory.
|
||||
|
||||
Future Work
|
||||
-----------
|
||||
|
||||
The following documents and YouTube videos represent the future work being planned for Tuskar-UI.
|
||||
|
||||
* `User Stories <https://etherpad.openstack.org/tuskar-ui-stories>`_ [YouTube Discussion: `Part 1 <http://www.youtube.com/watch?v=gmxCUNySYqc>`_ | `Part 2 <https://www.youtube.com/watch?v=E2TKZuwPtLA>`_ | `Part 3 <https://www.youtube.com/watch?v=GLg9AiBvRiI>`_]
|
||||
|
||||
|
||||
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.
|
||||
|
||||
@ -1,26 +1,30 @@
|
||||
Setup
|
||||
=====
|
||||
|
||||
This is a quick guide to setting up tuskar-ui.
|
||||
Note
|
||||
----
|
||||
|
||||
If you want to install and configure the entire TripleO + Tuskar + Tuskar UI
|
||||
stack, you can use
|
||||
`the devtest installation guide <https://wiki.openstack.org/wiki/Tuskar/Devtest>`_.
|
||||
|
||||
Otherwise, you can use the installation instructions for Tuskar UI below.
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
tuskar-ui is a web UI for talking to Tuskar. It is an extension of the
|
||||
existing Horizon web interface.
|
||||
|
||||
Installation prerequisites are:
|
||||
|
||||
1. A functional OpenStack installation. Horizon and tuskar-ui will
|
||||
1. A functional OpenStack installation. Horizon and Tuskar UI will
|
||||
connect to the Keystone service here. Keystone does *not* need to be
|
||||
on the same machine as your tuskar-ui interface, but its HTTP API
|
||||
on the same machine as your Tuskar UI interface, but its HTTP API
|
||||
must be accessible.
|
||||
2. A functional Tuskar installation. tuskar-ui talks to Tuskar via an
|
||||
2. A functional Tuskar installation. Tuskar UI talks to Tuskar via an
|
||||
HTTP interface. It may, but does not have to, reside on the same
|
||||
machine as tuskar-ui, but it must be network accessible.
|
||||
machine as Tuskar UI, but it must be network accessible.
|
||||
|
||||
You may find
|
||||
`the Tuskar install guide <https://github.com/openstack/tuskar/blob/master/docs/INSTALL.rst>`_
|
||||
`the Tuskar install guide <https://github.com/openstack/tuskar/blob/master/doc/source/INSTALL.rst>`_
|
||||
helpful.
|
||||
|
||||
For baremetal provisioning, you will want a Nova Baremetal driver
|
||||
@ -33,7 +37,7 @@ If you are using Devstack to run OpenStack, you can use
|
||||
Installing the packages
|
||||
-----------------------
|
||||
|
||||
tuskar-ui is a Django app written in Python and has a few installation
|
||||
Tuskar UI is a Django app written in Python and has a few installation
|
||||
dependencies:
|
||||
|
||||
On a RHEL 6 system, you should install the following:
|
||||
@ -57,7 +61,7 @@ other tools:
|
||||
Install the management UI
|
||||
-------------------------
|
||||
|
||||
Begin by cloning the horizon and tuskar-ui repositories:
|
||||
Begin by cloning the Horizon and Tuskar UI repositories:
|
||||
|
||||
::
|
||||
|
||||
@ -93,7 +97,7 @@ editor. You will want to customize several settings:
|
||||
- ``TUSKAR_ENDPOINT_URL`` should point to the Tuskar server you
|
||||
configured. It normally runs on port 8585.
|
||||
|
||||
Install Tuskar-UI with all dependencies in your virtual environment::
|
||||
Install Tuskar UI with all dependencies in your virtual environment::
|
||||
|
||||
tools/with_venv.sh pip install -r ../tuskar-ui/requirements.txt
|
||||
tools/with_venv.sh pip install -e ../tuskar-ui/
|
||||
@ -117,7 +121,7 @@ If everything has gone according to plan, you should be able to run:
|
||||
|
||||
tools/with_venv.sh ./manage.py runserver
|
||||
|
||||
and have the application start on port 8080. The Tuskar dashboard will
|
||||
and have the application start on port 8080. The Tuskar UI dashboard will
|
||||
be located at http://localhost:8080/infrastructure
|
||||
|
||||
If you wish to access it remotely (i.e., not just from localhost), you
|
||||
|
||||
Loading…
Reference in New Issue
Block a user