Files
karbor-dashboard/README.rst
Flavio Percoco 1919d1b665 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:

b'https://gist.github.com/26318164ea760d9a9234452836343c74\n'

Change-Id: I56e67db2a11b2acc58e8765e755466600e62fb17
2016-11-25 14:07:10 +01:00

61 lines
1.9 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/karbor-dashboard.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
===============================
karbor-dashboard
===============================
Karbor Dashboard
* Free software: Apache license
* Source: http://git.openstack.org/cgit/openstack/karbor-dashboard
* Bugs: http://bugs.launchpad.net/karbor-dashboard
Installation instructions
-------------------------
Begin by cloning the Horizon and Karbor Dashboard repositories::
git clone https://git.openstack.org/openstack/horizon
git clone https://git.openstack.org/openstack/karbor-dashboard
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 Karbor Dashboard with all dependencies in your virtual environment::
tools/with_venv.sh pip install -e ../karbor-dashboard/
And enable it in Horizon::
cp ../karbor-dashboard/karbor_dashboard/enabled/* openstack_dashboard/local/enabled/
To run horizon with the newly enabled Karbor Dashboard 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/