x/group-based-policy-specs
Code Issues Proposed changes

tox doesn't fail anymore at the py27 environment

Browse Source 
This patch fixes existing specs to totally conform to tox py27 environment
tests as specified by tests/test_titles.py. Semantic information of all
existing specs has not been changed.

Specifically, this patch makes the following changes:
* Fixes all titles and subtitles' capitalization inconsistencies:
  defaulting to only having the first word being capitalized (this seems
  to be the general rule in group-based-policy-specs);
* Adds missing titles and subtitles to some specs;
* Changes tests/test_titles.py for consistency: only 1st word capitalized;
* Changes tests/tests_titles.py: subtitle count inside Testing or
  Documentation impact no longer restricted to 0.

Change-Id: I88e30b0825f5279a8c6808fd9a2fc2987b6611f9
Closes-Bug: #1437282
This commit is contained in:
Igor Duarte Cardoso 2015-03-27 13:54:31 +00:00
parent 5a66a2b400
commit de694f7164
18 changed files with 119 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
specs/juno/example.rst
View File

@ -275,7 +275,7 @@ Aside from the API, are there other ways a user will interact with this feature?
* Does this change have an impact on python client? What does the user
interface there look like?
Performance Impact
Performance impact
------------------
Describe any potential performance impact on the system, for example
@ -349,7 +349,7 @@ Primary assignee:
Other contributors:
<launchpad-id or None>
Work Items
Work items
----------
Work items or tasks -- break the feature up into the things that need to be
@ -385,7 +385,7 @@ software configurations available)? If so, are there mitigation plans (3rd
party testing, gate enhancements, etc).
Documentation Impact
Documentation impact
====================
What is the impact on the docs team of this change? Some changes might require

6
specs/juno/external-connectivity.rst
View File

@ -307,7 +307,7 @@ Other end user impact
The python client and the UI have to expose the new model
to the end user.
Performance Impact
Performance impact
------------------
None
@ -334,7 +334,7 @@ Primary assignee:
Other contributors:
None
Work Items
Work items
----------
- Database and API;
@ -354,7 +354,7 @@ New unit tests will be added for the external connectivity extension
itself, and existing unit tests for the mapping will be updated
when needed.
Documentation Impact
Documentation impact
====================
Eventual GBP documentation will need to address configuration

6
specs/juno/gbp-extension-drivers.rst
View File

@ -136,7 +136,7 @@ The python client will need to handle the possibility that different
extensions are available based on which extension drivers are
configured.
Performance Impact
Performance impact
------------------
This blueprint should have minimal impact on performance. The GBP
@ -170,7 +170,7 @@ Primary assignee:
Other contributors:
None
Work Items
Work items
----------
* Port extension driver API and unit tests from ML2 to GBP, with
@ -198,7 +198,7 @@ New unit tests will be added for the extension driver framework
itself, and existing unit tests for the mapping will be updated to
configure the required extension driver(s).
Documentation Impact
Documentation impact
====================
Eventual GBP documentation will need to address configuring extension

6
specs/juno/gbp-oc-nvsd-driver.rst
View File

@ -64,7 +64,7 @@ Other end user impact
The driver will reuse the configuration for NVSD Neutron plugin [2] to access
the NVSD controller.
Performance Impact
Performance impact
------------------
This driver should allow for a more scalable solution of GBP deployments
@ -92,7 +92,7 @@ Hemanth Ravi (hemanthravi)
Subrahmanyam Ongole (songole)
Work Items
Work items
----------
1. Developing the NVSD GBP driver
@ -110,7 +110,7 @@ Unit tests will be provided.
The 3rd party One Convergence CI setup will be enhanced to cover the
testing of NVSD GBP driver using the NVSD controller.
Documentation Impact
Documentation impact
====================
Documentation needs to be updated to reflect the addition of a new

6
specs/juno/gbp-oc-nvsd-servicechain-driver.rst
View File

@ -67,7 +67,7 @@ Other end user impact
The driver will reuse the configuration for NVSD Neutron plugin [2] to access
the NVSD controller.
Performance Impact
Performance impact
------------------
This driver should allow for a more extensive rendering of GBP Service Chain
@ -97,7 +97,7 @@ Hemanth Ravi (hemanth-ravi)
Subrahmanyam Ongole (songole)
Work Items
Work items
----------
1. Developing the NVSD GBP Service Chain driver
@ -116,7 +116,7 @@ Unit tests will be provided.
The 3rd party One Convergence CI setup will be enhanced to cover the
testing of NVSD GBP Service Chain driver using the NVSD controller.
Documentation Impact
Documentation impact
====================
Documentation needs to be updated to reflect the addition of a new

8
specs/juno/gbp-odl-policy-driver.rst
View File

