diff --git a/doc/source/index.rst b/doc/source/index.rst index 01243b73..e2ab11b0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,12 +12,14 @@ Overview -------- .. toctree:: - :maxdepth: 2 + :maxdepth: 3 README refstack run_in_docker uploading_private_results + vendor_product + test_result_management ----- Specs diff --git a/doc/source/test_result_management.rst b/doc/source/test_result_management.rst new file mode 100755 index 00000000..d11b0a7a --- /dev/null +++ b/doc/source/test_result_management.rst @@ -0,0 +1,17 @@ +Test result management +====================== + +Test result to product version association +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Test results uploaded by users can be associated to a version of a product. To +perform this association, the user must be both the one who uploaded the result +and also an admin of the vendor which owns the product. Once a test result is +associated to a product, all admins of the vendor which owns the product can +manage the test result. + +Mark or unmark a test results as verified +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Only Foundation admins can mark and un-mark a test as verified. A verified +test result can not be updated or deleted. diff --git a/doc/source/vendor_product.rst b/doc/source/vendor_product.rst new file mode 100755 index 00000000..a3541c4e --- /dev/null +++ b/doc/source/vendor_product.rst @@ -0,0 +1,91 @@ +Vendor and product management +============================= + +RefStack has implemented a vendor and product registration process so that test +results can be associated to products of vendors. The creation and management +of vendor and product entities can be done using the RefStack Server UI or +RefStack APIs. The following is a quick guide outlining the information related +to the creation and management of those entities. + +Vendor entity +^^^^^^^^^^^^^ + +Any user who has successfully authenticated to the RefStack server can create +vendor entities. The minimum required information to create a vendor is the +vendor name. Users can update the rest of the vendor related information at a +later time. + +Vendor admin +~~~~~~~~~~~~~ + +Whenever a user creates a vendor, this user will be added as the vendor's first +vendor admin. Subsequently, any admin of the vendor can add additional users to +the vendor. In RefStack, the "OpenStack User ID" of users are used as the +identities for adding users to vendors. At the time this document is written, +RefStack has not implemented user roles, and as such, all users of a vendor are +admin users. + +Vendor types +~~~~~~~~~~~~~ + +There are four types of vendor entities in RefStack: + +- Foundation: + + This is a special entity representing the OpenStack Foundation. Users belong + to this entity are the Foundation admins. Foundation admins have visibility + to all vendors and products. + +- Private: + + A vendor will always be created with type "private". Vendors of this type + are only visible to their own users and Foundation admins. Vendor users can + initiate a registration request to the Foundation to change its type from + "private" to "official". + +- Pending + + Once a registration request is submitted, the vendor type will be changed + automatically from type "private" to "pending". Vendors of this type are + still only visible to their own users and Foundation admins. + +- Official + + Once a vendor registration request is approved by the Foundation. The vendor + type will be changed from "pending" to "official". Official vendors are + visible to all RefStack users. + +Product entity +^^^^^^^^^^^^^^ + +Any user who has successfully authenticated to the RefStack server can create +product entities. The minimum information needed to create a product entity is +as follows: + +- Name + + This is the name of the product entity being created. + +- Product type: + + Product types are defined by OpenStack as shown on the OpenStack Marketplace + ( https://www.openstack.org/marketplace/ ). Currently, there are three types + of products, namely: Distro & Appliances, Hosted Private Clouds and Public + Clouds. + +- Vendor + + This is the vendor which owns the product. A default vendor will be created + for the user if no vendor entity exists for this user. + +Whenever a product is created, by default, it is a private product and is only +visible to its vendor users. Vendor users can make a product publicly visible +as needed later. However, only products that are owned by official vendors can +be made publicly visible. + +Product version +~~~~~~~~~~~~~~~ + +A default version is created whenever a product is created. The name of the +default version is blank. The default version is used for products that have +no version. Users can add new product versions to the product as needed. diff --git a/refstack-ui/app/components/about/about.html b/refstack-ui/app/components/about/about.html index ece79b34..d6ab9912 100644 --- a/refstack-ui/app/components/about/about.html +++ b/refstack-ui/app/components/about/about.html @@ -1,85 +1,31 @@ -

- Overview -

-

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-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 - 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. - This will help to guide the DefCore-defined capabilities and help ensure - interoperability across the entire OpenStack ecosystem. It can also - 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 - 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: -

- -

- Get involved! -

- +