diff --git a/README.rst b/README.rst index 77ce2f27..93e88702 100644 --- a/README.rst +++ b/README.rst @@ -10,19 +10,27 @@ how we review and merge changes to the code itself. The layout of this repository is:: specs/approved/ - specs/backlog`/ - specs/-implemented/ + specs/backlog/ + specs/not-implemented/ + specs// + 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 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 +Specifications are proposed by adding them to the `specs/approved` directory, +adding a soft link to it from the `specs/not-implemented` directory, and +posting it for review. When a specification is fully implemented, the link in +`specs/not-implemented` directory should be moved to the appropriate +`specs/` directory. Not all approved specifications will get fully implemented. +Starting with the Mitaka development cycle, all approved specifications +(implemented and not-implemented) will reside in the `specs/approved` +directory. + Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:: diff --git a/doc/source/index.rst b/doc/source/index.rst index 83e096a5..3fca980d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -37,7 +37,7 @@ implemented: :glob: :maxdepth: 1 - specs/approved/* + specs/not-implemented/* Back-log of ideas @@ -61,6 +61,15 @@ development cycles in which they were completed. Mitaka ------ +4.3 +~~~ + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/4.3/* + Liberty ------- @@ -116,6 +125,19 @@ Juno specs/kilo/* specs/juno/* +.. + ---------------- + As of the start of the Mitaka development cycle, all approved specs + will reside in specs/approved (not-yet-implemented as well as implemented + specs). The files will not be moved (we hope). Instead, we will create + directories with links to these files. The specs/approved directory + will be hidden. + +.. toctree:: + :glob: + :hidden: + + specs/approved/* ================== Indices and tables diff --git a/specs/4.3/iscsi-deploy-in-band-cleaning.rst b/specs/4.3/iscsi-deploy-in-band-cleaning.rst new file mode 120000 index 00000000..cb90e60a --- /dev/null +++ b/specs/4.3/iscsi-deploy-in-band-cleaning.rst @@ -0,0 +1 @@ +../approved/iscsi-deploy-in-band-cleaning.rst \ No newline at end of file diff --git a/specs/4.3/new-ironic-driver-for-oneview.rst b/specs/4.3/new-ironic-driver-for-oneview.rst new file mode 120000 index 00000000..f6115615 --- /dev/null +++ b/specs/4.3/new-ironic-driver-for-oneview.rst @@ -0,0 +1 @@ +../approved/new-ironic-driver-for-oneview.rst \ No newline at end of file diff --git a/specs/4.3/radosgw-temp-url.rst b/specs/4.3/radosgw-temp-url.rst new file mode 120000 index 00000000..32c34f35 --- /dev/null +++ b/specs/4.3/radosgw-temp-url.rst @@ -0,0 +1 @@ +../approved/radosgw-temp-url.rst \ No newline at end of file diff --git a/specs/approved/manual-cleaning.rst b/specs/approved/manual-cleaning.rst index d962899c..25be854f 100644 --- a/specs/approved/manual-cleaning.rst +++ b/specs/approved/manual-cleaning.rst @@ -52,7 +52,8 @@ The main differences will be: * operators will be able to initiate a manual clean via the modified API to set the nodes's provision state. Details are described in the - :ref:`ProvisionCleanAPI` section. + `PUT .../states/provision <#put-v1-nodes-node-ident-states-provision>`_ + section below. * A manual clean step might need some arguments to be specified. (This might be useful for future automated steps too.) To support this, the @@ -72,7 +73,8 @@ The main differences will be: include any arguments that can be passed to the clean step. * operators will be able to get a list of possible steps via an API. The - :ref:`CleanStepsAPI` section provides more information. + `GET .../cleaning/steps <#get-nodes-node-ident-cleaning-steps>`_ section + below provides more information. * similar to executing automated clean steps, when the conductor attempts to execute a manual clean step, it will call execute_clean_step() on the driver @@ -121,8 +123,6 @@ This: REST API impact --------------- -.. _ProvisionCleanAPI: - PUT /v1/nodes//states/provision ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -173,7 +173,6 @@ be put in CLEANFAIL provision state with an appropriate error message. A new API version is needed to support this. -.. _CleanStepsAPI: GET /nodes//cleaning/steps ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/specs/not-implemented/add-pluggable-metrics-backend-for-ironic-and-ipa.rst b/specs/not-implemented/add-pluggable-metrics-backend-for-ironic-and-ipa.rst new file mode 120000 index 00000000..6ffc7214 --- /dev/null +++ b/specs/not-implemented/add-pluggable-metrics-backend-for-ironic-and-ipa.rst @@ -0,0 +1 @@ +../approved/add-pluggable-metrics-backend-for-ironic-and-ipa.rst \ No newline at end of file diff --git a/specs/not-implemented/agent-image-proxy.rst b/specs/not-implemented/agent-image-proxy.rst new file mode 120000 index 00000000..a0e2bf89 --- /dev/null +++ b/specs/not-implemented/agent-image-proxy.rst @@ -0,0 +1 @@ +../approved/agent-image-proxy.rst \ No newline at end of file diff --git a/specs/not-implemented/bare-metal-trust-using-intel-txt.rst b/specs/not-implemented/bare-metal-trust-using-intel-txt.rst new file mode 120000 index 00000000..b2265b78 --- /dev/null +++ b/specs/not-implemented/bare-metal-trust-using-intel-txt.rst @@ -0,0 +1 @@ +../approved/bare-metal-trust-using-intel-txt.rst \ No newline at end of file diff --git a/specs/not-implemented/cisco-ucs-hw-inspection.rst b/specs/not-implemented/cisco-ucs-hw-inspection.rst new file mode 120000 index 00000000..dcf837ba --- /dev/null +++ b/specs/not-implemented/cisco-ucs-hw-inspection.rst @@ -0,0 +1 @@ +../approved/cisco-ucs-hw-inspection.rst \ No newline at end of file diff --git a/specs/not-implemented/futurist.rst b/specs/not-implemented/futurist.rst new file mode 120000 index 00000000..4dafc135 --- /dev/null +++ b/specs/not-implemented/futurist.rst @@ -0,0 +1 @@ +../approved/futurist.rst \ No newline at end of file diff --git a/specs/not-implemented/inband-raid-configuration.rst b/specs/not-implemented/inband-raid-configuration.rst new file mode 120000 index 00000000..5de9d1a4 --- /dev/null +++ b/specs/not-implemented/inband-raid-configuration.rst @@ -0,0 +1 @@ +../approved/inband-raid-configuration.rst \ No newline at end of file diff --git a/specs/not-implemented/ipxe-dynamic-config.rst b/specs/not-implemented/ipxe-dynamic-config.rst new file mode 120000 index 00000000..1843977f --- /dev/null +++ b/specs/not-implemented/ipxe-dynamic-config.rst @@ -0,0 +1 @@ +../approved/ipxe-dynamic-config.rst \ No newline at end of file diff --git a/specs/not-implemented/ipxe-swift-tempurls.rst b/specs/not-implemented/ipxe-swift-tempurls.rst new file mode 120000 index 00000000..4826cd07 --- /dev/null +++ b/specs/not-implemented/ipxe-swift-tempurls.rst @@ -0,0 +1 @@ +../approved/ipxe-swift-tempurls.rst \ No newline at end of file diff --git a/specs/not-implemented/ironic-generic-raid-interface.rst b/specs/not-implemented/ironic-generic-raid-interface.rst new file mode 120000 index 00000000..ca5d13cd --- /dev/null +++ b/specs/not-implemented/ironic-generic-raid-interface.rst @@ -0,0 +1 @@ +../approved/ironic-generic-raid-interface.rst \ No newline at end of file diff --git a/specs/not-implemented/ironic-ml2-integration.rst b/specs/not-implemented/ironic-ml2-integration.rst new file mode 120000 index 00000000..a7f8452b --- /dev/null +++ b/specs/not-implemented/ironic-ml2-integration.rst @@ -0,0 +1 @@ +../approved/ironic-ml2-integration.rst \ No newline at end of file diff --git a/specs/not-implemented/manual-cleaning.rst b/specs/not-implemented/manual-cleaning.rst new file mode 120000 index 00000000..d934df05 --- /dev/null +++ b/specs/not-implemented/manual-cleaning.rst @@ -0,0 +1 @@ +../approved/manual-cleaning.rst \ No newline at end of file diff --git a/specs/not-implemented/network-provider.rst b/specs/not-implemented/network-provider.rst new file mode 120000 index 00000000..832fc984 --- /dev/null +++ b/specs/not-implemented/network-provider.rst @@ -0,0 +1 @@ +../approved/network-provider.rst \ No newline at end of file diff --git a/specs/not-implemented/nodes-tagging.rst b/specs/not-implemented/nodes-tagging.rst new file mode 120000 index 00000000..15ed73fd --- /dev/null +++ b/specs/not-implemented/nodes-tagging.rst @@ -0,0 +1 @@ +../approved/nodes-tagging.rst \ No newline at end of file diff --git a/specs/not-implemented/notifications.rst b/specs/not-implemented/notifications.rst new file mode 120000 index 00000000..267e98fa --- /dev/null +++ b/specs/not-implemented/notifications.rst @@ -0,0 +1 @@ +../approved/notifications.rst \ No newline at end of file diff --git a/specs/not-implemented/override-pxe-options-via-glance-property.rst b/specs/not-implemented/override-pxe-options-via-glance-property.rst new file mode 120000 index 00000000..512e86b2 --- /dev/null +++ b/specs/not-implemented/override-pxe-options-via-glance-property.rst @@ -0,0 +1 @@ +../approved/override-pxe-options-via-glance-property.rst \ No newline at end of file diff --git a/specs/not-implemented/petitboot-boot-driver.rst b/specs/not-implemented/petitboot-boot-driver.rst new file mode 120000 index 00000000..c62f6877 --- /dev/null +++ b/specs/not-implemented/petitboot-boot-driver.rst @@ -0,0 +1 @@ +../approved/petitboot-boot-driver.rst \ No newline at end of file diff --git a/specs/not-implemented/ssh-console-support.rst b/specs/not-implemented/ssh-console-support.rst new file mode 120000 index 00000000..f885697d --- /dev/null +++ b/specs/not-implemented/ssh-console-support.rst @@ -0,0 +1 @@ +../approved/ssh-console-support.rst \ No newline at end of file diff --git a/specs/not-implemented/third-party-ci.rst b/specs/not-implemented/third-party-ci.rst new file mode 120000 index 00000000..94a09642 --- /dev/null +++ b/specs/not-implemented/third-party-ci.rst @@ -0,0 +1 @@ +../approved/third-party-ci.rst \ No newline at end of file diff --git a/specs/not-implemented/version-caching.rst b/specs/not-implemented/version-caching.rst new file mode 120000 index 00000000..832405c4 --- /dev/null +++ b/specs/not-implemented/version-caching.rst @@ -0,0 +1 @@ +../approved/version-caching.rst \ No newline at end of file