mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-10-31 11:22:27 +00:00
Merge pull request #4543 from whowutwut/openbmc_flashing_doc
Add section for OpenBMC rflash in admin-guide
This commit is contained in:
zet809
GitHub
@@ -6,5 +6,5 @@ Advanced Operations
|
||||
|
||||
rinv.rst
|
||||
rvitals.rst
|
||||
rflash.rst
|
||||
rflash/index.rst
|
||||
rspconfig.rst
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
``rflash`` - Remote Firmware Flashing
|
||||
=====================================
|
||||
|
||||
See :doc:`rflash manpage </guides/admin-guides/references/man1/rflash.1>` for more information.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
ipmi.rst
|
||||
openbmc/index.rst
|
||||
@@ -1,7 +1,5 @@
|
||||
``rflash`` - Remote Firmware Flashing
|
||||
=====================================
|
||||
|
||||
See :doc:`rflash manpage </guides/admin-guides/references/man1/rflash.1>` for more information.
|
||||
IPMI Firmware Update
|
||||
====================
|
||||
|
||||
The ``rflash`` command is provided to assist the system administrator in updating firmware.
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
OpenBMC Firmware Update
|
||||
=======================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
manually.rst
|
||||
unattended.rst
|
||||
@@ -0,0 +1,10 @@
|
||||
Manual Firmware Flash
|
||||
=====================
|
||||
|
||||
.. include:: ./openbmc_common.rst
|
||||
:start-after: BEGIN_flashing_OpenBMC_Servers
|
||||
:end-before: END_flashing_OpenBMC_Servers
|
||||
|
||||
.. include:: ./openbmc_common.rst
|
||||
:start-after: BEGIN_Validation_OpenBMC_firmware
|
||||
:end-before: END_Validation_OpenBMC_firmware
|
||||
@@ -0,0 +1,100 @@
|
||||
.. BEGIN_unattended_OpenBMC_flashing
|
||||
|
||||
Unattended flash of OpenBMC firmware will do the following events:
|
||||
|
||||
#. Upload both BMC firmware file and PNOR firmware file
|
||||
#. Activate both BMC firmware and PNOR firmware
|
||||
#. If BMC firmware becomes activate, reboot BMC to apply new BMC firmware, or else, ``rflash`` will exit
|
||||
#. If BMC itself state is ``NotReady``, ``rflash`` will exit
|
||||
#. If BMC itself state is ``Ready``, and use ``--no-host-reboot`` option, ``rflash`` will not reboot the compute node
|
||||
#. If BMC itself state is ``Ready``, and do not use ``--no-host-reboot`` option, ``rflash`` will reboot the compute node to apply PNOR firmware
|
||||
|
||||
Use the following command to flash the firmware unattended: ::
|
||||
|
||||
rflash <noderange> -d /path/to/directory
|
||||
|
||||
Use the following command to flash the firmware unattended and not reboot the compute node: ::
|
||||
|
||||
rflash <noderange> -d /path/to/directory --no-host-reboot
|
||||
|
||||
If there are errors encountered during the flash process, take a look at the manual steps to continue flashing the BMC.
|
||||
|
||||
.. END_unattended_OpenBMC_flashing
|
||||
|
||||
.. BEGIN_flashing_OpenBMC_Servers
|
||||
|
||||
The sequence of events that must happen to flash OpenBMC firmware is the following:
|
||||
|
||||
#. Power off the Host
|
||||
#. Upload and Activate BMC
|
||||
#. Reboot the BMC (applies BMC)
|
||||
#. Upload and Activate PNOR
|
||||
#. Power on the Host (applies PNOR)
|
||||
|
||||
|
||||
Power off Host
|
||||
--------------
|
||||
|
||||
Use the rpower command to power off the host: ::
|
||||
|
||||
rpower <noderange> off
|
||||
|
||||
Upload and Activate BMC Firmware
|
||||
--------------------------------
|
||||
|
||||
Use the rflash command to upload and activate the PNOR firmware: ::
|
||||
|
||||
rflash <noderange> -a /path/to/obmc-phosphor-image-witherspoon.ubi.mtd.tar
|
||||
|
||||
If running ``rflash`` in Hierarchy, the firmware files must be accessible on the Service Nodes.
|
||||
|
||||
**Note:** If a .tar file is provided, the ``-a`` option does an upload and activate in one step. If an ID is provided, the ``-a`` option just does activate the specified firmware. After firmware is activated, use the ``rflash <noderange> -l`` to view. The ``rflash`` command shows ``(*)`` as the active firmware and ``(+)`` on the firmware that requires reboot to become effective.
|
||||
|
||||
Reboot the BMC
|
||||
--------------
|
||||
|
||||
Use the ``rpower`` command to reboot the BMC: ::
|
||||
|
||||
rpower <noderange> bmcreboot
|
||||
|
||||
The BMC will take 2-5 minutes to reboot, check the status using: ``rpower <noderange> bmcstate`` and wait for ``BMCReady`` to be returned.
|
||||
|
||||
**Known Issue:** On reboot, the first call to the BMC after reboot, xCAT will return ``Error: BMC did not respond within 10 seconds, retry the command.``. Please retry.
|
||||
|
||||
Upload and Activate PNOR Firmware
|
||||
---------------------------------
|
||||
|
||||
Use the rflash command to upload and activate the PNOR firmware: ::
|
||||
|
||||
rflash <noderange> -a /path/to/witherspoon.pnor.squashfs.tar
|
||||
|
||||
If running ``rflash`` in Hierarchy, the firmware files must be accessible on the Service Nodes.
|
||||
|
||||
**Note:** The ``-a`` option does an upload and activate in one step, after firmware is activated, use the ``rflash <noderange> -l`` to view. The ``rflash`` command shows ``(*)`` as the active firmware and ``(+)`` on the firmware that requires reboot to become effective.
|
||||
|
||||
Power on Host
|
||||
-------------
|
||||
|
||||
User the ``rpower`` command to power on the Host: ::
|
||||
|
||||
rpower <noderange> on
|
||||
|
||||
.. END_flashing_OpenBMC_Servers
|
||||
|
||||
.. BEGIN_Validation_OpenBMC_firmware
|
||||
|
||||
Validation
|
||||
----------
|
||||
|
||||
Use one of the following commands to validate firmware levels are in sync:
|
||||
|
||||
* Use the ``rinv`` command to validate firmware level: ::
|
||||
|
||||
rinv <noderange> firm -V | grep -i ibm | grep "\*" | xcoll
|
||||
|
||||
* Use the ``rflash`` command to validate the firmware level: ::
|
||||
|
||||
rflash <noderange> -l | grep "\*" | xcoll
|
||||
|
||||
|
||||
.. END_Validation_OpenBMC_firmware
|
||||
@@ -0,0 +1,10 @@
|
||||
Unattended Firmware Flash
|
||||
=========================
|
||||
|
||||
.. include:: ./openbmc_common.rst
|
||||
:start-after: BEGIN_unattended_OpenBMC_flashing
|
||||
:end-before: END_unattended_OpenBMC_flashing
|
||||
|
||||
.. include:: ./openbmc_common.rst
|
||||
:start-after: BEGIN_Validation_OpenBMC_firmware
|
||||
:end-before: END_Validation_OpenBMC_firmware
|
||||
@@ -5,4 +5,4 @@ Power9 Firmware Update
|
||||
:maxdepth: 2
|
||||
|
||||
ipmi.rst
|
||||
openbmc.rst
|
||||
openbmc/index.rst
|
||||
|
||||
@@ -1,79 +0,0 @@
|
||||
OpenBMC Firmware Update
|
||||
=======================
|
||||
|
||||
The process of updating firmware on the OpenBMC managed servers is documented below.
|
||||
|
||||
The sequence of events that must happen is the following:
|
||||
|
||||
* Power off the Host
|
||||
* Update and Activate PNOR
|
||||
* Update and Activate BMC
|
||||
* Reboot the BMC (applies BMC)
|
||||
* Power on the Host (applies PNOR)
|
||||
|
||||
**Note:** xCAT is working on streamlining this process to reduce the flexibility of the above steps at the convenience of the Administrator to handle the necessary reboots. See `Issue #4245 <https://github.com/xcat2/xcat-core/issues/4245>`_
|
||||
|
||||
|
||||
|
||||
Power off Host
|
||||
--------------
|
||||
|
||||
Use the rpower command to power off the host: ::
|
||||
|
||||
rpower <noderange> off
|
||||
|
||||
Update and Activate PNOR Firmware
|
||||
---------------------------------
|
||||
|
||||
Use the rflash command to upload and activate the PNOR firmware: ::
|
||||
|
||||
rflash <noderange> -a /path/to/witherspoon.pnor.squashfs.tar
|
||||
|
||||
If running ``rflash`` in Hierarchy, the firmware files must be accessible on the Service Nodes.
|
||||
|
||||
**Note:** The ``-a`` option does an upload and activate in one step, after firmware is activated, use the ``rflash <noderange> -l`` to view. The ``rflash`` command shows ``(*)`` as the active firmware and ``(+)`` on the firmware that requires reboot to become effective.
|
||||
|
||||
Update and Activate BMC Firmware
|
||||
--------------------------------
|
||||
|
||||
Use the rflash command to upload and activate the PNOR firmware: ::
|
||||
|
||||
rflash <noderange> -a /path/to/obmc-phosphor-image-witherspoon.ubi.mtd.tar
|
||||
|
||||
If running ``rflash`` in Hierarchy, the firmware files must be accessible on the Service Nodes.
|
||||
|
||||
**Note:** The ``-a`` option does an upload and activate in one step, after firmware is activated, use the ``rflash <noderange> -l`` to view. The ``rflash`` command shows ``(*)`` as the active firmware and ``(+)`` on the firmware that requires reboot to become effective.
|
||||
|
||||
Reboot the BMC
|
||||
--------------
|
||||
|
||||
Use the ``rpower`` command to reboot the BMC: ::
|
||||
|
||||
rpower <noderange> bmcreboot
|
||||
|
||||
The BMC will take 2-5 minutes to reboot, check the status using: ``rpower <noderange> bmcstate`` and wait for ``BMCReady`` to be returned.
|
||||
|
||||
**Known Issue:** On reboot, the first call to the BMC after reboot, xCAT will return ``Error: BMC did not respond within 10 seconds, retry the command.``. Please retry.
|
||||
|
||||
|
||||
Power on Host
|
||||
-------------
|
||||
|
||||
User the ``rpower`` command to power on the Host: ::
|
||||
|
||||
rpower <noderange> on
|
||||
|
||||
|
||||
Validation
|
||||
----------
|
||||
|
||||
Use one of the following commands to validate firmware levels are in sync:
|
||||
|
||||
* Use the ``rinv`` command to validate firmware level: ::
|
||||
|
||||
rinv <noderange> firm -V | grep -i ibm | grep "\*" | xcoll
|
||||
|
||||
* Use the ``rflash`` command to validate the firmware level: ::
|
||||
|
||||
rflash <noderange> -l | grep "\*" | xcoll
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
OpenBMC Firmware Update
|
||||
=======================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
unattended.rst
|
||||
manually.rst
|
||||
@@ -0,0 +1,10 @@
|
||||
Manual Firmware Flash
|
||||
=====================
|
||||
|
||||
.. include:: ../../../../../guides/admin-guides/manage_clusters/ppc64le/management/advanced/rflash/openbmc/openbmc_common.rst
|
||||
:start-after: BEGIN_flashing_OpenBMC_Servers
|
||||
:end-before: END_flashing_OpenBMC_Servers
|
||||
|
||||
.. include:: ../../../../../guides/admin-guides/manage_clusters/ppc64le/management/advanced/rflash/openbmc/openbmc_common.rst
|
||||
:start-after: BEGIN_Validation_OpenBMC_firmware
|
||||
:end-before: END_Validation_OpenBMC_firmware
|
||||
@@ -0,0 +1,10 @@
|
||||
Unattended Firmware Flash
|
||||
=========================
|
||||
|
||||
.. include:: ../../../../../guides/admin-guides/manage_clusters/ppc64le/management/advanced/rflash/openbmc/openbmc_common.rst
|
||||
:start-after: BEGIN_unattended_OpenBMC_flashing
|
||||
:end-before: END_unattended_OpenBMC_flashing
|
||||
|
||||
.. include:: ../../../../../guides/admin-guides/manage_clusters/ppc64le/management/advanced/rflash/openbmc/openbmc_common.rst
|
||||
:start-after: BEGIN_Validation_OpenBMC_firmware
|
||||
:end-before: END_Validation_OpenBMC_firmware
|
||||
Reference in New Issue
Block a user