[RFE] Extend the power Interface with soft power off and the management interface with NMI injection

[Vladyslav Drok]

It is proposed to enhance the current power interface to support soft power off and diagnostic interrupt (NMI [1]).

Both soft reboot and diagnostic interrupt (NMI) are supported by ipmitool.
$ man ipimtool
....
 power

        Performs a chassis control command to view and change the power state.

        diag

               Pulse a diagnostic interrupt (NMI) directly to the processor(s).

        soft

               Initiate a soft-shutdown of OS via ACPI. This can be
               done in a number of ways, commonly by simulating an
               overtemperture or by simulating a power button press.
               It is necessary for there to be Operating System support
               for ACPI and some sort of daemon watching for events for
               this soft power to work.
....

[1] http://en.wikipedia.org/wiki/Non-maskable_interrupt

- Nov 9th, 2015, Naohirot:
Overall idea can be found in the following presentation slides P.40 - P.54.

"Ironic Towards Truly Open and Reliable, Eventually for Mission Critical"
 http://www.slideshare.net/naohirot/ironic-towards-truly-open-and-reliable-eventually-for-mission-critical
 https://www.youtube.com/watch?v=MpSqDA3jo0I

[Vladyslav Drok (vdrok)]

Copy of whiteboard:

Gerrit topic: https://review.openstack.org/#q,topic:bp/enhance-power-interface-for-soft-reboot-and-nmi,n,z

Addressed by: https://review.openstack.org/186700
    Enhance Power Interface for Soft Reboot and NMI

Addressed by: https://review.openstack.org/187082
    Add iRMC vendor passthru for soft reboot and NMI

Gerrit topic: https://review.openstack.org/#q,topic:bp/enhance-power-interface-for-soft-power-off-and-inject-nmi,n,z

Addressed by: https://review.openstack.org/207897
    Enhance Power Interface for Soft Power Off and Inject NMI

Addressed by: https://review.openstack.org/216730
    Generic power I/F for soft power off and cancel task

Addressed by: https://review.openstack.org/216738
    Enhance ipmitool driver for soft power off and cancel task

Addressed by: https://review.openstack.org/216743
    Enhance iRMC driver for soft power off and cancel task

Gerrit topic: https://review.openstack.org/#q,topic:bp/task-control-functions-for-long-running-tasks,n,z

Addressed by: https://review.openstack.org/250783
    Add 'abort' support for Soft Power Off and Inject NMI

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/259320

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/293293

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/186700
Committed: https://git.openstack.org/cgit/openstack/ironic-specs/commit/?id=8bb750c0cfb5f2bfa8c0fd96c67a2e6396a90ded
Submitter: Jenkins
Branch: master

commit 8bb750c0cfb5f2bfa8c0fd96c67a2e6396a90ded
Author: Naohiro Tamura <email address hidden>
Date: Fri May 29 19:02:32 2015 +0900

    Enhance Driver Interface for Soft Power Off and Inject NMI

    This specification proposes the work required to enhance the driver
    interface to support soft power off and diagnostic interrupt (NMI [1]),
    and the work required to provide ipmitool reference implementation.

    [1] http://en.wikipedia.org/wiki/Non-maskable_interrupt

    Change-Id: I3dc6561ea7cecf8b8d998717fefa9cf8001d0f4c
    Partial-Bug: #1526226

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/348191

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/348721

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/348732

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/382194

[OpenStack Infra (hudson-openstack)]

Change abandoned by Naohiro Tamura (<email address hidden>) on branch: master
Review: https://review.openstack.org/293293
Reason: Vladyslav, Mario,

Thanks for the comment.
Since Newton Cycle has ended, I submitted this patch to the
ironic-staging-drivers repository,

https://review.openstack.org/#/c/390135/

Best regards,
Naohiro

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/216730
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=f15d5b9a37260b3876f9dadeb030412e6e1053b2
Submitter: Jenkins
Branch: master

commit f15d5b9a37260b3876f9dadeb030412e6e1053b2
Author: Naohiro Tamura <email address hidden>
Date: Fri Jul 31 00:34:08 2015 +0900

    Generic power interface for soft reboot and soft power off

    This patch updates the generic power interface to support SOFT_REBOOT
    and SOFT_POWER_OFF. And also it introduces "timeout" optional
    parameter for all power operations.

    Partial-Bug: #1526226
    Change-Id: I1c9bbd1f11f6a8565607c874b3c99aa10eeb62a5

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/216738
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=ed6c599083e9ddf8215c013dfe69947e86eeeaf0
Submitter: Jenkins
Branch: master

