Horizon UI for Monasca
Go to file
Witek Bedyk 855a1f2fc5 Use django.conf.settings instead of local_settings
The default and preferred way of modifying the settings of Horizon
plugin is to add a configuration file to
openstack_dashboard/local/local_settings.d/ directory [1]. For that to
work we should use the settings from django.conf.settings and not from
monitoring.config.local_settings.

[1] https://docs.openstack.org/horizon/latest/configuration/settings.html

Story: 2006556
Task: 36644

Change-Id: I5cd66954ffb1169f3149cd6f705593efe3a15b13
2019-09-16 15:19:32 +02:00
debian Initial installer work 2014-04-29 14:09:19 -06:00
grafana-dashboards fix a typo in drilldown.js 2018-05-23 23:56:47 +08:00
monitoring Use django.conf.settings instead of local_settings 2019-09-16 15:19:32 +02:00
tools Make monasca-ui python3 compatible 2018-03-29 15:53:22 -04:00
.gitignore Update pep8 checks 2018-04-18 16:09:26 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:44:03 +00:00
.zuul.yaml Add Python 3 Train unit tests 2019-07-05 13:16:28 -04:00
babel-django.cfg This is a preparation for using Zanata 2016-01-28 15:34:06 +09:00
babel-djangojs.cfg This is a preparation for using Zanata 2016-01-28 15:34:06 +09:00
LICENSE pypi packaging files 2014-05-30 16:52:14 -06:00
lower-constraints.txt Drop nose dependencies 2018-08-17 01:59:02 +09:00
manage.py Use django.conf.settings instead of local_settings 2019-09-16 15:19:32 +02:00
mkdocs.yml Change repositories from stackforge to openstack 2015-10-19 09:59:14 +05:30
README.rst Update hacking version to latest 2019-05-28 18:35:47 +08:00
requirements.txt Fix README.rst and add syntax check 2018-08-08 18:04:12 +02:00
run_tests.sh Move coverage reports to cover directory 2018-03-16 14:54:20 +01:00
setup.cfg Add Python 3 Train unit tests 2019-07-05 13:16:28 -04:00
setup.py Updated from global requirements 2017-03-02 11:47:16 +00:00
test-requirements.txt Update hacking version to latest 2019-05-28 18:35:47 +08:00
tox.ini Add Python 3 Train unit tests 2019-07-05 13:16:28 -04:00

Team and repository tags

image

monasca-ui

Monasca UI is implemented as a Horizon plugin that adds panels to Horizon. It is installed into devstack by the monasca-api plugin.

Devstack Deployment Set Up

  • cd /opt/stack/horizon
  • Install Openstack upper-constraints requirements pip install -c https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt -r requirements.txt
  • Clone monasca-ui: git clone https://opendev.org/openstack/monasca-ui.git
  • Add git+https://opendev.org/openstack/monasca-ui.git to requirements.txt.
  • Install monasca-ui required packages pip install -r requirements.txt (monasca-client packages will be installed.)
  • Edit openstack_dashboard/settings.py to include the following two lines:
    • import monitoring.enabled
    • monitoring.enabled, (Add this line to the settings_utils.update_dashboards list.)
  • Link monasca into Horizon:
ln -sf $(pwd)/../monasca-ui/monitoring/enabled/_50_admin_add_monitoring_panel.py \
    $(pwd)/openstack_dashboard/enabled/_50_admin_add_monitoring_panel.py
ln -sf $(pwd)/../monasca-ui/monitoring/conf/monitoring_policy.json \
    $(pwd)/openstack_dashboard/conf/monitoring_policy.json
ln -sfF $(pwd)/../monasca-ui/monitoring $(pwd)/monitoring
  • Collect static files, run tests
python manage.py collectstatic --noinput
python manage.py compress
./run_tests.sh
  • Restart apache service service apache2 restart

Development Environment Set Up

Get the Code

git clone https://opendev.org/openstack/monasca-ui.git  # clone monasca-ui
git clone https://opendev.org/openstack/horizon.git  # clone horizon
git clone https://github.com/monasca/grafana.git  # clone grafana
git clone https://github.com/openstack/monasca-grafana-datasource.git # clone grafana plugins

Set up Horizon

Since Monasca UI is a Horizon plugin, the first step is to get their development environment set up.

cd horizon
./run_tests.sh
cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py

Pro Tip: Make sure you have Horizon running correctly before proceeding. For more details visit: https://docs.openstack.org/horizon/latest/#setup

Set up Monasca-UI

  • Edit openstack_dashboard/local/local_settings.py to modify the OPENSTACK_HOST IP address to point to devstack.
  • Add monasca-client to requirements.txt. Get the latest version from: https://pypi.org/project/python-monascaclient
  • Link monasca into Horizon:
ln -sf $(pwd)/../monasca-ui/monitoring/enabled/_50_admin_add_monitoring_panel.py \
    $(pwd)/openstack_dashboard/enabled/_50_admin_add_monitoring_panel.py
ln -sf $(pwd)/../monasca-ui/monitoring/conf/monitoring_policy.json \
    $(pwd)/openstack_dashboard/conf/monitoring_policy.json
ln -sfF $(pwd)/../monasca-ui/monitoring $(pwd)/monitoring
./run_tests #load monasca-client into virtualenv

Set up Grafana 4.1

Start Server

./run_tests.sh --runserver

Style checks

To check if the code follows python coding style, run the following command from the root directory of this project:

$ tox -e pep8

Coverage checks

To measure the code coverage, run the following command from the root directory of this project:

$ tox -e cover

Unit tests

To run all the unit test cases, run the following command from the root directory of this project:

$ tox -e py27,py36