Docs Refactor
This patch is documentation only. The changes are not complete and information in the files should be updated as the progress progresses. The goal is NOT to update the files, but to move them into better locations as dicussed in weekly calls. The change includes making the root readme more general with links to deeper documents. Landing pages for running RefStack and TCUP have been moved to the /doc directory. Change-Id: Ifdf4afe0411f92253e0b4cb3ad64a0e6be3bd172
This commit is contained in:
Rob Hirschfeld
parent
84c0057204
commit
950e269233
70
README.rst
70
README.rst
@ -1,58 +1,40 @@
|
||||
RefStack
|
||||
========
|
||||
RefStack/TCUP and Driver Test
|
||||
=============================
|
||||
|
||||
Vendor-facing API for registration of interop-compliance endpoints and credentials for on-demand testing.
|
||||
This project support collection and publication of Community Test results for OpenStack. There are multiple components of this effort:
|
||||
|
||||
See (living) documentation at https://etherpad.openstack.org/RefStackBlueprint
|
||||
* `TCUP <doc/tcup.md>`_: Portable, Containerized Tempest for Community running and reporting results to RefStack
|
||||
* `RefStack <doc/refstack.md>`_: Community-facing API for registration of interop-compliance endpoints and credentials for on-demand testing.
|
||||
* Driver Test
|
||||
|
||||
|
||||
Okay, I'm Sold, How Do I Run This Myself?
|
||||
Participate
|
||||
-----------------------------------------
|
||||
|
||||
This is our documentation for how we get this set up::
|
||||
* General
|
||||
|
||||
# Git you clonin'
|
||||
git clone http://github.com/stackforge/refstack
|
||||
* Mailing List: fits@openstack.org
|
||||
* IRC: #refstack on Freenode
|
||||
* Dev Meetings: https://wiki.openstack.org/wiki/Meetings#DefCore_.2F_RefStack_Development_Meeting
|
||||
* Web-site: http://refstack.org
|
||||
* Wiki: https://wiki.openstack.org/wiki/RefStack
|
||||
|
||||
cd refstack
|
||||
* Development
|
||||
|
||||
# Setup or update the database
|
||||
# NOTE: you are going to have to modify the db connection string in
|
||||
# `alembic.ini` to get this working
|
||||
# PROTIP: if you just want to test this out, use `-n alembic_sqlite` to
|
||||
# make a local sqlite db
|
||||
# $ alembic -n alembic_sqlite upgrade head
|
||||
alembic upgrade head
|
||||
* Launchpad: https://launchpad.net/refstack
|
||||
* Blueprints: https://blueprints.launchpad.net/refstack
|
||||
* Bugs: https://bugs.launchpad.net/refstack
|
||||
* Code Reviews: https://review.openstack.org/#q,status:open+refstack,n,z
|
||||
|
||||
# Plug this bad boy into your server infrastructure.
|
||||
# We use nginx and gunicorn, you may use something else if you are smarter
|
||||
# than we are.
|
||||
# For the most basic setup that you can try right now, just kick off
|
||||
# gunicorn:
|
||||
gunicorn -b 0.0.0.0:8000 refstack.web:app
|
||||
Test your Cloud and Share! > Running TCUP
|
||||
-----------------------------------------
|
||||
|
||||
# To actually configure this winner, check out the config section and
|
||||
# crack open refstack.cfg in vim.
|
||||
# `vim refstack.cfg`
|
||||
TCUP (Tempest in a Container to Upload from Probe) is a portable way for community members to quickly and consistently run Tempest against private and public clouds.
|
||||
|
||||
# Now browse to http://localhost:8000
|
||||
`TCUP docs <doc/tcup.md>`_
|
||||
|
||||
Collecting the Results > Running RefStack
|
||||
-----------------------------------------
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
RefStack is a Web UI and API used to collect test results from TCUP and display results. This information is used by the DefCore committee to help select must-pass capabilities.
|
||||
|
||||
Coming soon!
|
||||
|
||||
TODO:
|
||||
=====
|
||||
|
||||
Metadata gathering:
|
||||
- Number of nodes
|
||||
- vCPUs
|
||||
- Distro
|
||||
- Deployment approach
|
||||
- RAM
|
||||
|
||||
Plugins:
|
||||
- Cinder
|
||||
- Neutron
|
||||
`RefStack docs <doc/refstack.md>`_
|
||||
|
||||
5
doc/README.md
Normal file
5
doc/README.md
Normal file
@ -0,0 +1,5 @@
|
||||
RefStack Documentation
|
||||
=============================
|
||||
|
||||
Welcome to RefStack. This project helps OpenStack collect and distribute test and validation information.
|
||||
|
||||
30
doc/refstack.md
Normal file
30
doc/refstack.md
Normal file
@ -0,0 +1,30 @@
|
||||
RefStack Configuration
|
||||
===========================
|
||||
|
||||
This is our documentation for how we get this set up::
|
||||
|
||||
# Git you clonin'
|
||||
git clone http://github.com/stackforge/refstack
|
||||
|
||||
cd refstack
|
||||
|
||||
# Setup or update the database
|
||||
# NOTE: you are going to have to modify the db connection string in
|
||||
# `alembic.ini` to get this working
|
||||
# PROTIP: if you just want to test this out, use `-n alembic_sqlite` to
|
||||
# make a local sqlite db
|
||||
# $ alembic -n alembic_sqlite upgrade head
|
||||
alembic upgrade head
|
||||
|
||||
# Plug this bad boy into your server infrastructure.
|
||||
# We use nginx and gunicorn, you may use something else if you are smarter
|
||||
# than we are.
|
||||
# For the most basic setup that you can try right now, just kick off
|
||||
# gunicorn:
|
||||
gunicorn -b 0.0.0.0:8000 refstack.web:app
|
||||
|
||||
# To actually configure this winner, check out the config section and
|
||||
# crack open refstack.cfg in vim.
|
||||
# `vim refstack.cfg`
|
||||
|
||||
# Now browse to http://localhost:8000
|
||||
22
doc/tcup.md
Normal file
22
doc/tcup.md
Normal file
@ -0,0 +1,22 @@
|
||||
TCUP Configuration
|
||||
===========================
|
||||
|
||||
# Install Docker using [[https://www.docker.io/gettingstarted/#h_installation]]
|
||||
|
||||
# Get the code
|
||||
git clone http://github.com/stackforge/refstack
|
||||
|
||||
# enter RefStack
|
||||
cd refstack
|
||||
|
||||
# create/copy your OpenStack credentials into openrc.sh an file
|
||||
|
||||
# Create the TCUP container
|
||||
docker build t-container
|
||||
|
||||
# Run the container
|
||||
docker run -v `pwd`:/tcup:rw -i -t 32fe2d733d51 /bin/bash
|
||||
|
||||
# Inside the container run the following
|
||||
source tcup/openrc.sh
|
||||
tcup/run_in_tcup.py
|
||||
Loading…
Reference in New Issue
Block a user