Merge pull request #329 from SUSE/jhalackova_efiboot_note

Added adding UEFI boot records.
SUSE · Apr 24, 2024 · d059319 · d059319
2 parents 911f94c + 4f904ea
commit d059319
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 22 deletions.
diff --git a/articles/deployment-raw-images-bare-metal.asm.xml b/articles/deployment-raw-images-bare-metal.asm.xml
@@ -32,6 +32,9 @@
     <resource xml:id="_deployment-raw-partitioning" href="../concepts/deployment-raw-partitioning.xml">
       <description>Default partitioning</description>
     </resource>
+    <resource xml:id="_deployment-efiboot-record" href="../concepts/deployment-efiboot-record.xml">
+      <description>Adjusting UEFI boot</description>
+    </resource>
   </resources>
   <!-- Tasks -->
   <resources>
@@ -242,10 +245,17 @@
 
       <module resourceref="_deployment-jeos-firstboot" renderas="section"/>
     </module>
-    <module renderas="section">
+    <module renderas="section" xml:id="deployment-postdeploy-steps">
       <merge>
         <title>Post-deployment steps</title>
       </merge>
+      <module resourceref="_deployment-efiboot-record" renderas="section">
+        <merge>
+          <abstract>
+            <para/>
+          </abstract>
+        </merge>
+        </module>
       <module resourceref="_deployment-registering-system" renderas="section"/>
     </module>
     <module resourceref="_legal"/>

diff --git a/articles/deployment-selfinstall-images-bare-metal.asm.xml b/articles/deployment-selfinstall-images-bare-metal.asm.xml
@@ -34,6 +34,9 @@
     <resource xml:id="_deployment-raw-partitioning" href="../concepts/deployment-raw-partitioning.xml">
       <description>Default partitioning</description>
     </resource>
+    <resource xml:id="_deployment-efiboot-record" href="../concepts/deployment-efiboot-record.xml">
+      <description>Adjusting UEFI boot</description>
+    </resource>
   </resources>
 
     <resources>
@@ -239,10 +242,17 @@
 
       <module resourceref="_deployment-jeos-firstboot" renderas="section"/>
     </module>
-    <module renderas="section">
+    <module renderas="section" xml:id="deployment-postdeploy-steps">
       <merge>
         <title>Post-deployment steps</title>
       </merge>
+      <module resourceref="_deployment-efiboot-record" renderas="section">
+        <merge>
+          <abstract>
+            <para/>
+          </abstract>
+        </merge>
+        </module>
       <module resourceref="_deployment-registering-system" renderas="section"/>
     </module>
     <module resourceref="_legal"/>

diff --git a/concepts/deployment-efiboot-record.xml b/concepts/deployment-efiboot-record.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
+<!-- This file can be edited downstream. -->
+<!DOCTYPE topic
+[
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for file and id naming conventions -->
+<!-- metadata is dealt with on the assembly level -->
+<topic xml:id="deployment-prebuilt-images-efiboot-record"
+ role="concept" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook" version="5.2"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>
+    <title>Adding UEFI boot records</title><!-- can be changed via merge in the assembly -->
+    <!--add author's email address-->
+    <meta name="maintainer" content="[email protected]" its:translate="no"/>
+    <abstract><!-- can be changed via merge in the assembly -->
+      <para>
+       The topic explains how to potentially adjust the UEFI boot records.
+      </para>
+    </abstract>
+  </info>  
+    <para>
+     During the deployment, the image of the system is
+     just copied to the selected disk. Therefore, an EFI boot entry is not
+     created. You may need to manually boot your system using the EFI
+     shell by selecting the &productname; boot loader. After the first boot, you can
+     use <command>efibootmgr</command> to create the boot entry.
+     <command>efibootmgr</command> is available by default in the deployed
+     image.
+    </para>
+  </topic>
diff --git a/tasks/deployment-raw-procedure.xml b/tasks/deployment-raw-procedure.xml
@@ -65,7 +65,7 @@
     <step>
       <para>
         Boot the raw disk image, and in the boot loader screen, select
-        <guimenu>SLE Micro 6.0</guimenu> and confirm with
+        <guimenu>SL Micro</guimenu> and confirm with
         <guimenu>Enter</guimenu>.
       </para>
     </step>
@@ -79,8 +79,9 @@
     </step>
     <step>
       <para>
-        After successful deployment, register your system as described in
-        <xref  linkend="deployment-registering-system"/>.
+        After successful deployment, refer to 
+        <xref linkend="deployment-postdeploy-steps"/> to register your system and/or create a
+        UEFI boot record.
       </para>
     </step>
   </procedure>

diff --git a/tasks/deployment-selfinstall-procedure.xml b/tasks/deployment-selfinstall-procedure.xml
@@ -46,8 +46,8 @@
     </step>
     <step>
       <para>
-        Select <phrase os="slemicro"><guimenu>Install SLE
-        Micro</guimenu></phrase> to start the installation process.
+        Select <guimenu>Install SL
+        Micro</guimenu> to start the installation process.
       </para>
     </step>
     <step>
@@ -66,31 +66,24 @@
     <step>
       <para>
         Start the configuration process by selecting
-        <phrase os="slemicro"><guimenu>SLE Micro</guimenu></phrase>. If the
+        <guimenu>SL Micro</guimenu>. If the
         configuration device is provided, &productnameshort; is configured
         according to the instructions provided on the configuration device.
         Otherwise &jeosfirstboot; is triggered as described in
         <xref linkend="deployment-jeos-firstboot"/>.
       </para>
     </step>
-    <step>
-      <important>
-        <title>Installation using the selfinstall ISO image does not create a boot EFI entry</title>
-        <para>
-          During the deployment of the selfinstall ISO, the image of the system
-          is just copied to the selected disk, therefore, an EFI boot entry is
-          not created (like it normally would if the system is deployed using
-          an installer). You might need to manually boot your system using the
-          EFI shell by selecting the &productnameshort; boot loader. After the
-          first boot, you can use <command>efibootmgr</command> to create the
-          boot entry. <command>efibootmgr</command> is available by default in
-          the deployed image.
-        </para>
-      </important>
+    <step>      
       <para>
         After the configuration process is complete, you can log in to your
         system.
       </para>
     </step>
+    <step>
+      <para>
+        Perform post-deployment steps as described in <xref linkend="deployment-postdeploy-steps"/>.
+      </para>
+    </step>
+
   </procedure>
 </topic>