From 0eb8c49b0164df77a7d74db022c29cb182f013a7 Mon Sep 17 00:00:00 2001 From: Denis Poisson Date: Thu, 28 Jun 2018 14:46:30 +0200 Subject: [PATCH] Convert README.md to ReStructuredText format Change-Id: I100bdb0db5e1bb17795a67c27d5337ea5e8c5f8d story: 2002163 task: 22601 --- README.md | 106 -------------------------------------------- README.rst | 128 +++++++++++++++++++++++++++++++++++++++++++++++++++++ setup.cfg | 2 +- 3 files changed, 129 insertions(+), 107 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 66ce6608..00000000 --- a/README.md +++ /dev/null @@ -1,106 +0,0 @@ -Team and repository tags -======================== - -[![Team and repository tags](https://governance.openstack.org/tc/badges/monasca-ui.svg)](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. - -# Deployment Set Up - -* Clone Horizon: `git clone https://git.openstack.org/openstack/horizon.git` - -* `cd horizon` -* Add `git+https://git.openstack.org/openstack/monasca-ui.git` to `requirements.txt`. -* Edit `openstack_dashboard/settings.py` to include the following two lines: - * `import monitoring.enabled` - * `monitoring.enabled,` (Add this line to the `settings.update_dashboards` list.) - - -# Development Environment Set Up - -## Get the Code - -``` -git clone https://git.openstack.org/openstack/monasca-ui.git # clone monasca-ui -git clone https://git.openstack.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 - -* 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: - * http://docs.grafana.org/project/building_from_source/ - * http://docs.grafana.org/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 py27,py35 diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..83269e4e --- /dev/null +++ b/README.rst @@ -0,0 +1,128 @@ +Team and repository tags +======================== + +.. 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. + +Deployment Set Up +================= + +- Clone Horizon: + ``git clone https://git.openstack.org/openstack/horizon.git`` + +- ``cd horizon`` +- Add ``git+https://git.openstack.org/openstack/monasca-ui.git`` to + ``requirements.txt``. +- Edit ``openstack_dashboard/settings.py`` to include the following two + lines: + + - ``import monitoring.enabled`` + - ``monitoring.enabled,`` (Add this line to the + ``settings.update_dashboards`` list.) + +Development Environment Set Up +============================== + +Get the Code +------------ + +:: + + git clone https://git.openstack.org/openstack/monasca-ui.git # clone monasca-ui + git clone https://git.openstack.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 +------------------ + +- 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: + + - http://docs.grafana.org/project/building_from_source/ + - http://docs.grafana.org/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 py27,py35 + +.. _Team and repository tags: https://governance.openstack.org/tc/reference/tags/index.html \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index 79aaad0d..4d7125e4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,7 @@ [metadata] name = monasca-ui summary = Monasca Plugin for Horizon -description-file = README.md +description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org home-page = https://github.com/openstack/monasca-ui