mistral-dashboard/README.rst
Flavio Percoco 92e3177b5a Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/db05066c92244167e9fa7f0109d8d9d5

Change-Id: I1ff7fe3892d930883cf9c00b270490115ea4a57e
2016-11-25 17:30:52 +01:00

69 lines
2.2 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/mistral-dashboard.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
=================
Mistral Dashboard
=================
Horizon plugin for Mistral.
Setup Instructions
==================
This instruction assumes that Horizon is already installed and it's installation
folder is <horizon>. Detailed information on how to install Horizon can be
found at http://docs.openstack.org/developer/horizon/quickstart.html#setup.
The installation folder of Mistral Dashboard will be referred to as <mistral-dashboard>.
The following should get you started::
Clone the repository into your local OpenStack directory:
$ git clone https://github.com/openstack/mistral-dashboard.git
Install mistral-dashboard
$ sudo pip install -e <mistral-dashboard>
Or if you're planning to run Horizon server in a virtual environment (see below):
$ tox -evenv -- pip install -e ../mistral-dashboard/
and then
$ cp -b <mistral-dashboard>/_50_mistral.py.example <horizon>/openstack_dashboard/local/enabled/_50_mistral.py
Since Mistral only supports Identity v3, you must ensure that the dashboard
points the proper OPENSTACK_KEYSTONE_URL in <horizon>/openstack_dashboard/local/local_settings.py file::
OPENSTACK_API_VERSIONS = {
"identity": 3,
}
OPENSTACK_KEYSTONE_URL = "http://%s:5000/v3" % OPENSTACK_HOST
Also, make sure you have changed OPENSTACK_HOST to point to your Keystone
server and check all endpoints are accessible. You may want to change
OPENSTACK_ENDPOINT_TYPE to "publicURL" if some of them are not.
When you're ready, you would need to either restart your apache::
$ sudo service apache2 restart
or run the development server (in case you have decided to use local horizon)::
$ cd ../horizon/
$ tox -evenv -- python manage.py runserver
Mistral-Dashboard Debug Instructions
------------------------------------
For debug instructions refer to `OpenStack Mistral Troubleshooting
<http://docs.openstack.org/developer/mistral/developer/troubleshooting.html>`_