From 090d5f9a2ab97c759ee24e436f56d4e3389f3cf2 Mon Sep 17 00:00:00 2001 From: cdiep Date: Mon, 31 Aug 2015 15:39:26 -0700 Subject: [PATCH] Rename "Refstack" to "RefStack" The RefStack team has decided to use "RefStack" as the name of our project. Change-Id: I0526e25e2c65c0b4ec7ff1eac7fb7b6165cc5961 --- README.rst | 14 +++++------ doc/refstack.md | 26 ++++++++++----------- refstack-ui/app/components/about/about.html | 10 ++++---- refstack-ui/app/components/home/home.html | 4 ++-- refstack-ui/app/shared/header/header.html | 4 ++-- run-in-docker | 12 +++++----- 6 files changed, 35 insertions(+), 35 deletions(-) diff --git a/README.rst b/README.rst index 3f5d6619..410342ec 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ -refstack +RefStack ======== -**What is refstack?** +**What is RefStack?** - Toolset for testing interoperability between OpenStack clouds. - Database backed website supporting collection and publication of @@ -11,15 +11,15 @@ refstack **Overview** -refstack intends on being THE source of tools for interoperability testing +RefStack intends on being THE source of tools for interoperability testing of OpenStack clouds. -refstack provides users in the OpenStack community with a Tempest wrapper, +RefStack provides users in the OpenStack community with a Tempest wrapper, refstack-client, that helps to verify interoperability of their cloud with other OpenStack clouds. It does so by validating any cloud implementation against the OpenStack Tempest API tests. -**refstack and DefCore** - The prototypical use case for refstack provides +**RefStack and DefCore** - The prototypical use case for RefStack provides the DefCore Committee the tools for vendors and other users to run API tests against their clouds to provide the DefCore committee with a reliable overview of what APIs and capabilities are being used in the marketplace. @@ -29,11 +29,11 @@ be used to validate clouds against existing DefCore capability lists, giving you assurance that your cloud faithfully implements OpenStack standards. -**Value Add for Vendors** - Vendors can use refstack to demonstrate that +**Value Add for Vendors** - Vendors can use RefStack to demonstrate that their distros, and/or their customers' installed clouds remain with OpenStack after their software has been incorporated into the distro or cloud. -**refstack consists of two parts:** +**RefStack consists of two parts:** * **refstack-api** Our API isn't just for us to collect data from private and public cloud diff --git a/doc/refstack.md b/doc/refstack.md index 5767f0ae..3f4137eb 100755 --- a/doc/refstack.md +++ b/doc/refstack.md @@ -1,4 +1,4 @@ -Refstack Quickstart +RefStack Quickstart =================== You can use docker for [one-click setup](run_in_docker.md) @@ -14,13 +14,13 @@ or follow step-by-step instructions below. - `sudo easy_install -U virtualenv` -####Install Refstack UI dependencies +####Install RefStack UI dependencies - `curl -sL https://deb.nodesource.com/setup | sudo bash -` - `sudo apt-get install nodejs` -####Setup the Refstack database +####Setup the RefStack database - Log into MySQL: `mysql -u root -p` @@ -57,11 +57,11 @@ or follow step-by-step instructions below. - Source to virtual environment: `source .venv/bin/activate` -####Install Refstack application (on ubuntu 14.x).. +####Install RefStack application (on ubuntu 14.x).. - `pip install .` -####Install needed Refstack UI library dependencies +####Install needed RefStack UI library dependencies - `npm install` @@ -85,7 +85,7 @@ or follow step-by-step instructions below. This should be the URL that the UI can be accessed from. This will likely be in the form `http://:8000` (8000 being the default port - Refstack is hosted on). For example: `http://192.168.56.101:8000` + RefStack is hosted on). For example: `http://192.168.56.101:8000` - `api_url` field in the `[api]` section. @@ -94,7 +94,7 @@ or follow step-by-step instructions below. - `app_dev_mode` field in the `[api]` section. - Set this field to true if you aren't creating a production-level Refstack + Set this field to true if you aren't creating a production-level RefStack deployment and are just trying things out or developing. Setting this field to true will allow you to quickly bring up both the API and UI together, with the UI files being served by a simple file server that comes with @@ -102,7 +102,7 @@ or follow step-by-step instructions below. ####Create UI config file -From the Refstack project root directory, create a config.json file +From the RefStack project root directory, create a config.json file and specify your API endpoint inside this file. This will be something like {"refstackApiUrl": "http://192.168.56.101:8000/v1"}: @@ -120,10 +120,10 @@ with an OpenStack OpenID endpoint. There are two options: Since openstackid checks for valid top-level domains, in both options you will likely have to edit the hosts file of the system where your web-browser for -viewing the Refstack site resides. On Linux systems, you would modify +viewing the RefStack site resides. On Linux systems, you would modify `/etc/hosts`, adding a line like the following: - ` ` + ` ` Example: @@ -141,7 +141,7 @@ of the IP. Using the official site is probably the easiest option as no additional configuration is needed besides the hosts file modifications as noted above. -Refstack, by default, points to this endpoint. +RefStack, by default, points to this endpoint. **Option 2 - Use Local Endpoint** @@ -174,7 +174,7 @@ You would then need to modify the `openstack_openid_endpoint` field in the Now it should be `2f178b0bf762`. -####Start Refstack +####Start RefStack A simple way to start refstack is to just kick off gunicorn using the `refstack-api` executable: @@ -188,7 +188,7 @@ Now available: - `http://:8000/v1/results` with response JSON including records consisting 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 + run records. The number of records per page is configurable via the RefStack configuration file. Filtering parameters such as page, start_date, and end_date can also be used to specify the desired records. For example: GET `http://:8000/v1/results?page=n` will return page *n* diff --git a/refstack-ui/app/components/about/about.html b/refstack-ui/app/components/about/about.html index 56790367..f53fa69b 100644 --- a/refstack-ui/app/components/about/about.html +++ b/refstack-ui/app/components/about/about.html @@ -1,14 +1,14 @@

