Merge pull request #63453 from jldohmann/OSDOCS-6047

OSDOCS-6047: replace non persistent device names

Author: jldohmann

modules/bmo-getting-the-baremetalhost-resource.adoc

@@ -69,7 +69,7 @@ spec:
   hardwareProfile: unknown
   online: true
   rootDeviceHints:
-    deviceName: /dev/sda
+    deviceName: /dev/disk/by-id/scsi-<serial_number>
   userData:
     name: worker-user-data-managed
     namespace: openshift-machine-api
@@ -107,7 +107,7 @@ status:
     storage:
     - hctl: "0:0:0:0"
       model: VK000960GWTTB
-      name: /dev/sda
+      name: /dev/disk/by-id/scsi-<serial_number>
       sizeBytes: 960197124096
       type: SSD
       vendor: ATA
@@ -130,7 +130,7 @@ status:
       hardwareRAIDVolumes: null
       softwareRAIDVolumes: []
     rootDeviceHints:
-      deviceName: /dev/sda
+      deviceName: /dev/disk/by-id/scsi-<serial_number>
     state: provisioned
   triedCredentials:
     credentials:

modules/cnf-topology-aware-lifecycle-manager-backup-feature.adoc

@@ -35,12 +35,12 @@ nodes:
     role: "master"
     rootDeviceHints:
         hctl: "0:2:0:0"
-        deviceName: /dev/sda
-........
-........
-    #Disk /dev/sda: 893.3 GiB, 959119884288 bytes, 1873281024 sectors
+        deviceName: /dev/disk/by-id/scsi-3600508b400105e210000900000490000
+...
+    #Disk /dev/disk/by-id/scsi-3600508b400105e210000900000490000:
+    #893.3 GiB, 959119884288 bytes, 1873281024 sectors
     diskPartition:
-        - device: /dev/sda
+        - device: /dev/disk/by-id/scsi-3600508b400105e210000900000490000
         partitions:
         - mount_point: /var/recovery
             size: 51200

modules/ibmz-configure-nbde-with-static-ip.adoc

@@ -91,7 +91,7 @@ endif::ibm-z-kvm[]
 ----
 $ coreos-installer pxe customize \
     /root/rhcos-bootfiles/rhcos-<release>-live-initramfs.s390x.img \
-    --dest-device /dev/sda --dest-karg-append \
+    --dest-device /dev/disk/by-id/scsi-<serial-number> --dest-karg-append \
     ip=<ip-address>::<gateway-ip>:<subnet-mask>::<network-device>:none \
     --dest-karg-append nameserver=<nameserver-ip> \
     --dest-karg-append rd.neednet=1 -o \
@@ -159,4 +159,4 @@ ifeval::["{context}" == "installing-restricted-networks-ibm-z"]
 endif::[]
 ifeval::["{context}" == "installing-restricted-networks-ibm-z-kvm"]
 :!ibm-z-kvm:
-endif::[]
+endif::[]

modules/installation-disk-partitioning-upi-templates.adoc

@@ -93,7 +93,7 @@ metadata:
   name: 98-var-partition
 storage:
   disks:
-  - device: /dev/<device_name> <1>
+  - device: /dev/disk/by-id/<device_name> <1>
     partitions:
     - label: var
       start_mib: <partition_start_offset> <2>

modules/installation-disk-partitioning.adoc

@@ -92,7 +92,7 @@ metadata:
   name: 98-var-partition
 storage:
   disks:
-  - device: /dev/<device_name> <1>
+  - device: /dev/disk/by-id/<device_name> <1>
     partitions:
     - label: var
       start_mib: <partition_start_offset> <2>

modules/installation-ibm-z-user-infra-machines-iso.adoc

@@ -79,7 +79,7 @@ Write all options in the parameter file as a single line and make sure you have
 ====
 When you install with multiple paths, you must enable multipathing directly after the installation, not at a later point in time, as this can cause problems.
 ====
-... Set the install device as: `coreos.inst.install_dev=/dev/sda`.
+... Set the install device as: `coreos.inst.install_dev=/dev/disk/by-id/scsi-<serial_number>`.
 +
 [NOTE]
 ====
@@ -99,7 +99,7 @@ The following is an example parameter file `worker-1.parm` for a worker node wit
 ----
 rd.neednet=1 \
 console=ttysclp0 \
-coreos.inst.install_dev=/dev/sda \
+coreos.inst.install_dev=/dev/disk/by-id/scsi-<serial_number> \
 coreos.live.rootfs_url=http://cl1.provide.example.com:8080/assets/rhcos-live-rootfs.s390x.img \
 coreos.inst.ignition_url=http://cl1.provide.example.com:8080/ignition/worker.ign \
 ip=172.18.78.2::172.18.78.1:255.255.255.0:::none nameserver=172.18.78.1 \

modules/installation-special-config-raid.adoc

@@ -35,16 +35,16 @@ metadata:
 boot_device:
   mirror:
     devices:
