Add "Ramdisk impact" section to spec template

As per the weekly meeting today [1] we have agreed to add a
new section to the spec template for changes that affect the
IPA ramdisk.

[1] http://eavesdrop.openstack.org/meetings/ironic/2016/ironic.2016-05-23-17.00.log.txt

Change-Id: I0f62e233dc7f2ad3e9940439f8ad7740de5e65c9

specs/approved/active-node-creation.rst

@@ -137,6 +137,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/add-infiniband-support.rst

@@ -135,6 +135,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/add-pluggable-metrics-backend-for-ironic-and-ipa.rst

@@ -168,6 +168,13 @@ Nova driver impact
 
 None.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/agent-api.rst

@@ -205,6 +205,11 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+None
+
 Security impact
 ---------------
 

specs/approved/agent-image-proxy.rst

@@ -116,6 +116,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/bare-metal-trust-using-intel-txt.rst

@@ -88,6 +88,13 @@ Nova driver impact
 ------------------
 Will pass the extra_spec "capabilities:trusted_boot=True" to Ironic
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 Increased confidence in bare metal nodes being free of rootkits and other

specs/approved/cisco-ucs-hw-inspection.rst

@@ -182,6 +182,13 @@ Nova driver impact
 
 None.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/cisco-ucs-oob-raid-configuration.rst

@@ -98,6 +98,13 @@ Nova driver impact
 ------------------
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 None

specs/approved/collect-system-logs-from-ipa.rst

@@ -206,6 +206,11 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+None
+
 Security impact
 ---------------
 

specs/approved/futurist.rst

@@ -83,6 +83,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/inband-raid-configuration.rst

@@ -128,6 +128,13 @@ Nova driver impact
 
 None.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/ipxe-dynamic-config.rst

@@ -116,6 +116,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/ipxe-swift-tempurls.rst

@@ -81,6 +81,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/ironic-generic-raid-interface.rst

@@ -478,6 +478,13 @@ Nova driver impact
 
 None.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/ironic-ml2-integration.rst

@@ -967,6 +967,12 @@ There will be changes necessary to the Nova driver. Proposed changes are:
   Nova to allow toggling between the old and the new methods. The flag could
   help de-couple the upgrading of Nova and of Ironic.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
 
 Security impact
 ---------------

specs/approved/ironicclient-osc-plugin.rst

@@ -309,6 +309,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/iscsi-deploy-in-band-cleaning.rst

@@ -155,6 +155,13 @@ Nova driver impact
 
 None.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/keystone-policy-support.rst

@@ -107,6 +107,13 @@ Existing deployments can continue to use a full-admin user as required prior
 to this feature. Once upgraded, a deployer could use a less-privileged user
 for nova-ironic interactions.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/manual-cleaning.rst

@@ -318,6 +318,13 @@ Nova driver impact
 None
 
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/network-provider.rst

@@ -188,6 +188,13 @@ Nova driver impact
 The Nova driver should not be directly impacted here; however, this does depend
 on changes to the Neutron network driver in Nova as described above.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/new-ironic-driver-for-oneview.rst

@@ -146,6 +146,13 @@ Nova driver impact
 ------------------
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 The connection with OneView is by default secure using TLS with certificate

specs/approved/node-name-regexp-api.rst

@@ -102,6 +102,13 @@ Nova driver impact
 
 None.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/nodes-tagging.rst

@@ -118,6 +118,13 @@ The tags information can be used for nova but it's not being
 considered as part of this spec, and may be addressed at a
 later time.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/notifications.rst

@@ -197,6 +197,13 @@ Nova driver impact
 
 None.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/nova-compatible-serial-console.rst