@ -30,7 +30,7 @@ The proposed change will:
2. Add a new ODL GBP Mechanism Driver for Neutron ML2 Plugin. Such a mechanism driver will provide a feedback loop to the ODL GBP Policy Mapping Driver to trigger policy target related operations when a VM is plugged into the Neutron port.
Alternative
Alternatives
------------
There are no alternatives to leverage the native GBP API in ODL.
@ -56,7 +56,7 @@ Other end user impact
Users deploying OpenStack with the Group Based Policy extensions will be able to
utilze these new APIs in conjunction with the Helium version of OpenDaylight.
Performance Impact
Performance impact
------------------
No change here.
@ -80,7 +80,7 @@ Stephen Wong (s3wong)
YaPeng Wu
Yi Yang
Work Items
Work items
----------
1. Add an OpenDaylight policy mapping driver to support Group Based Policy APIs
2. Add an OpenDaylight GBP Mechanism Driver for Neutron ML2 Plugin
@ -93,7 +93,7 @@ Testing
=======
Additional unit tests will be added. Furthermore, ODL policy driver should be added as part of OpenStack GBP's CI system
Documentation Impact
Documentation impact
====================
None

6
specs/juno/group-based-policy-abstraction.rst
View File

@ -854,7 +854,7 @@ Integration with following projects will be required:
* heat
* devstack
Performance Impact
Performance impact
------------------
A new layer of abstraction is being introduced. All performance considerations
@ -912,7 +912,7 @@ Assignee(s)
Kevin Benton (kevinbenton)
Work Items
Work items
----------
Policy Manager
@ -928,7 +928,7 @@ Testing
Both, functional and, system tests will be added.
Documentation Impact
Documentation impact
====================
Both, API and, Admin guide will be updated.

57
specs/juno/group-based-policy-automation.rst
View File

@ -45,6 +45,46 @@ Alternatives
None
Data model impact
-----------------
None
REST API impact
---------------
None
Security impact
---------------
None
Notifications impact
--------------------
None
Other end user impact
---------------------
None
Performance impact
------------------
None
Other deployer impact
---------------------
None
Developer impact
----------------
None
Implementation
==============
@ -53,7 +93,7 @@ Assignee(s)
Susaant Kondapaneni (susaant)
Work Items
Work items
----------
1. Implement resources for Endpoint, EndpointGroup, L3Policy and L2Policy
@ -65,3 +105,18 @@ Dependencies
============
- [1] Group-based policy abstractions: https://review.openstack.org/#/c/123494
Testing
=======
None
Documentation impact
====================
None
References
==========
None

6
specs/juno/group-based-policy-service-chaining.rst
View File

@ -255,7 +255,7 @@ Other end user impact
(configuration of service-chain-providers will be specific to
service-chain-providers and is not in the scope of this BP).
Performance Impact
Performance impact
------------------
No significant performance impact is expected.
@ -291,7 +291,7 @@ framework:
Sumit Naiksatam (snaiksat)
Work Items
Work items
----------
1. Build API
@ -310,7 +310,7 @@ Testing
Unit Tests will be provided.
Documentation Impact
Documentation impact
====================
Documentation will need to be updated for:

6
specs/juno/group-policy-apic-driver.rst
View File

@ -64,7 +64,7 @@ These parameters include the addresses, credentials, and any configuration
required for accessing or using the APIC controller. Where possible, it
will share the configuration with APIC ML2 driver.
Performance Impact
Performance impact
------------------
This driver should allow for more efficient and scalable solution
@ -92,7 +92,7 @@ Mandeep Dhami (mandeep-dhami)
Ivar Lazzaro (mmaleckk)
Work Items
Work items
----------
1. Developing the APIC GBP driver
@ -111,7 +111,7 @@ Since access to an APIC controller is required for testing the
proposed changes, 3rd party testing is required and will be
provided by Cisco CI system.
Documentation Impact
Documentation impact
====================
Documentation needs to be updated to reflect the addition of a new

6
specs/juno/introduce-shared-attribute.rst
View File

@ -174,7 +174,7 @@ Other end user impact
The end user will now be able to see and consume
shared resources.
Performance Impact
Performance impact
------------------
This blueprint does not have significant impact on performance.
@ -203,7 +203,7 @@ Primary assignee:
Other contributors:
None
Work Items
Work items
----------
* Add resource attribute to REST API;
@ -223,7 +223,7 @@ Testing
Unit tests will be added to verify the resource visibility
and usability.
Documentation Impact
Documentation impact
====================
Eventual GBP documentation will need to provide explanations

6
specs/juno/nuage-group-policy-driver.rst
View File

@ -61,7 +61,7 @@ Other end user impact
None
Performance Impact
Performance impact
------------------
This driver should allow for more efficient and scalable solution
@ -91,7 +91,7 @@ Assignee(s)
Ronak Shah (ronak-malav-shah)
Work Items
Work items
----------
1. Developing the Nuage GBP driver
@ -108,7 +108,7 @@ Testing
Unit tests will be provided.
Nuage CI may need to be enhanced to support this feature.
Documentation Impact
Documentation impact
====================
Documentation needs to be updated to reflect the addition of a new

