Add mogan spec template and tests
Change-Id: I1622117971d07bf849639253a9cca71e2412ff31
This commit is contained in:
Zhenguo Niu
parent
8ffa6ab7e4
commit
e472174607
@ -35,8 +35,8 @@ extensions = ['sphinx.ext.autodoc',
|
|||||||
]
|
]
|
||||||
|
|
||||||
# Feed configuration for yasfb
|
# Feed configuration for yasfb
|
||||||
feed_base_url = 'http://specs.openstack.org/openstack/ironic-specs'
|
feed_base_url = 'http://specs.openstack.org/openstack/mogan-specs'
|
||||||
feed_author = 'OpenStack Ironic Team'
|
feed_author = 'OpenStack Mogan Team'
|
||||||
|
|
||||||
todo_include_todos = True
|
todo_include_todos = True
|
||||||
|
|
||||||
@ -53,8 +53,8 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'Ironic Specs'
|
project = u'Mogan Specs'
|
||||||
copyright = u'%s, OpenStack Ironic Team' % datetime.date.today().year
|
copyright = u'%s, OpenStack Mogan Team' % datetime.date.today().year
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
@ -91,7 +91,7 @@ show_authors = False
|
|||||||
pygments_style = 'sphinx'
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting.
|
# A list of ignored prefixes for module index sorting.
|
||||||
modindex_common_prefix = ['ironic-specs.']
|
modindex_common_prefix = ['mogan-specs.']
|
||||||
|
|
||||||
# -- Options for man page output ----------------------------------------------
|
# -- Options for man page output ----------------------------------------------
|
||||||
man_pages = []
|
man_pages = []
|
||||||
@ -169,7 +169,7 @@ html_use_index = False
|
|||||||
#html_file_suffix = None
|
#html_file_suffix = None
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'Ironic-Specsdoc'
|
htmlhelp_basename = 'Mogan-Specsdoc'
|
||||||
|
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------------
|
# -- Options for LaTeX output --------------------------------------------------
|
||||||
@ -188,8 +188,8 @@ latex_elements = {
|
|||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index', 'Ironic-specs.tex', u'Ironic Specs',
|
('index', 'Mogan-specs.tex', u'Mogan Specs',
|
||||||
u'OpenStack Ironic Team', 'manual'),
|
u'OpenStack Mogan Team', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
@ -218,8 +218,8 @@ latex_documents = [
|
|||||||
# (source start file, target name, title, author,
|
# (source start file, target name, title, author,
|
||||||
# dir menu entry, description, category)
|
# dir menu entry, description, category)
|
||||||
texinfo_documents = [
|
texinfo_documents = [
|
||||||
('index', 'Ironic-specs', u'Ironic Design Specs',
|
('index', 'Mogan-specs', u'Mogan Design Specs',
|
||||||
u'OpenStack Ironic Team', 'ironic-specs', 'Design specifications for the Ironic project.',
|
u'OpenStack Mogan Team', 'mogan-specs', 'Design specifications for the Mogan project.',
|
||||||
'Miscellaneous'),
|
'Miscellaneous'),
|
||||||
]
|
]
|
||||||
|
|
||||||
@ -236,10 +236,10 @@ texinfo_documents = [
|
|||||||
# -- Options for Epub output ---------------------------------------------------
|
# -- Options for Epub output ---------------------------------------------------
|
||||||
|
|
||||||
# Bibliographic Dublin Core info.
|
# Bibliographic Dublin Core info.
|
||||||
epub_title = u'Ironic Specs'
|
epub_title = u'Mogan Specs'
|
||||||
epub_author = u'OpenStack Ironic Team'
|
epub_author = u'OpenStack Mogan Team'
|
||||||
epub_publisher = u'OpenStack Ironic Team'
|
epub_publisher = u'OpenStack Mogan Team'
|
||||||
epub_copyright = u'2014, OpenStack Ironic Team'
|
epub_copyright = u'2017, OpenStack Mogan Team'
|
||||||
|
|
||||||
# The language of the text. It defaults to the language option
|
# The language of the text. It defaults to the language option
|
||||||
# or en if the language is not set.
|
# or en if the language is not set.
|
||||||
|
|||||||
384
specs/ocata/approved/template.rst
Normal file
384
specs/ocata/approved/template.rst
Normal file
@ -0,0 +1,384 @@
|
|||||||
|
..
|
||||||
|
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||||
|
License.
|
||||||
|
|
||||||
|
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||||
|
|
||||||
|
==========================================
|
||||||
|
Example Spec - The title of your blueprint
|
||||||
|
==========================================
|
||||||
|
|
||||||
|
Include the URL of your launchpad blueprint:
|
||||||
|
|
||||||
|
https://blueprints.launchpad.net/mogan/+spec/example
|
||||||
|
|
||||||
|
Introduction paragraph -- why are we doing anything? A single paragraph of
|
||||||
|
prose that operators can understand. The title and this first paragraph
|
||||||
|
should be used as the subject line and body of the commit message
|
||||||
|
respectively.
|
||||||
|
|
||||||
|
Some notes about the mogan-spec and blueprint process:
|
||||||
|
|
||||||
|
* Not all blueprints need a spec. For more information see
|
||||||
|
http://docs.openstack.org/developer/mogan/blueprints.html#specs
|
||||||
|
|
||||||
|
* The aim of this document is first to define the problem we need to solve,
|
||||||
|
and second agree the overall approach to solve that problem.
|
||||||
|
|
||||||
|
* This is not intended to be extensive documentation for a new feature.
|
||||||
|
For example, there is no need to specify the exact configuration changes,
|
||||||
|
nor the exact details of any DB model changes. But you should still define
|
||||||
|
that such changes are required, and be clear on how that will affect
|
||||||
|
upgrades.
|
||||||
|
|
||||||
|
* You should aim to get your spec approved before writing your code.
|
||||||
|
While you are free to write prototypes and code before getting your spec
|
||||||
|
approved, its possible that the outcome of the spec review process leads
|
||||||
|
you towards a fundamentally different solution than you first envisaged.
|
||||||
|
|
||||||
|
* But, API changes are held to a much higher level of scrutiny.
|
||||||
|
As soon as an API change merges, we must assume it could be in production
|
||||||
|
somewhere, and as such, we then need to support that API change forever.
|
||||||
|
To avoid getting that wrong, we do want lots of details about API changes
|
||||||
|
upfront.
|
||||||
|
|
||||||
|
Some notes about using this template:
|
||||||
|
|
||||||
|
* Your spec should be in ReSTructured text, like this template.
|
||||||
|
|
||||||
|
* Please wrap text at 79 columns.
|
||||||
|
|
||||||
|
* The filename in the git repository should match the launchpad URL, for
|
||||||
|
example a URL of: https://blueprints.launchpad.net/mogan/+spec/awesome-thing
|
||||||
|
should be named awesome-thing.rst
|
||||||
|
|
||||||
|
* Please do not delete any of the sections in this template. If you have
|
||||||
|
nothing to say for a whole section, just write: None
|
||||||
|
|
||||||
|
* For help with syntax, see http://sphinx-doc.org/rest.html
|
||||||
|
|
||||||
|
* To test out your formatting, build the docs using tox and see the generated
|
||||||
|
HTML file in doc/build/html/specs/<path_of_your_file>
|
||||||
|
|
||||||
|
* If you would like to provide a diagram with your spec, ascii diagrams are
|
||||||
|
required. http://asciiflow.com/ is a very nice tool to assist with making
|
||||||
|
ascii diagrams. The reason for this is that the tool used to review specs is
|
||||||
|
based purely on plain text. Plain text will allow review to proceed without
|
||||||
|
having to look at additional files which can not be viewed in gerrit. It
|
||||||
|
will also allow inline feedback on the diagram itself.
|
||||||
|
|
||||||
|
* If your specification proposes any changes to the Mogan REST API such
|
||||||
|
as changing parameters which can be returned or accepted, or even
|
||||||
|
the semantics of what happens when a client calls into the API, then
|
||||||
|
you should add the APIImpact flag to the commit message. Specifications with
|
||||||
|
the APIImpact flag can be found with the following query:
|
||||||
|
|
||||||
|
https://review.openstack.org/#/q/status:open+project:openstack/mogan-specs+message:apiimpact,n,z
|
||||||
|
|
||||||
|
|
||||||
|
Problem description
|
||||||
|
===================
|
||||||
|
|
||||||
|
A detailed description of the problem. What problem is this blueprint
|
||||||
|
addressing?
|
||||||
|
|
||||||
|
Use Cases
|
||||||
|
---------
|
||||||
|
|
||||||
|
What use cases does this address? What impact on actors does this change have?
|
||||||
|
Ensure you are clear about the actors in each use case: Developer, End User,
|
||||||
|
Deployer etc.
|
||||||
|
|
||||||
|
Proposed change
|
||||||
|
===============
|
||||||
|
|
||||||
|
Here is where you cover the change you propose to make in detail. How do you
|
||||||
|
propose to solve this problem?
|
||||||
|
|
||||||
|
If this is one part of a larger effort make it clear where this piece ends. In
|
||||||
|
other words, what's the scope of this effort?
|
||||||
|
|
||||||
|
At this point, if you would like to just get feedback on if the problem and
|
||||||
|
proposed change fit in mogan, you can stop here and post this for review to get
|
||||||
|
preliminary feedback. If so please say:
|
||||||
|
Posting to get preliminary feedback on the scope of this spec.
|
||||||
|
|
||||||
|
Alternatives
|
||||||
|
------------
|
||||||
|
|
||||||
|
What other ways could we do this thing? Why aren't we using those? This doesn't
|
||||||
|
have to be a full literature review, but it should demonstrate that thought has
|
||||||
|
been put into why the proposed solution is an appropriate one.
|
||||||
|
|
||||||
|
Data model impact
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Changes which require modifications to the data model often have a wider impact
|
||||||
|
on the system. The community often has strong opinions on how the data model
|
||||||
|
should be evolved, from both a functional and performance perspective. It is
|
||||||
|
therefore important to capture and gain agreement as early as possible on any
|
||||||
|
proposed changes to the data model.
|
||||||
|
|
||||||
|
Questions which need to be addressed by this section include:
|
||||||
|
|
||||||
|
* What new data objects and/or database schema changes is this going to
|
||||||
|
require?
|
||||||
|
|
||||||
|
* What database migrations will accompany this change.
|
||||||
|
|
||||||
|
* How will the initial set of new data objects be generated, for example if you
|
||||||
|
need to take into account existing instances, or modify other existing data
|
||||||
|
describe how that will work.
|
||||||
|
|
||||||
|
REST API impact
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Each API method which is either added or changed should have the following
|
||||||
|
|
||||||
|
* Specification for the method
|
||||||
|
|
||||||
|
* A description of what the method does suitable for use in
|
||||||
|
user documentation
|
||||||
|
|
||||||
|
* Method type (POST/PUT/GET/DELETE)
|
||||||
|
|
||||||
|
* Normal http response code(s)
|
||||||
|
|
||||||
|
* Expected error http response code(s)
|
||||||
|
|
||||||
|
* A description for each possible error code should be included
|
||||||
|
describing semantic errors which can cause it such as
|
||||||
|
inconsistent parameters supplied to the method, or when an
|
||||||
|
instance is not in an appropriate state for the request to
|
||||||
|
succeed. Errors caused by syntactic problems covered by the JSON
|
||||||
|
schema definition do not need to be included.
|
||||||
|
|
||||||
|
* URL for the resource
|
||||||
|
|
||||||
|
* URL should not include underscores, and use hyphens instead.
|
||||||
|
|
||||||
|
* Parameters which can be passed via the url
|
||||||
|
|
||||||
|
* JSON schema definition for the request body data if allowed
|
||||||
|
|
||||||
|
* Field names should use snake_case style, not CamelCase or MixedCase
|
||||||
|
style.
|
||||||
|
|
||||||
|
* JSON schema definition for the response body data if any
|
||||||
|
|
||||||
|
* Field names should use snake_case style, not CamelCase or MixedCase
|
||||||
|
style.
|
||||||
|
|
||||||
|
* Example use case including typical API samples for both data supplied
|
||||||
|
by the caller and the response
|
||||||
|
|
||||||
|
* Discuss any policy changes, and discuss what things a deployer needs to
|
||||||
|
think about when defining their policy.
|
||||||
|
|
||||||
|
Note that the schema should be defined as restrictively as
|
||||||
|
possible. Parameters which are required should be marked as such and
|
||||||
|
only under exceptional circumstances should additional parameters
|
||||||
|
which are not defined in the schema be permitted (eg
|
||||||
|
additionaProperties should be False).
|
||||||
|
|
||||||
|
Reuse of existing predefined parameter types such as regexps for
|
||||||
|
passwords and user defined names is highly encouraged.
|
||||||
|
|
||||||
|
Security impact
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Describe any potential security impact on the system. Some of the items to
|
||||||
|
consider include:
|
||||||
|
|
||||||
|
* Does this change touch sensitive data such as tokens, keys, or user data?
|
||||||
|
|
||||||
|
* Does this change alter the API in a way that may impact security, such as
|
||||||
|
a new way to access sensitive information or a new way to login?
|
||||||
|
|
||||||
|
* Does this change involve cryptography or hashing?
|
||||||
|
|
||||||
|
* Does this change require the use of sudo or any elevated privileges?
|
||||||
|
|
||||||
|
* Does this change involve using or parsing user-provided data? This could
|
||||||
|
be directly at the API level or indirectly such as changes to a cache layer.
|
||||||
|
|
||||||
|
* Can this change enable a resource exhaustion attack, such as allowing a
|
||||||
|
single API interaction to consume significant server resources? Some examples
|
||||||
|
of this include launching subprocesses for each connection, or entity
|
||||||
|
expansion attacks in XML.
|
||||||
|
|
||||||
|
For more detailed guidance, please see the OpenStack Security Guidelines as
|
||||||
|
a reference (https://wiki.openstack.org/wiki/Security/Guidelines). These
|
||||||
|
guidelines are a work in progress and are designed to help you identify
|
||||||
|
security best practices. For further information, feel free to reach out
|
||||||
|
to the OpenStack Security Group at openstack-security@lists.openstack.org.
|
||||||
|
|
||||||
|
Notifications impact
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Please specify any changes to notifications. Be that an extra notification,
|
||||||
|
changes to an existing notification, or removing a notification.
|
||||||
|
|
||||||
|
Other end user impact
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Aside from the API, are there other ways a user will interact with this
|
||||||
|
feature?
|
||||||
|
|
||||||
|
* Does this change have an impact on python-moganclient? What does the user
|
||||||
|
interface there look like?
|
||||||
|
|
||||||
|
Performance Impact
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Describe any potential performance impact on the system, for example
|
||||||
|
how often will new code be called, and is there a major change to the calling
|
||||||
|
pattern of existing code.
|
||||||
|
|
||||||
|
Examples of things to consider here include:
|
||||||
|
|
||||||
|
* A periodic task might look like a small addition but if it calls conductor or
|
||||||
|
another service the load is multiplied by the number of nodes in the system.
|
||||||
|
|
||||||
|
* Scheduler filters get called once per host for every instance being created,
|
||||||
|
so any latency they introduce is linear with the size of the system.
|
||||||
|
|
||||||
|
* A small change in a utility function or a commonly used decorator can have a
|
||||||
|
large impacts on performance.
|
||||||
|
|
||||||
|
* Calls which result in a database queries (whether direct or via conductor)
|
||||||
|
can have a profound impact on performance when called in critical sections of
|
||||||
|
the code.
|
||||||
|
|
||||||
|
* Will the change include any locking, and if so what considerations are there
|
||||||
|
on holding the lock?
|
||||||
|
|
||||||
|
Other deployer impact
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Discuss things that will affect how you deploy and configure OpenStack
|
||||||
|
that have not already been mentioned, such as:
|
||||||
|
|
||||||
|
* What config options are being added? Should they be more generic than
|
||||||
|
proposed (for example a flag that other hypervisor drivers might want to
|
||||||
|
implement as well)? Are the default values ones which will work well in
|
||||||
|
real deployments?
|
||||||
|
|
||||||
|
* Is this a change that takes immediate effect after its merged, or is it
|
||||||
|
something that has to be explicitly enabled?
|
||||||
|
|
||||||
|
* If this change is a new binary, how would it be deployed?
|
||||||
|
|
||||||
|
* Please state anything that those doing continuous deployment, or those
|
||||||
|
upgrading from the previous release, need to be aware of. Also describe
|
||||||
|
any plans to deprecate configuration values or features. For example, if we
|
||||||
|
change the directory name that instances are stored in, how do we handle
|
||||||
|
instance directories created before the change landed? Do we move them? Do
|
||||||
|
we have a special case in the code? Do we assume that the operator will
|
||||||
|
recreate all the instances in their cloud?
|
||||||
|
|
||||||
|
Developer impact
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Discuss things that will affect other developers working on OpenStack,
|
||||||
|
such as:
|
||||||
|
|
||||||
|
* If the blueprint proposes a change to the driver API, discussion of how
|
||||||
|
other hypervisors would implement the feature is required.
|
||||||
|
|
||||||
|
|
||||||
|
Implementation
|
||||||
|
==============
|
||||||
|
|
||||||
|
Assignee(s)
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Who is leading the writing of the code? Or is this a blueprint where you're
|
||||||
|
throwing it out there to see who picks it up?
|
||||||
|
|
||||||
|
If more than one person is working on the implementation, please designate the
|
||||||
|
primary author and contact.
|
||||||
|
|
||||||
|
Primary assignee:
|
||||||
|
<launchpad-id or None>
|
||||||
|
|
||||||
|
Other contributors:
|
||||||
|
<launchpad-id or None>
|
||||||
|
|
||||||
|
Work Items
|
||||||
|
----------
|
||||||
|
|
||||||
|
Work items or tasks -- break the feature up into the things that need to be
|
||||||
|
done to implement it. Those parts might end up being done by different people,
|
||||||
|
but we're mostly trying to understand the timeline for implementation.
|
||||||
|
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
============
|
||||||
|
|
||||||
|
* Include specific references to specs and/or blueprints in mogan, or in other
|
||||||
|
projects, that this one either depends on or is related to.
|
||||||
|
|
||||||
|
* If this requires functionality of another project that is not currently used
|
||||||
|
by Mogan, document that fact.
|
||||||
|
|
||||||
|
* Does this feature require any new library dependencies or code otherwise not
|
||||||
|
included in OpenStack? Or does it depend on a specific version of library?
|
||||||
|
|
||||||
|
|
||||||
|
Testing
|
||||||
|
=======
|
||||||
|
|
||||||
|
Please discuss the important scenarios needed to test here, as well as
|
||||||
|
specific edge cases we should be ensuring work correctly. For each
|
||||||
|
scenario please specify if this requires specialized hardware, a full
|
||||||
|
openstack environment, or can be simulated inside the Mogan tree.
|
||||||
|
|
||||||
|
Please discuss how the change will be tested. We especially want to know what
|
||||||
|
tempest tests will be added. It is assumed that unit test coverage will be
|
||||||
|
added so that doesn't need to be mentioned explicitly, but discussion of why
|
||||||
|
you think unit tests are sufficient and we don't need to add more tempest
|
||||||
|
tests would need to be included.
|
||||||
|
|
||||||
|
Is this untestable in gate given current limitations (specific hardware /
|
||||||
|
software configurations available)? If so, are there mitigation plans (3rd
|
||||||
|
party testing, gate enhancements, etc).
|
||||||
|
|
||||||
|
|
||||||
|
Documentation Impact
|
||||||
|
====================
|
||||||
|
|
||||||
|
Which audiences are affected most by this change, and which documentation
|
||||||
|
titles on docs.openstack.org should be updated because of this change? Don't
|
||||||
|
repeat details discussed above, but reference them here in the context of
|
||||||
|
documentation for multiple audiences. For example, the Operations Guide targets
|
||||||
|
cloud operators, and the End User Guide would need to be updated if the change
|
||||||
|
offers a new feature available through the CLI or dashboard. If a config option
|
||||||
|
changes or is deprecated, note here that the documentation needs to be updated
|
||||||
|
to reflect this specification's change.
|
||||||
|
|
||||||
|
References
|
||||||
|
==========
|
||||||
|
|
||||||
|
Please add any useful references here. You are not required to have any
|
||||||
|
reference. Moreover, this specification should still make sense when your
|
||||||
|
references are unavailable. Examples of what you could include are:
|
||||||
|
|
||||||
|
* Links to mailing list or IRC discussions
|
||||||
|
|
||||||
|
* Links to notes from a summit session
|
||||||
|
|
||||||
|
* Links to relevant research, if appropriate
|
||||||
|
|
||||||
|
* Related specifications as appropriate (e.g. if it's an EC2 thing, link the
|
||||||
|
EC2 docs)
|
||||||
|
|
||||||
|
* Anything else you feel it is worthwhile to refer to
|
||||||
|
|
||||||
|
.. list-table:: Revisions
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Release Name
|
||||||
|
- Description
|
||||||
|
* - Ocata
|
||||||
|
- Introduced
|
||||||
384
specs/template.rst
Normal file
384
specs/template.rst
Normal file
@ -0,0 +1,384 @@
|
|||||||
|
..
|
||||||
|
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||||
|
License.
|
||||||
|
|
||||||
|
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||||
|
|
||||||
|
==========================================
|
||||||
|
Example Spec - The title of your blueprint
|
||||||
|
==========================================
|
||||||
|
|
||||||
|
Include the URL of your launchpad blueprint:
|
||||||
|
|
||||||
|
https://blueprints.launchpad.net/mogan/+spec/example
|
||||||
|
|
||||||
|
Introduction paragraph -- why are we doing anything? A single paragraph of
|
||||||
|
prose that operators can understand. The title and this first paragraph
|
||||||
|
should be used as the subject line and body of the commit message
|
||||||
|
respectively.
|
||||||
|
|
||||||
|
Some notes about the mogan-spec and blueprint process:
|
||||||
|
|
||||||
|
* Not all blueprints need a spec. For more information see
|
||||||
|
http://docs.openstack.org/developer/mogan/blueprints.html#specs
|
||||||
|
|
||||||
|
* The aim of this document is first to define the problem we need to solve,
|
||||||
|
and second agree the overall approach to solve that problem.
|
||||||
|
|
||||||
|
* This is not intended to be extensive documentation for a new feature.
|
||||||
|
For example, there is no need to specify the exact configuration changes,
|
||||||
|
nor the exact details of any DB model changes. But you should still define
|
||||||
|
that such changes are required, and be clear on how that will affect
|
||||||
|
upgrades.
|
||||||
|
|
||||||
|
* You should aim to get your spec approved before writing your code.
|
||||||
|
While you are free to write prototypes and code before getting your spec
|
||||||
|
approved, its possible that the outcome of the spec review process leads
|
||||||
|
you towards a fundamentally different solution than you first envisaged.
|
||||||
|
|
||||||
|
* But, API changes are held to a much higher level of scrutiny.
|
||||||
|
As soon as an API change merges, we must assume it could be in production
|
||||||
|
somewhere, and as such, we then need to support that API change forever.
|
||||||
|
To avoid getting that wrong, we do want lots of details about API changes
|
||||||
|
upfront.
|
||||||
|
|
||||||
|
Some notes about using this template:
|
||||||
|
|
||||||
|
* Your spec should be in ReSTructured text, like this template.
|
||||||
|
|
||||||
|
* Please wrap text at 79 columns.
|
||||||
|
|
||||||
|
* The filename in the git repository should match the launchpad URL, for
|
||||||
|
example a URL of: https://blueprints.launchpad.net/mogan/+spec/awesome-thing
|
||||||
|
should be named awesome-thing.rst
|
||||||
|
|
||||||
|
* Please do not delete any of the sections in this template. If you have
|
||||||
|
nothing to say for a whole section, just write: None
|
||||||
|
|
||||||
|
* For help with syntax, see http://sphinx-doc.org/rest.html
|
||||||
|
|
||||||
|
* To test out your formatting, build the docs using tox and see the generated
|
||||||
|
HTML file in doc/build/html/specs/<path_of_your_file>
|
||||||
|
|
||||||
|
* If you would like to provide a diagram with your spec, ascii diagrams are
|
||||||
|
required. http://asciiflow.com/ is a very nice tool to assist with making
|
||||||
|
ascii diagrams. The reason for this is that the tool used to review specs is
|
||||||
|
based purely on plain text. Plain text will allow review to proceed without
|
||||||
|
having to look at additional files which can not be viewed in gerrit. It
|
||||||
|
will also allow inline feedback on the diagram itself.
|
||||||
|
|
||||||
|
* If your specification proposes any changes to the Mogan REST API such
|
||||||
|
as changing parameters which can be returned or accepted, or even
|
||||||
|
the semantics of what happens when a client calls into the API, then
|
||||||
|
you should add the APIImpact flag to the commit message. Specifications with
|
||||||
|
the APIImpact flag can be found with the following query:
|
||||||
|
|
||||||
|
https://review.openstack.org/#/q/status:open+project:openstack/mogan-specs+message:apiimpact,n,z
|
||||||
|
|
||||||
|
|
||||||
|
Problem description
|
||||||
|
===================
|
||||||
|
|
||||||
|
A detailed description of the problem. What problem is this blueprint
|
||||||
|
addressing?
|
||||||
|
|
||||||
|
Use Cases
|
||||||
|
---------
|
||||||
|
|
||||||
|
What use cases does this address? What impact on actors does this change have?
|
||||||
|
Ensure you are clear about the actors in each use case: Developer, End User,
|
||||||
|
Deployer etc.
|
||||||
|
|
||||||
|
Proposed change
|
||||||
|
===============
|
||||||
|
|
||||||
|
Here is where you cover the change you propose to make in detail. How do you
|
||||||
|
propose to solve this problem?
|
||||||
|
|
||||||
|
If this is one part of a larger effort make it clear where this piece ends. In
|
||||||
|
other words, what's the scope of this effort?
|
||||||
|
|
||||||
|
At this point, if you would like to just get feedback on if the problem and
|
||||||
|
proposed change fit in mogan, you can stop here and post this for review to get
|
||||||
|
preliminary feedback. If so please say:
|
||||||
|
Posting to get preliminary feedback on the scope of this spec.
|
||||||
|
|
||||||
|
Alternatives
|
||||||
|
------------
|
||||||
|
|
||||||
|
What other ways could we do this thing? Why aren't we using those? This doesn't
|
||||||
|
have to be a full literature review, but it should demonstrate that thought has
|
||||||
|
been put into why the proposed solution is an appropriate one.
|
||||||
|
|
||||||
|
Data model impact
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Changes which require modifications to the data model often have a wider impact
|
||||||
|
on the system. The community often has strong opinions on how the data model
|
||||||
|
should be evolved, from both a functional and performance perspective. It is
|
||||||
|
therefore important to capture and gain agreement as early as possible on any
|
||||||
|
proposed changes to the data model.
|
||||||
|
|
||||||
|
Questions which need to be addressed by this section include:
|
||||||
|
|
||||||
|
* What new data objects and/or database schema changes is this going to
|
||||||
|
require?
|
||||||
|
|
||||||
|
* What database migrations will accompany this change.
|
||||||
|
|
||||||
|
* How will the initial set of new data objects be generated, for example if you
|
||||||
|
need to take into account existing instances, or modify other existing data
|
||||||
|
describe how that will work.
|
||||||
|
|
||||||
|
REST API impact
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Each API method which is either added or changed should have the following
|
||||||
|
|
||||||
|
* Specification for the method
|
||||||
|
|
||||||
|
* A description of what the method does suitable for use in
|
||||||
|
user documentation
|
||||||
|
|
||||||
|
* Method type (POST/PUT/GET/DELETE)
|
||||||
|
|
||||||
|
* Normal http response code(s)
|
||||||
|
|
||||||
|
* Expected error http response code(s)
|
||||||
|
|
||||||
|
* A description for each possible error code should be included
|
||||||
|
describing semantic errors which can cause it such as
|
||||||
|
inconsistent parameters supplied to the method, or when an
|
||||||
|
instance is not in an appropriate state for the request to
|
||||||
|
succeed. Errors caused by syntactic problems covered by the JSON
|
||||||
|
schema definition do not need to be included.
|
||||||
|
|
||||||
|
* URL for the resource
|
||||||
|
|
||||||
|
* URL should not include underscores, and use hyphens instead.
|
||||||
|
|
||||||
|
* Parameters which can be passed via the url
|
||||||
|
|
||||||
|
* JSON schema definition for the request body data if allowed
|
||||||
|
|
||||||
|
* Field names should use snake_case style, not CamelCase or MixedCase
|
||||||
|
style.
|
||||||
|
|
||||||
|
* JSON schema definition for the response body data if any
|
||||||
|
|
||||||
|
* Field names should use snake_case style, not CamelCase or MixedCase
|
||||||
|
style.
|
||||||
|
|
||||||
|
* Example use case including typical API samples for both data supplied
|
||||||
|
by the caller and the response
|
||||||
|
|
||||||
|
* Discuss any policy changes, and discuss what things a deployer needs to
|
||||||
|
think about when defining their policy.
|
||||||
|
|
||||||
|
Note that the schema should be defined as restrictively as
|
||||||
|
possible. Parameters which are required should be marked as such and
|
||||||
|
only under exceptional circumstances should additional parameters
|
||||||
|
which are not defined in the schema be permitted (eg
|
||||||
|
additionaProperties should be False).
|
||||||
|
|
||||||
|
Reuse of existing predefined parameter types such as regexps for
|
||||||
|
passwords and user defined names is highly encouraged.
|
||||||
|
|
||||||
|
Security impact
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Describe any potential security impact on the system. Some of the items to
|
||||||
|
consider include:
|
||||||
|
|
||||||
|
* Does this change touch sensitive data such as tokens, keys, or user data?
|
||||||
|
|
||||||
|
* Does this change alter the API in a way that may impact security, such as
|
||||||
|
a new way to access sensitive information or a new way to login?
|
||||||
|
|
||||||
|
* Does this change involve cryptography or hashing?
|
||||||
|
|
||||||
|
* Does this change require the use of sudo or any elevated privileges?
|
||||||
|
|
||||||
|
* Does this change involve using or parsing user-provided data? This could
|
||||||
|
be directly at the API level or indirectly such as changes to a cache layer.
|
||||||
|
|
||||||
|
* Can this change enable a resource exhaustion attack, such as allowing a
|
||||||
|
single API interaction to consume significant server resources? Some examples
|
||||||
|
of this include launching subprocesses for each connection, or entity
|
||||||
|
expansion attacks in XML.
|
||||||
|
|
||||||
|
For more detailed guidance, please see the OpenStack Security Guidelines as
|
||||||
|
a reference (https://wiki.openstack.org/wiki/Security/Guidelines). These
|
||||||
|
guidelines are a work in progress and are designed to help you identify
|
||||||
|
security best practices. For further information, feel free to reach out
|
||||||
|
to the OpenStack Security Group at openstack-security@lists.openstack.org.
|
||||||
|
|
||||||
|
Notifications impact
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Please specify any changes to notifications. Be that an extra notification,
|
||||||
|
changes to an existing notification, or removing a notification.
|
||||||
|
|
||||||
|
Other end user impact
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Aside from the API, are there other ways a user will interact with this
|
||||||
|
feature?
|
||||||
|
|
||||||
|
* Does this change have an impact on python-moganclient? What does the user
|
||||||
|
interface there look like?
|
||||||
|
|
||||||
|
Performance Impact
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Describe any potential performance impact on the system, for example
|
||||||
|
how often will new code be called, and is there a major change to the calling
|
||||||
|
pattern of existing code.
|
||||||
|
|
||||||
|
Examples of things to consider here include:
|
||||||
|
|
||||||
|
* A periodic task might look like a small addition but if it calls conductor or
|
||||||
|
another service the load is multiplied by the number of nodes in the system.
|
||||||
|
|
||||||
|
* Scheduler filters get called once per host for every instance being created,
|
||||||
|
so any latency they introduce is linear with the size of the system.
|
||||||
|
|
||||||
|
* A small change in a utility function or a commonly used decorator can have a
|
||||||
|
large impacts on performance.
|
||||||
|
|
||||||
|
* Calls which result in a database queries (whether direct or via conductor)
|
||||||
|
can have a profound impact on performance when called in critical sections of
|
||||||
|
the code.
|
||||||
|
|
||||||
|
* Will the change include any locking, and if so what considerations are there
|
||||||
|
on holding the lock?
|
||||||
|
|
||||||
|
Other deployer impact
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Discuss things that will affect how you deploy and configure OpenStack
|
||||||
|
that have not already been mentioned, such as:
|
||||||
|
|
||||||
|
* What config options are being added? Should they be more generic than
|
||||||
|
proposed (for example a flag that other hypervisor drivers might want to
|
||||||
|
implement as well)? Are the default values ones which will work well in
|
||||||
|
real deployments?
|
||||||
|
|
||||||
|
* Is this a change that takes immediate effect after its merged, or is it
|
||||||
|
something that has to be explicitly enabled?
|
||||||
|
|
||||||
|
* If this change is a new binary, how would it be deployed?
|
||||||
|
|
||||||
|
* Please state anything that those doing continuous deployment, or those
|
||||||
|
upgrading from the previous release, need to be aware of. Also describe
|
||||||
|
any plans to deprecate configuration values or features. For example, if we
|
||||||
|
change the directory name that instances are stored in, how do we handle
|
||||||
|
instance directories created before the change landed? Do we move them? Do
|
||||||
|
we have a special case in the code? Do we assume that the operator will
|
||||||
|
recreate all the instances in their cloud?
|
||||||
|
|
||||||
|
Developer impact
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Discuss things that will affect other developers working on OpenStack,
|
||||||
|
such as:
|
||||||
|
|
||||||
|
* If the blueprint proposes a change to the driver API, discussion of how
|
||||||
|
other hypervisors would implement the feature is required.
|
||||||
|
|
||||||
|
|
||||||
|
Implementation
|
||||||
|
==============
|
||||||
|
|
||||||
|
Assignee(s)
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Who is leading the writing of the code? Or is this a blueprint where you're
|
||||||
|
throwing it out there to see who picks it up?
|
||||||
|
|
||||||
|
If more than one person is working on the implementation, please designate the
|
||||||
|
primary author and contact.
|
||||||
|
|
||||||
|
Primary assignee:
|
||||||
|
<launchpad-id or None>
|
||||||
|
|
||||||
|
Other contributors:
|
||||||
|
<launchpad-id or None>
|
||||||
|
|
||||||
|
Work Items
|
||||||
|
----------
|
||||||
|
|
||||||
|
Work items or tasks -- break the feature up into the things that need to be
|
||||||
|
done to implement it. Those parts might end up being done by different people,
|
||||||
|
but we're mostly trying to understand the timeline for implementation.
|
||||||
|
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
============
|
||||||
|
|
||||||
|
* Include specific references to specs and/or blueprints in mogan, or in other
|
||||||
|
projects, that this one either depends on or is related to.
|
||||||
|
|
||||||
|
* If this requires functionality of another project that is not currently used
|
||||||
|
by Mogan, document that fact.
|
||||||
|
|
||||||
|
* Does this feature require any new library dependencies or code otherwise not
|
||||||
|
included in OpenStack? Or does it depend on a specific version of library?
|
||||||
|
|
||||||
|
|
||||||
|
Testing
|
||||||
|
=======
|
||||||
|
|
||||||
|
Please discuss the important scenarios needed to test here, as well as
|
||||||
|
specific edge cases we should be ensuring work correctly. For each
|
||||||
|
scenario please specify if this requires specialized hardware, a full
|
||||||
|
openstack environment, or can be simulated inside the Mogan tree.
|
||||||
|
|
||||||
|
Please discuss how the change will be tested. We especially want to know what
|
||||||
|
tempest tests will be added. It is assumed that unit test coverage will be
|
||||||
|
added so that doesn't need to be mentioned explicitly, but discussion of why
|
||||||
|
you think unit tests are sufficient and we don't need to add more tempest
|
||||||
|
tests would need to be included.
|
||||||
|
|
||||||
|
Is this untestable in gate given current limitations (specific hardware /
|
||||||
|
software configurations available)? If so, are there mitigation plans (3rd
|
||||||
|
party testing, gate enhancements, etc).
|
||||||
|
|
||||||
|
|
||||||
|
Documentation Impact
|
||||||
|
====================
|
||||||
|
|
||||||
|
Which audiences are affected most by this change, and which documentation
|
||||||
|
titles on docs.openstack.org should be updated because of this change? Don't
|
||||||
|
repeat details discussed above, but reference them here in the context of
|
||||||
|
documentation for multiple audiences. For example, the Operations Guide targets
|
||||||
|
cloud operators, and the End User Guide would need to be updated if the change
|
||||||
|
offers a new feature available through the CLI or dashboard. If a config option
|
||||||
|
changes or is deprecated, note here that the documentation needs to be updated
|
||||||
|
to reflect this specification's change.
|
||||||
|
|
||||||
|
References
|
||||||
|
==========
|
||||||
|
|
||||||
|
Please add any useful references here. You are not required to have any
|
||||||
|
reference. Moreover, this specification should still make sense when your
|
||||||
|
references are unavailable. Examples of what you could include are:
|
||||||
|
|
||||||
|
* Links to mailing list or IRC discussions
|
||||||
|
|
||||||
|
* Links to notes from a summit session
|
||||||
|
|
||||||
|
* Links to relevant research, if appropriate
|
||||||
|
|
||||||
|
* Related specifications as appropriate (e.g. if it's an EC2 thing, link the
|
||||||
|
EC2 docs)
|
||||||
|
|
||||||
|
* Anything else you feel it is worthwhile to refer to
|
||||||
|
|
||||||
|
.. list-table:: Revisions
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Release Name
|
||||||
|
- Description
|
||||||
|
* - Ocata
|
||||||
|
- Introduced
|
||||||
130
tests/test_titles.py
Normal file
130
tests/test_titles.py
Normal file
@ -0,0 +1,130 @@
|
|||||||
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
# not use this file except in compliance with the License. You may obtain
|
||||||
|
# a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
# License for the specific language governing permissions and limitations
|
||||||
|
# under the License.
|
||||||
|
|
||||||
|
import glob
|
||||||
|
import re
|
||||||
|
|
||||||
|
import docutils.core
|
||||||
|
import testtools
|
||||||
|
|
||||||
|
|
||||||
|
class TestTitles(testtools.TestCase):
|
||||||
|
def _get_title(self, section_tree):
|
||||||
|
section = {
|
||||||
|
'subtitles': [],
|
||||||
|
}
|
||||||
|
for node in section_tree:
|
||||||
|
if node.tagname == 'title':
|
||||||
|
section['name'] = node.rawsource
|
||||||
|
elif node.tagname == 'section':
|
||||||
|
subsection = self._get_title(node)
|
||||||
|
section['subtitles'].append(subsection['name'])
|
||||||
|
return section
|
||||||
|
|
||||||
|
def _get_titles(self, spec):
|
||||||
|
titles = {}
|
||||||
|
for node in spec:
|
||||||
|
if node.tagname == 'section':
|
||||||
|
# Note subsection subtitles are thrown away
|
||||||
|
section = self._get_title(node)
|
||||||
|
titles[section['name']] = section['subtitles']
|
||||||
|
return titles
|
||||||
|
|
||||||
|
def _check_titles(self, filename, expect, actual):
|
||||||
|
missing_sections = [x for x in expect.keys() if (
|
||||||
|
x not in actual.keys())]
|
||||||
|
extra_sections = [x for x in actual.keys() if x not in expect.keys()]
|
||||||
|
|
||||||
|
msgs = []
|
||||||
|
if len(missing_sections) > 0:
|
||||||
|
msgs.append("Missing sections: %s" % missing_sections)
|
||||||
|
if len(extra_sections) > 0:
|
||||||
|
msgs.append("Extra sections: %s" % extra_sections)
|
||||||
|
|
||||||
|
for section in expect.keys():
|
||||||
|
missing_subsections = [x for x in expect[section]
|
||||||
|
if x not in actual.get(section, {})]
|
||||||
|
# extra subsections are allowed
|
||||||
|
if len(missing_subsections) > 0:
|
||||||
|
msgs.append("Section '%s' is missing subsections: %s"
|
||||||
|
% (section, missing_subsections))
|
||||||
|
|
||||||
|
if len(msgs) > 0:
|
||||||
|
self.fail("While checking '%s':\n %s"
|
||||||
|
% (filename, "\n ".join(msgs)))
|
||||||
|
|
||||||
|
def _check_lines_wrapping(self, tpl, raw):
|
||||||
|
code_block = False
|
||||||
|
for i, line in enumerate(raw.split("\n")):
|
||||||
|
# NOTE(ndipanov): Allow code block lines to be longer than 79 ch
|
||||||
|
if code_block:
|
||||||
|
if not line or line.startswith(" "):
|
||||||
|
continue
|
||||||
|
else:
|
||||||
|
code_block = False
|
||||||
|
if "::" in line:
|
||||||
|
code_block = True
|
||||||
|
if "http://" in line or "https://" in line:
|
||||||
|
continue
|
||||||
|
# Allow lines which do not contain any whitespace
|
||||||
|
if re.match("\s*[^\s]+$", line):
|
||||||
|
continue
|
||||||
|
self.assertTrue(
|
||||||
|
len(line) < 80,
|
||||||
|
msg="%s:%d: Line limited to a maximum of 79 characters." %
|
||||||
|
(tpl, i + 1))
|
||||||
|
|
||||||
|
def _check_no_cr(self, tpl, raw):
|
||||||
|
matches = re.findall('\r', raw)
|
||||||
|
self.assertEqual(
|
||||||
|
len(matches), 0,
|
||||||
|
"Found %s literal carriage returns in file %s" %
|
||||||
|
(len(matches), tpl))
|
||||||
|
|
||||||
|
def _check_no_zwsp(self, tpl, raw):
|
||||||
|
matches = raw.decode('utf-8').find(u"\u200B")
|
||||||
|
self.assertEqual(
|
||||||
|
matches, -1,
|
||||||
|
"Found zero width space characters in file %s" %
|
||||||
|
(tpl))
|
||||||
|
|
||||||
|
def _check_trailing_spaces(self, tpl, raw):
|
||||||
|
for i, line in enumerate(raw.split("\n")):
|
||||||
|
trailing_spaces = re.findall(" +$", line)
|
||||||
|
self.assertEqual(len(trailing_spaces), 0,
|
||||||
|
"Found trailing spaces on line %s of %s" % (i + 1, tpl))
|
||||||
|
|
||||||
|
def test_template(self):
|
||||||
|
releases = [x.split('/')[1] for x in glob.glob('specs/*/')]
|
||||||
|
self.assertTrue(len(releases), "Not able to find spec directories")
|
||||||
|
|
||||||
|
with open("specs/template.rst") as f:
|
||||||
|
template = f.read()
|
||||||
|
spec = docutils.core.publish_doctree(template)
|
||||||
|
template_titles = self._get_titles(spec)
|
||||||
|
|
||||||
|
for release in releases:
|
||||||
|
files = glob.glob("specs/%s/*/*" % release)
|
||||||
|
for filename in files:
|
||||||
|
self.assertTrue(filename.endswith(".rst"),
|
||||||
|
"spec %s must use 'rst' extension."
|
||||||
|
% filename)
|
||||||
|
with open(filename) as f:
|
||||||
|
data = f.read()
|
||||||
|
|
||||||
|
spec = docutils.core.publish_doctree(data)
|
||||||
|
titles = self._get_titles(spec)
|
||||||
|
self._check_titles(filename, template_titles, titles)
|
||||||
|
self._check_lines_wrapping(filename, data)
|
||||||
|
self._check_no_cr(filename, data)
|
||||||
|
self._check_no_zwsp(filename, data)
|
||||||
|
self._check_trailing_spaces(filename, data)
|
||||||
Loading…
Reference in New Issue
Block a user