Apply OpenStack Cookiecutter template
Change-Id: I7172220a2b40cb856080e958bd4a340975449181
This commit is contained in:
Hongbin Lu
parent
a2bcf0a7e6
commit
af2e4fcee4
6
.coveragerc
Normal file
6
.coveragerc
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
[run]
|
||||||
|
branch = True
|
||||||
|
source = os_ken
|
||||||
|
|
||||||
|
[report]
|
||||||
|
ignore_errors = True
|
||||||
72
.gitignore
vendored
72
.gitignore
vendored
@ -1,17 +1,59 @@
|
|||||||
*.py[co]
|
*.py[cod]
|
||||||
*~
|
|
||||||
*.egg-info/
|
|
||||||
build/
|
|
||||||
dist/
|
|
||||||
|
|
||||||
GTAGS
|
# C extensions
|
||||||
GRTAGS
|
*.so
|
||||||
GPATH
|
|
||||||
GSYMS
|
# Packages
|
||||||
*.log
|
*.egg*
|
||||||
.venv/
|
*.egg-info
|
||||||
.tox/
|
dist
|
||||||
.coverage
|
build
|
||||||
covhtml/
|
eggs
|
||||||
coverage.xml
|
parts
|
||||||
|
bin
|
||||||
|
var
|
||||||
|
sdist
|
||||||
|
develop-eggs
|
||||||
|
.installed.cfg
|
||||||
|
lib
|
||||||
|
lib64
|
||||||
|
|
||||||
|
# Installer logs
|
||||||
|
pip-log.txt
|
||||||
|
|
||||||
|
# Unit test / coverage reports
|
||||||
|
cover/
|
||||||
|
.coverage*
|
||||||
|
!.coveragerc
|
||||||
|
.tox
|
||||||
nosetests.xml
|
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?
|
||||||
|
|
||||||
|
# Files created by releasenotes build
|
||||||
|
releasenotes/build
|
||||||
|
|||||||
4
.gitreview
Normal file
4
.gitreview
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
[gerrit]
|
||||||
|
host=review.openstack.org
|
||||||
|
port=29418
|
||||||
|
project=openstack/os-ken.git
|
||||||
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=${OS_TEST_PATH:-./os_ken/tests}
|
||||||
|
top_dir=./
|
||||||
3
.zuul.yaml
Normal file
3
.zuul.yaml
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
- project:
|
||||||
|
templates:
|
||||||
|
- noop-jobs
|
||||||
119
CONTRIBUTING.rst
119
CONTRIBUTING.rst
@ -1,114 +1,15 @@
|
|||||||
*******************************
|
If you would like to contribute to the development of OpenStack, you must
|
||||||
How to Get Your Change Into Ryu
|
follow the steps in this page:
|
||||||
*******************************
|
|
||||||
|
|
||||||
Submitting a change
|
http://docs.openstack.org/infra/manual/developers.html
|
||||||
===================
|
|
||||||
|
|
||||||
Send patches to ryu-devel@lists.sourceforge.net. Please don't use "Pull
|
If you already have a good understanding of how the system works and your
|
||||||
Request" on GitHub. We expect you to send patches in "git-format-patch"
|
OpenStack accounts are set up, you can skip to the development workflow
|
||||||
style.
|
section of this documentation to learn how changes to OpenStack should be
|
||||||
|
submitted for review via the Gerrit tool:
|
||||||
|
|
||||||
.. code-block:: bash
|
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
|
|
||||||
# "N" means the number of commits to be included
|
Pull requests submitted through GitHub will be ignored.
|
||||||
$ git format-patch -s HEAD~N
|
|
||||||
|
|
||||||
# To add cover (e.g., [PATCH 0/X]), specify "--cover-letter" option
|
Bugs should be filed on Launchpad: https://bugs.launchpad.net/neutron
|
||||||
$ git format-patch -s --cover-letter HEAD~N
|
|
||||||
|
|
||||||
# You can send patches by "git send-email" command
|
|
||||||
$ git send-email --to="ryu-devel@lists.sourceforge.net" *.patch
|
|
||||||
|
|
||||||
Please check your changes with autopep8, pycodestyle(pep8) and running
|
|
||||||
unit tests to make sure that they don't break the existing features.
|
|
||||||
The following command does all for you.
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
# Install dependencies of tests
|
|
||||||
$ pip install -r tools/test-requires
|
|
||||||
|
|
||||||
# Execute autopep8
|
|
||||||
# Also, it is convenient to add settings of your editor or IDE for
|
|
||||||
# applying autopep8 automatically.
|
|
||||||
$ autopep8 --recursive --in-place ryu/
|
|
||||||
|
|
||||||
# Execute unit tests and pycodestyle(pep8)
|
|
||||||
$ ./run_tests.sh
|
|
||||||
|
|
||||||
Of course, you are encouraged to add unit tests when you add new
|
|
||||||
features (it's not a must though).
|
|
||||||
|
|
||||||
Python version and libraries
|
|
||||||
============================
|
|
||||||
* Python 2.7, 3.4, 3.5:
|
|
||||||
|
|
||||||
Ryu supports multiple Python version. CI tests on Travis-CI is running
|
|
||||||
on these versions.
|
|
||||||
|
|
||||||
* standard library + widely used library:
|
|
||||||
|
|
||||||
Basically widely used == OpenStack adopted.
|
|
||||||
As usual there are exceptions. Or python binding library for other
|
|
||||||
component.
|
|
||||||
|
|
||||||
Coding style guide
|
|
||||||
==================
|
|
||||||
* pep8:
|
|
||||||
|
|
||||||
As python is used, PEP8 is would be hopefully mandatory for
|
|
||||||
https://www.python.org/dev/peps/pep-0008/
|
|
||||||
|
|
||||||
* pylint:
|
|
||||||
|
|
||||||
Although pylint is useful for finding bugs, but pylint score not very
|
|
||||||
important for now because we're still at early development stage.
|
|
||||||
https://www.pylint.org/
|
|
||||||
|
|
||||||
* Google python style guide is very helpful:
|
|
||||||
http://google.github.io/styleguide/pyguide.html
|
|
||||||
|
|
||||||
* Guidelines derived from Guido's Recommendations:
|
|
||||||
|
|
||||||
============================= ================= ========
|
|
||||||
Type Public Internal
|
|
||||||
============================= ================= ========
|
|
||||||
Packages lower_with_under
|
|
||||||
Modules lower_with_under _lower_with_under
|
|
||||||
Classes CapWords _CapWords
|
|
||||||
Exceptions CapWords
|
|
||||||
Functions lower_with_under() _lower_with_under()
|
|
||||||
Global/Class Constants CAPS_WITH_UNDER _CAPS_WITH_UNDER
|
|
||||||
Global/Class Variables lower_with_under _lower_with_under
|
|
||||||
Instance Variables lower_with_under _lower_with_under (protected) or __lower_with_under (private)
|
|
||||||
Method Names lower_with_under() _lower_with_under() (protected) or __lower_with_under() (private)
|
|
||||||
Function/Method Parameters lower_with_under
|
|
||||||
Local Variables lower_with_under
|
|
||||||
============================= ================= ========
|
|
||||||
|
|
||||||
* OpenStack Nova style guide:
|
|
||||||
https://github.com/openstack/nova/blob/master/HACKING.rst
|
|
||||||
|
|
||||||
* JSON files:
|
|
||||||
|
|
||||||
Ryu source tree has JSON files under ryu/tests/unit/ofproto/json.
|
|
||||||
They are used by unit tests. To make patches easier to read,
|
|
||||||
they are normalized using tools/normalize_json.py. Please re-run
|
|
||||||
the script before committing changes to these JSON files.
|
|
||||||
|
|
||||||
Reference
|
|
||||||
=========
|
|
||||||
* Python Essential Reference, 4th Edition [Amazon]
|
|
||||||
* Paperback: 717 pages
|
|
||||||
* Publisher: Addison-Wesley Professional; 4 edition (July 19, 2009)
|
|
||||||
* Language: English
|
|
||||||
* ISBN-10: 0672329786
|
|
||||||
* ISBN-13: 978-0672329784
|
|
||||||
|
|
||||||
* The Python Standard Library by Example (Developer's Library)
|
|
||||||
* Paperback: 1344 pages
|
|
||||||
* Publisher: Addison-Wesley Professional; 1 edition (June 11, 2011)
|
|
||||||
* Language: English
|
|
||||||
* ISBN-10: 0321767349
|
|
||||||
* ISBN-13: 978-0321767349
|
|
||||||
|
|||||||
4
HACKING.rst
Normal file
4
HACKING.rst
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
os-ken Style Commandments
|
||||||
|
===============================================
|
||||||
|
|
||||||
|
Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/
|
||||||
26
LICENSE
26
LICENSE
@ -174,29 +174,3 @@
|
|||||||
incurred by, or claims asserted against, such Contributor by reason
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
of your accepting any such warranty or additional liability.
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|||||||
76
README.rst
76
README.rst
@ -1,69 +1,13 @@
|
|||||||
What's Ryu
|
======
|
||||||
==========
|
os-ken
|
||||||
Ryu is a component-based software defined networking framework.
|
======
|
||||||
|
|
||||||
Ryu provides software components with well defined API that make it
|
A component-based software defined networking framework in OpenStack.
|
||||||
easy for developers to create new network management and control
|
|
||||||
applications. Ryu supports various protocols for managing network
|
|
||||||
devices, such as OpenFlow, Netconf, OF-config, etc. About OpenFlow,
|
|
||||||
Ryu supports fully 1.0, 1.2, 1.3, 1.4, 1.5 and Nicira Extensions.
|
|
||||||
|
|
||||||
All of the code is freely available under the Apache 2.0 license. Ryu
|
This is a fork of the Ryu library tailored for OpenStack Neutron.
|
||||||
is fully written in Python.
|
|
||||||
|
|
||||||
|
* License: Apache License, Version 2.0
|
||||||
Quick Start
|
* Documentation: https://docs.openstack.org/os-ken/latest/
|
||||||
===========
|
* Source: https://git.openstack.org/cgit/openstack/os-ken
|
||||||
Installing Ryu is quite easy::
|
* Bugs: https://bugs.launchpad.net/os-ken
|
||||||
|
* Release Notes: https://docs.openstack.org/releasenotes/os-ken
|
||||||
% pip install ryu
|
|
||||||
|
|
||||||
If you prefer to install Ryu from the source code::
|
|
||||||
|
|
||||||
% git clone git://github.com/osrg/ryu.git
|
|
||||||
% cd ryu; pip install .
|
|
||||||
|
|
||||||
If you want to write your Ryu application, have a look at
|
|
||||||
`Writing ryu application <http://ryu.readthedocs.io/en/latest/writing_ryu_app.html>`_ document.
|
|
||||||
After writing your application, just type::
|
|
||||||
|
|
||||||
% ryu-manager yourapp.py
|
|
||||||
|
|
||||||
|
|
||||||
Optional Requirements
|
|
||||||
=====================
|
|
||||||
|
|
||||||
Some functionalities of ryu requires extra packages:
|
|
||||||
|
|
||||||
- OF-Config requires lxml and ncclient
|
|
||||||
- NETCONF requires paramiko
|
|
||||||
- BGP speaker (SSH console) requires paramiko
|
|
||||||
- Zebra protocol service (database) requires SQLAlchemy
|
|
||||||
|
|
||||||
If you want to use the functionalities, please install requirements::
|
|
||||||
|
|
||||||
% pip install -r tools/optional-requires
|
|
||||||
|
|
||||||
Please refer to tools/optional-requires for details.
|
|
||||||
|
|
||||||
|
|
||||||
Prerequisites
|
|
||||||
=============
|
|
||||||
If you got some error messages at installation step, please confirm
|
|
||||||
dependencies for building required Python packages.
|
|
||||||
|
|
||||||
On Ubuntu(16.04 LTS or later)::
|
|
||||||
|
|
||||||
% apt install gcc python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev zlib1g-dev
|
|
||||||
|
|
||||||
|
|
||||||
Support
|
|
||||||
=======
|
|
||||||
Ryu Official site is `<http://osrg.github.io/ryu/>`_.
|
|
||||||
|
|
||||||
If you have any
|
|
||||||
questions, suggestions, and patches, the mailing list is available at
|
|
||||||
`ryu-devel ML
|
|
||||||
<https://lists.sourceforge.net/lists/listinfo/ryu-devel>`_.
|
|
||||||
`The ML archive at Gmane <http://dir.gmane.org/gmane.network.ryu.devel>`_
|
|
||||||
is also available.
|
|
||||||
|
|||||||
4
doc/requirements.txt
Normal file
4
doc/requirements.txt
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||||
|
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||||
|
# releasenotes
|
||||||
|
reno>=2.5.0 # Apache-2.0
|
||||||
5
doc/source/admin/index.rst
Normal file
5
doc/source/admin/index.rst
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
====================
|
||||||
|
Administrators guide
|
||||||
|
====================
|
||||||
|
|
||||||
|
Administrators guide of os-ken.
|
||||||
238
doc/source/conf.py
Normal file → Executable file
238
doc/source/conf.py
Normal file → Executable file
@ -1,224 +1,82 @@
|
|||||||
# -*- coding: utf-8 -*-
|
# -*- 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
|
||||||
#
|
#
|
||||||
# ryu documentation build configuration file, created by
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
# sphinx-quickstart on Mon Dec 5 15:38:48 2011.
|
|
||||||
#
|
#
|
||||||
# This file is execfile()d with the current directory set to its containing dir.
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
#
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
# Note that not all possible configuration values are present in this
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
# autogenerated file.
|
# implied.
|
||||||
#
|
# See the License for the specific language governing permissions and
|
||||||
# All configuration values have a default; values that are commented out
|
# limitations under the License.
|
||||||
# serve to show the default.
|
|
||||||
|
|
||||||
import sys, os
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
|
||||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
||||||
sys.path.insert(0, os.path.abspath('../..'))
|
sys.path.insert(0, os.path.abspath('../..'))
|
||||||
sys.path.insert(0, os.path.abspath('.'))
|
# -- General configuration ----------------------------------------------------
|
||||||
|
|
||||||
from ryu import version as ryu_version
|
# 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',
|
||||||
|
]
|
||||||
|
|
||||||
# -- General configuration -----------------------------------------------------
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
|
# text edit cycles.
|
||||||
# If your documentation needs a minimal Sphinx version, state it here.
|
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
||||||
#needs_sphinx = '1.0'
|
|
||||||
|
|
||||||
# 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' ]
|
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
|
||||||
templates_path = ['_templates']
|
|
||||||
|
|
||||||
# The suffix of source filenames.
|
# The suffix of source filenames.
|
||||||
source_suffix = '.rst'
|
source_suffix = '.rst'
|
||||||
|
|
||||||
# The encoding of source files.
|
|
||||||
#source_encoding = 'utf-8-sig'
|
|
||||||
|
|
||||||
# The master toctree document.
|
# The master toctree document.
|
||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'Ryu'
|
project = u'os-ken'
|
||||||
copyright = u'2011-2014 Nippon Telegraph and Telephone Corporation'
|
copyright = u'2018, OpenStack Developers'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# openstackdocstheme options
|
||||||
# |version| and |release|, also used in various other places throughout the
|
repository_name = 'openstack/os-ken'
|
||||||
# built documents.
|
bug_project = 'neutron'
|
||||||
#
|
bug_tag = ''
|
||||||
# The short X.Y version.
|
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||||
version = ryu_version
|
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = ryu_version
|
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
||||||
# for a list of supported languages.
|
|
||||||
#language = None
|
|
||||||
|
|
||||||
# There are two options for replacing |today|: either, you set today to some
|
|
||||||
# non-false value, then it is used:
|
|
||||||
#today = ''
|
|
||||||
# Else, today_fmt is used as the format for a strftime call.
|
|
||||||
#today_fmt = '%B %d, %Y'
|
|
||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and
|
|
||||||
# directories to ignore when looking for source files.
|
|
||||||
exclude_patterns = []
|
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
|
||||||
#default_role = None
|
|
||||||
|
|
||||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
#add_function_parentheses = True
|
add_function_parentheses = True
|
||||||
|
|
||||||
# If true, the current module name will be prepended to all description
|
# If true, the current module name will be prepended to all description
|
||||||
# unit titles (such as .. function::).
|
# unit titles (such as .. function::).
|
||||||
#add_module_names = True
|
add_module_names = True
|
||||||
|
|
||||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
||||||
# output. They are ignored by default.
|
|
||||||
#show_authors = False
|
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting.
|
# -- Options for HTML output --------------------------------------------------
|
||||||
#modindex_common_prefix = []
|
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
# -- Options for HTML output ---------------------------------------------------
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||||
|
# html_theme_path = ["."]
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# html_theme = '_theme'
|
||||||
# a list of builtin themes.
|
# html_static_path = ['static']
|
||||||
html_theme = 'sphinx_rtd_theme'
|
html_theme = 'openstackdocs'
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a theme
|
|
||||||
# further. For a list of options available for each theme, see the
|
|
||||||
# documentation.
|
|
||||||
#html_theme_options = {}
|
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
|
||||||
#html_theme_path = []
|
|
||||||
|
|
||||||
# The name for this set of Sphinx documents. If None, it defaults to
|
|
||||||
# "<project> v<release> documentation".
|
|
||||||
#html_title = None
|
|
||||||
|
|
||||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
||||||
#html_short_title = None
|
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top
|
|
||||||
# of the sidebar.
|
|
||||||
#html_logo = None
|
|
||||||
|
|
||||||
# The name of an image file (within the static path) to use as favicon of the
|
|
||||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
||||||
# pixels large.
|
|
||||||
#html_favicon = None
|
|
||||||
|
|
||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
||||||
html_static_path = ['_static']
|
|
||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
||||||
# using the given strftime format.
|
|
||||||
#html_last_updated_fmt = '%b %d, %Y'
|
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
||||||
# typographically correct entities.
|
|
||||||
#html_use_smartypants = True
|
|
||||||
# (Deprecated since version 1.6)
|
|
||||||
|
|
||||||
# Custom sidebar templates, maps document names to template names.
|
|
||||||
#html_sidebars = {}
|
|
||||||
|
|
||||||
# Additional templates that should be rendered to pages, maps page names to
|
|
||||||
# template names.
|
|
||||||
#html_additional_pages = {}
|
|
||||||
|
|
||||||
# If false, no module index is generated.
|
|
||||||
#html_domain_indices = True
|
|
||||||
|
|
||||||
# If false, no index is generated.
|
|
||||||
#html_use_index = True
|
|
||||||
|
|
||||||
# If true, the index is split into individual pages for each letter.
|
|
||||||
#html_split_index = False
|
|
||||||
|
|
||||||
# If true, links to the reST sources are added to the pages.
|
|
||||||
#html_show_sourcelink = True
|
|
||||||
|
|
||||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
|
||||||
#html_show_sphinx = True
|
|
||||||
|
|
||||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
|
||||||
#html_show_copyright = True
|
|
||||||
|
|
||||||
# If true, an OpenSearch description file will be output, and all pages will
|
|
||||||
# contain a <link> tag referring to it. The value of this option must be the
|
|
||||||
# base URL from which the finished HTML is served.
|
|
||||||
#html_use_opensearch = ''
|
|
||||||
|
|
||||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
|
||||||
#html_file_suffix = None
|
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'ryudoc'
|
htmlhelp_basename = '%sdoc' % project
|
||||||
|
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------------
|
|
||||||
|
|
||||||
# The paper size ('letter' or 'a4').
|
|
||||||
#latex_paper_size = 'letter'
|
|
||||||
|
|
||||||
# The font size ('10pt', '11pt' or '12pt').
|
|
||||||
#latex_font_size = '10pt'
|
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
# (source start file, target name, title, author, documentclass
|
||||||
|
# [howto/manual]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index', 'ryu.tex', u'ryu Documentation',
|
('index',
|
||||||
u'ryu development team', 'manual'),
|
'%s.tex' % project,
|
||||||
|
u'%s Documentation' % project,
|
||||||
|
u'OpenStack Developers', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
# the title page.
|
#intersphinx_mapping = {'http://docs.python.org/': None}
|
||||||
#latex_logo = None
|
|
||||||
|
|
||||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
|
||||||
# not chapters.
|
|
||||||
#latex_use_parts = False
|
|
||||||
|
|
||||||
# If true, show page references after internal links.
|
|
||||||
#latex_show_pagerefs = False
|
|
||||||
|
|
||||||
# If true, show URL addresses after external links.
|
|
||||||
#latex_show_urls = False
|
|
||||||
|
|
||||||
# Additional stuff for the LaTeX preamble.
|
|
||||||
#latex_preamble = ''
|
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals.
|
|
||||||
#latex_appendices = []
|
|
||||||
|
|
||||||
# If false, no module index is generated.
|
|
||||||
#latex_domain_indices = True
|
|
||||||
|
|
||||||
|
|
||||||
# -- Options for manual page output --------------------------------------------
|
|
||||||
|
|
||||||
# One entry per manual page. List of tuples
|
|
||||||
# (source start file, name, description, authors, manual section).
|
|
||||||
man_pages = [
|
|
||||||
('index', 'ryu', u'ryu Documentation',
|
|
||||||
[u'Ryu development team'], 8),
|
|
||||||
('man/ryu', 'ryu', u'management for Ryu application',
|
|
||||||
[u'Ryu development team'], 8),
|
|
||||||
('man/ryu_manager', 'ryu-manager', 'management for Ryu application',
|
|
||||||
[u'Ryu development team'], 8),
|
|
||||||
]
|
|
||||||
|
|||||||
5
doc/source/configuration/index.rst
Normal file
5
doc/source/configuration/index.rst
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
=============
|
||||||
|
Configuration
|
||||||
|
=============
|
||||||
|
|
||||||
|
Configuration of os-ken.
|
||||||
4
doc/source/contributor/contributing.rst
Normal file
4
doc/source/contributor/contributing.rst
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
============
|
||||||
|
Contributing
|
||||||
|
============
|
||||||
|
.. include:: ../../../CONTRIBUTING.rst
|
||||||
9
doc/source/contributor/index.rst
Normal file
9
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
===========================
|
||||||
|
Contributor Documentation
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
contributing
|
||||||
|
|
||||||
@ -1,23 +1,24 @@
|
|||||||
.. ryu documentation master file, created by
|
.. os-ken documentation master file, created by
|
||||||
sphinx-quickstart on Mon Dec 5 15:38:48 2011.
|
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
************************************************
|
======================================
|
||||||
Welcome to RYU the Network Operating System(NOS)
|
Welcome to the documentation of os_ken
|
||||||
************************************************
|
======================================
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
getting_started.rst
|
readme
|
||||||
developing.rst
|
library/index
|
||||||
configuration.rst
|
contributor/index
|
||||||
tests.rst
|
configuration/index
|
||||||
snort_integrate.rst
|
user/index
|
||||||
app.rst
|
admin/index
|
||||||
|
reference/index
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
@ -25,4 +26,3 @@ Indices and tables
|
|||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
||||||
|
|||||||
7
doc/source/library/index.rst
Normal file
7
doc/source/library/index.rst
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
========
|
||||||
|
Usage
|
||||||
|
========
|
||||||
|
|
||||||
|
To use os-ken in a project::
|
||||||
|
|
||||||
|
import os_ken
|
||||||
1
doc/source/readme.rst
Normal file
1
doc/source/readme.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
.. include:: ../../README.rst
|
||||||
5
doc/source/reference/index.rst
Normal file
5
doc/source/reference/index.rst
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
==========
|
||||||
|
References
|
||||||
|
==========
|
||||||
|
|
||||||
|
References of os-ken.
|
||||||
5
doc/source/user/index.rst
Normal file
5
doc/source/user/index.rst
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
===========
|
||||||
|
Users guide
|
||||||
|
===========
|
||||||
|
|
||||||
|
Users guide of os-ken.
|
||||||
19
os_ken/__init__.py
Normal file
19
os_ken/__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(
|
||||||
|
'os-ken').version_string()
|
||||||
0
os_ken/tests/__init__.py
Normal file
0
os_ken/tests/__init__.py
Normal file
23
os_ken/tests/base.py
Normal file
23
os_ken/tests/base.py
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
# Copyright 2010-2011 OpenStack Foundation
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
from oslotest import base
|
||||||
|
|
||||||
|
|
||||||
|
class TestCase(base.BaseTestCase):
|
||||||
|
|
||||||
|
"""Test case base class for all unit tests."""
|
||||||
28
os_ken/tests/test_os_ken.py
Normal file
28
os_ken/tests/test_os_ken.py
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
# -*- 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.
|
||||||
|
|
||||||
|
"""
|
||||||
|
test_os_ken
|
||||||
|
----------------------------------
|
||||||
|
|
||||||
|
Tests for `os_ken` module.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from os_ken.tests import base
|
||||||
|
|
||||||
|
|
||||||
|
class TestOs_ken(base.TestCase):
|
||||||
|
|
||||||
|
def test_something(self):
|
||||||
|
pass
|
||||||
0
releasenotes/notes/.placeholder
Normal file
0
releasenotes/notes/.placeholder
Normal file
0
releasenotes/source/_static/.placeholder
Normal file
0
releasenotes/source/_static/.placeholder
Normal file
0
releasenotes/source/_templates/.placeholder
Normal file
0
releasenotes/source/_templates/.placeholder
Normal file
281
releasenotes/source/conf.py
Normal file
281
releasenotes/source/conf.py
Normal file
@ -0,0 +1,281 @@
|
|||||||
|
# -*- 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.
|
||||||
|
|
||||||
|
# This file is execfile()d with the current directory set to its
|
||||||
|
# containing dir.
|
||||||
|
#
|
||||||
|
# Note that not all possible configuration values are present in this
|
||||||
|
# autogenerated file.
|
||||||
|
#
|
||||||
|
# All configuration values have a default; values that are commented out
|
||||||
|
# serve to show the default.
|
||||||
|
|
||||||
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
# sys.path.insert(0, os.path.abspath('.'))
|
||||||
|
|
||||||
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
|
# needs_sphinx = '1.0'
|
||||||
|
|
||||||
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
|
# ones.
|
||||||
|
extensions = [
|
||||||
|
'openstackdocstheme',
|
||||||
|
'reno.sphinxext',
|
||||||
|
]
|
||||||
|
|
||||||
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
templates_path = ['_templates']
|
||||||
|
|
||||||
|
# The suffix of source filenames.
|
||||||
|
source_suffix = '.rst'
|
||||||
|
|
||||||
|
# The encoding of source files.
|
||||||
|
# source_encoding = 'utf-8-sig'
|
||||||
|
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = 'index'
|
||||||
|
|
||||||
|
# General information about the project.
|
||||||
|
project = u'os_ken Release Notes'
|
||||||
|
copyright = u'2018, OpenStack Developers'
|
||||||
|
|
||||||
|
# openstackdocstheme options
|
||||||
|
repository_name = 'openstack/os-ken'
|
||||||
|
bug_project = 'neutron'
|
||||||
|
bug_tag = ''
|
||||||
|
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||||
|
|
||||||
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
|
# |version| and |release|, also used in various other places throughout the
|
||||||
|
# built documents.
|
||||||
|
#
|
||||||
|
# The short X.Y version.
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = ''
|
||||||
|
# The short X.Y version.
|
||||||
|
version = ''
|
||||||
|
|
||||||
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
# for a list of supported languages.
|
||||||
|
# language = None
|
||||||
|
|
||||||
|
# There are two options for replacing |today|: either, you set today to some
|
||||||
|
# non-false value, then it is used:
|
||||||
|
# today = ''
|
||||||
|
# Else, today_fmt is used as the format for a strftime call.
|
||||||
|
# today_fmt = '%B %d, %Y'
|
||||||
|
|
||||||
|
# List of patterns, relative to source directory, that match files and
|
||||||
|
# directories to ignore when looking for source files.
|
||||||
|
exclude_patterns = []
|
||||||
|
|
||||||
|
# The reST default role (used for this markup: `text`) to use for all
|
||||||
|
# documents.
|
||||||
|
# default_role = None
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||||
|
# output. They are ignored by default.
|
||||||
|
# show_authors = False
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
|
# A list of ignored prefixes for module index sorting.
|
||||||
|
# modindex_common_prefix = []
|
||||||
|
|
||||||
|
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||||
|
# keep_warnings = False
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTML output ----------------------------------------------
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
html_theme = 'openstackdocs'
|
||||||
|
|
||||||
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
|
# further. For a list of options available for each theme, see the
|
||||||
|
# documentation.
|
||||||
|
# html_theme_options = {}
|
||||||
|
|
||||||
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
|
# html_theme_path = []
|
||||||
|
|
||||||
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
|
# "<project> v<release> documentation".
|
||||||
|
# html_title = None
|
||||||
|
|
||||||
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||||
|
# html_short_title = None
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
|
# of the sidebar.
|
||||||
|
# html_logo = None
|
||||||
|
|
||||||
|
# The name of an image file (within the static path) to use as favicon of the
|
||||||
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
|
# pixels large.
|
||||||
|
# html_favicon = None
|
||||||
|
|
||||||
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
|
html_static_path = ['_static']
|
||||||
|
|
||||||
|
# Add any extra paths that contain custom files (such as robots.txt or
|
||||||
|
# .htaccess) here, relative to this directory. These files are copied
|
||||||
|
# directly to the root of the documentation.
|
||||||
|
# html_extra_path = []
|
||||||
|
|
||||||
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
|
# using the given strftime format.
|
||||||
|
# html_last_updated_fmt = '%b %d, %Y'
|
||||||
|
|
||||||
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||||
|
# typographically correct entities.
|
||||||
|
# html_use_smartypants = True
|
||||||
|
|
||||||
|
# Custom sidebar templates, maps document names to template names.
|
||||||
|
# html_sidebars = {}
|
||||||
|
|
||||||
|
# Additional templates that should be rendered to pages, maps page names to
|
||||||
|
# template names.
|
||||||
|
# html_additional_pages = {}
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
# html_domain_indices = True
|
||||||
|
|
||||||
|
# If false, no index is generated.
|
||||||
|
# html_use_index = True
|
||||||
|
|
||||||
|
# If true, the index is split into individual pages for each letter.
|
||||||
|
# html_split_index = False
|
||||||
|
|
||||||
|
# If true, links to the reST sources are added to the pages.
|
||||||
|
# html_show_sourcelink = True
|
||||||
|
|
||||||
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||||
|
# html_show_sphinx = True
|
||||||
|
|
||||||
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||||
|
# html_show_copyright = True
|
||||||
|
|
||||||
|
# If true, an OpenSearch description file will be output, and all pages will
|
||||||
|
# contain a <link> tag referring to it. The value of this option must be the
|
||||||
|
# base URL from which the finished HTML is served.
|
||||||
|
# html_use_opensearch = ''
|
||||||
|
|
||||||
|
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||||
|
# html_file_suffix = None
|
||||||
|
|
||||||
|
# Output file base name for HTML help builder.
|
||||||
|
htmlhelp_basename = 'os_kenReleaseNotesdoc'
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for LaTeX output ---------------------------------------------
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
# The paper size ('letterpaper' or 'a4paper').
|
||||||
|
# 'papersize': 'letterpaper',
|
||||||
|
|
||||||
|
# The font size ('10pt', '11pt' or '12pt').
|
||||||
|
# 'pointsize': '10pt',
|
||||||
|
|
||||||
|
# Additional stuff for the LaTeX preamble.
|
||||||
|
# 'preamble': '',
|
||||||
|
}
|
||||||
|
|
||||||
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
|
# (source start file, target name, title,
|
||||||
|
# author, documentclass [howto, manual, or own class]).
|
||||||
|
latex_documents = [
|
||||||
|
('index', 'os_kenReleaseNotes.tex',
|
||||||
|
u'os_ken Release Notes Documentation',
|
||||||
|
u'OpenStack Foundation', 'manual'),
|
||||||
|
]
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
|
# the title page.
|
||||||
|
# latex_logo = None
|
||||||
|
|
||||||
|
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||||
|
# not chapters.
|
||||||
|
# latex_use_parts = False
|
||||||
|
|
||||||
|
# If true, show page references after internal links.
|
||||||
|
# latex_show_pagerefs = False
|
||||||
|
|
||||||
|
# If true, show URL addresses after external links.
|
||||||
|
# latex_show_urls = False
|
||||||
|
|
||||||
|
# Documents to append as an appendix to all manuals.
|
||||||
|
# latex_appendices = []
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
# latex_domain_indices = True
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for manual page output ---------------------------------------
|
||||||
|
|
||||||
|
# One entry per manual page. List of tuples
|
||||||
|
# (source start file, name, description, authors, manual section).
|
||||||
|
man_pages = [
|
||||||
|
('index', 'os_kenrereleasenotes',
|
||||||
|
u'os_ken Release Notes Documentation',
|
||||||
|
[u'OpenStack Foundation'], 1)
|
||||||
|
]
|
||||||
|
|
||||||
|
# If true, show URL addresses after external links.
|
||||||
|
# man_show_urls = False
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for Texinfo output -------------------------------------------
|
||||||
|
|
||||||
|
# Grouping the document tree into Texinfo files. List of tuples
|
||||||
|
# (source start file, target name, title, author,
|
||||||
|
# dir menu entry, description, category)
|
||||||
|
texinfo_documents = [
|
||||||
|
('index', 'os_ken ReleaseNotes',
|
||||||
|
u'os_ken Release Notes Documentation',
|
||||||
|
u'OpenStack Foundation', 'os_kenReleaseNotes',
|
||||||
|
'One line description of project.',
|
||||||
|
'Miscellaneous'),
|
||||||
|
]
|
||||||
|
|
||||||
|
# Documents to append as an appendix to all manuals.
|
||||||
|
# texinfo_appendices = []
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
# texinfo_domain_indices = True
|
||||||
|
|
||||||
|
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||||
|
# texinfo_show_urls = 'footnote'
|
||||||
|
|
||||||
|
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||||
|
# texinfo_no_detailmenu = False
|
||||||
|
|
||||||
|
# -- Options for Internationalization output ------------------------------
|
||||||
|
locale_dirs = ['locale/']
|
||||||
8
releasenotes/source/index.rst
Normal file
8
releasenotes/source/index.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
============================================
|
||||||
|
os_ken Release Notes
|
||||||
|
============================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
unreleased
|
||||||
5
releasenotes/source/unreleased.rst
Normal file
5
releasenotes/source/unreleased.rst
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
==============================
|
||||||
|
Current Series Release Notes
|
||||||
|
==============================
|
||||||
|
|
||||||
|
.. release-notes::
|
||||||
14
requirements.txt
Normal file
14
requirements.txt
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
# 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.
|
||||||
|
|
||||||
|
pbr>=2.0 # Apache-2.0
|
||||||
|
eventlet!=0.18.3,>=0.18.2,!=0.20.1,!=0.21.0,!=0.23.0
|
||||||
|
msgpack>=0.3.0 # RPC library, BGP speaker(net_cntl)
|
||||||
|
netaddr
|
||||||
|
oslo.config>=2.5.0
|
||||||
|
ovs>=2.6.0 # OVSDB
|
||||||
|
routes # wsgi
|
||||||
|
six>=1.4.0
|
||||||
|
tinyrpc # RPC library, BGP speaker(net_cntl)
|
||||||
|
webob>=1.2 # wsgi
|
||||||
68
setup.cfg
68
setup.cfg
@ -1,57 +1,37 @@
|
|||||||
[metadata]
|
[metadata]
|
||||||
name = ryu
|
name = os-ken
|
||||||
summary = Component-based Software-defined Networking Framework
|
summary = A component-based software defined networking framework for OpenStack.
|
||||||
license = Apache License 2.0
|
description-file =
|
||||||
author = Ryu project team
|
README.rst
|
||||||
author-email = ryu-devel@lists.sourceforge.net
|
author = OpenStack
|
||||||
home-page = http://osrg.github.io/ryu/
|
author-email = openstack-dev@lists.openstack.org
|
||||||
description-file = README.rst
|
home-page = http://www.openstack.org/
|
||||||
platform = any
|
|
||||||
classifier =
|
classifier =
|
||||||
Development Status :: 5 - Production/Stable
|
Environment :: OpenStack
|
||||||
|
Intended Audience :: Information Technology
|
||||||
|
Intended Audience :: System Administrators
|
||||||
License :: OSI Approved :: Apache Software License
|
License :: OSI Approved :: Apache Software License
|
||||||
Topic :: System :: Networking
|
Operating System :: POSIX :: Linux
|
||||||
Natural Language :: English
|
|
||||||
Programming Language :: Python
|
Programming Language :: Python
|
||||||
|
Programming Language :: Python :: 2
|
||||||
Programming Language :: Python :: 2.7
|
Programming Language :: Python :: 2.7
|
||||||
Programming Language :: Python :: 3
|
Programming Language :: Python :: 3
|
||||||
Programming Language :: Python :: 3.4
|
|
||||||
Programming Language :: Python :: 3.5
|
Programming Language :: Python :: 3.5
|
||||||
Programming Language :: Python :: 3.6
|
|
||||||
Programming Language :: Python :: 3.7
|
|
||||||
Operating System :: Unix
|
|
||||||
keywords =
|
|
||||||
openflow
|
|
||||||
openvswitch
|
|
||||||
openstack
|
|
||||||
|
|
||||||
[files]
|
[files]
|
||||||
packages =
|
packages =
|
||||||
ryu
|
os_ken
|
||||||
data_files =
|
|
||||||
etc/ryu =
|
|
||||||
etc/ryu/ryu.conf
|
|
||||||
|
|
||||||
[build_sphinx]
|
[compile_catalog]
|
||||||
all_files = 1
|
directory = os_ken/locale
|
||||||
build-dir = doc/build
|
domain = os_ken
|
||||||
source-dir = doc/source
|
|
||||||
|
|
||||||
[bdist_rpm]
|
[update_catalog]
|
||||||
Release = 1
|
domain = os_ken
|
||||||
Group = Applications/Accessories
|
output_dir = os_ken/locale
|
||||||
Requires = python-eventlet, python-routes, python-webob, python-paramiko, python-netaddr, python-lxml, python-oslo-config, python-msgpack
|
input_file = os_ken/locale/os_ken.pot
|
||||||
doc_files = LICENSE
|
|
||||||
MANIFEST.in
|
|
||||||
README.rst
|
|
||||||
CONTRIBUTING.rst
|
|
||||||
doc/
|
|
||||||
|
|
||||||
[global]
|
[extract_messages]
|
||||||
setup-hooks =
|
keywords = _ gettext ngettext l_ lazy_gettext
|
||||||
ryu.hooks.setup_hook
|
mapping_file = babel.cfg
|
||||||
|
output_file = os_ken/locale/os_ken.pot
|
||||||
[entry_points]
|
|
||||||
console_scripts =
|
|
||||||
ryu-manager = ryu.cmd.manager:main
|
|
||||||
ryu = ryu.cmd.ryu_base:main
|
|
||||||
|
|||||||
23
setup.py
23
setup.py
@ -1,5 +1,4 @@
|
|||||||
# Copyright (C) 2011, 2012 Nippon Telegraph and Telephone Corporation.
|
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
|
||||||
# Copyright (C) 2011 Isaku Yamahata <yamahata at valinux co jp>
|
|
||||||
#
|
#
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
# you may not use this file except in compliance with the License.
|
# you may not use this file except in compliance with the License.
|
||||||
@ -14,17 +13,17 @@
|
|||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
# a bug workaround. http://bugs.python.org/issue15881
|
# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
|
||||||
|
import setuptools
|
||||||
|
|
||||||
|
# In python < 2.7.4, a lazy loading of package `pbr` will break
|
||||||
|
# setuptools if some other modules registered functions in `atexit`.
|
||||||
|
# solution from: http://bugs.python.org/issue15881#msg170215
|
||||||
try:
|
try:
|
||||||
import multiprocessing
|
import multiprocessing # noqa
|
||||||
except ImportError:
|
except ImportError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
import setuptools
|
setuptools.setup(
|
||||||
import ryu.hooks
|
setup_requires=['pbr'],
|
||||||
|
pbr=True)
|
||||||
|
|
||||||
ryu.hooks.save_orig()
|
|
||||||
setuptools.setup(name='ryu',
|
|
||||||
setup_requires=['pbr'],
|
|
||||||
pbr=True)
|
|
||||||
|
|||||||
17
test-requirements.txt
Normal file
17
test-requirements.txt
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# 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>=0.12.0,<0.13 # Apache-2.0
|
||||||
|
|
||||||
|
coverage>=4.0,!=4.4 # Apache-2.0
|
||||||
|
python-subunit>=0.0.18 # Apache-2.0/BSD
|
||||||
|
oslotest>=1.10.0 # Apache-2.0
|
||||||
|
stestr>=1.0.0 # Apache-2.0
|
||||||
|
testtools>=1.4.0 # MIT
|
||||||
|
autopep8
|
||||||
|
mock
|
||||||
|
nose
|
||||||
|
pycodestyle
|
||||||
|
pylint
|
||||||
|
formencode
|
||||||
99
tox.ini
99
tox.ini
@ -1,67 +1,52 @@
|
|||||||
[tox]
|
[tox]
|
||||||
envlist = py27,py34,py35,py36,py37,pypy,pycodestyle,autopep8
|
minversion = 2.0
|
||||||
|
envlist = py35,py27,pep8
|
||||||
|
skipsdist = True
|
||||||
|
|
||||||
[testenv]
|
[testenv]
|
||||||
deps =
|
|
||||||
-U
|
|
||||||
-r{toxinidir}/tools/pip-requires
|
|
||||||
--no-cache-dir
|
|
||||||
usedevelop = True
|
usedevelop = True
|
||||||
passenv= NOSE_VERBOSE
|
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
|
||||||
# Note: To check whether tools/pip-requires satisfies the requirements
|
setenv =
|
||||||
# for running Ryu, the following runs ryu-manager berfore installing
|
VIRTUAL_ENV={envdir}
|
||||||
# the addtional requirements.
|
PYTHONWARNINGS=default::DeprecationWarning
|
||||||
|
OS_STDOUT_CAPTURE=1
|
||||||
|
OS_STDERR_CAPTURE=1
|
||||||
|
OS_TEST_TIMEOUT=60
|
||||||
|
deps = -r{toxinidir}/test-requirements.txt
|
||||||
|
commands = stestr run {posargs}
|
||||||
|
|
||||||
|
[testenv:pep8]
|
||||||
|
commands = flake8 {posargs}
|
||||||
|
|
||||||
|
[testenv:venv]
|
||||||
|
commands = {posargs}
|
||||||
|
|
||||||
|
[testenv:cover]
|
||||||
|
setenv =
|
||||||
|
VIRTUAL_ENV={envdir}
|
||||||
|
PYTHON=coverage run --source os_ken --parallel-mode
|
||||||
commands =
|
commands =
|
||||||
ryu-manager ryu/tests/unit/cmd/dummy_openflow_app.py
|
stestr run {posargs}
|
||||||
pip install -r{toxinidir}/tools/optional-requires -r{toxinidir}/tools/test-requires
|
coverage combine
|
||||||
coverage run --source=ryu ryu/tests/run_tests.py '{posargs}'
|
coverage html -d cover
|
||||||
|
coverage xml -o cover/coverage.xml
|
||||||
|
|
||||||
[testenv:scenario]
|
[testenv:docs]
|
||||||
|
deps = -r{toxinidir}/doc/requirements.txt
|
||||||
|
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||||
|
|
||||||
|
[testenv:releasenotes]
|
||||||
|
deps = {[testenv:docs]deps}
|
||||||
commands =
|
commands =
|
||||||
python ryu/tests/integrated/run_test.py
|
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
||||||
|
|
||||||
[testenv:py27]
|
[testenv:debug]
|
||||||
commands =
|
commands = oslo_debug_helper {posargs}
|
||||||
{[testenv]commands}
|
|
||||||
{[testenv:scenario]commands}
|
|
||||||
|
|
||||||
[testenv:py36]
|
[flake8]
|
||||||
commands =
|
# E123, E125 skipped as they are invalid PEP-8.
|
||||||
{[testenv]commands}
|
|
||||||
{[testenv:scenario]commands}
|
|
||||||
|
|
||||||
[testenv:pycodestyle]
|
show-source = True
|
||||||
deps =
|
ignore = E123,E125
|
||||||
-U
|
builtins = _
|
||||||
--no-cache-dir
|
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build
|
||||||
pycodestyle
|
|
||||||
commands =
|
|
||||||
pycodestyle
|
|
||||||
|
|
||||||
[testenv:autopep8]
|
|
||||||
# If some errors displayed with this test, please reformat codes with the
|
|
||||||
# following command first.
|
|
||||||
# $ autopep8 --recursive --in-place ryu/
|
|
||||||
whitelist_externals=bash
|
|
||||||
deps =
|
|
||||||
-U
|
|
||||||
--no-cache-dir
|
|
||||||
autopep8
|
|
||||||
commands =
|
|
||||||
bash -c 'test -z "$(autopep8 --recursive --diff ryu/)"'
|
|
||||||
|
|
||||||
[pycodestyle]
|
|
||||||
exclude = pbr-*,.venv,.tox,.git,doc,dist,tools,vcsversion.py,.pyc,ryu/contrib
|
|
||||||
# W503: line break before binary operator
|
|
||||||
# W504: line break after binary operator
|
|
||||||
# E116: unexpected indentation (comment)
|
|
||||||
# E402: module level import not at top of file
|
|
||||||
# E501: line too long (>79 characters)
|
|
||||||
# E722: do not use bare except, specify exception instead
|
|
||||||
# E731: do not assign a lambda expression, use a def
|
|
||||||
# E741: do not use variables named 'l', 'O', or 'I'
|
|
||||||
ignore = W503,W504,E116,E402,E501,E722,E731,E741
|
|
||||||
|
|
||||||
[pep8]
|
|
||||||
exclude = pbr-*,.venv,.tox,.git,doc,dist,tools,vcsversion.py,.pyc,ryu/contrib
|
|
||||||
ignore = W503,E116,E402,E501,E722,E731,E741
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user