diff --git a/README.rst b/README.rst index e61e6b53..8dcf2b3b 100755 --- a/README.rst +++ b/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 `_: Portable, Containerized Tempest for Community running and reporting results to RefStack +* `RefStack `_: 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 `_ +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 `_ diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..edfc5893 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,5 @@ +RefStack Documentation +============================= + +Welcome to RefStack. This project helps OpenStack collect and distribute test and validation information. + diff --git a/doc/refstack.md b/doc/refstack.md new file mode 100644 index 00000000..656b25d8 --- /dev/null +++ b/doc/refstack.md @@ -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 diff --git a/doc/tcup.md b/doc/tcup.md new file mode 100644 index 00000000..f56c7710 --- /dev/null +++ b/doc/tcup.md @@ -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