Overview

-

Refstack intends on being THE source of tools for interoperability testing +

RefStack intends on being THE source of tools for interoperability testing of OpenStack clouds.

-

Refstack provides users in the OpenStack community with a Tempest wrapper, +

RefStack provides users in the OpenStack community with a Tempest wrapper, refstack-client, that helps to verify interoperability of their cloud with other OpenStack clouds. It does so by validating any cloud implementation against the OpenStack Tempest API tests.

- Refstack and DefCore - The prototypical use case for Refstack provides + RefStack and DefCore - The prototypical use case for RefStack provides the DefCore Committee the tools for vendors and other users to run API tests against their clouds to provide the DefCore committee with a reliable overview of what APIs and capabilities are being used in the marketplace. @@ -19,12 +19,12 @@ standards.

- Value Add for Vendors - Vendors can use Refstack to demonstrate that + Value Add for Vendors - Vendors can use RefStack to demonstrate that their distros, and/or their customers' installed clouds remain with OpenStack after their software has been incorporated into the distro or cloud.

- Refstack consists of two parts: + RefStack consists of two parts:

  • diff --git a/refstack-ui/app/components/home/home.html b/refstack-ui/app/components/home/home.html index bbd48200..2820576a 100644 --- a/refstack-ui/app/components/home/home.html +++ b/refstack-ui/app/components/home/home.html @@ -4,14 +4,14 @@

    OpenStack Interoperability

    -

    Refstack is a source of tools for OpenStack interoperability testing.

    +

    RefStack is a source of tools for OpenStack interoperability testing.

    -

    What is Refstack?

    +

    What is RefStack?

    • Toolset for testing interoperability between OpenStack clouds.
    • Database backed website supporting collection and publication of diff --git a/refstack-ui/app/shared/header/header.html b/refstack-ui/app/shared/header/header.html index 94c822ba..9320d262 100644 --- a/refstack-ui/app/shared/header/header.html +++ b/refstack-ui/app/shared/header/header.html @@ -1,5 +1,5 @@ -
      Refstack -Refstack +
      RefStack +RefStack