Initialize the venus-specs project
Change-Id: I788a3c0a4ec29deaeb8a73ce061aaa9dbd06e0b2
This commit is contained in:
jiasirui
parent
d39782ea43
commit
85954e9f55
6
.coveragerc
Normal file
6
.coveragerc
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
[run]
|
||||||
|
branch = True
|
||||||
|
source = specs
|
||||||
|
|
||||||
|
[report]
|
||||||
|
ignore_errors = True
|
||||||
63
.gitignore
vendored
Normal file
63
.gitignore
vendored
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
*.py[cod]
|
||||||
|
|
||||||
|
# C extensions
|
||||||
|
*.so
|
||||||
|
|
||||||
|
# Packages
|
||||||
|
*.egg*
|
||||||
|
*.egg-info
|
||||||
|
dist
|
||||||
|
build
|
||||||
|
eggs
|
||||||
|
parts
|
||||||
|
bin
|
||||||
|
var
|
||||||
|
sdist
|
||||||
|
develop-eggs
|
||||||
|
.installed.cfg
|
||||||
|
lib
|
||||||
|
lib64
|
||||||
|
|
||||||
|
#IDEA
|
||||||
|
.idea
|
||||||
|
|
||||||
|
# Installer logs
|
||||||
|
pip-log.txt
|
||||||
|
|
||||||
|
# Unit test / coverage reports
|
||||||
|
cover/
|
||||||
|
.coverage*
|
||||||
|
!.coveragerc
|
||||||
|
.tox
|
||||||
|
nosetests.xml
|
||||||
|
.testrepository
|
||||||
|
.stestr
|
||||||
|
.venv
|
||||||
|
|
||||||
|
# Translations
|
||||||
|
*.mo
|
||||||
|
|
||||||
|
# Mr Developer
|
||||||
|
.mr.developer.cfg
|
||||||
|
.project
|
||||||
|
.pydevproject
|
||||||
|
|
||||||
|
# Complexity
|
||||||
|
output/*.html
|
||||||
|
output/*/index.html
|
||||||
|
|
||||||
|
# Sphinx
|
||||||
|
doc/build
|
||||||
|
|
||||||
|
# pbr generates these
|
||||||
|
AUTHORS
|
||||||
|
ChangeLog
|
||||||
|
|
||||||
|
# Editors
|
||||||
|
*~
|
||||||
|
.*.swp
|
||||||
|
.*sw?
|
||||||
|
.vscode/*
|
||||||
|
|
||||||
|
# Files created by releasenotes build
|
||||||
|
releasenotes/build
|
||||||
3
.mailmap
Normal file
3
.mailmap
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# Format is:
|
||||||
|
# <preferred e-mail> <other e-mail 1>
|
||||||
|
# <preferred e-mail> <other e-mail 2>
|
||||||
3
.stestr.conf
Normal file
3
.stestr.conf
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
[DEFAULT]
|
||||||
|
test_path=./specs/tests
|
||||||
|
top_dir=./
|
||||||
17
CONTRIBUTING.rst
Normal file
17
CONTRIBUTING.rst
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
If you would like to contribute to the development of OpenStack, you must
|
||||||
|
follow the steps in this page:
|
||||||
|
|
||||||
|
http://docs.openstack.org/infra/manual/developers.html
|
||||||
|
|
||||||
|
If you already have a good understanding of how the system works and your
|
||||||
|
OpenStack accounts are set up, you can skip to the development workflow
|
||||||
|
section of this documentation to learn how changes to OpenStack should be
|
||||||
|
submitted for review via the Gerrit tool:
|
||||||
|
|
||||||
|
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
|
|
||||||
|
Pull requests submitted through GitHub will be ignored.
|
||||||
|
|
||||||
|
Bugs should be filed on Launchpad, not GitHub:
|
||||||
|
|
||||||
|
https://bugs.launchpad.net/venus
|
||||||
4
HACKING.rst
Normal file
4
HACKING.rst
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
venus-specs Style Commandments
|
||||||
|
===============================================
|
||||||
|
|
||||||
|
Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/
|
||||||
176
LICENSE
Normal file
176
LICENSE
Normal file
@ -0,0 +1,176 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
42
README.rst
Normal file
42
README.rst
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
========================
|
||||||
|
Team and repository tags
|
||||||
|
========================
|
||||||
|
|
||||||
|
.. image:: http://governance.openstack.org/tc/badges/venus-specs.svg
|
||||||
|
:target: http://governance.openstack.org/tc/reference/tags/index.html
|
||||||
|
|
||||||
|
.. Change things from this point on
|
||||||
|
|
||||||
|
===============================
|
||||||
|
OpenStack Venus Specifications
|
||||||
|
===============================
|
||||||
|
|
||||||
|
This git repository is used to hold approved design specifications for additions
|
||||||
|
to the Venus project. Reviews of the specs are done in gerrit, using a similar
|
||||||
|
workflow to how we review and merge changes to the code itself.
|
||||||
|
|
||||||
|
The layout of this repository is::
|
||||||
|
|
||||||
|
specs/<release>/
|
||||||
|
|
||||||
|
Where there are two sub-directories:
|
||||||
|
|
||||||
|
specs/<release>/approved: specifications approved but not yet implemented
|
||||||
|
specs/<release>/implemented: implemented specifications
|
||||||
|
|
||||||
|
This directory structure allows you to see what we thought about doing,
|
||||||
|
decided to do, and actually got done. Users interested in functionality in a
|
||||||
|
given release should only refer to the ``implemented`` directory.
|
||||||
|
|
||||||
|
You can find an example spec in `doc/source/specs/template.rst`.
|
||||||
|
|
||||||
|
To track all the blueprints of venus, please refer to the trello board:
|
||||||
|
https://trello.com/b/4nFtHNSg/queens-dev
|
||||||
|
|
||||||
|
To validate that the specification is syntactically correct (i.e. get more
|
||||||
|
confidence in the Jenkins result), please execute the following command::
|
||||||
|
|
||||||
|
$ tox
|
||||||
|
|
||||||
|
After running ``tox``, the documentation will be available for viewing in HTML
|
||||||
|
format in the ``doc/build/`` directory.
|
||||||
7
doc/requirements.txt
Normal file
7
doc/requirements.txt
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
# The order of packages is significant, because pip processes them in the order
|
||||||
|
# of appearance. Changing the order has an impact on the overall integration
|
||||||
|
# process, which may cause wedges in the gate later.
|
||||||
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
|
sphinxcontrib-seqdiag>=0.8.4 # BSD
|
||||||
|
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||||
|
yasfb>=0.5.1
|
||||||
92
doc/source/conf.py
Normal file
92
doc/source/conf.py
Normal file
@ -0,0 +1,92 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# 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 os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
sys.path.insert(0, os.path.abspath('../..'))
|
||||||
|
# -- General configuration ----------------------------------------------------
|
||||||
|
|
||||||
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
|
extensions = [
|
||||||
|
'sphinx.ext.autodoc',
|
||||||
|
'openstackdocstheme',
|
||||||
|
#'sphinx.ext.intersphinx',
|
||||||
|
'sphinxcontrib.seqdiag',
|
||||||
|
'yasfb',
|
||||||
|
]
|
||||||
|
|
||||||
|
# Feed configuration for yasfb
|
||||||
|
feed_base_url = 'http://specs.openstack.org/openstack/venus-specs'
|
||||||
|
feed_author = 'OpenStack Development Team'
|
||||||
|
|
||||||
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
|
# text edit cycles.
|
||||||
|
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
||||||
|
|
||||||
|
# The suffix of source filenames.
|
||||||
|
source_suffix = '.rst'
|
||||||
|
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = 'index'
|
||||||
|
|
||||||
|
# General information about the project.
|
||||||
|
project = u'venus-specs'
|
||||||
|
copyright = u'2017, OpenStack Developers'
|
||||||
|
|
||||||
|
# openstackdocstheme options
|
||||||
|
openstackdocs_repo_name = 'openstack/venus-specs'
|
||||||
|
openstackdocs_auto_name = False
|
||||||
|
openstackdocs_use_storyboard = True
|
||||||
|
|
||||||
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
|
add_function_parentheses = True
|
||||||
|
|
||||||
|
# If true, the current module name will be prepended to all description
|
||||||
|
# unit titles (such as .. function::).
|
||||||
|
add_module_names = True
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
|
pygments_style = 'native'
|
||||||
|
|
||||||
|
# -- Options for HTML output --------------------------------------------------
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||||
|
# html_theme_path = ["."]
|
||||||
|
# html_theme = '_theme'
|
||||||
|
# html_static_path = ['static']
|
||||||
|
html_theme = 'openstackdocs'
|
||||||
|
|
||||||
|
# Output file base name for HTML help builder.
|
||||||
|
htmlhelp_basename = '%sdoc' % project
|
||||||
|
|
||||||
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
|
# (source start file, target name, title, author, documentclass
|
||||||
|
# [howto/manual]).
|
||||||
|
latex_documents = [
|
||||||
|
('index',
|
||||||
|
'%s.tex' % project,
|
||||||
|
u'%s Documentation' % project,
|
||||||
|
u'OpenStack Developers', 'manual'),
|
||||||
|
]
|
||||||
|
|
||||||
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
|
#intersphinx_mapping = {'http://docs.python.org/': None}
|
||||||
|
|
||||||
|
# -- seqdiag configuration ----------------------------------------------------
|
||||||
|
|
||||||
|
seqdiag_html_image_format = 'SVG'
|
||||||
|
seqdiag_antialias = True
|
||||||
232
doc/source/index.rst
Normal file
232
doc/source/index.rst
Normal file
@ -0,0 +1,232 @@
|
|||||||
|
.. venus-specs documentation master file, created by
|
||||||
|
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
============
|
||||||
|
Venus Specs
|
||||||
|
============
|
||||||
|
|
||||||
|
Wallaby
|
||||||
|
-------
|
||||||
|
This section has a list of specs for the Wallaby release.
|
||||||
|
|
||||||
|
Template:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Specification Template (Wallaby release) <specs/wallaby-template>
|
||||||
|
|
||||||
|
Wallaby implemented specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/wallaby/implemented/*
|
||||||
|
|
||||||
|
Wallaby approved (but not implemented) specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/wallaby/approved/*
|
||||||
|
|
||||||
|
Victoria
|
||||||
|
--------
|
||||||
|
This section has a list of specs for the Victoria release.
|
||||||
|
|
||||||
|
Template:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Specification Template (Victoria release) <specs/victoria-template>
|
||||||
|
|
||||||
|
Victoria implemented specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/victoria/implemented/*
|
||||||
|
|
||||||
|
Victoria approved (but not implemented) specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/victoria/approved/*
|
||||||
|
|
||||||
|
Ussuri
|
||||||
|
------
|
||||||
|
This section has a list of specs for the Ussuri release.
|
||||||
|
|
||||||
|
Template:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Specification Template (Ussuri release) <specs/ussuri-template>
|
||||||
|
|
||||||
|
Ussuri implemented specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/ussuri/implemented/*
|
||||||
|
|
||||||
|
Ussuri approved (but not implemented) specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/ussuri/approved/*
|
||||||
|
|
||||||
|
Train
|
||||||
|
-----
|
||||||
|
This section has a list of specs for the Train release.
|
||||||
|
|
||||||
|
Template:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Specification Template (Train release) <specs/train-template>
|
||||||
|
|
||||||
|
Train implemented specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/train/implemented/*
|
||||||
|
|
||||||
|
Train approved (but not implemented) specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/train/approved/*
|
||||||
|
|
||||||
|
Stein
|
||||||
|
-----
|
||||||
|
This section has a list of specs for the Stein release.
|
||||||
|
|
||||||
|
Template:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Specification Template (Stein release) <specs/stein-template>
|
||||||
|
|
||||||
|
Stein implemented specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/stein/implemented/*
|
||||||
|
|
||||||
|
Stein approved (but not implemented) specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/stein/approved/*
|
||||||
|
|
||||||
|
Rocky
|
||||||
|
-----
|
||||||
|
This section has a list of specs for the Rocky release.
|
||||||
|
|
||||||
|
Template:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Specification Template (Rocky release) <specs/rocky-template>
|
||||||
|
|
||||||
|
Rocky implemented specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/rocky/implemented/*
|
||||||
|
|
||||||
|
Rocky approved (but not implemented) specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/rocky/approved/*
|
||||||
|
|
||||||
|
Queens
|
||||||
|
------
|
||||||
|
This section has a list of specs for the Queens release.
|
||||||
|
|
||||||
|
Template:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Specification Template (Queens release) <specs/queens-template>
|
||||||
|
|
||||||
|
Queens implemented specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/queens/implemented/*
|
||||||
|
|
||||||
|
Queens approved (but not implemented) specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/queens/approved/*
|
||||||
|
|
||||||
|
Pike
|
||||||
|
----
|
||||||
|
This section has a list of specs for the Pike release.
|
||||||
|
|
||||||
|
Template:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Specification Template (Pike release) <specs/pike-template>
|
||||||
|
|
||||||
|
Pike implemented specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/pike/implemented/*
|
||||||
|
|
||||||
|
Pike approved (but not implemented) specs:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/pike/approved/*
|
||||||
19
doc/source/specs/__init__.py
Normal file
19
doc/source/specs/__init__.py
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
# 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 pbr.version
|
||||||
|
|
||||||
|
|
||||||
|
__version__ = pbr.version.VersionInfo(
|
||||||
|
'venus-specs').version_string()
|
||||||
392
doc/source/specs/wallaby-template.rst
Normal file
392
doc/source/specs/wallaby-template.rst
Normal file
@ -0,0 +1,392 @@
|
|||||||
|
..
|
||||||
|
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/openstack-venus/+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 venus-spec and blueprint process:
|
||||||
|
|
||||||
|
* Not all blueprints need a spec. For more information see
|
||||||
|
https://docs.openstack.org/developer/venus/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/openstack-venus/+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 Venus 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.opendev.org/#/q/status:open+project:openstack/venus+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 Venus, 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-venusclient? 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 venus, 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 Venus, 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 Venus 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
|
||||||
|
|
||||||
|
|
||||||
|
History
|
||||||
|
=======
|
||||||
|
|
||||||
|
Optional section intended to be used each time the spec is updated to describe
|
||||||
|
new design, API or any database schema updated. Useful to let reader understand
|
||||||
|
what's happened along the time.
|
||||||
|
|
||||||
|
.. list-table:: Revisions
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Release Name
|
||||||
|
- Description
|
||||||
|
* - Wallaby
|
||||||
|
- Introduced
|
||||||
392
doc/source/specs/wallaby/approved/template.rst
Normal file
392
doc/source/specs/wallaby/approved/template.rst
Normal file
@ -0,0 +1,392 @@
|
|||||||
|
..
|
||||||
|
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/openstack-venus/+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 venus-spec and blueprint process:
|
||||||
|
|
||||||
|
* Not all blueprints need a spec. For more information see
|
||||||
|
https://docs.openstack.org/developer/venus/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/openstack-venus/+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 Venus 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.opendev.org/#/q/status:open+project:openstack/venus+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 Venus, 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-venusclient? 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 venus, 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 Venus, 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 Venus 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
|
||||||
|
|
||||||
|
|
||||||
|
History
|
||||||
|
=======
|
||||||
|
|
||||||
|
Optional section intended to be used each time the spec is updated to describe
|
||||||
|
new design, API or any database schema updated. Useful to let reader understand
|
||||||
|
what's happened along the time.
|
||||||
|
|
||||||
|
.. list-table:: Revisions
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Release Name
|
||||||
|
- Description
|
||||||
|
* - Wallaby
|
||||||
|
- Introduced
|
||||||
392
doc/source/specs/wallaby/implemented/template.rst
Normal file
392
doc/source/specs/wallaby/implemented/template.rst
Normal file
@ -0,0 +1,392 @@
|
|||||||
|
..
|
||||||
|
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/openstack-venus/+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 venus-spec and blueprint process:
|
||||||
|
|
||||||
|
* Not all blueprints need a spec. For more information see
|
||||||
|
https://docs.openstack.org/developer/venus/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/openstack-venus/+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 Venus 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.opendev.org/#/q/status:open+project:openstack/venus+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 Venus, 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-venusclient? 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 venus, 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 Venus, 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 Venus 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
|
||||||
|
|
||||||
|
|
||||||
|
History
|
||||||
|
=======
|
||||||
|
|
||||||
|
Optional section intended to be used each time the spec is updated to describe
|
||||||
|
new design, API or any database schema updated. Useful to let reader understand
|
||||||
|
what's happened along the time.
|
||||||
|
|
||||||
|
.. list-table:: Revisions
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Release Name
|
||||||
|
- Description
|
||||||
|
* - Wallaby
|
||||||
|
- Introduced
|
||||||
14
setup.cfg
Normal file
14
setup.cfg
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
[metadata]
|
||||||
|
name = venus-specs
|
||||||
|
summary = Venus Specifications
|
||||||
|
description-file =
|
||||||
|
README.rst
|
||||||
|
author = OpenStack
|
||||||
|
author-email = openstack-discuss@lists.openstack.org
|
||||||
|
home-page = http://specs.openstack.org/openstack/venus-specs/
|
||||||
|
classifier =
|
||||||
|
Environment :: OpenStack
|
||||||
|
Intended Audience :: Information Technology
|
||||||
|
Intended Audience :: System Administrators
|
||||||
|
License :: OSI Approved :: Apache Software License
|
||||||
|
Operating System :: POSIX :: Linux
|
||||||
20
setup.py
Normal file
20
setup.py
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
# Copyright 2020 Inspur
|
||||||
|
#
|
||||||
|
# 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 setuptools
|
||||||
|
|
||||||
|
setuptools.setup(
|
||||||
|
setup_requires=['pbr'],
|
||||||
|
pbr=True)
|
||||||
19
specs/__init__.py
Normal file
19
specs/__init__.py
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
# 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 pbr.version
|
||||||
|
|
||||||
|
|
||||||
|
__version__ = pbr.version.VersionInfo(
|
||||||
|
'venus-specs').version_string()
|
||||||
392
specs/wallaby-template.rst
Normal file
392
specs/wallaby-template.rst
Normal file
@ -0,0 +1,392 @@
|
|||||||
|
..
|
||||||
|
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/openstack-venus/+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 venus-spec and blueprint process:
|
||||||
|
|
||||||
|
* Not all blueprints need a spec. For more information see
|
||||||
|
https://docs.openstack.org/developer/venus/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/openstack-venus/+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 Venus 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.opendev.org/#/q/status:open+project:openstack/venus+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 Venus, 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-venusclient? 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 venus, 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 Venus, 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 Venus 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
|
||||||
|
|
||||||
|
|
||||||
|
History
|
||||||
|
=======
|
||||||
|
|
||||||
|
Optional section intended to be used each time the spec is updated to describe
|
||||||
|
new design, API or any database schema updated. Useful to let reader understand
|
||||||
|
what's happened along the time.
|
||||||
|
|
||||||
|
.. list-table:: Revisions
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Release Name
|
||||||
|
- Description
|
||||||
|
* - Wallaby
|
||||||
|
- Introduced
|
||||||
392
specs/wallaby/approved/template.rst
Normal file
392
specs/wallaby/approved/template.rst
Normal file
@ -0,0 +1,392 @@
|
|||||||
|
..
|
||||||
|
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/openstack-venus/+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 venus-spec and blueprint process:
|
||||||
|
|
||||||
|
* Not all blueprints need a spec. For more information see
|
||||||
|
https://docs.openstack.org/developer/venus/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/openstack-venus/+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 Venus 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.opendev.org/#/q/status:open+project:openstack/venus+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 Venus, 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-venusclient? 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 venus, 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 Venus, 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 Venus 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
|
||||||
|
|
||||||
|
|
||||||
|
History
|
||||||
|
=======
|
||||||
|
|
||||||
|
Optional section intended to be used each time the spec is updated to describe
|
||||||
|
new design, API or any database schema updated. Useful to let reader understand
|
||||||
|
what's happened along the time.
|
||||||
|
|
||||||
|
.. list-table:: Revisions
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Release Name
|
||||||
|
- Description
|
||||||
|
* - Wallaby
|
||||||
|
- Introduced
|
||||||
392
specs/wallaby/implemented/template.rst
Normal file
392
specs/wallaby/implemented/template.rst
Normal file
@ -0,0 +1,392 @@
|
|||||||
|
..
|
||||||
|
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/openstack-venus/+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 venus-spec and blueprint process:
|
||||||
|
|
||||||
|
* Not all blueprints need a spec. For more information see
|
||||||
|
https://docs.openstack.org/developer/venus/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/openstack-venus/+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 Venus 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.opendev.org/#/q/status:open+project:openstack/venus+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 Venus, 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-venusclient? 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 venus, 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 Venus, 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 Venus 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
|
||||||
|
|
||||||
|
|
||||||
|
History
|
||||||
|
=======
|
||||||
|
|
||||||
|
Optional section intended to be used each time the spec is updated to describe
|
||||||
|
new design, API or any database schema updated. Useful to let reader understand
|
||||||
|
what's happened along the time.
|
||||||
|
|
||||||
|
.. list-table:: Revisions
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Release Name
|
||||||
|
- Description
|
||||||
|
* - Wallaby
|
||||||
|
- Introduced
|
||||||
12
test-requirements.txt
Normal file
12
test-requirements.txt
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# The order of packages is significant, because pip processes them in the order
|
||||||
|
# of appearance. Changing the order has an impact on the overall integration
|
||||||
|
# process, which may cause wedges in the gate later.
|
||||||
|
|
||||||
|
hacking>=3.0,<3.1 # Apache-2.0
|
||||||
|
|
||||||
|
coverage>=4.0,!=4.4 # Apache-2.0
|
||||||
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
|
stestr>=1.0.0 # Apache-2.0
|
||||||
|
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||||
|
pbr>=2.0 # Apache-2.0
|
||||||
|
doc8>=0.8.0 # Apache-2.0
|
||||||
56
tox.ini
Normal file
56
tox.ini
Normal file
@ -0,0 +1,56 @@
|
|||||||
|
[tox]
|
||||||
|
minversion = 3.1.1
|
||||||
|
envlist = docs,pep8
|
||||||
|
skipsdist = True
|
||||||
|
ignore_basepython_conflict = True
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
basepython = python3
|
||||||
|
usedevelop = True
|
||||||
|
setenv =
|
||||||
|
VIRTUAL_ENV={envdir}
|
||||||
|
PYTHONWARNINGS=default::DeprecationWarning
|
||||||
|
OS_STDOUT_CAPTURE=1
|
||||||
|
OS_STDERR_CAPTURE=1
|
||||||
|
OS_TEST_TIMEOUT=60
|
||||||
|
deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
||||||
|
-r{toxinidir}/test-requirements.txt
|
||||||
|
-r{toxinidir}/doc/requirements.txt
|
||||||
|
commands = stestr run {posargs}
|
||||||
|
|
||||||
|
[testenv:pep8]
|
||||||
|
commands =
|
||||||
|
flake8 {posargs}
|
||||||
|
doc8 specs/
|
||||||
|
|
||||||
|
[testenv:venv]
|
||||||
|
commands = {posargs}
|
||||||
|
|
||||||
|
[testenv:cover]
|
||||||
|
setenv =
|
||||||
|
VIRTUAL_ENV={envdir}
|
||||||
|
PYTHON=coverage run --source specs --parallel-mode
|
||||||
|
commands =
|
||||||
|
stestr run {posargs}
|
||||||
|
coverage combine
|
||||||
|
coverage html -d cover
|
||||||
|
coverage xml -o cover/coverage.xml
|
||||||
|
|
||||||
|
[testenv:docs]
|
||||||
|
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||||
|
doc8 --ignore D001 doc/
|
||||||
|
|
||||||
|
[testenv:releasenotes]
|
||||||
|
commands =
|
||||||
|
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
||||||
|
|
||||||
|
[testenv:debug]
|
||||||
|
commands = oslo_debug_helper {posargs}
|
||||||
|
|
||||||
|
[flake8]
|
||||||
|
# E123, E125 skipped as they are invalid PEP-8.
|
||||||
|
|
||||||
|
show-source = True
|
||||||
|
ignore = E123,E125
|
||||||
|
builtins = _
|
||||||
|
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build
|
||||||
Loading…
Reference in New Issue
Block a user