Files
vitrage-dashboard/README.rst
Ifat Afek f529174252 Add .rst files check to pep8
Errors in README.rst prevent the package from being registered in Pypi. We would like pep8 to fail in these cases.
For more details, see: http://lists.openstack.org/pipermail/openstack-dev/2018-June/131233.html

Change-Id: I8a6c333c4c968054fe8b63bdf844fe8d94ce98b5
2018-06-07 09:12:50 +00:00

70 lines
1.7 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/vitrage-dashboard.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
=================
Vitrage Dashboard
=================
Vitrage is the Openstack RCA (Root Cause Analysis) Engine for organizing,
analyzing and expanding OpenStack alarms & events, yielding insights
regarding the root cause of problems and deducing the existence of problems
before they are directly detected.
Vitrage Dashboard is an extension for OpenStack Dashboard that provides a UI for
Vitrage.
Project Resources
-----------------
* `Vitrage at Launchpad <https://launchpad.net/vitrage>`_
* `Wiki <https://wiki.openstack.org/wiki/Vitrage>`_
* `Code Review <https://review.openstack.org/>`_
How to use this package
-----------------------
With Devstack
-------------
Add the following to your Devstack local.conf file
::
enable_plugin vitrage-dashboard https://git.openstack.org/openstack/vitrage-dashboard
With Horizon
------------
::
git clone https://github.com/openstack/horizon.git
git clone https://github.com/openstack/vitrage-dashboard.git
git clone https://github.com/openstack/python-vitrageclient.git
cd ../horizon
./run_tests.sh -f --docs
cp ./openstack_dashboard/local/local_settings.py.example ./openstack_dashboard/local/local_settings.py
pushd ../vitrage-dashboard
../horizon/tools/with_venv.sh pip install -e.
cp -a vitrage_dashboard/enabled/* ../horizon/openstack_dashboard/enabled/
popd
cd python-vitrageclient
../horizon/tools/with_venv.sh pip install -e.