interop/DesignatedSections.rst
Mark T. Voelker f597dd12c0 Move Governance/DesignatedSections into gerrit
At the April 8, 2015 DefCore Scale.11 meeting, the DefCore committee
decided to migrate some existing wiki artifacts into
gerrit.  This patch represents one such migration.  This patch
reproduces content previously housed at the following URL in RST
so that it can be placed more easily in source control:

https://wiki.openstack.org/wiki/Governance/DesignatedSections

One trivial formatting change has been made to best accommodate the new
RST format: the page title has been changed from the old wiki-enforced heading
"Governance/DesignatedSections" to the more plain-English equivalent
"Designated Sections".  I've also removed the sentence "The DefCore
Committee maintains this page" from the top since ownership is now
implied in gerrit.  Aside from these changes, the text of the document
is completely unaltered from it's state in the wiki on the day this patch
was submitted.

Change-Id: Iee78f8eeec3db6525edb821f5cb34c67a072269f
2015-04-10 11:14:30 -04:00

86 lines
2.3 KiB
ReStructuredText
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

===================
Designated Sections
===================
.. contents::
Designated Sections Illustration
================================
.. image:: images/Defcore_designated_sections.png
Designated Sections Selection Guidance
======================================
::
_Approved 2014 Dec 2_
There DefCore committee identified 10 selection criteria. The first seven are technical from the TC and last three allow the Board to resolve issues without needed a technical judgement.
1. Designated if the code provides the project external REST API
2. Designated if the code is shared and provides common functionality for
all options
3. Designated if the code implements logic that is critical for
cross­platform operation
4. NOT Designated if project design explicitly intended this section to be
replaceable
5. NOT Designated if code extends the project external REST API in a new or
different way
6. NOT Designated if code is being deprecated
7. NOT Designated if code interfaces to vendor­specific functions
8. NOT Designated by Default
1. Unless code is designated, it is assumed to be undesignated.
2. This aligns with the Apache license.
3. We have a preference for smaller core.
9. Designated by Consensus
1. If the community cannot reach a consensus about designation then it
is considered undesignated.
2. Time to reach consensus will be short: days, not months
3. Except obvious trolling, this prevents endless wrangling.
4. If theres a difference of opinion then the safe choice is
UNdesignated.
10. Designated is Guidance
1. Loose descriptions of designated sections are acceptable.
2. The goal is guidance on where we want upstream contributions not a
code inspection police state. Guidance will be revised per release
as part of the DefCore process.
Designated Sections
===================
Havana
------
The Board approve the following Sections on 2014 Dec 2:
* Havana Nova is by default designated except scheduler, filter, drivers,
API extensions and networking.
* Havana Cinder designated sections are the API implementation code
* Havana Glance designated sections are the API implementation code and
domain model.
* Havana Swift designated sections are proxy server, object server,
container server, account server and select middleware (complete list
provided by PTL).