* Creating doc/source directory * First pass at index.rst * Moving process directory into doc/source * Moving schema directory into doc/source * Added tox job for doc building * Updated tox.ini doc8 job to scan doc/source only Change-Id: Iec39fa40c3d0e0ee317e625e39f789114da40fea
3.8 KiB
OpenStack DefCore Lexicon
Licensing the OpenStack commercial-use marks requires passing tests of DefCore required capabilities, and including designated sections of code. There are multiple marks available for vendors depending on which capability groupings are passed.
TERMS:
- Advisory
-
Capabilities that have been suggested for the next guideline.
- Capability
-
The functionality ensured by a set of tests collected into a group as defined by the DefCore committee Required - capabilities that are required to meet the guideline.
- Certify or Accredit
-
DefCore does not do any of these things for OpenStack clouds. These actions would fall under the governance of the Foundation trademark policy.
- Community
-
The universe of people and companies that are involved in the OpenStack project as active contributors, users, operators, vendors and enthusiasts. This is a very broad group with diverse interests, needs and participation levels. (see also Participant)
- Component
-
A collection of functionality generally used together (e.g.: object, compute).
- Contributor
-
Word to be avoided in this process due to confusion with other uses.
- Core
-
Word to be avoided in this process due to confusion with other uses.
- DefCore
-
The OpenStack board committee that manages commercial definition of OpenStack for trademark purposes.
- DefCore Process
-
The process used by DefCore to score capabilities and select criteria.
- Deprecated
-
Capabilities that will be removed in the next guideline.
- Designated Sections
-
Portions of the OpenStack codebase that must be used to provide required capabilities in a product wishing to use the OpenStack trademark. Designated sections fulfill one or more of the following criteria: they provide the project-external REST API, or are shared and provide common functionality for all options, or implement logic that is critical for cross-platform operation. Designated sections must exist in the OpenStack gerrit namespace and have corresponding tests. Code that meets the following criteria will not be considered designated: provides vendor-specific functionality, are explicitly intended by the project maintainers to be replaceable, extend the project REST API in a new or different way, or code that is being deprecated.
- Flagged Test
-
A test that does not provide consistent results in the field and it not required for vendor self-test.
- Guidelines
-
Output of the DefCore process detailing which sections and capabilities are required. Guidelines will be approved on a regular cadence and identified by the date of approval.
- OpenStack Mark
-
Right granted by the OpenStack Foundation to use the name and logo of OpenStack in a vendor’s product.
- Participant
-
The subset of the Community that actively engages in creating components of OpenStack including, but not limited to, the code, documentation, training, product management and other materials. For DefCore purposes, Participant is not limited to the community members identified as "ATC" as per http://git.openstack.org/cgit/openstack/governance/tree/reference/charter.rst#n132 (see also Technical Leadership)
- Platform
-
The collection of components required to use the least restricted mark.
- Self-test
-
Process by which a vendor runs tests against their product or service without 3rd party observation.
- Technical Leadership
-
The subset of the Participants (see above) that are recognized by the community to guide the technical direction of the OpenStack project. These leaders include the Technical Committee (TC) and Project Technical Leads (PTL). See: http://git.openstack.org/cgit/openstack/governance/tree/reference/charter.rst
- Test
-
Program that exercises functionality of a component to validate expected behavior and provides pass or fail judgement.