Browse Source

Cookiecutter commit

Change-Id: I9237adf2c01e0b10bd23eaac59d4bb33bc94fe93
Graham Hayes 3 years ago
parent
commit
68efa29e49
21 changed files with 660 additions and 0 deletions
  1. 36
    0
      .gitignore
  2. 3
    0
      .mailmap
  3. 7
    0
      .testr.conf
  4. 21
    0
      CONTRIBUTING.rst
  5. 3
    0
      LICENSE
  6. 6
    0
      MANIFEST.in
  7. 13
    0
      README.rst
  8. 93
    0
      doc/source/conf.py
  9. 21
    0
      doc/source/contributing.rst
  10. 33
    0
      doc/source/index.rst
  11. 13
    0
      doc/source/readme.rst
  12. 1
    0
      doc/source/specs
  13. 86
    0
      doc/source/template.rst
  14. 4
    0
      requirements.txt
  15. 24
    0
      setup.cfg
  16. 22
    0
      setup.py
  17. 0
    0
      specs/.gitignore
  18. 163
    0
      specs/liberty/placeholder.rst
  19. 86
    0
      template.rst
  20. 0
    0
      test-requirements.txt
  21. 25
    0
      tox.ini

+ 36
- 0
.gitignore View File

@@ -0,0 +1,36 @@
1
+*.py[cod]
2
+
3
+# Packages
4
+*.egg
5
+*.egg-info
6
+dist
7
+build
8
+eggs
9
+parts
10
+sdist
11
+develop-eggs
12
+.installed.cfg
13
+
14
+# Installer logs
15
+pip-log.txt
16
+
17
+# Unit test / coverage reports
18
+.tox
19
+nosetests.xml
20
+.testrepository
21
+
22
+# Mr Developer
23
+.mr.developer.cfg
24
+.project
25
+.pydevproject
26
+
27
+# Sphinx
28
+doc/build
29
+
30
+# pbr generates these
31
+AUTHORS
32
+ChangeLog
33
+
34
+# Editors
35
+*~
36
+.*.swp

+ 3
- 0
.mailmap View File

@@ -0,0 +1,3 @@
1
+# Format is:
2
+# <preferred e-mail> <other e-mail 1>
3
+# <preferred e-mail> <other e-mail 2>

+ 7
- 0
.testr.conf View File

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

+ 21
- 0
CONTRIBUTING.rst View File

@@ -0,0 +1,21 @@
1
+=============================================
2
+Contributing to: kosmos-specs
3
+=============================================
4
+
5
+If you would like to contribute to the development of OpenStack, you must
6
+follow the steps in this page:
7
+
8
+   http://docs.openstack.org/infra/manual/developers.html
9
+
10
+If you already have a good understanding of how the system works and your
11
+OpenStack accounts are set up, you can skip to the development workflow
12
+section of this documentation to learn how changes to OpenStack should be
13
+submitted for review via the Gerrit tool:
14
+
15
+   http://docs.openstack.org/infra/manual/developers.html#development-workflow
16
+
17
+Pull requests submitted through GitHub will be ignored.
18
+
19
+Bugs should be filed on Launchpad, not GitHub:
20
+
21
+   https://bugs.launchpad.net/kosmos

+ 3
- 0
LICENSE View File

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

+ 6
- 0
MANIFEST.in View File

@@ -0,0 +1,6 @@
1
+include AUTHORS
2
+include ChangeLog
3
+exclude .gitignore
4
+exclude .gitreview
5
+
6
+global-exclude *.pyc

+ 13
- 0
README.rst View File

@@ -0,0 +1,13 @@
1
+===============================
2
+kosmos-specs
3
+===============================
4
+
5
+Specifications for the Kosmos Project (Global Load Balancing)
6
+
7
+* Free software: Apache license
8
+* Documentation: http://docs.openstack.org/developer/kosmos-specs
9
+
10
+Features
11
+--------
12
+
13
+* TODO

+ 93
- 0
doc/source/conf.py View File

