:title: refstack

.. _refstack:

Refstack
########

Refstack is a public facing test reporting site supporting the efforts of
the Interop Working Group to identify widely deployed capabilities and also to
verify the test results against the established capability specification.
More about InteropWG can be found at
https://docs.opendev.org/openinfra/interop/latest/

At a Glance
===========

:Hosts:
  * refstack01.openstack.org
:Ansible:
  * :git_file:`playbooks/service-refstack.yaml`
  * :git_file:`docker/refstack/Dockerfile`
:Projects:
  * https://opendev.org/openinfra/refstack/
:Bugs:
  * https://storyboard.openstack.org/#!/project/openinfra/refstack

Overview
========

There are three major components in the Refstack server:

* Refstack-UI
* Refstack-API
* Database

These run as two containers (UI/API and mariadb) on the host.

Refstack-UI
-----------

Refstack-UI is a web interface for interacting with data collected with
the API server and client.

Refstack-API
------------

Refstack-API server is a central repository for the collection of
interoperability test results. It also provides APIs to facilitate the
uploading/retrieval of test data.  Users can use the refstack-client tool
to anonymously upload their data to the refstack.openstack.org site.

Mariadb database
----------------

This is the database to host the user uploaded test results data.

More information about the Refstack project can be found at
 https://docs.opendev.org/openinfra/refstack/latest/