openstack/ironic-prometheus-exporter
Code Issues Proposed changes

Reconfigure tox.ini

Browse Source 
Update minversion of tox to 3.9.0 to support inline comments [1]

Move pep8 and coverage test requirements to tox.ini

Add doc8 test and fix some doc files

[1] https://tox.readthedocs.io/en/latest/changelog.html#v3-9-0-2019-04-17

Change-Id: Iea5fa73ebe2b92fd848b92826b04d04fa0969ac1
This commit is contained in:
Riccardo Pittau 2021-01-23 18:40:47 +01:00
parent 36f2ccb44f
commit 198f07df9a
4 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/configuration.rst
View File

@ -1,8 +1,9 @@
Configuration Configuration
============= =============
To enable the ironic-prometheus-exporter to collect the sensor data from Ironic, To enable the ironic-prometheus-exporter to collect the sensor data from
it's necessary to enable some configuration parameters in the ``ironic.conf``. Ironic, it's necessary to enable some configuration parameters in the
``ironic.conf``.
Below you can see an example of the required configuration, the table Below you can see an example of the required configuration, the table
:ref:`ipe_conf` shows all the available configuration options. :ref:`ipe_conf` shows all the available configuration options.
@ -24,7 +25,8 @@ Example of configuration
.. _ipe_conf: .. _ipe_conf:
.. list-table:: Configuration options for the ironic-prometheus-exporter in Ironic .. list-table:: Configuration options for the ironic-prometheus-exporter
in Ironic
:widths: 15 15 10 50 10 :widths: 15 15 10 50 10
:header-rows: 1 :header-rows: 1
@ -70,5 +72,5 @@ Example of configuration
.. note:: .. note::
After doing the modifications in the ``ironic.conf`` don't forget to re-start After doing the modifications in the ``ironic.conf`` don't forget to
the ironic-conductor service re-start the ironic-conductor service

7
doc/source/install.rst
View File

@ -35,5 +35,8 @@ on RDO.
$ pip install entry_point_inspector --user <user> $ pip install entry_point_inspector --user <user>
$ epi group show oslo.messaging.notify.drivers $ epi group show oslo.messaging.notify.drivers
- Output in case of a successful installation: `prometheus_exporter` is listed in the `Name` column and the `Error` column should be empty. - Output in case of a successful installation: `prometheus_exporter` is listed
- Output in case of an unsuccessful installation: `prometheus_exporter` is listed in the `Name` column and the `Error` column will have more information. in the `Name` column and the `Error` column should be empty.
- Output in case of an unsuccessful installation: `prometheus_exporter` is
listed in the `Name` column and the `Error` column will have more
information.

5
test-requirements.txt
View File

@ -1,9 +1,4 @@
hacking>=3.1.0,<4.0.0 # Apache-2.0
flake8
flake8-import-order>=0.17.1
stestr>=2.0.0 # Apache-2.0 stestr>=2.0.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0
pycodestyle>=2.0.0,<2.7.0 # MIT

12
tox.ini
View File

@ -1,5 +1,5 @@
[tox] [tox]
minversion = 3.2.1 minversion = 3.9.0
envlist = py3,pep8 envlist = py3,pep8
skipsdist = True skipsdist = True
ignore_basepython_conflict=true ignore_basepython_conflict=true
@ -20,12 +20,18 @@ deps =
commands = stestr run {posargs} commands = stestr run {posargs}
[testenv:pep8] [testenv:pep8]
commands = flake8 {posargs} deps =
hacking>=3.1.0,<4.0.0 # Apache-2.0
doc8>=0.8.1 # Apache-2.0
flake8-import-order>=0.17.1 # LGPLv3
pycodestyle>=2.0.0,<2.7.0 # MIT
commands =
flake8 {posargs}
doc8 README.rst CONTRIBUTING.md doc/source
[testenv:cover] [testenv:cover]
setenv = setenv =
PYTHON=coverage run --parallel-mode PYTHON=coverage run --parallel-mode
commands = commands =
coverage erase coverage erase
stestr run {posargs} stestr run {posargs}