@@ -0,0 +1,93 @@
1
+# -*- coding: utf-8 -*-
2
+# Licensed under the Apache License, Version 2.0 (the "License");
3
+# you may not use this file except in compliance with the License.
4
+# You may obtain a copy of the License at
5
+#
6
+#    http://www.apache.org/licenses/LICENSE-2.0
7
+#
8
+# Unless required by applicable law or agreed to in writing, software
9
+# distributed under the License is distributed on an "AS IS" BASIS,
10
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11
+# implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+
15
+import datetime
16
+import os
17
+import sys
18
+
19
+sys.path.insert(0, os.path.abspath('../..'))
20
+# -- General configuration ----------------------------------------------------
21
+
22
+# Add any Sphinx extension module names here, as strings. They can be
23
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
24
+extensions = [
25
+    'sphinx.ext.autodoc',
26
+    #'sphinx.ext.intersphinx',
27
+    'oslosphinx',
28
+    'yasfb',
29
+]
30
+
31
+# Feed configuration for yasfb
32
+feed_base_url = 'http://specs.openstack.org/openstack/kosmos-specs'
33
+feed_author = 'OpenStack Development Team'
34
+
35
+exclude_patterns = [
36
+    'template.rst',
37
+]
38
+
39
+# Optionally allow the use of sphinxcontrib.spelling to verify the
40
+# spelling of the documents.
41
+try:
42
+    import sphinxcontrib.spelling
43
+    extensions.append('sphinxcontrib.spelling')
44
+except ImportError:
45
+    pass
46
+
47
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
48
+# text edit cycles.
49
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
50
+
51
+# The suffix of source filenames.
52
+source_suffix = '.rst'
53
+
54
+# The master toctree document.
55
+master_doc = 'index'
56
+
57
+# General information about the project.
58
+project = u'kosmos-specs'
59
+copyright = u'%s, OpenStack Foundation' % datetime.date.today().year
60
+
61
+# If true, '()' will be appended to :func: etc. cross-reference text.
62
+add_function_parentheses = True
63
+
64
+# If true, the current module name will be prepended to all description
65
+# unit titles (such as .. function::).
66
+add_module_names = True
67
+
68
+# The name of the Pygments (syntax highlighting) style to use.
69
+pygments_style = 'sphinx'
70
+
71
+# -- Options for HTML output --------------------------------------------------
72
+
73
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
74
+# Sphinx are currently 'default' and 'sphinxdoc'.
75
+# html_theme_path = ["."]
76
+# html_theme = '_theme'
77
+# html_static_path = ['static']
78
+
79
+# Output file base name for HTML help builder.
80
+htmlhelp_basename = '%sdoc' % project
81
+
82
+# Grouping the document tree into LaTeX files. List of tuples
83
+# (source start file, target name, title, author, documentclass
84
+# [howto/manual]).
85
+latex_documents = [
86
+    ('index',
87
+     '%s.tex' % project,
88
+     u'%s Documentation' % project,
89
+     u'OpenStack Foundation', 'manual'),
90
+]
91
+
92
+# Example configuration for intersphinx: refer to the Python standard library.
93
+#intersphinx_mapping = {'http://docs.python.org/': None}

+ 21
- 0
doc/source/contributing.rst View File

@@ -0,0 +1,21 @@
1
+=============================================
2
+Contributing to: kosmos-specs
3
+=============================================
4
+
5
+If you would like to contribute to the development of OpenStack, you must
6
+follow the steps in this page:
7
+
8
+   http://docs.openstack.org/infra/manual/developers.html
9
+
10
+If you already have a good understanding of how the system works and your
11
+OpenStack accounts are set up, you can skip to the development workflow
12
+section of this documentation to learn how changes to OpenStack should be
13
+submitted for review via the Gerrit tool:
14
+
15
+   http://docs.openstack.org/infra/manual/developers.html#development-workflow
16
+
17
+Pull requests submitted through GitHub will be ignored.
18
+
19
+Bugs should be filed on Launchpad, not GitHub:
20
+
21
+   https://bugs.launchpad.net/kosmos

+ 33
- 0
doc/source/index.rst View File

