heat-dashboard/README.rst
Keiichi Hikita fe76077425 Split out heat own items from Horizon settings.
Heat relevant contents will be split out
from Horizon in Queens release.

After this splitting out, Heat-Dashboard must have
its own settings in Heat-Dashboard repository.

So this review request includes following.

- Create own settings under local_settings.d
- Add procedure for installing above settings.
- Fix installation procedure according to above changes.

Change-Id: I0b9a9907cb0c02aed70e7c1af3d9d07b0ddeffb6
2017-12-04 10:45:44 +09: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/etc/* \
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/.