system-config/doc/source/openstack-health.rst
Ian Wienand 882b730fdf Update to openstackdocstheme
This modernises the openstack-infra documentation by switching to
openstackdocstheme.  Update dependencies as required.

To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.

It seems later sphinx has included it's own ":file:" role which now
conflicts.  Change it it ":cgit_file:" in our documentation.  Remove
the custom header template which no longer applies.  Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)

Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c
2018-06-25 11:19:43 +10:00

42 lines
1.3 KiB
ReStructuredText

:title: openstack-health
.. _openstack-health:
OpenStack-Health
################
At a Glance
===========
:Hosts:
* API Server: http://health.openstack.org
* Frontend: http://status.openstack.org/openstack-health
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-openstack_health/tree/
* :cgit_file:`modules/openstack_project/manifests/openstack_health_api.pp`
* :cgit_file:`modules/openstack_project/manifests/status.pp`
:Configuration:
* :cgit_file:`modules/openstack_project/files/git/cgitrc`
:Projects:
* https://git.openstack.org/cgit/openstack/openstack-health/tree
Overview
========
The OpenStack Health dashboard provides a view of the status of all the tests
running in our continuous integration infrastructure that we collect results
data in subunit2sql for. It is composed of 2 pieces:
#. The REST API that provides the data used for the dashboard visualizations
#. The JS frontend which is used to visualize the data returned by the REST
API
The REST API is deployed on it's own server. It is written in python using flask
and is deployed using mod_wsgi under apache.
The frontend component is deployed on status.openstack.org.
Both components are continually deployed from the project repo, so as soon
as a commit lands in the openstack-health repo it will be applied to the
deployment.