Initial commit

Change-Id: I2b02c253c8f06642f5468332d622f624cd30292b
This commit is contained in:
Dmitry Tantsur 2015-12-02 13:55:41 +01:00
parent 8f7a80c22e
commit ac093b15be
15 changed files with 522 additions and 0 deletions

36
.gitignore vendored Normal file
View File

@ -0,0 +1,36 @@
*.py[cod]
# Packages
*.egg
*.egg-info
dist
build
eggs
parts
sdist
develop-eggs
.installed.cfg
# Installer logs
pip-log.txt
# Unit test / coverage reports
.tox
nosetests.xml
.testrepository
# Mr Developer
.mr.developer.cfg
.project
.pydevproject
# Sphinx
doc/build
# pbr generates these
AUTHORS
ChangeLog
# Editors
*~
.*.swp

7
.testr.conf Normal file
View File

@ -0,0 +1,7 @@
[DEFAULT]
test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \
OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \
OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \
${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION
test_id_option=--load-list $IDFILE
test_list_option=--list

3
LICENSE Normal file
View File

@ -0,0 +1,3 @@
This work is licensed under a Creative Commons Attribution 3.0 Unported License.
http://creativecommons.org/licenses/by/3.0/legalcode

8
README.rst Normal file
View File

@ -0,0 +1,8 @@
===============================
ironic-inspector specs
===============================
Specs for Ironic Inspector
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/ironic-inspector

92
doc/source/conf.py Executable file
View 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 datetime
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',
#'sphinx.ext.intersphinx',
'oslosphinx',
'yasfb',
]
# Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/ironic-inspector'
feed_author = 'OpenStack Ironic Inspector Team'
exclude_patterns = [
]
# Optionally allow the use of sphinxcontrib.spelling to verify the
# spelling of the documents.
try:
import sphinxcontrib.spelling
extensions.append('sphinxcontrib.spelling')
except ImportError:
pass
# 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'Ironic Inspector Specs'
copyright = u'%s, OpenStack Ironic Inspector Team' % datetime.date.today().year
# 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 = 'sphinx'
# -- 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']
# 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,
project,
u'OpenStack Ironic Inspector Team', 'manual'),
]
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}

26
doc/source/index.rst Normal file
View File

@ -0,0 +1,26 @@
Ironic Inspector Design Specifications
======================================
.. toctree::
:glob:
:maxdepth: 1
specs/*
Template for Writing Ironic Inspector Specs
===========================================
.. toctree::
:maxdepth: 3
template
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

1
doc/source/specs Symbolic link
View File

@ -0,0 +1 @@
../../specs/

1
doc/source/template.rst Symbolic link
View File

@ -0,0 +1 @@
../../template.rst

4
requirements.txt Normal file
View File

@ -0,0 +1,4 @@
pbr>=0.11,<2.0
oslosphinx
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
yasfb>=0.5.1

24
setup.cfg Normal file
View File

@ -0,0 +1,24 @@
[metadata]
name = ironic-inspector-specs
summary = Specs for Ironic Inspector
description-file =
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://www.openstack.org/
classifier =
Environment :: OpenStack
Intended Audience :: Developers
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[pbr]
warnerrors = True
[upload_sphinx]
upload-dir = doc/build/html

22
setup.py Executable file
View File

@ -0,0 +1,22 @@
#!/usr/bin/env python
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
#
# 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.
# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
import setuptools
setuptools.setup(
setup_requires=['pbr'],
pbr=True)

0
specs/.gitkeep Normal file
View File

271
template.rst Normal file
View File

@ -0,0 +1,271 @@
..
This work is licensed under a Creative Commons Attribution 3.0 Unported
License.
http://creativecommons.org/licenses/by/3.0/legalcode
=============================
The title of your blueprint
=============================
Include the URL of your launchpad blueprint:
https://blueprints.launchpad.net/ironic-inspector/+spec/example
Introduction paragraph -- why are we doing anything?
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 must match the launchpad URL, for
example a URL of:
https://blueprints.launchpad.net/ironic-inspector/+spec/awesome-thing
must 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, or see:
http://rst.ninjs.org
* 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.
Problem description
===================
A detailed description of the problem:
* For a new feature this might be use cases. Ensure you are clear about the
actors in each use case: End User, Admin User, Deployer, or another Service
* For a major reworking of something existing it would describe the
problems in that feature that are being addressed.
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?
Include where in the ironic-inspector tree hierarchy this will reside.
Alternatives
------------
This is an optional section, where it does apply we'd just like a demonstration
that some thought has been put into why the proposed approach is the best 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.
HTTP API impact
---------------
Describe changes to the HTTP API.
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/PATCH)
* Normal http response code(s)
* Expected error http response code(s)
* A description for each possible error code should be included.
Describe semantic errors which can cause it, such as
inconsistent parameters supplied to the method, or when a
resource 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
* Parameters which can be passed via the url, including data types
* JSON schema definition for the body data if allowed
* JSON schema definition for the response data if any
* Does the API microversion need to increment?
* Example use case including typical API samples for both data supplied
by the caller and the response
* Is this change discoverable by clients? Not all clients will upgrade at the
same time, so this change must work with older clients without breaking them.
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.
Reuse of existing predefined parameter types is highly encouraged.
Client (CLI) impact
-------------------
Typically, but not always, if there are any REST API changes, there are
corresponding changes to python-ironic-inspector-client. If so, what does
the user interface look like. If not, describe why there are REST API changes
but no changes to the client.
Performance and scalability 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.
Describe any potential scalability impact on the system, for example any
increase in network, RPC, or database traffic, or whether the feature
requires synchronization across multiple services.
Security impact
---------------
Describe any potential security impact on the system.
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 hardware drivers might want to
implement as well)? Are the default values appropriate for production?
Provide an explanation of why these defaults are reasonable.
* Is this a change that takes immediate effect after it's merged, or is it
something that has to be explicitly enabled?
* If this change adds a new service that deployers will be required to run,
how would it be deployed? Describe the expected topology, for example,
what network connectivity the new service would need, what service(s) it
would interact with, how many should run relative to the size of the
deployment, and so on.
* 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.
* If your proposal includes any changes to the REST API, describe how existing
clients will continue to function when interacting with an upgraded API
server.
* Describe what testing you will be adding to ensure that backwards
compatibility is maintained.
* If deprecating an existing feature or API, describe the deprecation plan, and
for how long compatibility will be maintained.
Developer impact
----------------
Discuss things that will affect other developers working on OpenStack,
such as:
* If the blueprint proposes a change to the hooks API, discussion of how
other hooks would implement the feature is required. Describe how
existing hooks will continue to function after the change.
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>
Can optionally can list additional ids if they intend on doing
substantial implementation work on this blueprint.
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 ironic-inspector,
or in other projects, that this one either depends on or is related to.
- 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 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.
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

1
test-requirements.txt Normal file
View File

@ -0,0 +1 @@
doc8 # Apache-2.0

26
tox.ini Normal file
View File

@ -0,0 +1,26 @@
[tox]
minversion = 1.6
envlist = pep8,docs
[testenv]
usedevelop = True
deps = -r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
[testenv:venv]
commands = {posargs}
[testenv:pep8]
basepython = python2.7
commands =
doc8 README.rst doc/source specs
[testenv:docs]
commands = python setup.py build_sphinx
[testenv:spelling]
deps =
-r{toxinidir}/requirements.txt
sphinxcontrib-spelling
PyEnchant
commands = sphinx-build -b spelling doc/source doc/build/spelling