Monasca UI
========================
.. image:: https://governance.openstack.org/tc/badges/monasca-ui.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
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.yaml \
$(pwd)/openstack_dashboard/conf/monitoring_policy.yaml
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.yaml \
$(pwd)/openstack_dashboard/conf/monitoring_policy.yaml
ln -sfF $(pwd)/../monasca-ui/monitoring $(pwd)/monitoring
./run_tests #load monasca-client into virtualenv
Set up Grafana 4.1
------------------
- The grafana4 branch of grafana is stable, as is master in
monasca-grafana-datasource.
- Copy ``monasca-grafana-datasource/`` into
``grafana/plugins/monasca-grafana-datasource/``.
- Use the grafana docs to build and deploy grafana:
- https://grafana.com/docs/project/building_from_source/
- https://grafana.com/docs/installation/configuration/
- Copy ``monasca-ui/grafana-dashboards/*`` to ``/public/dashboards/``
in your grafana deployment.
- Set ``GRAFANA_URL`` in the Horizon settings.
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 py36
Raw data
{
"_id": null,
"home_page": "https://opendev.org/openstack/monasca-ui",
"name": "monasca-ui",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/80/50/a9851487e5e9351fbc10639ffca578ad930c98e0d9dc63e144aa6b9646d5/monasca-ui-8.0.0.tar.gz",
"platform": null,
"description": "Monasca UI\n========================\n\n.. image:: https://governance.openstack.org/tc/badges/monasca-ui.svg\n :target: https://governance.openstack.org/tc/reference/tags/index.html\n\nmonasca-ui\n==========\n\nMonasca UI is implemented as a Horizon plugin that adds panels to\nHorizon. It is installed into devstack by the monasca-api plugin.\n\nDevstack Deployment Set Up\n==========================\n\n- ``cd /opt/stack/horizon``\n- Install Openstack upper-constraints requirements\n ``pip install -c https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt -r requirements.txt``\n- Clone monasca-ui:\n ``git clone https://opendev.org/openstack/monasca-ui.git``\n- Add ``git+https://opendev.org/openstack/monasca-ui.git`` to\n ``requirements.txt``.\n- Install monasca-ui required packages\n ``pip install -r requirements.txt`` (monasca-client packages will be installed.)\n- Edit ``openstack_dashboard/settings.py`` to include the following two\n lines:\n\n - ``import monitoring.enabled``\n - ``monitoring.enabled,`` (Add this line to the\n ``settings_utils.update_dashboards`` list.)\n- Link monasca into Horizon:\n\n::\n\n ln -sf $(pwd)/../monasca-ui/monitoring/enabled/_50_admin_add_monitoring_panel.py \\\n $(pwd)/openstack_dashboard/enabled/_50_admin_add_monitoring_panel.py\n ln -sf $(pwd)/../monasca-ui/monitoring/conf/monitoring_policy.yaml \\\n $(pwd)/openstack_dashboard/conf/monitoring_policy.yaml\n ln -sfF $(pwd)/../monasca-ui/monitoring $(pwd)/monitoring\n\n- Collect static files, run tests\n\n::\n\n python manage.py collectstatic --noinput\n python manage.py compress\n ./run_tests.sh\n\n- Restart apache service ``service apache2 restart``\n\nDevelopment Environment Set Up\n==============================\n\nGet the Code\n------------\n\n::\n\n git clone https://opendev.org/openstack/monasca-ui.git # clone monasca-ui\n git clone https://opendev.org/openstack/horizon.git # clone horizon\n git clone https://github.com/monasca/grafana.git # clone grafana\n git clone https://github.com/openstack/monasca-grafana-datasource.git # clone grafana plugins\n\nSet up Horizon\n--------------\n\nSince Monasca UI is a Horizon plugin, the first step is to get their\ndevelopment environment set up.\n\n::\n\n cd horizon\n ./run_tests.sh\n cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py\n\nPro Tip: Make sure you have Horizon running correctly before proceeding.\nFor more details visit: https://docs.openstack.org/horizon/latest/#setup\n\nSet up Monasca-UI\n-----------------\n\n- Edit ``openstack_dashboard/local/local_settings.py`` to modify the\n ``OPENSTACK_HOST`` IP address to point to devstack.\n- Add ``monasca-client`` to ``requirements.txt``. Get the latest\n version from: https://pypi.org/project/python-monascaclient\n- Link monasca into Horizon:\n\n::\n\n ln -sf $(pwd)/../monasca-ui/monitoring/enabled/_50_admin_add_monitoring_panel.py \\\n $(pwd)/openstack_dashboard/enabled/_50_admin_add_monitoring_panel.py\n ln -sf $(pwd)/../monasca-ui/monitoring/conf/monitoring_policy.yaml \\\n $(pwd)/openstack_dashboard/conf/monitoring_policy.yaml\n ln -sfF $(pwd)/../monasca-ui/monitoring $(pwd)/monitoring\n ./run_tests #load monasca-client into virtualenv\n\nSet up Grafana 4.1\n------------------\n\n- The grafana4 branch of grafana is stable, as is master in\n monasca-grafana-datasource.\n- Copy ``monasca-grafana-datasource/`` into\n ``grafana/plugins/monasca-grafana-datasource/``.\n- Use the grafana docs to build and deploy grafana:\n\n - https://grafana.com/docs/project/building_from_source/\n - https://grafana.com/docs/installation/configuration/\n\n- Copy ``monasca-ui/grafana-dashboards/*`` to ``/public/dashboards/``\n in your grafana deployment.\n- Set ``GRAFANA_URL`` in the Horizon settings.\n\nStart Server\n------------\n\n::\n\n ./run_tests.sh --runserver\n\nStyle checks\n------------\n\nTo check if the code follows python coding style, run the following\ncommand from the root directory of this project:\n\n::\n\n $ tox -e pep8\n\nCoverage checks\n---------------\n\nTo measure the code coverage, run the following command from the root\ndirectory of this project:\n\n::\n\n $ tox -e cover\n\nUnit tests\n----------\n\nTo run all the unit test cases, run the following command from the root\ndirectory of this project:\n\n::\n\n $ tox -e py36\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Monasca Plugin for Horizon",
"version": "8.0.0",
"project_urls": {
"Homepage": "https://opendev.org/openstack/monasca-ui"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3f5d19565f77d7b0720cdbdbde1a7eefa7b327c266ce76bed3370321b6000a5",
"md5": "46a85f99600a20bfd4efe44501d6daa2",
"sha256": "1fcc0fe66159b5e658e9d89a42828f53d8b8636feee47541c050e0b30361c395"
},
"downloads": -1,
"filename": "monasca_ui-8.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46a85f99600a20bfd4efe44501d6daa2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 142243,
"upload_time": "2023-03-22T12:26:40",
"upload_time_iso_8601": "2023-03-22T12:26:40.933807Z",
"url": "https://files.pythonhosted.org/packages/e3/f5/d19565f77d7b0720cdbdbde1a7eefa7b327c266ce76bed3370321b6000a5/monasca_ui-8.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8050a9851487e5e9351fbc10639ffca578ad930c98e0d9dc63e144aa6b9646d5",
"md5": "1f8eb9ceab35e1dfe698586ddf7a30c7",
"sha256": "bb393295761cc61162a34a360c8ec2fbaffc927eaa152693a361089cec431d38"
},
"downloads": -1,
"filename": "monasca-ui-8.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1f8eb9ceab35e1dfe698586ddf7a30c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 108722,
"upload_time": "2023-03-22T12:26:42",
"upload_time_iso_8601": "2023-03-22T12:26:42.659642Z",
"url": "https://files.pythonhosted.org/packages/80/50/a9851487e5e9351fbc10639ffca578ad930c98e0d9dc63e144aa6b9646d5/monasca-ui-8.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-22 12:26:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "monasca-ui"
}
JSON