diff --git a/doc/source/conf.py b/doc/source/conf.py index e9e001eda..c4c4994c4 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -77,6 +77,7 @@ exclude_patterns = [ '**/example.rst', '**/template.rst', '**/skeleton.rst', + '**/archive', ] # The reST default role (used for this markup: `text`) to use for all documents. diff --git a/doc/source/index.rst b/doc/source/index.rst index 7faf33b8c..3d3b9ac27 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -4,8 +4,8 @@ Neutron Project Specifications ============================== -Mitaka approved specs -===================== +Mitaka +====== .. toctree:: :glob: @@ -13,8 +13,8 @@ Mitaka approved specs specs/mitaka/* -Liberty approved specs -====================== +Liberty +======= .. toctree:: :glob: @@ -22,8 +22,8 @@ Liberty approved specs specs/liberty/* -Kilo approved specs -=================== +Kilo +==== .. toctree:: :glob: @@ -31,26 +31,8 @@ Kilo approved specs specs/kilo/* -Liberty backlog specs -===================== - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/liberty-backlog/* - -Kilo backlog specs -=================== - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/kilo-backlog/* - -Juno approved specs -=================== +Juno +==== .. toctree:: :glob: @@ -58,24 +40,14 @@ Juno approved specs specs/juno/* -API specs -========= +Backlog +======= .. toctree:: :glob: :maxdepth: 1 - specs/api/* - - -Neutron Incubator ------------------ - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/juno-incubator/* + specs/backlog/** ================== Indices and tables diff --git a/specs/api/agent_management.rst b/misc/api/agent_management.rst similarity index 100% rename from specs/api/agent_management.rst rename to misc/api/agent_management.rst diff --git a/specs/api/agent_schedulers.rst b/misc/api/agent_schedulers.rst similarity index 100% rename from specs/api/agent_schedulers.rst rename to misc/api/agent_schedulers.rst diff --git a/specs/api/allowed_address_pairs.rst b/misc/api/allowed_address_pairs.rst similarity index 100% rename from specs/api/allowed_address_pairs.rst rename to misc/api/allowed_address_pairs.rst diff --git a/specs/api/configurable_external_gateway_modes.rst b/misc/api/configurable_external_gateway_modes.rst similarity index 100% rename from specs/api/configurable_external_gateway_modes.rst rename to misc/api/configurable_external_gateway_modes.rst diff --git a/specs/api/external_networks__external-net_.rst b/misc/api/external_networks__external-net_.rst similarity index 100% rename from specs/api/external_networks__external-net_.rst rename to misc/api/external_networks__external-net_.rst diff --git a/specs/api/extra_dhcp_options__extra-dhcp-opt_.rst b/misc/api/extra_dhcp_options__extra-dhcp-opt_.rst similarity index 100% rename from specs/api/extra_dhcp_options__extra-dhcp-opt_.rst rename to misc/api/extra_dhcp_options__extra-dhcp-opt_.rst diff --git a/specs/api/extra_routes.rst b/misc/api/extra_routes.rst similarity index 100% rename from specs/api/extra_routes.rst rename to misc/api/extra_routes.rst diff --git a/specs/api/firewall_as_a_service__fwaas_.rst b/misc/api/firewall_as_a_service__fwaas_.rst similarity index 100% rename from specs/api/firewall_as_a_service__fwaas_.rst rename to misc/api/firewall_as_a_service__fwaas_.rst diff --git a/specs/api/layer-3_networking.rst b/misc/api/layer-3_networking.rst similarity index 100% rename from specs/api/layer-3_networking.rst rename to misc/api/layer-3_networking.rst diff --git a/specs/api/load-balancer-as-a-service__lbaas_.rst b/misc/api/load-balancer-as-a-service__lbaas_.rst similarity index 100% rename from specs/api/load-balancer-as-a-service__lbaas_.rst rename to misc/api/load-balancer-as-a-service__lbaas_.rst diff --git a/specs/api/metering_labels_and_rules.rst b/misc/api/metering_labels_and_rules.rst similarity index 100% rename from specs/api/metering_labels_and_rules.rst rename to misc/api/metering_labels_and_rules.rst diff --git a/specs/api/multiple_provider_networks.rst b/misc/api/multiple_provider_networks.rst similarity index 100% rename from specs/api/multiple_provider_networks.rst rename to misc/api/multiple_provider_networks.rst diff --git a/specs/api/networking_api_overview.rst b/misc/api/networking_api_overview.rst similarity index 100% rename from specs/api/networking_api_overview.rst rename to misc/api/networking_api_overview.rst diff --git a/specs/api/networking_general_api_information.rst b/misc/api/networking_general_api_information.rst similarity index 100% rename from specs/api/networking_general_api_information.rst rename to misc/api/networking_general_api_information.rst diff --git a/specs/api/ports.rst b/misc/api/ports.rst similarity index 100% rename from specs/api/ports.rst rename to misc/api/ports.rst diff --git a/specs/api/ports_binding_extended_attributes__ports_.rst b/misc/api/ports_binding_extended_attributes__ports_.rst similarity index 100% rename from specs/api/ports_binding_extended_attributes__ports_.rst rename to misc/api/ports_binding_extended_attributes__ports_.rst diff --git a/specs/api/provider_networks__provider_.rst b/misc/api/provider_networks__provider_.rst similarity index 100% rename from specs/api/provider_networks__provider_.rst rename to misc/api/provider_networks__provider_.rst diff --git a/specs/api/quotas.rst b/misc/api/quotas.rst similarity index 100% rename from specs/api/quotas.rst rename to misc/api/quotas.rst diff --git a/specs/api/security_groups_and_rules__security-groups_.rst b/misc/api/security_groups_and_rules__security-groups_.rst similarity index 100% rename from specs/api/security_groups_and_rules__security-groups_.rst rename to misc/api/security_groups_and_rules__security-groups_.rst diff --git a/specs/api/subnets.rst b/misc/api/subnets.rst similarity index 100% rename from specs/api/subnets.rst rename to misc/api/subnets.rst diff --git a/specs/api/virtual_private_network_as_a_service__vpnaas_.rst b/misc/api/virtual_private_network_as_a_service__vpnaas_.rst similarity index 100% rename from specs/api/virtual_private_network_as_a_service__vpnaas_.rst rename to misc/api/virtual_private_network_as_a_service__vpnaas_.rst diff --git a/specs/juno-incubator/example.rst b/misc/juno-incubator/example.rst similarity index 100% rename from specs/juno-incubator/example.rst rename to misc/juno-incubator/example.rst diff --git a/specs/juno-incubator/lbaas-api-and-objmodel-improvement.rst b/misc/juno-incubator/lbaas-api-and-objmodel-improvement.rst similarity index 100% rename from specs/juno-incubator/lbaas-api-and-objmodel-improvement.rst rename to misc/juno-incubator/lbaas-api-and-objmodel-improvement.rst diff --git a/specs/juno-incubator/lbaas-l7-rules.rst b/misc/juno-incubator/lbaas-l7-rules.rst similarity index 100% rename from specs/juno-incubator/lbaas-l7-rules.rst rename to misc/juno-incubator/lbaas-l7-rules.rst diff --git a/specs/juno-incubator/lbaas-ref-driver-impl-tls.rst b/misc/juno-incubator/lbaas-ref-driver-impl-tls.rst similarity index 100% rename from specs/juno-incubator/lbaas-ref-driver-impl-tls.rst rename to misc/juno-incubator/lbaas-ref-driver-impl-tls.rst diff --git a/specs/juno-incubator/lbaas-refactor-haproxy-namespace-driver-to-new-driver-interface.rst b/misc/juno-incubator/lbaas-refactor-haproxy-namespace-driver-to-new-driver-interface.rst similarity index 100% rename from specs/juno-incubator/lbaas-refactor-haproxy-namespace-driver-to-new-driver-interface.rst rename to misc/juno-incubator/lbaas-refactor-haproxy-namespace-driver-to-new-driver-interface.rst diff --git a/specs/juno-incubator/lbaas-tls.rst b/misc/juno-incubator/lbaas-tls.rst similarity index 100% rename from specs/juno-incubator/lbaas-tls.rst rename to misc/juno-incubator/lbaas-tls.rst diff --git a/specs/juno-incubator/radware-lbaas-driver.rst b/misc/juno-incubator/radware-lbaas-driver.rst similarity index 100% rename from specs/juno-incubator/radware-lbaas-driver.rst rename to misc/juno-incubator/radware-lbaas-driver.rst diff --git a/specs/archive/README b/specs/archive/README new file mode 100644 index 000000000..d2775f5ea --- /dev/null +++ b/specs/archive/README @@ -0,0 +1,3 @@ +If X is the current release, this contains any spec that did not +complete in X-2 (or older), and was not moved forward. Ideally +this directory would be empty. diff --git a/specs/kilo-backlog/extra-dhcp-opts-ipv4-ipv6.rst b/specs/archive/kilo/extra-dhcp-opts-ipv4-ipv6.rst similarity index 100% rename from specs/kilo-backlog/extra-dhcp-opts-ipv4-ipv6.rst rename to specs/archive/kilo/extra-dhcp-opts-ipv4-ipv6.rst diff --git a/specs/kilo-backlog/guru-meditation-report.rst b/specs/archive/kilo/guru-meditation-report.rst similarity index 100% rename from specs/kilo-backlog/guru-meditation-report.rst rename to specs/archive/kilo/guru-meditation-report.rst diff --git a/specs/kilo-backlog/iptables-driver.rst b/specs/archive/kilo/iptables-driver.rst similarity index 100% rename from specs/kilo-backlog/iptables-driver.rst rename to specs/archive/kilo/iptables-driver.rst diff --git a/specs/kilo-backlog/migration-from-nova-net.rst b/specs/archive/kilo/migration-from-nova-net.rst similarity index 100% rename from specs/kilo-backlog/migration-from-nova-net.rst rename to specs/archive/kilo/migration-from-nova-net.rst diff --git a/specs/kilo-backlog/ml2-cisco-nexus-md-prov-segment.rst b/specs/archive/kilo/ml2-cisco-nexus-md-prov-segment.rst similarity index 100% rename from specs/kilo-backlog/ml2-cisco-nexus-md-prov-segment.rst rename to specs/archive/kilo/ml2-cisco-nexus-md-prov-segment.rst diff --git a/specs/kilo-backlog/ofagent-bridge-setup.rst b/specs/archive/kilo/ofagent-bridge-setup.rst similarity index 100% rename from specs/kilo-backlog/ofagent-bridge-setup.rst rename to specs/archive/kilo/ofagent-bridge-setup.rst diff --git a/specs/kilo-backlog/ofagent-sub-driver.rst b/specs/archive/kilo/ofagent-sub-driver.rst similarity index 100% rename from specs/kilo-backlog/ofagent-sub-driver.rst rename to specs/archive/kilo/ofagent-sub-driver.rst diff --git a/specs/kilo-backlog/plugin-interface-perestroika.rst b/specs/archive/kilo/plugin-interface-perestroika.rst similarity index 100% rename from specs/kilo-backlog/plugin-interface-perestroika.rst rename to specs/archive/kilo/plugin-interface-perestroika.rst diff --git a/specs/kilo-backlog/pydev-debugger-support.rst b/specs/archive/kilo/pydev-debugger-support.rst similarity index 100% rename from specs/kilo-backlog/pydev-debugger-support.rst rename to specs/archive/kilo/pydev-debugger-support.rst diff --git a/specs/kilo-backlog/retargetable-functional-testing.rst b/specs/archive/kilo/retargetable-functional-testing.rst similarity index 100% rename from specs/kilo-backlog/retargetable-functional-testing.rst rename to specs/archive/kilo/retargetable-functional-testing.rst diff --git a/specs/kilo-backlog/vmware-lbaas-v2.rst b/specs/archive/kilo/vmware-lbaas-v2.rst similarity index 100% rename from specs/kilo-backlog/vmware-lbaas-v2.rst rename to specs/archive/kilo/vmware-lbaas-v2.rst diff --git a/specs/backlog/README b/specs/backlog/README new file mode 100644 index 000000000..5b4db68ae --- /dev/null +++ b/specs/backlog/README @@ -0,0 +1,2 @@ +If X is the current release, this contains any spec that did not +complete in X-1. Ideally this directory would be empty. diff --git a/specs/liberty-backlog/add-port-timestamp.rst b/specs/backlog/liberty/add-port-timestamp.rst similarity index 100% rename from specs/liberty-backlog/add-port-timestamp.rst rename to specs/backlog/liberty/add-port-timestamp.rst diff --git a/specs/liberty-backlog/adopt-oslo-guru-reports.rst b/specs/backlog/liberty/adopt-oslo-guru-reports.rst similarity index 100% rename from specs/liberty-backlog/adopt-oslo-guru-reports.rst rename to specs/backlog/liberty/adopt-oslo-guru-reports.rst diff --git a/specs/liberty-backlog/decompose-aas.rst b/specs/backlog/liberty/decompose-aas.rst similarity index 100% rename from specs/liberty-backlog/decompose-aas.rst rename to specs/backlog/liberty/decompose-aas.rst diff --git a/specs/liberty-backlog/dmvpn.rst b/specs/backlog/liberty/dmvpn.rst similarity index 100% rename from specs/liberty-backlog/dmvpn.rst rename to specs/backlog/liberty/dmvpn.rst diff --git a/specs/liberty-backlog/lbaas-l7-rules.rst b/specs/backlog/liberty/lbaas-l7-rules.rst similarity index 100% rename from specs/liberty-backlog/lbaas-l7-rules.rst rename to specs/backlog/liberty/lbaas-l7-rules.rst diff --git a/specs/liberty-backlog/microversioning.rst b/specs/backlog/liberty/microversioning.rst similarity index 100% rename from specs/liberty-backlog/microversioning.rst rename to specs/backlog/liberty/microversioning.rst diff --git a/specs/liberty-backlog/neutron-lib.rst b/specs/backlog/liberty/neutron-lib.rst similarity index 100% rename from specs/liberty-backlog/neutron-lib.rst rename to specs/backlog/liberty/neutron-lib.rst diff --git a/specs/liberty-backlog/reference-split.rst b/specs/backlog/liberty/reference-split.rst similarity index 100% rename from specs/liberty-backlog/reference-split.rst rename to specs/backlog/liberty/reference-split.rst diff --git a/specs/liberty-backlog/service-group.rst b/specs/backlog/liberty/service-group.rst similarity index 100% rename from specs/liberty-backlog/service-group.rst rename to specs/backlog/liberty/service-group.rst diff --git a/specs/liberty-backlog/stateless-floatingips.rst b/specs/backlog/liberty/stateless-floatingips.rst similarity index 100% rename from specs/liberty-backlog/stateless-floatingips.rst rename to specs/backlog/liberty/stateless-floatingips.rst diff --git a/specs/juno/example.rst b/specs/juno/example.rst deleted file mode 120000 index dc9373e3a..000000000 --- a/specs/juno/example.rst +++ /dev/null @@ -1 +0,0 @@ -../template.rst \ No newline at end of file diff --git a/specs/kilo/dummy.rst b/specs/kilo/dummy.rst deleted file mode 100644 index 11530074c..000000000 --- a/specs/kilo/dummy.rst +++ /dev/null @@ -1,108 +0,0 @@ -.. - This work is licensed under a Creative Commons Attribution 3.0 Unported - License. - - http://creativecommons.org/licenses/by/3.0/legalcode - -========================================== -Title of your blueprint -========================================== - - -Problem Description -=================== - - -Proposed Change -=============== - - -Data Model Impact ------------------ - - -REST API Impact ---------------- - - -Security Impact ---------------- - - -Notifications Impact --------------------- - - -Other End User Impact ---------------------- - - -Performance Impact ------------------- - - -IPv6 Impact ------------ - - -Other Deployer Impact ---------------------- - - -Developer Impact ----------------- - - -Community Impact ----------------- - - -Alternatives ------------- - - -Implementation -============== - -Assignee(s) ------------ - - -Work Items ----------- - - -Dependencies -============ - - -Testing -======= - -Tempest Tests -------------- - - -Functional Tests ----------------- - - -API Tests ---------- - - -Documentation Impact -==================== - -User Documentation ------------------- - - -Developer Documentation ------------------------ - - -References -========== - - diff --git a/specs/kilo/example.rst b/specs/kilo/example.rst deleted file mode 120000 index dc9373e3a..000000000 --- a/specs/kilo/example.rst +++ /dev/null @@ -1 +0,0 @@ -../template.rst \ No newline at end of file diff --git a/specs/kilo-backlog/reorganize-unit-test-tree.rst b/specs/kilo/reorganize-unit-test-tree.rst similarity index 100% rename from specs/kilo-backlog/reorganize-unit-test-tree.rst rename to specs/kilo/reorganize-unit-test-tree.rst diff --git a/specs/liberty-backlog/arp-spoof-filtering-ebtables.rst b/specs/liberty/arp-spoof-filtering-ebtables.rst similarity index 100% rename from specs/liberty-backlog/arp-spoof-filtering-ebtables.rst rename to specs/liberty/arp-spoof-filtering-ebtables.rst diff --git a/specs/kilo-backlog/better-quotas.rst b/specs/liberty/better-quotas.rst similarity index 100% rename from specs/kilo-backlog/better-quotas.rst rename to specs/liberty/better-quotas.rst diff --git a/specs/liberty/dummy.rst b/specs/liberty/dummy.rst deleted file mode 100644 index 11530074c..000000000 --- a/specs/liberty/dummy.rst +++ /dev/null @@ -1,108 +0,0 @@ -.. - This work is licensed under a Creative Commons Attribution 3.0 Unported - License. - - http://creativecommons.org/licenses/by/3.0/legalcode - -========================================== -Title of your blueprint -========================================== - - -Problem Description -=================== - - -Proposed Change -=============== - - -Data Model Impact ------------------ - - -REST API Impact ---------------- - - -Security Impact ---------------- - - -Notifications Impact --------------------- - - -Other End User Impact ---------------------- - - -Performance Impact ------------------- - - -IPv6 Impact ------------ - - -Other Deployer Impact ---------------------- - - -Developer Impact ----------------- - - -Community Impact ----------------- - - -Alternatives ------------- - - -Implementation -============== - -Assignee(s) ------------ - - -Work Items ----------- - - -Dependencies -============ - - -Testing -======= - -Tempest Tests -------------- - - -Functional Tests ----------------- - - -API Tests ---------- - - -Documentation Impact -==================== - -User Documentation ------------------- - - -Developer Documentation ------------------------ - - -References -========== - - diff --git a/specs/liberty/example.rst b/specs/liberty/example.rst deleted file mode 100644 index 8c58bb558..000000000 --- a/specs/liberty/example.rst +++ /dev/null @@ -1,487 +0,0 @@ -.. - This work is licensed under a Creative Commons Attribution 3.0 Unported - License. - - http://creativecommons.org/licenses/by/3.0/legalcode - -========================================== -Example Spec - The title of your blueprint -========================================== - -Include the URL of your launchpad blueprint: - -https://blueprints.launchpad.net/neutron/+spec/example - -Introduction paragraph -- why are we doing anything? A single paragraph of -prose that **operators, deployers, and developers** can understand. - -If your specification proposes any changes to the Neutron REST API such -as changing parameters which can be returned or accepted, or even -the semantics of what happens when a client calls into the API, then -you should add the APIImpact flag to the commit message. Specifications with -the APIImpact flag can be found with the following query: - -https://review.openstack.org/#/q/status:open+project:openstack/neutron-specs+message:apiimpact,n,z - - -Problem Description -=================== - -A detailed description of the problem: - -* For a new feature this should be use cases. Ensure you are clear about the - actors in each use case: End User vs Deployer - -* For a major reworking of something existing it would describe the - problems in that feature that are being addressed. - - -Proposed Change -=============== - -Here is where you cover the change you propose to make in detail. How do you -propose to solve this problem? - -If this is one part of a larger effort make it clear where this piece ends. In -other words, what's the scope of this effort? - -Data Model Impact ------------------ - -Changes which require modifications to the data model often have a wider impact -on the system. The community often has strong opinions on how the data model -should be evolved, from both a functional and performance perspective. It is -therefore important to capture and gain agreement as early as possible on any -proposed changes to the data model. - -Questions which need to be addressed by this section include: - -* What new data objects and/or database schema changes is this going to require? - -* What database migrations will accompany this change. - -* How will the initial set of new data objects be generated, for example if you - need to take into account existing instances, or modify other existing data - describe how that will work. - -REST API Impact ---------------- - -For each API resource to be implemented using Neutron's attribute map -facility (see the neutron.api.v2.attributes), describe the resource -collection and specify the name, type, and other essential details of -each new or modified attribute. A table similar to the following may -be used: - -+----------+-------+---------+---------+------------+--------------+ -|Attribute |Type |Access |Default |Validation/ |Description | -|Name | | |Value |Conversion | | -+==========+=======+=========+=========+============+==============+ -|id |string |RO, all |generated|N/A |identity | -| |(UUID) | | | | | -+----------+-------+---------+---------+------------+--------------+ -|name |string |RW, all |'' |string |human-readable| -| | | | | |name | -+----------+-------+---------+---------+------------+--------------+ -|color |string |RW, admin|'red' |'red', |color | -| | | | |'yellow', or|indicating | -| | | | |'green' |state | -+----------+-------+---------+---------+------------+--------------+ - - -Here is the other example of the table using csv-table - - -.. csv-table:: CSVTable - :header: Attribute Name,Type,Access,Default Value,Validation Conversion,Description - - id,string (UUID),"RO, all",generated,N/A,identity - name,string,"RW, all","''",string,human-readable name - color,string,"RW, admin",red,"'red', 'yellow' or 'green'",color indicating state - - -Each API method which is either added or changed that does not use -Neutron's attribute map facility should have the following: - -* Specification for the method - - * A description of what the method does suitable for use in - user documentation - - * Method type (POST/PUT/GET/DELETE) - - * Normal http response code(s) - - * Expected error http response code(s) - - * A description for each possible error code should be included - describing semantic errors which can cause it such as - inconsistent parameters supplied to the method, or when an - instance is not in an appropriate state for the request to - succeed. Errors caused by syntactic problems covered by the JSON - schema defintion do not need to be included. - - * URL for the resource - - * Parameters which can be passed via the url - - * JSON schema definition for the body data if allowed - - * JSON schema definition for the response data if any - -* Example use case including typical API samples for both data supplied - by the caller and the response - -* Discuss any API policy changes, and discuss what things a deployer needs to - think about when defining their API policy. This is in reference to the - policy.json file. - -Note that the schema should be defined as restrictively as -possible. Parameters which are required should be marked as such and -only under exceptional circumstances should additional parameters -which are not defined in the schema be permitted (eg -additionaProperties should be False). - -Reuse of existing predefined parameter types such as regexps for -passwords and user defined names is highly encouraged. - -Security Impact ---------------- - -Describe any potential security impact on the system. Some of the items to -consider include: - -* Does this change touch sensitive data such as tokens, keys, or user data? - -* Does this change alter the API in a way that may impact security, such as - a new way to access sensitive information or a new way to login? - -* Does this change involve cryptography or hashing? - -* Does this change require the use of sudo or any elevated privileges? - -* Does this change involve using or parsing user-provided data? This could - be directly at the API level or indirectly such as changes to a cache layer. - -* Can this change enable a resource exhaustion attack, such as allowing a - single API interaction to consume significant server resources? Some examples - of this include launching subprocesses for each connection, or entity - expansion attacks in XML. - -For more detailed guidance, please see the OpenStack Security Guidelines -[#security_guidelines]_ as a reference. These guidelines are a work in -progress and are designed to help you identify security best practices. -For further information, feel free to reach out to the OpenStack Security -Group at openstack-security@lists.openstack.org. - -.. [#security_guidelines] OpenStack Security Guidelines - https://wiki.openstack.org/wiki/Security/Guidelines - -Notifications Impact --------------------- - -Please specify any changes to notifications. Be that an extra notification, -changes to an existing notification, or removing a notification. - -Other End User Impact ---------------------- - -Aside from the API, are there other ways a user will interact with this feature? - -* Does this change have an impact on python-neutronclient? What does the user - interface there look like? - -Performance Impact ------------------- - -Describe any potential performance impact on the system, for example -how often will new code be called, and is there a major change to the calling -pattern of existing code. - -Examples of things to consider here include: - -* A periodic task might look like a small addition but if it calls conductor or - another service the load is multiplied by the number of nodes in the system. - -* A small change in a utility function or a commonly used decorator can have a - large impacts on performance. - -* Calls which result in a database queries (whether direct or via conductor) can - have a profound impact on performance when called in critical sections of the - code. - -* Will the change include any locking, and if so what considerations are there on - holding the lock? - -IPv6 Impact ------------ - -Describe if this change will have an effect on IPv6 in Neutron. You should also -document here how your change will work with the existing IPv6 infrastructure -in Neutron. - -* Does this change work with IPv6? - -* Does this change require Neutron changes to facilitate working with IPv6? - -* Describe how this change will work when deployed with IPv6 tenant networks. - -Other Deployer Impact ---------------------- - -Discuss things that will affect how you deploy and configure OpenStack -that have not already been mentioned, such as: - -* What config options are being added? Should they be more generic than - proposed (for example a flag that other hypervisor drivers might want to - implement as well)? Are the default values ones which will work well in - real deployments? - -* Is this a change that takes immediate effect after its merged, or is it - something that has to be explicitly enabled? - -* If this change is a new binary, how would it be deployed? - -* Please state anything that those doing continuous deployment, or those - upgrading from the previous release, need to be aware of. Also describe - any plans to deprecate configuration values or features. For example, if we - change the directory name that instances are stored in, how do we handle - instance directories created before the change landed? Do we move them? Do - we have a special case in the code? Do we assume that the operator will - recreate all the instances in their cloud? - -* Does this require downtime or manual intervention to apply when upgrading? - -Developer Impact ----------------- - -Discuss things that will affect other developers working on OpenStack, -such as: - -* If the blueprint proposes a change to the API, discussion of how other - plugins would implement the feature is required. - -Community Impact ----------------- - -Describe how this change fits in with the direction the Neutron community is -going. - -* Has the change been discussed on mailing lists, at the weekly Neutron - meeting, or at a Design Summit? - -* Does the change fit with the direction of the Neutron community? - -Alternatives ------------- - -What other ways could we do this thing? Why aren't we using those? This doesn't -have to be a full literature review, but it should demonstrate that thought has -been put into why the proposed solution is an appropriate one. - - -Implementation -============== - -Assignee(s) ------------ - -Who is leading the writing of the code? Or is this a blueprint where you're -throwing it out there to see who picks it up? - -If more than one person is working on the implementation, please designate the -primary author and contact. - -Primary assignee: - - -Other contributors: - - -Work Items ----------- - -Work items or tasks -- break the feature up into the things that need to be -done to implement it. Those parts might end up being done by different people, -but we're mostly trying to understand the timeline for implementation. - - -Dependencies -============ - -* Include specific references to specs and/or blueprints in neutron, or in other - projects, that this one either depends on or is related to. - -* If this requires functionality of another project that is not currently used - by Neutron (such as the glance v2 API when we previously only required v1), - document that fact. - -* Does this feature require any new library dependencies or code otherwise not - included in OpenStack? Or does it depend on a specific version of library? - - -Testing -======= - -Please discuss how the change will be tested. We especially want to know what -tempest tests will be added. It is assumed that unit test coverage will be -added so that doesn't need to be mentioned explicitly, but discussion of why -you think unit tests are sufficient and we don't need to add more tempest -tests would need to be included. - -Is this untestable in gate given current limitations (specific hardware / -software configurations available)? If so, are there mitigation plans (3rd -party testing, gate enhancements, etc). - -Tempest Tests -------------- - -List new, changed, or deleted Tempest tests in this section. If a blueprint -has been filed in the Tempest specs repository, please cross reference that -blueprint here. - -Functional Tests ----------------- - -Please document any functional tests which this change will require. New -features will require functional tests before being allowed to be merged. -Code refactors may require functional tests. - -API Tests ---------- - -Add changes to API tests in this section. This is required if the change is -adding, removing, or changing any API related code in Neutron. - - -Documentation Impact -==================== - -What is the impact on the docs team of this change? Some changes might require -donating resources to the docs team to have the documentation updated. Don't -repeat details discussed above, but please reference them here. - -User Documentation ------------------- - -Specify any User Documentation which needs to be changed. Reference the guides -which need updating due to this change. - -Developer Documentation ------------------------ - -If API changes are being made, specify the developer API documentation which -will be updated to reflect the new changes here. - -References -========== - -Please add any useful references here. You are not required to have any -reference. Moreover, this specification should still make sense when your -references are unavailable. Examples of what you could include are: - -* Links to mailing list or IRC discussions - -* Links to notes from a summit session - -* Links to relevant research, if appropriate - -* Related specifications as appropriate (e.g. link any vendor documentation) - -* Anything else you feel it is worthwhile to refer to - - -NOTE: Please remove everything from here and down. This section is meant to -show examples of how to format the spec. - -Some notes about using this template: - -* Your spec should be in ReSTructured text, like this template. - -* Please wrap text at 80 columns. - -* The filename in the git repository should match the launchpad URL, for - example a URL of: https://blueprints.launchpad.net/neutron/+spec/awesome-thing - should be named awesome-thing.rst - -* Please do not delete any of the sections in this template. If you have - nothing to say for a whole section, just write: None - -* For help with syntax, see http://sphinx-doc.org/rest.html - -* To test out your formatting, build the docs using tox, or see: - http://rst.ninjs.org - -* If you would like to provide a diagram with your spec, text representations - are preferred. http://asciiflow.com/ is a very nice tool to assist with - making ascii diagrams. blockdiag is another tool. These are described below. - If you require an image (screenshot) for your BP, attaching that to the BP - and checking it in is also accepted. However, text representations are prefered. - -* Diagram examples - -asciiflow:: - - +----------+ +-----------+ +----------+ - | A | | B | | C | - | +-----+ +--------+ | - +----------+ +-----------+ +----------+ - -blockdiag - -.. blockdiag:: - - blockdiag sample { - a -> b -> c; - } - -actdiag - -.. actdiag:: - - actdiag { - write -> convert -> image - lane user { - label = "User" - write [label = "Writing reST"]; - image [label = "Get diagram IMAGE"]; - } - lane actdiag { - convert [label = "Convert reST to Image"]; - } - } - -nwdiag - -.. nwdiag:: - - nwdiag { - network dmz { - address = "210.x.x.x/24" - - web01 [address = "210.x.x.1"]; - web02 [address = "210.x.x.2"]; - } - network internal { - address = "172.x.x.x/24"; - - web01 [address = "172.x.x.1"]; - web02 [address = "172.x.x.2"]; - db01; - db02; - } - } - - -seqdiag - -.. seqdiag:: - - seqdiag { - browser -> webserver [label = "GET /index.html"]; - browser <-- webserver; - browser -> webserver [label = "POST /blog/comment"]; - webserver -> database [label = "INSERT comment"]; - webserver <-- database; - browser <-- webserver; - } diff --git a/specs/kilo-backlog/full-stack-white-box-tests.rst b/specs/liberty/full-stack-white-box-tests.rst similarity index 100% rename from specs/kilo-backlog/full-stack-white-box-tests.rst rename to specs/liberty/full-stack-white-box-tests.rst diff --git a/tests/test_titles.py b/tests/test_titles.py index 6bc2278f7..bfc197ba6 100644 --- a/tests/test_titles.py +++ b/tests/test_titles.py @@ -97,7 +97,8 @@ class TestTitles(testtools.TestCase): releases = [x.split('/')[1] for x in glob.glob('specs/*/')] for release in releases: if release[0] < 'k': - # Don't bother enforcement for specs before Kilo. + # Don't bother enforcement for specs before Kilo, + # or that belong to 'archive' and 'backlog' continue try: # Support release-specific template.