commit ed6c599083e9ddf8215c013dfe69947e86eeeaf0
Author: Naohiro Tamura <email address hidden>
Date: Tue Aug 25 17:39:46 2015 +0900

    Ipmitool power driver for soft reboot and soft power off

    This patch enhances ipmitool power driver to support SOFT_REBOOT
    and SOFT_POWER_OFF.

    Partial-Bug: #1526226
    Change-Id: If01721625c22a578b4311b82104cd895139e3a01

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/348191
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=58d59db30fb5925bd3a7d326338cc57e44df04b5
Submitter: Jenkins
Branch: master

commit 58d59db30fb5925bd3a7d326338cc57e44df04b5
Author: Naohiro Tamura <email address hidden>
Date: Thu Jul 28 11:49:45 2016 +0900

    Generic management I/F for Inject NMI

    This patch updates the generic management interface and adds a new
    REST API to support the injection of Non-Masking Interrupts (NMI) for
    a node. This feature can be used for hardware diagnostics, and actual
    support depends on a driver.

    Partial-Bug: #1526226
    Change-Id: I08d74f5ccbc386baca1fb29e428fe01924499d45

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/423986

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/348721
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=22a3a5a271d738530861615fd7586bb7d808a6d4
Submitter: Jenkins
Branch: master

commit 22a3a5a271d738530861615fd7586bb7d808a6d4
Author: Naohiro Tamura <email address hidden>
Date: Fri Jul 29 12:02:59 2016 +0900

    Ipmitool management driver for Inject NMI

    This patch enhances ipmitool management driver to support Inject NMI.

    Partial-Bug: #1526226
    Change-Id: I6def498a6f242b34f647bb670d3fbfcb99fb667a

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/424396

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/348732
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=c46b720036a3cb6c07b3c76913ede8cb02ecdae2
Submitter: Jenkins
Branch: master

commit c46b720036a3cb6c07b3c76913ede8cb02ecdae2
Author: Naohiro Tamura <email address hidden>
Date: Fri Jul 29 14:12:52 2016 +0900

    iRMC management driver for Inject NMI

    This patch enhances iRMC management driver to support Inject NMI.

    Partial-Bug: #1526226
    Change-Id: Id9dde5094239f215297d350a78b005accbdd8be4

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/424396
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=07d4f4e16a0945d4b17f6e9d50ba10c2cba19e66
Submitter: Jenkins
Branch: master

commit 07d4f4e16a0945d4b17f6e9d50ba10c2cba19e66
Author: Naohiro Tamura <email address hidden>
Date: Tue Jan 24 09:55:59 2017 +0900

    Fix rel note format of the new feature Inject NMI

    This is a follow-up patch for "Ipmitool management driver for Inject
    NMI" [1] so that the fix release note can be merged as a list item
    properly.

     [1] I6def498a6f242b34f647bb670d3fbfcb99fb667a

    Change-Id: I3b61a5cfd5aff2c4f28d692b86b3f7227be6fd78
    Partial-Bug: #1526226

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/216743
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=d2a4dca36d236f29298ef6f00ee36cf0b3d6f976
Submitter: Jenkins
Branch: master

commit d2a4dca36d236f29298ef6f00ee36cf0b3d6f976
Author: Naohiro Tamura <email address hidden>
Date: Tue Aug 25 18:54:51 2015 +0900

    iRMC power driver for soft reboot and soft power off

    This patch enhances iRMC power driver to support SOFT_REBOOT_SOFT and
    SOFT_POWER_OFF.

    Partial-Bug: #1526226
    Change-Id: I8c69904063ac0a9e042f54158a20347f0c2325e1

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/425541

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/425593

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/425541
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=401f78203e85f25bb6c91c415b68713cde783b7f
Submitter: Jenkins
Branch: master

commit 401f78203e85f25bb6c91c415b68713cde783b7f
Author: Naohiro Tamura <email address hidden>
Date: Thu Jan 26 14:21:35 2017 +0900

    Update iRMC driver doc for soft reboot and soft power off

    This patch adds soft reboot and soft power off requirements, pysnmp
    and ServerView Agents, to iRMC driver documentation.

    Change-Id: I0987349e71086757e404e954596e301cad59709c
    Partial-Bug: #1526226

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/426024

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/426024
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=25a536b225db51a6ec00cffde6d3537962a8d055
Submitter: Jenkins
Branch: master

