Merge "Add document describing the newly added vendor and product features"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
d6b5f7f2ab
@ -12,12 +12,14 @@ Overview
|
|||||||
--------
|
--------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 3
|
||||||
|
|
||||||
README
|
README
|
||||||
refstack
|
refstack
|
||||||
run_in_docker
|
run_in_docker
|
||||||
uploading_private_results
|
uploading_private_results
|
||||||
|
vendor_product
|
||||||
|
test_result_management
|
||||||
|
|
||||||
-----
|
-----
|
||||||
Specs
|
Specs
|
||||||
|
|||||||
17
doc/source/test_result_management.rst
Executable file
17
doc/source/test_result_management.rst
Executable file
@ -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.
|
||||||
91
doc/source/vendor_product.rst
Executable file
91
doc/source/vendor_product.rst
Executable file
@ -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.
|
||||||
@ -1,85 +1,31 @@
|
|||||||
<p>
|
<h1>RefStack Documentation</h1>
|
||||||
<strong>Overview</strong>
|
|
||||||
</p>
|
<p>RefStack is a source of tools for interoperability testing of OpenStack clouds.</p>
|
||||||
<p>RefStack intends on being THE source of tools for interoperability testing
|
<p>To learn more about RefStack, visit the links below.</p>
|
||||||
of OpenStack clouds.</p>
|
|
||||||
<p>RefStack provides users in the OpenStack community with a Tempest wrapper,
|
<ol>
|
||||||
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.</p>
|
|
||||||
<p>
|
|
||||||
<strong>RefStack and DefCore</strong> - 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.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
<strong>Value Add for Vendors</strong> - 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.
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
<strong>RefStack consists of two parts:</strong>
|
|
||||||
</p>
|
|
||||||
<ul>
|
|
||||||
<li>
|
<li>
|
||||||
<dl>
|
<a href="http://github.com/openstack/refstack/blob/master/README.rst#refstack"
|
||||||
<dt>
|
target="_blank"
|
||||||
<strong>refstack-api</strong>
|
</a>
|
||||||
</dt>
|
<strong>About RefStack</strong>
|
||||||
<dd>
|
|
||||||
<p>Our API isn't just for us to collect data from private and public cloud
|
|
||||||
vendors. It can be used by vendors in house to compare interoperability
|
|
||||||
data over time.</p>
|
|
||||||
<ul>
|
|
||||||
<li>install docs:
|
|
||||||
<a href="https://github.com/openstack/refstack/blob/master/doc/source/refstack.rst">doc/refstack.rst</a>
|
|
||||||
</li>
|
|
||||||
<li>repository:
|
|
||||||
<a href="http://git.openstack.org/cgit/openstack/refstack">http://git.openstack.org/cgit/openstack/refstack</a>
|
|
||||||
</li>
|
|
||||||
<li>reviews:
|
|
||||||
<a href="https://review.openStack.org/#q,status:open+refstack,n,z">https://review.OpenStack.org/#q,status:open+refstack,n,z</a>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<dl>
|
<a href="http://github.com/openstack/refstack/blob/master/doc/source/uploading_private_results.rst#how-to-upload-test-results-to-refstack"
|
||||||
<dt>
|
target="_blank"
|
||||||
<strong>refstack-client</strong>
|
</a>
|
||||||
</dt>
|
<strong>How to upload test results to RefStack</strong>
|
||||||
<dd>
|
|
||||||
<p>refstack-client contains the tools you will need to run the DefCore tests.</p>
|
|
||||||
<ul>
|
|
||||||
<li>repository:
|
|
||||||
<a href="http://git.openstack.org/cgit/openstack/refstack-client">http://git.openstack.org/cgit/openstack/refstack-client</a>
|
|
||||||
</li>
|
</li>
|
||||||
<li>reviews:
|
<li>
|
||||||
<a href="https://review.openstack.org/#q,status:open+refstack-client,n,z">https://review.openstack.org/#q,status:open+refstack-client,n,z</a>
|
<a href="http://github.com/openstack/refstack/blob/master/doc/source/vendor_product.rst#vendor-and-product-management"
|
||||||
|
target="_blank"
|
||||||
|
</a>
|
||||||
|
<strong>Vendor and product management</strong>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
<li>
|
||||||
</dd>
|
<a href="http://github.com/openstack/refstack/blob/master/doc/source/test_result_management.rst#test-result-management"
|
||||||
</dl>
|
target="_blank"
|
||||||
|
</a>
|
||||||
|
<strong>Test result management</strong>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ol>
|
||||||
<p>
|
|
||||||
<strong>Get involved!</strong>
|
|
||||||
</p>
|
|
||||||
<ul>
|
|
||||||
<li>Mailing List: openstack-dev@lists.openstack.org </li>
|
|
||||||
<li>IRC: #refstack on Freenode</li>
|
|
||||||
<li>Dev Meetings: Mondays @ 19:00 UTC in #openstack-meeting-alt on Freenode</li>
|
|
||||||
<li>Web-site:
|
|
||||||
<a href="https://refstack.openstack.org">https://refstack.openstack.org</a>
|
|
||||||
</li>
|
|
||||||
<li>Wiki:
|
|
||||||
<a href="https://wiki.OpenStack.org/wiki/RefStack">https://wiki.OpenStack.org/wiki/RefStack</a>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user