heat-dashboard/README.rst
Jean-Philippe Evrard df306b6628 Change location of conf files in README
The configuration files have been moved to be shipped with
the dashboard, but the location of the files haven't been updated
in the readme. This should fix it.

Change-Id: I3a3ae9930a7d553d0c463dd120b8ccbb39cec056
2018-01-26 09:13:32 +00:00

84 lines
2.4 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/heat-dashboard.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
==============
Heat Dashboard
==============
Horizon plugin for Heat
* License: Apache license
* Source: http://git.openstack.org/cgit/openstack/heat-dashboard
* Bugs: http://bugs.launchpad.net/heat-dashboard
Use Heat Dashboard in DevStack
------------------------------
Set up your ``local.conf`` to enable heat-dashboard::
[[local|localrc]]
enable_plugin heat-dashboard https://git.openstack.org/openstack/heat-dashboard
.. note::
You also need to install Heat itself into DevStack to use Heat Dashboard.
Manual Installation
-------------------
Clone both Horizon and Heat Dashboard repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/openstack/heat-dashboard
Create a virtual environment and install Horizon relevant packages::
pip install -r horizon/requirements.txt
Create your ``local_settings.py`` file::
cp horizon/openstack_dashboard/local/local_settings.py.example \
horizon/openstack_dashboard/local/local_settings.py
Open newly created ``local_settings.py`` with your text editor,
and set some parameter to connect to your OpenStack environment:
- Set ``OPENSTACK_HOST`` as hostname or IP address of your OpenStack server.
- Verify that the ``OPENSTACK_KEYSTONE_URL`` and
``OPENSTACK_KEYSTONE_DEFAULT_ROLE`` settings are correct for your
environment. (They should be correct unless you modified your
OpenStack server to change them.)
Install Heat Dashboard with all relevant packages to your Horizon environment::
pip install -e ./heat-dashboard/
Enable heat-dashboard plugin in your Horizon environment::
cp heat-dashboard/heat_dashboard/enabled/* \
horizon/openstack_dashboard/local/enabled
cp heat-dashboard/heat_dashboard/conf/* \
horizon/openstack_dashboard/conf/
cp heat-dashboard/heat_dashboard/local_settings.d/* \
horizon/openstack_dashboard/local/local_settings.d/
Finally you can launch Horizon with Heat Dashboard plugin::
cd horizon
python manage.py runserver 0.0.0.0:8080
Now you can connect to your Horizon including Heat Dashboard plugin
from your browser with URL http://localhost:8080/.