-      - /dev/sda
-      - /dev/sdb
+      - /dev/disk/by-id/scsi-3600508b400105e210000900000490000
+      - /dev/disk/by-id/scsi-SSEAGATE_ST373453LW_3HW1RHM6
 storage:
   disks:
-    - device: /dev/sda
+    - device: /dev/disk/by-id/scsi-3600508b400105e210000900000490000
       partitions:
         - label: root-1
           size_mib: 25000 <1>
         - label: var-1
-    - device: /dev/sdb
+    - device: /dev/disk/by-id/scsi-SSEAGATE_ST373453LW_3HW1RHM6
       partitions:
         - label: root-2
           size_mib: 25000 <1>

modules/installation-user-infra-machines-advanced-customizing-live-serial-console.adoc

@@ -23,13 +23,13 @@ $ coreos-installer iso customize rhcos-<version>-live.x86_64.iso \
   --dest-ignition <path> \//<1>
   --dest-console tty0 \//<2>
   --dest-console ttyS0,<options> \//<3>
-  --dest-device /dev/sda <4>
+  --dest-device /dev/disk/by-id/scsi-<serial_number> <4>
 ----
 +
 <1> The location of the Ignition config to install.
 <2> The desired secondary console. In this case, the graphical console. Omitting this option will disable the graphical console.
 <3> The desired primary console. In this case, the serial console. The `options` field defines the baud rate and other settings. A common value for this field is `115200n8`. If no options are provided, the default kernel value of `9600n8` is used. For more information on the format of this option, see the link:https://www.kernel.org/doc/html/latest/admin-guide/serial-console.html[Linux kernel serial console] documentation.
-<4> The specified disk to install to. In this case, `/dev/sda`. If you omit this option, the {boot-media} automatically runs the installation program which will fail unless you also specify the `coreos.inst.install_dev` kernel argument.
+<4> The specified disk to install to. If you omit this option, the {boot-media} automatically runs the installation program which will fail unless you also specify the `coreos.inst.install_dev` kernel argument.
 +
 [NOTE]
 ====
@@ -58,14 +58,14 @@ $ coreos-installer pxe customize rhcos-<version>-live-initramfs.x86_64.img \
   --dest-ignition <path> \//<1>
   --dest-console tty0 \//<2>
   --dest-console ttyS0,<options> \//<3>
-  --dest-device /dev/sda \//<4>
+  --dest-device /dev/disk/by-id/scsi-<serial_number> \//<4>
   -o rhcos-<version>-custom-initramfs.x86_64.img
 ----
 +
 <1> The location of the Ignition config to install.
 <2> The desired secondary console. In this case, the graphical console. Omitting this option will disable the graphical console.
 <3> The desired primary console. In this case, the serial console. The `options` field defines the baud rate and other settings. A common value for this field is `115200n8`. If no options are provided, the default kernel value of `9600n8` is used. For more information on the format of this option, see the link:https://www.kernel.org/doc/html/latest/admin-guide/serial-console.html[Linux kernel serial console] documentation.
-<4> The specified disk to install to. In this case, `/dev/sda`. If you omit this option, the {boot-media} automatically runs the installer which will fail unless you also specify the `coreos.inst.install_dev` kernel argument.
+<4> The specified disk to install to. If you omit this option, the {boot-media} automatically runs the installer which will fail unless you also specify the `coreos.inst.install_dev` kernel argument.
 +
 Your customizations are applied and affect every subsequent boot of the {boot-media}.
 endif::[]

modules/installation-user-infra-machines-advanced-customizing-live.adoc

@@ -28,7 +28,7 @@ ifeval::["{boot-media}" == "ISO image"]
 ----
 $ coreos-installer iso customize rhcos-<version>-live.x86_64.iso \
     --dest-ignition bootstrap.ign \ <1>
-    --dest-device /dev/sda <2>
+    --dest-device /dev/disk/by-id/scsi-<serial_number> <2>
 ----
 endif::[]
 
@@ -39,7 +39,7 @@ ifeval::["{boot-media}" == "PXE environment"]
 ----
 $ coreos-installer pxe customize rhcos-<version>-live-initramfs.x86_64.img \
     --dest-ignition bootstrap.ign \ <1>
-    --dest-device /dev/sda \ <2>
+    --dest-device /dev/disk/by-id/scsi-<serial_number> \ <2>
     -o rhcos-<version>-custom-initramfs.x86_64.img
 ----
 endif::[]

modules/installation-user-infra-machines-advanced-enabling-serial-console.adoc

@@ -21,7 +21,7 @@ By default, the {op-system-first} serial console is disabled and all output is w
 $ coreos-installer install \
   --console=tty0 \//<1>
   --console=ttyS0,<options> \//<2>
-  --ignition-url=http://host/worker.ign /dev/sda
+  --ignition-url=http://host/worker.ign /dev/disk/by-id/scsi-<serial_number>
 ----
 +
 <1> The desired secondary console. In this case, the graphical console. Omitting this option will disable the graphical console.