@@ -0,0 +1,33 @@
1
+.. kosmos-specs documentation master file, created by
2
+   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
3
+   You can adapt this file completely to your liking, but it should at least
4
+   contain the root `toctree` directive.
5
+
6
+kosmos-specs Design Specifications
7
+==================================================
8
+
9
+Liberty approved specs:
10
+
11
+.. toctree::
12
+   :glob:
13
+   :maxdepth: 1
14
+
15
+   specs/liberty/*
16
+
17
+
18
+kosmos-specs Repository Information
19
+===================================================
20
+
21
+.. toctree::
22
+   :maxdepth: 2
23
+
24
+   README <readme>
25
+   contributing
26
+
27
+
28
+Indices and tables
29
+==================
30
+
31
+* :ref:`genindex`
32
+* :ref:`modindex`
33
+* :ref:`search`

+ 13
- 0
doc/source/readme.rst View File

@@ -0,0 +1,13 @@
1
+===============================
2
+kosmos-specs
3
+===============================
4
+
5
+Specifications for the Kosmos Project (Global Load Balancing)
6
+
7
+* Free software: Apache license
8
+* Documentation: http://docs.openstack.org/developer/kosmos-specs
9
+
10
+Features
11
+--------
12
+
13
+* TODO

+ 1
- 0
doc/source/specs View File

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

+ 86
- 0
doc/source/template.rst View File

@@ -0,0 +1,86 @@
1
+..
2
+
3
+This work is licensed under a Creative Commons Attribution 3.0 Unported License.
4
+http://creativecommons.org/licenses/by/3.0/legalcode
5
+
6
+..
7
+  This template should be in ReSTructured text. The filename in the git
8
+  repository should match the launchpad URL, for example a URL of
9
+  https://blueprints.launchpad.net/kosmos/+spec/awesome-thing should be named
10
+  awesome-thing.rst .  Please do not delete any of the sections in this
11
+  template.  If you have nothing to say for a whole section, just write: None
12
+  For help with syntax, see http://sphinx-doc.org/rest.html
13
+  To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html
14
+
15
+=============================
16
+ The title of your blueprint
17
+=============================
18
+
19
+Include the URL of your launchpad blueprint:
20
+
21
+https://blueprints.launchpad.net//+spec/example
22
+
23
+Introduction paragraph -- why are we doing anything?
24
+
25
+Problem description
26
+===================
27
+
28
+A detailed description of the problem.
29
+
30
+Proposed change
31
+===============
32
+
33
+Here is where you cover the change you propose to make in detail. How do you
34
+propose to solve this problem?
35
+
36
+If this is one part of a larger effort make it clear where this piece ends. In
37
+other words, what's the scope of this effort?
38
+
39
+Include where in the kosmos tree hierarchy this will reside.
40
+
41
+Alternatives
42
+------------
43
+
44
+This is an optional section, where it does apply we'd just like a demonstration
45
+that some thought has been put into why the proposed approach is the best one.
46
+
47
+Implementation
48
+==============
49
+
50
+Assignee(s)
51
+-----------
52
+
53
+Who is leading the writing of the code? Or is this a blueprint where you're
54
+throwing it out there to see who picks it up?
55
+
56
+If more than one person is working on the implementation, please designate the
57
+primary author and contact.
58
+
59
+Primary assignee:
60
+  <launchpad-id or None>
61
+
62
+Can optionally can list additional ids if they intend on doing
63
+substantial implementation work on this blueprint.
64
+
65
+Milestones
66
+----------
67
+
68
+Target Milestone for completion:
69
+  Juno-1
70
+
71
+Work Items
72
+----------
73
+
74
+Work items or tasks -- break the feature up into the things that need to be
75
+done to implement it. Those parts might end up being done by different people,
76
+but we're mostly trying to understand the timeline for implementation.
77
+
78
+
79
+Dependencies
80
+============
81
+
82
+- Include specific references to specs and/or blueprints in kosmos, or in other
83
+  projects, that this one either depends on or is related to.
84
+
85
+- Does this feature require any new library dependencies or code otherwise not
86
+  included in OpenStack? Or does it depend on a specific version of library?

+ 4
- 0
requirements.txt View File

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

+ 24
- 0
setup.cfg View File

@@ -0,0 +1,24 @@
1
+[metadata]
2
+name = kosmos-specs
3
+summary = Specifications for the Kosmos Project (Global Load Balancing)
4
+description-file =
5
+    README.rst
6
+author = OpenStack
7
+author-email = openstack-dev@lists.openstack.org
8
+home-page = http://www.openstack.org/
9
+classifier =
10
+    Environment :: OpenStack
11
+    Intended Audience :: Developers
12
+    License :: OSI Approved :: Apache Software License
13
+    Operating System :: POSIX :: Linux
14
+
15
+[build_sphinx]
16
+source-dir = doc/source
17
+build-dir = doc/build
18
+all_files = 1
19
+
20
+[pbr]
21
+warnerrors = True
22
+
23
+[upload_sphinx]
24
+upload-dir = doc/build/html

+ 22
- 0
setup.py View File

@@ -0,0 +1,22 @@
1
+#!/usr/bin/env python
2
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
3
+#
4
+# Licensed under the Apache License, Version 2.0 (the "License");
5
+# you may not use this file except in compliance with the License.
6
+# You may obtain a copy of the License at
7
+#
8
+#    http://www.apache.org/licenses/LICENSE-2.0
9
+#
10
+# Unless required by applicable law or agreed to in writing, software
11
+# distributed under the License is distributed on an "AS IS" BASIS,
12
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13
+# implied.
14
+# See the License for the specific language governing permissions and
15
+# limitations under the License.
16
+
17
+# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
18
+import setuptools
19
+
20
+setuptools.setup(
21
+    setup_requires=['pbr'],
22
+    pbr=True)

+ 0
- 0
specs/.gitignore View File


+ 163
- 0
specs/liberty/placeholder.rst View File

@@ -0,0 +1,163 @@
1
+..
2
+
3
+This work is licensed under a Creative Commons Attribution 3.0 Unported License.
4
+http://creativecommons.org/licenses/by/3.0/legalcode
5
+
6
+..
7
+  This template should be in ReSTructured text. The filename in the git
8
+  repository should match the launchpad URL, for example a URL of
9
+  https://blueprints.launchpad.net/gslb/+spec/awesome-thing should be named
10
+  awesome-thing.rst .  Please do not delete any of the sections in this
11
+  template.  If you have nothing to say for a whole section, just write: None
12
+  For help with syntax, see http://sphinx-doc.org/rest.html
13
+  To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html
14
+
15
+=============================
16
+ The title of your blueprint
17
+=============================
18
+
19
+Include the URL of your launchpad blueprint:
20
+
21
+https://blueprints.launchpad.net/kosmos/+spec/example
22
+
23
+Introduction paragraph -- why are we doing anything?
24
+
25
+
26
+Problem description
27
+===================
28
+
29
+A detailed description of the problem.
30
+
31
+Proposed change
32
+===============
33
+
34
+Here is where you cover the change you propose to make in detail. How do you
35
+propose to solve this problem?
36
+
37
+If this is one part of a larger effort make it clear where this piece ends. In
38
+other words, what's the scope of this effort?
39
+
40
+Include where in the designate tree hierarchy this will reside.
41
+
42
+API Changes
43
+-----------
44
+
45
+Include API Changes here. If you are adding endpoints / add major modifications
46
+please ensure you have examples for calls / results - eg:
47
+
48
+POST /v2/doohickey
49
+^^^^^^^^^^^^^^^^^^
50
+
51
+This creates a doohicky.
52
+
53
+It returns an ID and the doohickey
54
+
55
+.. code-block:: http
56
+
57
+    POST /v2/doohickey HTTP/1.1
58
+    Accept: application/json
59
+    Content-Type: application/json
60
+
61
+    {
62
+        "doohickey":{
63
+            "foo":"bar"
64
+        }
65
+    }
66
+
67
+    HTTP/1.1 201 Created
68
+    Content-Type: application/json; charset=UTF-8
69
+    Location: /v2/doohickey/cddda8f0-f558-11e3-a3ac-0800200c9a66
70
+
71
+    {
72
+        "doohickey":{
73
+            "id":"cddda8f0-f558-11e3-a3ac-0800200c9a66",
74
+            "foo":"bar",
75
+            "links":{
76
+                "self" : "/v2/doohickey/cddda8f0-f558-11e3-a3ac-0800200c9a66"
77
+            }
78
+        }
79
+    }
80
+
81
+It may be usefull to add a table with the parameters, and a info about them
82
+
83
++-----------+--------------------------------+----------+
84
+| Parameter | Description                    | Required |
85
++===========+================================+==========+
86
+| foo       | the foo value for the doohicky | Yes      |
87
++-----------+--------------------------------+----------+
88
+
89
+Central Changes
90
+---------------
91
+
92
+Any changes to the central service
93
+
94
+Storage Changes
95
+---------------
96
+
97
+Any changes to the DB. This should be a table (if creating a new table)
98
+eg:
99
+
100
+
101
+New Table - DooHickey
102
+^^^^^^^^^^^^^^^^^^^^^
103
+
104
++-----+---------+-----------+---------+
105
+| Row | Type    | Nullable? | Unique? |
106
++=====+=========+===========+=========+
107
+| id  | uuid    | No        | Yes     |
108
++-----+---------+-----------+---------+
109
+| foo | VARCHAR | No        | No      |
110
++-----+---------+-----------+---------+
111
+
112
+Other Changes
113
+-------------
114
+
115
+Any other changes to Designate, broken down by which sub system is being
116
+changed
117
+
118
+Alternatives
119
+------------
120
+
121
+This is an optional section, where it does apply we'd just like a demonstration
122
+that some thought has been put into why the proposed approach is the best one.
123
+
124
+Implementation
125
+==============
126
+
127
+Assignee(s)
128
+-----------
129
+
130
+Who is leading the writing of the code? Or is this a blueprint where you're
131
+throwing it out there to see who picks it up?
132
+
133
+If more than one person is working on the implementation, please designate the
134
+primary author and contact.
135
+
136
+Primary assignee:
137
+  <launchpad-id or None>
138
+
139
+Can optionally can list additional ids if they intend on doing
140
+substantial implementation work on this blueprint.
141
+
142
+Milestones
143
+----------
144
+
145
+Target Milestone for completion:
146
+  Juno-1
147
+
148
+Work Items
149
+----------
150
+
151
+Work items or tasks -- break the feature up into the things that need to be
152
+done to implement it. Those parts might end up being done by different people,
153
+but we're mostly trying to understand the timeline for implementation.
154
+
155
+
156
+Dependencies
157
+============
158
+
159
+- Include specific references to specs and/or blueprints in designate, or in other
160
+  projects, that this one either depends on or is related to.
161
+
162
+- Does this feature require any new library dependencies or code otherwise not
163
+  included in OpenStack? Or does it depend on a specific version of library?

+ 86
- 0
template.rst View File

@@ -0,0 +1,86 @@
1
+..
2
+
3
+This work is licensed under a Creative Commons Attribution 3.0 Unported License.
4
+http://creativecommons.org/licenses/by/3.0/legalcode
5
+
6
+..
7
+  This template should be in ReSTructured text. The filename in the git
8
+  repository should match the launchpad URL, for example a URL of
9
+  https://blueprints.launchpad.net/kosmos/+spec/awesome-thing should be named
10
+  awesome-thing.rst .  Please do not delete any of the sections in this
11
+  template.  If you have nothing to say for a whole section, just write: None
12
+  For help with syntax, see http://sphinx-doc.org/rest.html
13
+  To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html
14
+
15
+=============================
16
+ The title of your blueprint
17
+=============================
18
+
19
+Include the URL of your launchpad blueprint:
20
+
21
+https://blueprints.launchpad.net//+spec/example
22
+
23
+Introduction paragraph -- why are we doing anything?
24
+
25
+Problem description
26
+===================
27
+
28
+A detailed description of the problem.
29
+
30
+Proposed change
31
+===============
32
+
33
+Here is where you cover the change you propose to make in detail. How do you
34
+propose to solve this problem?
35
+
36
+If this is one part of a larger effort make it clear where this piece ends. In
37
+other words, what's the scope of this effort?
38
+
39
+Include where in the kosmos tree hierarchy this will reside.
40
+
41
+Alternatives
42
+------------
43
+
44
+This is an optional section, where it does apply we'd just like a demonstration
45
+that some thought has been put into why the proposed approach is the best one.
46
+
47
+Implementation
48
+==============
49
+
50
+Assignee(s)
51
+-----------
52
+
53
+Who is leading the writing of the code? Or is this a blueprint where you're
54
+throwing it out there to see who picks it up?
55
+
56
+If more than one person is working on the implementation, please designate the
57
+primary author and contact.
58
+
59
+Primary assignee:
60
+  <launchpad-id or None>
61
+
62
+Can optionally can list additional ids if they intend on doing
63
+substantial implementation work on this blueprint.
64
+
65
+Milestones
66
+----------
67
+
68
+Target Milestone for completion:
69
+  Juno-1
70
+
71
+Work Items
72
+----------
73
+
74
+Work items or tasks -- break the feature up into the things that need to be
75
+done to implement it. Those parts might end up being done by different people,
76
+but we're mostly trying to understand the timeline for implementation.
77
+
78
+
79
+Dependencies
80
+============
81
+
82
+- Include specific references to specs and/or blueprints in kosmos, or in other
83
+  projects, that this one either depends on or is related to.
84
+
85
+- Does this feature require any new library dependencies or code otherwise not
86
+  included in OpenStack? Or does it depend on a specific version of library?

+ 0
- 0
test-requirements.txt View File


+ 25
- 0
tox.ini View File

@@ -0,0 +1,25 @@
1
+[tox]
2
+minversion = 1.6
3
+envlist = docs
4
+skipsdist = True
5
+
6
+[testenv]
7
+usedevelop = True
8
+install_command = pip install -U {opts} {packages}
9
+setenv =
10
+   VIRTUAL_ENV={envdir}
11
+deps = -r{toxinidir}/requirements.txt
12
+       -r{toxinidir}/test-requirements.txt
13
+
14
+[testenv:venv]
15
+commands = {posargs}
16
+
17
+[testenv:docs]
18
+commands = python setup.py build_sphinx
19
+
20
+[testenv:spelling]
21
+deps =
22
+   -r{toxinidir}/requirements.txt
23
+   sphinxcontrib-spelling
24
+   PyEnchant
25
+commands = sphinx-build -b spelling doc/source doc/build/spelling

Loading…
Cancel
Save