Merge "Add examples of BIOS and BMC configuration"

[icn.git] / doc / installation-guide.md

diff --git a/doc/installation-guide.md b/doc/installation-guide.md
index f823b3d..d24f3ce 100644 (file)
--- a/doc/installation-guide.md
+++ b/doc/installation-guide.md
@@ -10,6 +10,11 @@ Due to the almost limitless number of possible hardware
 configurations, this installation guide has chosen a concrete
 configuration to use in the examples that follow.
 
+> NOTE: The example configuration's BMC does not support Redfish
+> virtual media, and therefore IPMI is used instead.  When supported
+> by the BMC, it is recommended to use the more secure Redfish virtual
+> media option as shown [Quick start guide](quick-start.md).
+
 The configuration contains the following three machines.
 
 <table id="orgf44d94a" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
@@ -110,7 +115,8 @@ There is an additional network connected to a high-speed switch:
 #### Baseboard Management Controller (BMC) configuration
 
 The BMC IP address should be statically assigned using the machine's
-BMC tool or application.
+BMC tool or application.  Configuration of the pod11-node3 machine is
+shown in [Appendix A](#bmc-configuration).
     
 To verify IPMI is configured correctly for each cluster machine, use
 ipmitool:
@@ -138,7 +144,8 @@ ipmitool](https://www.thomas-krenn.com/en/wiki/Configuring_IPMI_under_Linux_usin
 #### PXE Boot configuration
 
 Each cluster machine must be configured to PXE boot from the interface
-attached to the `provisioning` network.
+attached to the `provisioning` network.  Configuration of the
+pod11-node3 machine is shown in [Appendix A](#pxe-boot-configuration-1).
 
 One method of verifying PXE boot is configured correctly is to access
 the remote console of the machine and observe the boot process. If
@@ -158,6 +165,12 @@ If tcpdump does not show any traffic, verify that the any switches are
 configured properly to forward PXE boot requests (i.e. VLAN
 configuration).
 
+### Additional BIOS configuration
+
+Each cluster machine should also be configured to enable any desired
+features such as virtualization support.  Configuration of the
+pod11-node3 machine is shown in [Appendix
+A](#additional-bios-configuration-1).
 
 ## Jump server
 
@@ -238,7 +251,7 @@ Metal Operator resources it uses into a Helm chart.
 
 ### Configuration
 
-> NOTE:/ To assist in the migration of R5 and earlier release's use from
+> NOTE: To assist in the migration of R5 and earlier release's use from
 > nodes.json and the Provisioning resource to the site YAML described
 > below, a helper script is provided at tools/migration/to<sub>r6.sh</sub>.
 
@@ -775,4 +788,39 @@ examining the `BareMetalHost` resources, etc.
 
     root@pod11-node5:# kubectl -n flux-system delete Kustomization icn-master-site-pod11
 
+## Appendix A: BMC and BIOS configuration of pod11-node3
+
+The BMC and BIOS configuration will vary depending on the vendor.  The
+below is intended only to provide some guidance on what to look for in
+the hardware used in the chosen configuration.
+
+### BMC configuration
+
+BMC IP address configured in the BIOS.
+
+![img](./pod11-node3-bios-bmc-configuration.png "BMC LAN Configuration")
+
+BMC IP address configured in the web console.
+
+![img](./pod11-node3-ip-configuration.png "BMC LAN Configuration")
+
+IPMI configuration.  Not shown is the cipher suite configuration.
+
+![img](./pod11-node3-ipmi-over-lan.png "IPMI over LAN")
+
+### PXE boot configuration
+
+The screens below show enabling PXE boot for the specified NIC and
+ensuring it is first in the boot order.
+
+![img](./pod11-node3-bios-enable-pxe.png "Enable PXE boot")
+
+![img](./pod11-node3-bios-nic-boot-order.png "NIC boot order")
+
+### Additional BIOS configuration
+
+The screens below show enabling virtualization options in the BIOS.
+
+![img](./pod11-node3-bios-vt-x.png "Enable Intel VT-x")
 
+![img](./pod11-node3-bios-vt-d.png "Enable Intel VT-d")