26
specs/kilo/dummy.rst
View File

@ -9,47 +9,47 @@ Title of your blueprint
==========================================
Problem Description
Problem description
===================
Proposed Change
Proposed change
===============
Data Model Impact
Data model impact
-----------------
REST API Impact
REST API impact
---------------
Security Impact
Security impact
---------------
Notifications Impact
Notifications impact
--------------------
Other End User Impact
Other end user impact
---------------------
Performance Impact
Performance impact
------------------
Other Deployer Impact
Other deployer impact
---------------------
Developer Impact
Developer impact
----------------
Community Impact
Community impact
----------------
@ -64,7 +64,7 @@ Assignee(s)
-----------
Work Items
Work items
----------
@ -87,7 +87,7 @@ API Tests
---------
Documentation Impact
Documentation impact
====================
User Documentation

6
specs/kilo/example.rst
View File

@ -275,7 +275,7 @@ Aside from the API, are there other ways a user will interact with this feature?
* Does this change have an impact on python client? What does the user
interface there look like?
Performance Impact
Performance impact
------------------
Describe any potential performance impact on the system, for example
@ -349,7 +349,7 @@ Primary assignee:
Other contributors:
<launchpad-id or None>
Work Items
Work items
----------
Work items or tasks -- break the feature up into the things that need to be
@ -385,7 +385,7 @@ software configurations available)? If so, are there mitigation plans (3rd
party testing, gate enhancements, etc).
Documentation Impact
Documentation impact
====================
What is the impact on the docs team of this change? Some changes might require

8
specs/kilo/gbp-refactor-neutron-restful-api.rst
View File

@ -35,7 +35,7 @@ This will be similar to how nova is doing it [2].
2. Refactor resource mapping driver code to replace neutron neutron-plugin
calls with the neutron v2 API calls.
Alternative
Alternatives
------------
None.
@ -61,7 +61,7 @@ Other end user impact
---------------------
None.
Performance Impact
Performance impact
------------------
There will be some minimal performance imapct after refactoring as RESTful
APIs are used.
@ -83,7 +83,7 @@ Yapeng Wu
Yi Yang
Work Items
Work items
----------
1. Add neutron v2 API module.
2. In RMD, replace neutron-plugin calls with neutron v2 API calls.
@ -114,7 +114,7 @@ When GBP becomes an independent server, the neutron-wsgi calls will being
refactored. These refactor can be handled in the spec for the independent
server.
Documentation Impact
Documentation impact
====================
None

6
specs/skeleton.rst
View File

@ -41,7 +41,7 @@ Other end user impact
---------------------
Performance Impact
Performance impact
------------------
@ -60,7 +60,7 @@ Assignee(s)
-----------
Work Items
Work items
----------
@ -72,7 +72,7 @@ Testing
=======
Documentation Impact
Documentation impact
====================

6
specs/template.rst
View File

@ -274,7 +274,7 @@ Aside from the API, are there other ways a user will interact with this feature?
* Does this change have an impact on python client? What does the user
interface there look like?
Performance Impact
Performance impact
------------------
Describe any potential performance impact on the system, for example
@ -348,7 +348,7 @@ Primary assignee:
Other contributors:
<launchpad-id or None>
Work Items
Work items
----------
Work items or tasks -- break the feature up into the things that need to be
@ -384,7 +384,7 @@ software configurations available)? If so, are there mitigation plans (3rd
party testing, gate enhancements, etc).
Documentation Impact
Documentation impact
====================
What is the impact on the docs team of this change? Some changes might require

8
tests/test_titles.py
View File

@ -64,7 +64,7 @@ class TestTitles(testtools.TestCase):
self.assertIn('Security impact', titles[proposed])
self.assertIn('Notifications impact', titles[proposed])
self.assertIn('Other end user impact', titles[proposed])
self.assertIn('Performance Impact', titles[proposed])
self.assertIn('Performance impact', titles[proposed])
self.assertIn('Other deployer impact', titles[proposed])
self.assertIn('Developer impact', titles[proposed])
@ -72,7 +72,7 @@ class TestTitles(testtools.TestCase):
self.assertIn(impl, titles)
self.assertEqual(2, len(titles[impl]))
self.assertIn('Assignee(s)', titles[impl])
self.assertIn('Work Items', titles[impl])
self.assertIn('Work items', titles[impl])
deps = 'Dependencies'
self.assertIn(deps, titles)
@ -80,11 +80,9 @@ class TestTitles(testtools.TestCase):
testing = 'Testing'
self.assertIn(testing, titles)
self.assertEqual(0, len(titles[testing]))
docs = 'Documentation Impact'
docs = 'Documentation impact'
self.assertIn(docs, titles)
self.assertEqual(0, len(titles[docs]))
refs = 'References'
self.assertIn(refs, titles)