diff --git a/README.rst b/README.rst index 54d4b78c..22a84200 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,7 @@ refstack **What is refstack?** - Toolset for testing interoperability between OpenStack clouds. -- Database backed website supporting collection and publication of +- Database backed website supporting collection and publication of Community Test results for OpenStack. - User interface to display individual test run results. @@ -40,7 +40,8 @@ after their software has been incorporated into the distro or cloud. vendors. It can be used by vendors in house to compare interoperability data over time. - * install docs: `doc/refstack.md `_ + * API server install docs: `doc/refstack.md `_ + * UI server install docs: `refstack-ui/README.rst `_ * repository: http://git.openstack.org/cgit/stackforge/refstack * storyboard: https://storyboard.openstack.org/#!/project/700 * reviews: https://review.OpenStack.org/#q,status:open+refstack,n,z diff --git a/doc/refstack.md b/doc/refstack.md index eb650a14..15eb38d0 100755 --- a/doc/refstack.md +++ b/doc/refstack.md @@ -58,10 +58,26 @@ Refstack Quickstart information of your environment. Example of config file with default values available in etc directory. -- At the minimum the value of the `connection` field in the `[database]` - section should be updated. For example, if the backend database is MySQL - then update: `#connection = ` to - `connection = mysql+pymysql://refstack:@x.x.x.x/refstack` +- At the minimum, the following values should be updated: + + - `connection` field in the `[database]`section. + + For example, if the backend database is MySQL then update: + `#connection = ` to + `connection = mysql+pymysql://refstack:@x.x.x.x/refstack` + + - `allowed_cors_origins`. + + Update to your UI server address. For example: + `allowed_cors_origins = http://192.168.56.104:8080` + + Note that in this example and the one below the UI and API server are + served on the same server but on different ports. + + - `test_results_url` + + Updated to your API server address. For example: + `test_results_url = http://192.168.56.104:8000/output.html?test_id=%s` ####Database sync @@ -91,7 +107,7 @@ gunicorn: Now available: -- http://localhost:8000/ with JSON response {'Root': 'OK'}; -- http://localhost:8000/v1/results with response JSON including records consisted of , and of the test runs. The default response is limited to one page of the most recent uploaded test run records. The number of records per page is configurable via the Refstack configuration file. Filtering parameters such as page, start_date, end_date ... can also be used to specify the desired records. For example: get http://localhost:8000/v1/results?page=n will return page n of the data. +- `http://localhost:8000/` with JSON response {'Root': 'OK'}; +- `http://localhost:8000/v1/results` with response JSON including records consisted of ``, `` and `` of the test runs. The default response is limited to one page of the most recent uploaded test run records. The number of records per page is configurable via the Refstack configuration file. Filtering parameters such as page, start_date, end_date ... can also be used to specify the desired records. For example: get `http://localhost:8000/v1/results?page=n` will return page n of the data. -- http://localhost:8000/v1/results/ with response JSON including the detail test results of the specified +- `http://localhost:8000/v1/results/` with response JSON including the detail test results of the specified ``