commit 25a536b225db51a6ec00cffde6d3537962a8d055
Author: Naohiro Tamura <email address hidden>
Date: Fri Jan 27 10:12:30 2017 +0900

    Follow-up iRMC driver doc update

    This is a nit follow-up patch of "Update iRMC driver doc for soft
    reboot and soft power off" [1] to add URLs to ServerView Agents and
    iRMC S4 Manual.

     [1] I0987349e71086757e404e954596e301cad59709c

    Change-Id: Idf0bda1ea660096043379556d08ba3027d1b9e85
    Partial-Bug: #1526226

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/423941
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=3a91dafb1ad9f7a0dc968fc84d8087288c1f5d5e
Submitter: Jenkins
Branch: master

commit 3a91dafb1ad9f7a0dc968fc84d8087288c1f5d5e
Author: Naohiro Tamura <email address hidden>
Date: Mon Jan 23 14:56:18 2017 +0900

    Add Inject NMI to api-ref

    This patch updates api-ref documentation with Inject NMI (Non-Masking
    Interrupts) that were added in API microversion 1.29.

    Partial-Bug: #1526226
    Change-Id: I5003abcfd9a79751f40964c5bd5cb0bd550ba89d

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/427000

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/423986
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=53a4aa99c966e0ee7aaec7a6042a6523713649bc
Submitter: Jenkins
Branch: master

commit 53a4aa99c966e0ee7aaec7a6042a6523713649bc
Author: Naohiro Tamura <email address hidden>
Date: Mon Jan 23 16:32:08 2017 +0900

    Add soft reboot, soft power off and power timeout to api-ref

    This patch updates api-ref documentation with soft reboot, soft power
    off and power timeout that were added in API microversion 1.27.

    Partial-Bug: #1526226
    Change-Id: I9b17da3e5e02f7e3de0c5c2b3dec1e81bf642391

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/425593
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=2ab96f68357c6c567ce8e1de7e6ed9952a8626d7
Submitter: Jenkins
Branch: master

commit 2ab96f68357c6c567ce8e1de7e6ed9952a8626d7
Author: Naohiro Tamura <email address hidden>
Date: Thu Jan 26 17:04:06 2017 +0900

    Follow-up iRMC power driver for soft reboot/poff

    This is a follow-up patch of "iRMC power driver for soft reboot and
    soft power off" [1] to fix a nit of exception handling code and to
    make soft reboot wait logic more robust.

      [1] I8c69904063ac0a9e042f54158a20347f0c2325e1

    Change-Id: I25bd413eb0f3e6c6229bf4fa053ca6ed31a5691d
    Partial-Bug: #1526226

[John L. Villalovos (happycamp)]

Is this done?

[Sam Betts (sambetts)]

There are a couple of patches still referencing this as a Partial-Bug,

* https://review.openstack.org/#/c/382194
* https://review.openstack.org/#/c/427000

I think this should be closed out, and a new RFE opened for those patches. Its pretty much a separate feature...

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/523335

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/523335
Committed: https://git.openstack.org/cgit/openstack/ironic-specs/commit/?id=044a6a04a24fec949b4b7036ba5403944114ac98
Submitter: Zuul
Branch: master

commit 044a6a04a24fec949b4b7036ba5403944114ac98
Author: Hironori Shiina <email address hidden>
Date: Tue Nov 28 17:17:08 2017 +0900

    Remove API change for supported power states

    This patch removes an API change to expose supported power states from
    the SPEC to support soft shutdown and NMI injection. This API change
    will be discussed with another RFE.

    Change-Id: Ibff36165b9e6dedeef16e98fed60d85213b6581c
    Closes-Bug: 1526226
    Related-Bug: 1734827

[OpenStack Infra (hudson-openstack)]

Change abandoned by Julia Kreger (<email address hidden>) on branch: master
Review: https://review.opendev.org/250783
Reason: Abandoning spec as it has not been updated in nearly three years. If there is interest in it at a later time, it can be resurrected.

[OpenStack Infra (hudson-openstack)]

Change abandoned by "Dmitry Tantsur <email address hidden>" on branch: master
Review: https://review.opendev.org/c/openstack/ironic-specs/+/259320
Reason: Abandoning because of inactivity