castellan-ui/README.rst

65 lines
1.8 KiB
ReStructuredText

===============================
Castellan UI
===============================
Generic Key Manager UI Plugin for Horizon
* Free software: Apache license
* Source: http://git.openstack.org/cgit/openstack/castellan-ui
* Bugs: http://bugs.launchpad.net/castellan-ui
Features
--------
* TODO
Enabling in DevStack
--------------------
Add this repo as an external repository into your ``local.conf`` file::
[[local|localrc]]
enable_plugin castellan-ui https://github.com/openstack/castellan-ui
Manual Installation
-------------------
Begin by cloning the Horizon and Castellan UI repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/openstack/castellan-ui
Create a virtual environment and install Horizon dependencies::
cd horizon
python tools/install_venv.py
Set up your ``local_settings.py`` file::
cp openstack_dashboard/local/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:
- ``OPENSTACK_HOST`` should be configured with the hostname 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 Castellan UI with all dependencies in your virtual environment::
tools/with_venv.sh pip install -e ../castellan-ui/
And enable it in Horizon::
TODO(kfarr): add the panel group here
TODO(kfarr): add the panels here
To run horizon with the newly enabled Castellan UI plugin run::
./run_tests.sh --runserver 0.0.0.0:8080
to have the application start on port 8080 and the horizon dashboard will be
available in your browser at http://localhost:8080/