Update README.rst to include Python and testing instructions.
This updates the README to include missing instructions for installing the Python module and basic information on testing. Additionally, a link to the planning etherpad is also included. Change-Id: I75795888bd19eb8116d86ee9647a2eeb6f3119be
This commit is contained in:
parent
acfbad02df
commit
d13506d750
49
README.rst
49
README.rst
@ -1,11 +1,11 @@
|
|||||||
=================
|
========
|
||||||
StackViz: Angular
|
StackViz
|
||||||
=================
|
========
|
||||||
A visualization utility to help analyze the performance of DevStack setup and
|
A visualization utility to help analyze the performance of DevStack setup and
|
||||||
Tempest executions.
|
Tempest executions.
|
||||||
|
|
||||||
Installation
|
Installation - Frontend
|
||||||
============
|
=======================
|
||||||
Installation of the frontend requires Node.js and Gulp. On Ubuntu::
|
Installation of the frontend requires Node.js and Gulp. On Ubuntu::
|
||||||
|
|
||||||
sudo apt-get install nodejs npm nodejs-legacy
|
sudo apt-get install nodejs npm nodejs-legacy
|
||||||
@ -15,6 +15,13 @@ Then, install the Node modules by running, from the project directory::
|
|||||||
|
|
||||||
npm install
|
npm install
|
||||||
|
|
||||||
|
Installation - Processing
|
||||||
|
=========================
|
||||||
|
The data processor is a small Python module located in the same source tree. To
|
||||||
|
install, run::
|
||||||
|
|
||||||
|
sudo pip install .
|
||||||
|
|
||||||
Usage - Development
|
Usage - Development
|
||||||
===================
|
===================
|
||||||
A development server can be run as follows::
|
A development server can be run as follows::
|
||||||
@ -29,6 +36,10 @@ your runs::
|
|||||||
|
|
||||||
stackviz-export -f <path/to/subunit> --dstat <path/to/dstat> app/data/
|
stackviz-export -f <path/to/subunit> --dstat <path/to/dstat> app/data/
|
||||||
|
|
||||||
|
During :code:`gulp dev`, files written to :code:`app/data/` will be
|
||||||
|
automatically synchronized with the browser. Note that these files will *not* be
|
||||||
|
copied to :code:`build/` during :code:`gulp prod`, but you can copy them
|
||||||
|
manually using :code:`gulp data`.
|
||||||
|
|
||||||
Usage - Production
|
Usage - Production
|
||||||
==================
|
==================
|
||||||
@ -49,20 +60,18 @@ distribution. Note that all files are not required:
|
|||||||
- Source maps (:code:`js/main.js.map`, :code:`js/main.js.map.gz`): only required
|
- Source maps (:code:`js/main.js.map`, :code:`js/main.js.map.gz`): only required
|
||||||
for debugging purposes.
|
for debugging purposes.
|
||||||
|
|
||||||
Roadmap
|
Data should be written to :code:`build/data/` using :code:`stackviz-export` like
|
||||||
|
above. Note that the static production code generated above is portable, and can
|
||||||
|
be generated anywhere and copied to another host to be combined with exported
|
||||||
|
data.
|
||||||
|
|
||||||
|
Testing
|
||||||
=======
|
=======
|
||||||
- Project split: All server-side components will be removed, and replaced with
|
* Python tests: :code:`tox -epy27`
|
||||||
specialized data transformation tools.
|
* JavaScript unit tests: :code:`gulp unit`
|
||||||
|
* JavaScript E2E tests: :code:`gulp e2e`
|
||||||
|
|
||||||
- Data sources and processing: `stackviz` Python project, with
|
Roadmap and Planning
|
||||||
`stackviz-export` used to generate JSON data files and configuration.
|
====================
|
||||||
|
- Planning: https://etherpad.openstack.org/p/stackviz
|
||||||
- Web interface:
|
- Gate integration planning: https://etherpad.openstack.org/p/BKgWlKIjgQ
|
||||||
|
|
||||||
- Will remain in this namespace (:code:`openstack-qa/stackviz`).
|
|
||||||
- Will decouple data processing from build process, allowing for
|
|
||||||
distribution to nodes as a prebuilt static site.
|
|
||||||
- Data sources will be configured in a :code:`config.json`.
|
|
||||||
- Will support local and remote sources via REST/JSONP (pending API spec).
|
|
||||||
|
|
||||||
- Upstream Implementation: https://etherpad.openstack.org/p/BKgWlKIjgQ
|
|
||||||
|
Loading…
Reference in New Issue
Block a user