@@ -134,6 +134,11 @@ nova.virt.libvirt.driver.LibvirtDriver.get_serial_console(). No other
 impact for nova, and nova-serialproxy works well with the new one.
 And also, nova has agreed to the nova side of the work [#]_.
 
+Ramdisk impact
+--------------
+
+None
+
 Security impact
 ---------------
 

specs/approved/oneview-drivers-dynamic-allocation.rst

@@ -229,6 +229,13 @@ Nova driver impact
 ------------------
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/override-pxe-options-via-glance-property.rst

@@ -90,6 +90,13 @@ Nova driver impact
 ------------------
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 None

specs/approved/partition-image-support-for-agent-driver.rst

@@ -86,6 +86,13 @@ Nova driver impact
 
 None.
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/petitboot-boot-driver.rst

@@ -157,6 +157,18 @@ Nova driver impact
 ------------------
 None
 
+Ramdisk impact
+--------------
+
+A ramdisk capable of running on PPC64 hardware will need to be built, however,
+this may be done downstream.
+
+Support should be added to ramdisk build tooling, such as
+``disk-image-builder`` and ``coreos-image-builder``, to build such ramdisks.
+
+.. NOTE: This section was not present at the time this spec was approved.
+
+
 Security impact
 ---------------
 None

specs/approved/radosgw-temp-url.rst

@@ -100,6 +100,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/ssh-console-support.rst

@@ -81,6 +81,13 @@ Nova driver impact
 ------------------
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 None

specs/approved/third-party-ci.rst

@@ -161,6 +161,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/version-caching.rst

@@ -112,6 +112,13 @@ Nova driver impact
 
 None
 
+Ramdisk impact
+--------------
+
+N/A
+
+.. NOTE: This section was not present at the time this spec was approved.
+
 Security impact
 ---------------
 

specs/approved/volume-connection-information.rst

@@ -729,6 +729,11 @@ volume connector information to Cinder which returns the target information.
 This is then passed down to Ironic. Detailed information about Nova Ironic
 driver can be found in the spec [5].
 
+Ramdisk impact
+--------------
+
+None
+
 Security impact
 ---------------
 

specs/template.rst

@@ -264,6 +264,57 @@ Questions which need to be addressed in this section include:
   affects existing functionality of the nova.virt.ironic driver, how will an
   upgrade be performed? How will it be tested?
 
+Ramdisk impact
+--------------
+
+The ``ironic-python-agent`` project has become an integral component in nearly
+every Ironic deployment, and is used throughout the life cycle of each Node
+from inspection to deployment and cleaning. There are multiple ways to build a
+ramdisk containing this agent which cater to different environments, and
+operators are encouraged to build their own ramdisks as well.
+
+In this section, please describe any changes you expect to make to the
+``ironic-python-agent`` or its member classes, to the ramdisk build process, or
+that otherwise affect the resulting ramdisk and its contents. Be mindful of
+the downstream impact this may have, and to the impact on compatibility.
+
+If your change to the ramdisk will also require a change in Ironic, and you
+think they should be upgraded together, then you should approach the problem
+differently. Forward and backward compatibility, within at least one release,
+must be maintained between Ironic and the IPA ramdisk.
+
+This could include changes in any of the following:
+
+* Are you proposing a change to the ironic-python-agent API, or adding an
+  extension to it?
+
+* Are you adding a new ironic-python-agent HardwareManager? This is like adding
+  a new driver and should be documented, but will probably be easy to accept.
+
+* Are you changing the HardwareManager base class or interface definitions?
+  This is considered an API change and needs to be considered closely for
+  potential impact on downstream users.
+
+* Are you adding a new extension to IPA? This will require support in Ironic,
+  and care will need to be taken to retain compatibility with ramdisks that
+  lack this extension.
+
+* Are you adding or changing a method on an existing IPA extension? This is
+  likely to break compatibility.
+
+* Are you changing the build process, or proposing a new one?
+
+* If you are adding any new dependencies, explicitly call them out, and
+  indicate any expected change in the size of the resulting ramdisk. This may
+  affect performance in some environments.
+
+* Are you proposing a change to the hardware inventory returned by
+  list_hardware_info? This is part of the interface, and a change here will
+  affect out of tree drivers.
+
+* Are you proposing changes to ironic-inspector, or changes that will affect
+  it? This is now packaged with the default ramdisk capabilities.
+
 Security impact
 ---------------