mirror of
				https://github.com/xcat2/xcat-core.git
				synced 2025-10-27 01:15:34 +00:00 
			
		
		
		
	Add section for OpenBMC rflash in admin-guide, link this section to CORAL reference section
This commit is contained in:
		| @@ -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 | ||||
|  | ||||
|    unattended.rst | ||||
|    manually.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 | ||||
| @@ -1,18 +1,27 @@ | ||||
| OpenBMC Firmware Update | ||||
| ======================= | ||||
| .. BEGIN_unattended_OpenBMC_flashing | ||||
| 
 | ||||
| The process of updating firmware on the OpenBMC managed servers is documented below.   | ||||
| Unattended flash of OpenBMC managed BMC means that xCAT will attempt to: | ||||
| 
 | ||||
| The sequence of events that must happen is the following:  | ||||
| #. Upload and active BMC, PNOR or both depending on which files are provided. | ||||
| #. Reboot the necessary components (BMC and/or HOST) to activate the firmware levels | ||||
| 
 | ||||
|   * Power off the Host  | ||||
|   * Update and Activate PNOR | ||||
|   * Update and Activate BMC  | ||||
|   * Reboot the BMC (applies BMC) | ||||
|   * Power on the Host (applies PNOR)  | ||||
| Use the following command to flash the firmware unattended: :: | ||||
| 
 | ||||
| **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>`_ | ||||
|     rpower <noderange> -d /path/to/directory | ||||
| 
 | ||||
| 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  | ||||
| @@ -22,18 +31,7 @@ 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 | ||||
| Upload and Activate BMC Firmware | ||||
| -------------------------------- | ||||
| 
 | ||||
| Use the rflash command to upload and activate the PNOR firmware: :: | ||||
| @@ -55,6 +53,16 @@ The BMC will take 2-5 minutes to reboot, check the status using: ``rpower <noder | ||||
| 
 | ||||
| **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 | ||||
| ------------- | ||||
| @@ -63,6 +71,9 @@ User the ``rpower`` command to power on the Host: :: | ||||
| 
 | ||||
|    rpower <noderange> on  | ||||
| 
 | ||||
| .. END_flashing_OpenBMC_Servers | ||||
| 
 | ||||
| .. BEGIN_Validation_OpenBMC_firmware | ||||
| 
 | ||||
| Validation | ||||
| ---------- | ||||
| @@ -77,3 +88,5 @@ Use one of the following commands to validate firmware levels are in sync: | ||||
| 
 | ||||
|    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 | ||||
|   | ||||
| @@ -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