diff --git a/README.rst b/README.rst index 7c9c878a..77ce2f27 100644 --- a/README.rst +++ b/README.rst @@ -9,19 +9,19 @@ how we review and merge changes to the code itself. The layout of this repository is:: - specs// + specs/approved/ + specs/backlog`/ + specs/-implemented/ + +There are also placeholder directories for old links that have been moved. Specifications must follow the template which can be found at `doc/source/specs/template.rst`. -Specifications are proposed for a given release by adding them to the -`specs/` directory and posting it for review. The implementation -status of a blueprint for a given release can be found by looking at the -blueprint in launchpad. Not all approved blueprints will get fully implemented. - -Specifications have to be re-proposed for every release. The review may be -quick, but even if something was previously approved, it should be re-reviewed -to make sure it still makes sense as written. +Specifications are proposed by adding them to the `specs/approved` directory +and posting it for review. When a spec is fully implemented, it should be +moved to specs/-implemented. Not all approved blueprints will get +fully implemented. Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad diff --git a/doc/source/index.rst b/doc/source/index.rst index 610c3cb8..bb13dc62 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,24 +5,34 @@ Ironic Project Specifications ============================= This serves as a reference for approved specs within the current, and each -prior, release cycle. At the end of a cycle, specs which were approved but not -implemented at all will be deleted and should be re-proposed. Specs which were -partly implemented will be modified to indicate such, and a continuation spec -should be proposed for the new cycle. Additionally, a "backlog" of ideas is -maintained to indicate the agreed-upon goals for the project which have no -specific work being done on them at this time. +prior, development cycle. Specs begin life in the "approved" tree, and once +implemented, are moved to the "implemented" tree for that development cycle. +At the end of a cycle, specs which were partially implemented should remain +in the "approved" tree, only moving to "implemented" when the work is +completely done. Additionally, a "backlog" of ideas is maintained to indicate +the agreed-upon goals for the project which have no specific work being done +on them at this time. Current Cycle ============= -Liberty -------- +Approved +-------- .. toctree:: :glob: :maxdepth: 1 - specs/liberty/* + specs/approved/* + +Implemented in Liberty +---------------------- + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/liberty-implemented/* Idea back-log ------------- @@ -46,15 +56,7 @@ Implemented specs: :glob: :maxdepth: 1 - specs/kilo/* - -Unimplemented, but approved, specs: - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/kilo-archive/* + specs/kilo-implemented/* Juno ---- @@ -63,7 +65,7 @@ Juno :glob: :maxdepth: 1 - specs/juno/* + specs/juno-implemented/* ================== diff --git a/specs/liberty/add-pluggable-metrics-backend-for-ironic-and-ipa.rst b/specs/approved/add-pluggable-metrics-backend-for-ironic-and-ipa.rst similarity index 100% rename from specs/liberty/add-pluggable-metrics-backend-for-ironic-and-ipa.rst rename to specs/approved/add-pluggable-metrics-backend-for-ironic-and-ipa.rst diff --git a/specs/liberty/bare-metal-trust-using-intel-txt.rst b/specs/approved/bare-metal-trust-using-intel-txt.rst similarity index 100% rename from specs/liberty/bare-metal-trust-using-intel-txt.rst rename to specs/approved/bare-metal-trust-using-intel-txt.rst diff --git a/specs/liberty/deprecate-bash-ramdisk.rst b/specs/approved/deprecate-bash-ramdisk.rst similarity index 100% rename from specs/liberty/deprecate-bash-ramdisk.rst rename to specs/approved/deprecate-bash-ramdisk.rst diff --git a/specs/liberty/enroll-node-state.rst b/specs/approved/enroll-node-state.rst similarity index 100% rename from specs/liberty/enroll-node-state.rst rename to specs/approved/enroll-node-state.rst diff --git a/specs/liberty/futurist.rst b/specs/approved/futurist.rst similarity index 100% rename from specs/liberty/futurist.rst rename to specs/approved/futurist.rst diff --git a/specs/liberty/implement-zapping-states.rst b/specs/approved/implement-zapping-states.rst similarity index 100% rename from specs/liberty/implement-zapping-states.rst rename to specs/approved/implement-zapping-states.rst diff --git a/specs/liberty/inband-raid-configuration.rst b/specs/approved/inband-raid-configuration.rst similarity index 100% rename from specs/liberty/inband-raid-configuration.rst rename to specs/approved/inband-raid-configuration.rst diff --git a/specs/liberty/ipxe-dynamic-config.rst b/specs/approved/ipxe-dynamic-config.rst similarity index 100% rename from specs/liberty/ipxe-dynamic-config.rst rename to specs/approved/ipxe-dynamic-config.rst diff --git a/specs/liberty/ipxe-swift-tempurls.rst b/specs/approved/ipxe-swift-tempurls.rst similarity index 100% rename from specs/liberty/ipxe-swift-tempurls.rst rename to specs/approved/ipxe-swift-tempurls.rst diff --git a/specs/liberty/irmc-virtualmedia-deploy-driver.rst b/specs/approved/irmc-virtualmedia-deploy-driver.rst similarity index 100% rename from specs/liberty/irmc-virtualmedia-deploy-driver.rst rename to specs/approved/irmc-virtualmedia-deploy-driver.rst diff --git a/specs/liberty/ironic-generic-raid-interface.rst b/specs/approved/ironic-generic-raid-interface.rst similarity index 100% rename from specs/liberty/ironic-generic-raid-interface.rst rename to specs/approved/ironic-generic-raid-interface.rst diff --git a/specs/liberty/ironic-ml2-integration.rst b/specs/approved/ironic-ml2-integration.rst similarity index 100% rename from specs/liberty/ironic-ml2-integration.rst rename to specs/approved/ironic-ml2-integration.rst diff --git a/specs/liberty/network-provider.rst b/specs/approved/network-provider.rst similarity index 100% rename from specs/liberty/network-provider.rst rename to specs/approved/network-provider.rst diff --git a/specs/liberty/new-boot-interface.rst b/specs/approved/new-boot-interface.rst similarity index 100% rename from specs/liberty/new-boot-interface.rst rename to specs/approved/new-boot-interface.rst diff --git a/specs/liberty/nodes-tagging.rst b/specs/approved/nodes-tagging.rst similarity index 100% rename from specs/liberty/nodes-tagging.rst rename to specs/approved/nodes-tagging.rst diff --git a/specs/liberty/override-pxe-options-via-glance-property.rst b/specs/approved/override-pxe-options-via-glance-property.rst similarity index 100% rename from specs/liberty/override-pxe-options-via-glance-property.rst rename to specs/approved/override-pxe-options-via-glance-property.rst diff --git a/specs/liberty/petitboot-boot-driver.rst b/specs/approved/petitboot-boot-driver.rst similarity index 100% rename from specs/liberty/petitboot-boot-driver.rst rename to specs/approved/petitboot-boot-driver.rst diff --git a/specs/liberty/remove-swift-dependency-for-ilo-drivers.rst b/specs/approved/remove-swift-dependency-for-ilo-drivers.rst similarity index 100% rename from specs/liberty/remove-swift-dependency-for-ilo-drivers.rst rename to specs/approved/remove-swift-dependency-for-ilo-drivers.rst diff --git a/specs/liberty/uefi-secure-boot-pxe-ilo.rst b/specs/approved/uefi-secure-boot-pxe-ilo.rst similarity index 100% rename from specs/liberty/uefi-secure-boot-pxe-ilo.rst rename to specs/approved/uefi-secure-boot-pxe-ilo.rst diff --git a/specs/liberty/version-caching.rst b/specs/approved/version-caching.rst similarity index 100% rename from specs/liberty/version-caching.rst rename to specs/approved/version-caching.rst diff --git a/specs/kilo-archive/drac-bios-mgmt.rst b/specs/backlog/drac-bios-mgmt.rst similarity index 100% rename from specs/kilo-archive/drac-bios-mgmt.rst rename to specs/backlog/drac-bios-mgmt.rst diff --git a/specs/kilo-archive/partition-image-support-for-agent-driver.rst b/specs/backlog/partition-image-support-for-agent-driver.rst similarity index 100% rename from specs/kilo-archive/partition-image-support-for-agent-driver.rst rename to specs/backlog/partition-image-support-for-agent-driver.rst diff --git a/specs/kilo-archive/support-per-driver-sensor-meters.rst b/specs/backlog/support-per-driver-sensor-meters.rst similarity index 100% rename from specs/kilo-archive/support-per-driver-sensor-meters.rst rename to specs/backlog/support-per-driver-sensor-meters.rst diff --git a/specs/juno/add-node-instance-info.rst b/specs/juno-implemented/add-node-instance-info.rst similarity index 100% rename from specs/juno/add-node-instance-info.rst rename to specs/juno-implemented/add-node-instance-info.rst diff --git a/specs/juno/add-nodelocked-retry.rst b/specs/juno-implemented/add-nodelocked-retry.rst similarity index 100% rename from specs/juno/add-nodelocked-retry.rst rename to specs/juno-implemented/add-nodelocked-retry.rst diff --git a/specs/juno/agent-driver.rst b/specs/juno-implemented/agent-driver.rst similarity index 100% rename from specs/juno/agent-driver.rst rename to specs/juno-implemented/agent-driver.rst diff --git a/specs/juno/cleanup-all-imagecaches.rst b/specs/juno-implemented/cleanup-all-imagecaches.rst similarity index 100% rename from specs/juno/cleanup-all-imagecaches.rst rename to specs/juno-implemented/cleanup-all-imagecaches.rst diff --git a/specs/juno/device-status-check-with-fuser.rst b/specs/juno-implemented/device-status-check-with-fuser.rst similarity index 100% rename from specs/juno/device-status-check-with-fuser.rst rename to specs/juno-implemented/device-status-check-with-fuser.rst diff --git a/specs/juno/drac-management-driver.rst b/specs/juno-implemented/drac-management-driver.rst similarity index 100% rename from specs/juno/drac-management-driver.rst rename to specs/juno-implemented/drac-management-driver.rst diff --git a/specs/juno/drac-power-driver.rst b/specs/juno-implemented/drac-power-driver.rst similarity index 100% rename from specs/juno/drac-power-driver.rst rename to specs/juno-implemented/drac-power-driver.rst diff --git a/specs/juno/enabling-ipmi-double-bridge-support.rst b/specs/juno-implemented/enabling-ipmi-double-bridge-support.rst similarity index 100% rename from specs/juno/enabling-ipmi-double-bridge-support.rst rename to specs/juno-implemented/enabling-ipmi-double-bridge-support.rst diff --git a/specs/juno/get-required-driver-info.rst b/specs/juno-implemented/get-required-driver-info.rst similarity index 100% rename from specs/juno/get-required-driver-info.rst rename to specs/juno-implemented/get-required-driver-info.rst diff --git a/specs/juno/ilo-virtualmedia-ipa.rst b/specs/juno-implemented/ilo-virtualmedia-ipa.rst similarity index 100% rename from specs/juno/ilo-virtualmedia-ipa.rst rename to specs/juno-implemented/ilo-virtualmedia-ipa.rst diff --git a/specs/juno/ipxe-boot.rst b/specs/juno-implemented/ipxe-boot.rst similarity index 100% rename from specs/juno/ipxe-boot.rst rename to specs/juno-implemented/ipxe-boot.rst diff --git a/specs/juno/ironic-ilo-power-driver.rst b/specs/juno-implemented/ironic-ilo-power-driver.rst similarity index 100% rename from specs/juno/ironic-ilo-power-driver.rst rename to specs/juno-implemented/ironic-ilo-power-driver.rst diff --git a/specs/juno/ironic-ilo-virtualmedia-driver.rst b/specs/juno-implemented/ironic-ilo-virtualmedia-driver.rst similarity index 100% rename from specs/juno/ironic-ilo-virtualmedia-driver.rst rename to specs/juno-implemented/ironic-ilo-virtualmedia-driver.rst diff --git a/specs/juno/ironic-snmp-power-driver.rst b/specs/juno-implemented/ironic-snmp-power-driver.rst similarity index 100% rename from specs/juno/ironic-snmp-power-driver.rst rename to specs/juno-implemented/ironic-snmp-power-driver.rst diff --git a/specs/juno/new-management-interface.rst b/specs/juno-implemented/new-management-interface.rst similarity index 100% rename from specs/juno/new-management-interface.rst rename to specs/juno-implemented/new-management-interface.rst diff --git a/specs/juno/send-data-to-ceilometer.rst b/specs/juno-implemented/send-data-to-ceilometer.rst similarity index 100% rename from specs/juno/send-data-to-ceilometer.rst rename to specs/juno-implemented/send-data-to-ceilometer.rst diff --git a/specs/juno/support-external-dhcp.rst b/specs/juno-implemented/support-external-dhcp.rst similarity index 100% rename from specs/juno/support-external-dhcp.rst rename to specs/juno-implemented/support-external-dhcp.rst diff --git a/specs/juno/swift-temp-url.rst b/specs/juno-implemented/swift-temp-url.rst similarity index 100% rename from specs/juno/swift-temp-url.rst rename to specs/juno-implemented/swift-temp-url.rst diff --git a/specs/juno/uefi-boot-for-ironic.rst b/specs/juno-implemented/uefi-boot-for-ironic.rst similarity index 100% rename from specs/juno/uefi-boot-for-ironic.rst rename to specs/juno-implemented/uefi-boot-for-ironic.rst diff --git a/specs/kilo/amt-pxe-driver.rst b/specs/kilo-implemented/amt-pxe-driver.rst similarity index 100% rename from specs/kilo/amt-pxe-driver.rst rename to specs/kilo-implemented/amt-pxe-driver.rst diff --git a/specs/kilo/api-microversions.rst b/specs/kilo-implemented/api-microversions.rst similarity index 100% rename from specs/kilo/api-microversions.rst rename to specs/kilo-implemented/api-microversions.rst diff --git a/specs/kilo/automate-uefi-bios-iso-creation.rst b/specs/kilo-implemented/automate-uefi-bios-iso-creation.rst similarity index 100% rename from specs/kilo/automate-uefi-bios-iso-creation.rst rename to specs/kilo-implemented/automate-uefi-bios-iso-creation.rst diff --git a/specs/kilo/driver-internal-info.rst b/specs/kilo-implemented/driver-internal-info.rst similarity index 100% rename from specs/kilo/driver-internal-info.rst rename to specs/kilo-implemented/driver-internal-info.rst diff --git a/specs/kilo/driver-periodic-tasks.rst b/specs/kilo-implemented/driver-periodic-tasks.rst similarity index 100% rename from specs/kilo/driver-periodic-tasks.rst rename to specs/kilo-implemented/driver-periodic-tasks.rst diff --git a/specs/kilo/expose-configdrive.rst b/specs/kilo-implemented/expose-configdrive.rst similarity index 100% rename from specs/kilo/expose-configdrive.rst rename to specs/kilo-implemented/expose-configdrive.rst diff --git a/specs/kilo/extend-vendor-passthru.rst b/specs/kilo-implemented/extend-vendor-passthru.rst similarity index 100% rename from specs/kilo/extend-vendor-passthru.rst rename to specs/kilo-implemented/extend-vendor-passthru.rst diff --git a/specs/kilo/ilo-cleaning-support.rst b/specs/kilo-implemented/ilo-cleaning-support.rst similarity index 100% rename from specs/kilo/ilo-cleaning-support.rst rename to specs/kilo-implemented/ilo-cleaning-support.rst diff --git a/specs/kilo/ilo-management-interface.rst b/specs/kilo-implemented/ilo-management-interface.rst similarity index 100% rename from specs/kilo/ilo-management-interface.rst rename to specs/kilo-implemented/ilo-management-interface.rst diff --git a/specs/kilo/ilo-properties-capabilities-discovery.rst b/specs/kilo-implemented/ilo-properties-capabilities-discovery.rst similarity index 100% rename from specs/kilo/ilo-properties-capabilities-discovery.rst rename to specs/kilo-implemented/ilo-properties-capabilities-discovery.rst diff --git a/specs/kilo/implement-cleaning-states.rst b/specs/kilo-implemented/implement-cleaning-states.rst similarity index 100% rename from specs/kilo/implement-cleaning-states.rst rename to specs/kilo-implemented/implement-cleaning-states.rst diff --git a/specs/kilo/inband-properties-discovery.rst b/specs/kilo-implemented/inband-properties-discovery.rst similarity index 100% rename from specs/kilo/inband-properties-discovery.rst rename to specs/kilo-implemented/inband-properties-discovery.rst diff --git a/specs/kilo/irmc-management-driver.rst b/specs/kilo-implemented/irmc-management-driver.rst similarity index 100% rename from specs/kilo/irmc-management-driver.rst rename to specs/kilo-implemented/irmc-management-driver.rst diff --git a/specs/kilo/irmc-power-driver.rst b/specs/kilo-implemented/irmc-power-driver.rst similarity index 100% rename from specs/kilo/irmc-power-driver.rst rename to specs/kilo-implemented/irmc-power-driver.rst diff --git a/specs/kilo/ironic-node-properties-discovery.rst b/specs/kilo-implemented/ironic-node-properties-discovery.rst similarity index 100% rename from specs/kilo/ironic-node-properties-discovery.rst rename to specs/kilo-implemented/ironic-node-properties-discovery.rst diff --git a/specs/kilo/ironic-virtualbox-webservice-support.rst b/specs/kilo-implemented/ironic-virtualbox-webservice-support.rst similarity index 100% rename from specs/kilo/ironic-virtualbox-webservice-support.rst rename to specs/kilo-implemented/ironic-virtualbox-webservice-support.rst diff --git a/specs/kilo/local-boot-support-with-partition-images.rst b/specs/kilo-implemented/local-boot-support-with-partition-images.rst similarity index 100% rename from specs/kilo/local-boot-support-with-partition-images.rst rename to specs/kilo-implemented/local-boot-support-with-partition-images.rst diff --git a/specs/kilo/logical-names.rst b/specs/kilo-implemented/logical-names.rst similarity index 100% rename from specs/kilo/logical-names.rst rename to specs/kilo-implemented/logical-names.rst diff --git a/specs/kilo/maintenance-reason.rst b/specs/kilo-implemented/maintenance-reason.rst similarity index 100% rename from specs/kilo/maintenance-reason.rst rename to specs/kilo-implemented/maintenance-reason.rst diff --git a/specs/kilo/new-ironic-state-machine.rst b/specs/kilo-implemented/new-ironic-state-machine.rst similarity index 100% rename from specs/kilo/new-ironic-state-machine.rst rename to specs/kilo-implemented/new-ironic-state-machine.rst diff --git a/specs/kilo/non-glance-image-refs.rst b/specs/kilo-implemented/non-glance-image-refs.rst similarity index 100% rename from specs/kilo/non-glance-image-refs.rst rename to specs/kilo-implemented/non-glance-image-refs.rst diff --git a/specs/kilo/root-device-hints.rst b/specs/kilo-implemented/root-device-hints.rst similarity index 100% rename from specs/kilo/root-device-hints.rst rename to specs/kilo-implemented/root-device-hints.rst diff --git a/specs/kilo/seamicro-serial-console.rst b/specs/kilo-implemented/seamicro-serial-console.rst similarity index 100% rename from specs/kilo/seamicro-serial-console.rst rename to specs/kilo-implemented/seamicro-serial-console.rst diff --git a/specs/kilo/uefi-secure-boot.rst b/specs/kilo-implemented/uefi-secure-boot.rst similarity index 100% rename from specs/kilo/uefi-secure-boot.rst rename to specs/kilo-implemented/uefi-secure-boot.rst diff --git a/specs/kilo/whole-disk-image-support.rst b/specs/kilo-implemented/whole-disk-image-support.rst similarity index 100% rename from specs/kilo/whole-disk-image-support.rst rename to specs/kilo-implemented/whole-disk-image-support.rst diff --git a/specs/liberty/cisco-ucs-pxe-driver.rst b/specs/liberty-implemented/cisco-ucs-pxe-driver.rst similarity index 100% rename from specs/liberty/cisco-ucs-pxe-driver.rst rename to specs/liberty-implemented/cisco-ucs-pxe-driver.rst diff --git a/specs/liberty/feature-based-releases.rst b/specs/liberty-implemented/feature-based-releases.rst similarity index 100% rename from specs/liberty/feature-based-releases.rst rename to specs/liberty-implemented/feature-based-releases.rst diff --git a/specs/liberty/msft-ocs-power-driver.rst b/specs/liberty-implemented/msft-ocs-power-driver.rst similarity index 100% rename from specs/liberty/msft-ocs-power-driver.rst rename to specs/liberty-implemented/msft-ocs-power-driver.rst diff --git a/specs/liberty/wol-power-driver.rst b/specs/liberty-implemented/wol-power-driver.rst similarity index 100% rename from specs/liberty/wol-power-driver.rst rename to specs/liberty-implemented/wol-power-driver.rst diff --git a/tests/test_titles.py b/tests/test_titles.py index 05b4f8fb..862ae0f0 100644 --- a/tests/test_titles.py +++ b/tests/test_titles.py @@ -18,7 +18,7 @@ import docutils.core import testtools -RELEASE = 'liberty' +CURRENT_DIR = 'approved' FIRST_TITLE = 'Problem description' @@ -162,7 +162,7 @@ class TestTitles(testtools.TestCase): def test_current_cycle_template(self): template_titles = self._get_template_titles() - files = glob.glob('specs/%s/*' % RELEASE) + files = glob.glob('specs/%s/*' % CURRENT_DIR) for filename in files: self._check_file_ext(filename)