Create a Bootable Device: Difference between revisions

From Alpine Linux
m (fixed small typo)
(updated wiki based on comment by reddit user kooroo at https://redd.it/1bezynm)
Line 1: Line 1:
{{Note|These instructions are exclusively for x86_64 and x86. For ARM boards, see [[Alpine_on_ARM#Preparing_installation_media]].}}
{{Note|These instructions are exclusively for x86_64 and x86. For ARM boards, see [[Alpine_on_ARM#Preparing_installation_media|Alpine on ARM]].}}


This page is about creating directly customizable boot devices. If you are looking for instructions on creating (flashing) read-only (iso9660 "CD" filesystem) images onto installation media, see the [[Installation#Flashing_.28direct_data_writing.29_the_installation_image-file_onto_a_device_or_media|Installation]] page instead.
This page is about creating directly customizable boot devices. A directly customizable Alpine Linux boot medium is basically an Alpine system in '''[[Installation#Diskless_Mode|diskless]]''' or '''[[Installation#Data_Disk_Mode|data]]''' disk-mode installed to (and booting from) a device with a writable filesystem. It allows to also upgrade the kernel with its modules and firmware that is used to boot the system with the [[Alpine_Linux_package_management#Upgrading_.22diskless.22_and_.22data.22_disk_mode_installs|update-kernel]] script.


A directly customizable Alpine Linux boot medium is basically an Alpine system in '''[[Installation#Diskless_Mode|diskless]]''' or '''[[Installation#Data_Disk_Mode|data]]''' disk-mode installed to (and booting from) a device with a writable filesystem. It allows to also upgrade the kernel with its modules and firmware that is used to boot the system with the <code>[[Alpine_Linux_package_management#Upgrading_.22diskless.22_and_.22data.22_disk_mode_installs|update-kernel]]</code> script.
The more general local customizations, the configs (.apkovl) and the package cache, may of course also be stored on the same device, as long as the hardware is not being set to be write-locked by a hardware switch.
== Requirements ==
 
* An Alpine Linux [[Installation#Preparing_installation_media|Installation Media]], can be either USB or cd-rom.
* A customizable boot device that can range from an USB drive to internal or external HDD, CF "CompactFlash", or SDcard, to install Alpine Linux in '''[[Installation#Diskless_Mode|diskless]]''' or '''[[Installation#Data_Disk_Mode|data]]''' mode.
 
== Using setup-bootable  ==
 
Using <code>setup-bootable</code> script as explained in [[Alpine_setup_scripts#setup-bootable|setup-bootable]] page is now the preferred method to create a directly customizable bootable device.
 
Complete the [[#Installation_Step_Details|Installation]] until the [[#Base_configuration|base configuration]] step by booting from an Alpine Linux [[Installation#Preparing_installation_media|Installation Media]]. Ensure that customizable boot device is already plugged in or installed.
Prepare your customizable boot device. Install the necessary tools to make sure your bootable device doesn't have weird stuff that affects you later:


The more general local customizations, the configs (.apkovl) and the package cache, may of course also be stored on the same device, as long as the hardware is not being set to be write-locked by a hardware switch.
{{Cmd|# apk add dosfstools wipefs util-linux}}
 
Run <Code>lsblk</Code> to figure out what the disk to turn into your bootable device. Let's say it's /dev/sda for this example, change as needed:
 
{{Warning|The below step will nuke EVERYTHING on the disk /dev/sda. Do not proceed if you're unsure or if you have valuable data.}}
{{Cmd|# wipefs --all /dev/sda}}
 
[[Setting_up_disks_manually#Creating_partitions|Create a partition]] sda1 with the desired size, set the type to win95 fat, and set the bootable flag on it. Alter as you need.
 
[[Filesystems#Formatting_Partitions|Format]] the newly created partition
 
{{cmd|mkfs.vfat /dev/sda1}}


Figure out where your install media files are mounted. if you run a df, you should see a read only mount for something like '''/media/cdrom''' or '''/media/usb''' or something else, depending on your environment. Let's use '''/media/cdrom''' for an example and '''/dev/sda1''' is the partition in the customizable boot device:
   
   
= Requirements =
{{Cmd|# setup-bootable -v /media/cdrom /dev/sda1}}


* An Alpine Linux CD-ROM or an .iso file containing the desired Alpine release ([https://alpinelinux.org/downloads/ Download]).
After that's done, remove [[Installation#Preparing_installation_media|Installation Media]] and [[Installation#Reboot|reboot]] the system.  
* A device like an USB drive (flash, external HD, card reader, etc.) or a CF "CompactFlash", or SDcard.


= Using setup-bootable  =
Now the system will boot from the customizable boot device '''{{path|/dev/sda}}''', where all the files are stored in '''{{path|/dev/sda1}}''' partition.


This is now the preferable method to create a directly customizable bootable device.
Login as root and run <code>setup-alpine</Code> once again to complete the [[#Installation_Step_Details|Installation]] until the [[#Base_configuration|base configuration]] step.  


It consists an [[Installation]] of a '''diskless''' or '''data''' mode system with configs and package cache on the target device, and using the <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code> script to make the device bootable.
# setup-alpine
...
Which disk(s) would you like to use? (or '?' for help or 'none') [none]  
Enter where to store configs ('floppy', 'sda1', 'usb' or 'none') [sda1]:
Enter apk cache directory (or '?' or 'none') [/media/sda1/cache]:
 
When it gets to the part where it asks you to pick what disk you want, select '''none'''.
The script will then ask about storing configs. Choose the customizable boot device you booted from (it would be 'sda1' in the above example).
Then it'll ask you where to store your cache, accept the default or type as follows i.e {{Path|/media/sda1/cache}}. Refer [[Alpine_Linux_package_management#Local_Cache|APK Local Cache]] for more details.
 
Since this is [[Installation#Diskless_Mode|diskless]] mode, always remember to run  <Code>lbu ci</Code> to commit the above changes to disk.  
{{Cmd|# lbu ci}}


= Manually copying Alpine files =
Test/verify by rebooting and seeing that your alpine setup is preserved in the customizable boot device.


If you can't/won't use '''setup-bootable''', you can manually create a customizable (writable) USB boot device instead.
== Manually copying Alpine files ==
If you do not want to use <Code>Setup-bootable</Code>, you can manually create a customizable (writable) boot device by manually copying Alpine Linux Files.


=== Copying ISO/tarball contents to a USB stick ===
=== Copying ISO/tarball contents to a USB stick ===
Line 66: Line 102:




=== Troubleshooting ===
=== Finishing installation ===
 
==== Wrong Device Name ====
 
If you cannot boot from the boot device and you see something like:
Mounting boot media failed.
initramfs emergency recovery shell launched. Type 'exit' to continue boot
then it is likely that the device name in {{Path|syslinux.cfg}} is wrong. You should replace the device name in this line:
append initrd=/boot/grsec.gz alpine_dev='''usbdisk''':vfat modules=loop,cramfs,sd-mod,usb-storage quiet
with the proper device name.
* For boot from USB, the device name should be 'usbdisk' (as shown above)
* For other options, you can run <code>cat /proc/partitions</code> to see the available disks (i.e. 'sda' or 'sdb')
 
==== Non-FAT32 Filesystems ====
 
===== Diskless and data mode booting =====
 
When the boot device is formatted with a filesystem other than those supported by default, the necessary initfs features need to be added to the modloop using <code>update-kernel</code>. See: [[Alpine_Linux_package_management#Upgrading_.22diskless.22_and_.22data.22_disk_mode_installs]]
 
===== Sys mode booting  =====
 
Mount the boot device and edit the {{Path|syslinux.cfg}} file.
 
Then locate the "append" line, and change the <code>alpine_dev=</code> setting to match the used filesystem and add the filesystem's kernel module to the <code>modules=</code> list.
 
For example, change
append [...] alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet
to
append [...] alpine_dev=usbdisk:'''ext4''' modules=loop,cramfs,sd-mod,usb-storage''',ext4''' quiet
in the case of an ext4 formatted partition. (Or correspondingly for other filesystems, if they are supported by syslinux and the Alpine Linux kernel.)
 
== Finishing installation ==


After one has booted the previously created Alpine Linux bootable USB medium, one has to prepare USB stick to hold local customizations and run ''setup-alpine'' to finish the installation.
After one has booted the previously created Alpine Linux bootable USB medium, one has to prepare USB stick to hold local customizations and run ''setup-alpine'' to finish the installation.
 
First let's find out where is our just booted USB media mounted, the location could vary.
First let's find out where is our just booted USB media mounted, the location could vary.
 
  # mount | grep /media
  # mount | grep /media
  /dev/sdU1 on /media/sdU1 type vfat (rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=utf8,shortname=mixed,errors=remount-ro)
  /dev/sdU1 on /media/sdU1 type vfat (rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=utf8,shortname=mixed,errors=remount-ro)
 
Create local directory on USB media to hold local APK cache (see [[Alpine_Linux_package_management#Local_Cache|APK Local Cache]] for details).
Create local directory on USB media to hold local APK cache (see [[Alpine_Linux_package_management#Local_Cache|APK Local Cache]] for details).


Line 132: Line 137:
Now all the customization are saved into the ''foo.apkovl.tar.gz'' compressed tarball on the USB stick itself.
Now all the customization are saved into the ''foo.apkovl.tar.gz'' compressed tarball on the USB stick itself.


= Troubleshooting =
 
== Troubleshooting ==
 
=== Wrong Device Name ===
 
If you cannot boot from the boot device and you see something like:
Mounting boot media failed.
initramfs emergency recovery shell launched. Type 'exit' to continue boot
then it is likely that the device name in {{Path|syslinux.cfg}} is wrong. You should replace the device name in this line:
append initrd=/boot/grsec.gz alpine_dev='''usbdisk''':vfat modules=loop,cramfs,sd-mod,usb-storage quiet
with the proper device name.
* For boot from USB, the device name should be 'usbdisk' (as shown above)
* For other options, you can run <code>cat /proc/partitions</code> to see the available disks (i.e. 'sda' or 'sdb')
 
===Non-FAT32 Filesystems  ===
 
When the boot device is formatted with a filesystem other than those supported by default, the necessary initfs features need to be added to the modloop using <code>update-kernel</code>. See: [[Alpine_Linux_package_management#Upgrading_.22diskless.22_and_.22data.22_disk_mode_installs]]
 
Mount the boot device and edit the {{Path|syslinux.cfg}} file.
 
Then locate the "append" line, and change the <code>alpine_dev=</code> setting to match the used filesystem and add the filesystem's kernel module to the <code>modules=</code> list.
 
For example, change
append [...] alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet
to
append [...] alpine_dev=usbdisk:'''ext4''' modules=loop,cramfs,sd-mod,usb-storage''',ext4''' quiet
in the case of an ext4 formatted partition. (Or correspondingly for other filesystems, if they are supported by syslinux and the Alpine Linux kernel.)


=== Slow USB Devices ===
=== Slow USB Devices ===
Line 144: Line 175:


Also, many CF card readers don't support DMA correctly, so you may need to add ''nodma'' to the ''append'' line of the syslinux.cfg file.
Also, many CF card readers don't support DMA correctly, so you may need to add ''nodma'' to the ''append'' line of the syslinux.cfg file.


[[Category:Installation]]
[[Category:Installation]]

Revision as of 18:44, 23 October 2024

Note: These instructions are exclusively for x86_64 and x86. For ARM boards, see Alpine on ARM.

This page is about creating directly customizable boot devices. A directly customizable Alpine Linux boot medium is basically an Alpine system in diskless or data disk-mode installed to (and booting from) a device with a writable filesystem. It allows to also upgrade the kernel with its modules and firmware that is used to boot the system with the update-kernel script.

The more general local customizations, the configs (.apkovl) and the package cache, may of course also be stored on the same device, as long as the hardware is not being set to be write-locked by a hardware switch.

Requirements

  • An Alpine Linux Installation Media, can be either USB or cd-rom.
  • A customizable boot device that can range from an USB drive to internal or external HDD, CF "CompactFlash", or SDcard, to install Alpine Linux in diskless or data mode.

Using setup-bootable

Using setup-bootable script as explained in setup-bootable page is now the preferred method to create a directly customizable bootable device.

Complete the Installation until the base configuration step by booting from an Alpine Linux Installation Media. Ensure that customizable boot device is already plugged in or installed.

Prepare your customizable boot device. Install the necessary tools to make sure your bootable device doesn't have weird stuff that affects you later:

# apk add dosfstools wipefs util-linux

Run lsblk to figure out what the disk to turn into your bootable device. Let's say it's /dev/sda for this example, change as needed:

Warning: The below step will nuke EVERYTHING on the disk /dev/sda. Do not proceed if you're unsure or if you have valuable data.


# wipefs --all /dev/sda

Create a partition sda1 with the desired size, set the type to win95 fat, and set the bootable flag on it. Alter as you need.

Format the newly created partition

mkfs.vfat /dev/sda1

Figure out where your install media files are mounted. if you run a df, you should see a read only mount for something like /media/cdrom or /media/usb or something else, depending on your environment. Let's use /media/cdrom for an example and /dev/sda1 is the partition in the customizable boot device:

# setup-bootable -v /media/cdrom /dev/sda1

After that's done, remove Installation Media and reboot the system.

Now the system will boot from the customizable boot device /dev/sda, where all the files are stored in /dev/sda1 partition.

Login as root and run setup-alpine once again to complete the Installation until the base configuration step.

# setup-alpine
...
Which disk(s) would you like to use? (or '?' for help or 'none') [none] 
Enter where to store configs ('floppy', 'sda1', 'usb' or 'none') [sda1]: 
Enter apk cache directory (or '?' or 'none') [/media/sda1/cache]:

When it gets to the part where it asks you to pick what disk you want, select none. The script will then ask about storing configs. Choose the customizable boot device you booted from (it would be 'sda1' in the above example). Then it'll ask you where to store your cache, accept the default or type as follows i.e /media/sda1/cache. Refer APK Local Cache for more details.

Since this is diskless mode, always remember to run lbu ci to commit the above changes to disk.

# lbu ci

Test/verify by rebooting and seeing that your alpine setup is preserved in the customizable boot device.

Manually copying Alpine files

If you do not want to use Setup-bootable, you can manually create a customizable (writable) boot device by manually copying Alpine Linux Files.

Copying ISO/tarball contents to a USB stick

This method is written for copying files from an Alpine ISO file but also works for Alpine tarballs (.tar.gz files) with a one line tweak (see below).

  1. Install some prerequisites. (If you're not currently using Alpine Linux then you probably have these installed already, otherwise you'll have to figure out how to install them.)

    apk add dosfstools
    apk add syslinux

  2. Set the environment variable 'mydev' to the device file name of the USB stick that Alpine Linux is to be installed to:
    Warning: BE SURE TO GET THIS RIGHT OR ELSE YOU COULD OVERWRITE THE WRONG DISK!

    Note: If USB stick's device name ends in a digit, you might have to replace all instances of ${mydev}1 with ${mydev}p1 below.

    mydev=/dev/sdU

  3. Make sure that the target drive's existing partitions, if any, are not mounted:

    umount -q $mydev?

  4. Copy and paste the following as a single command to wipe the target drive, create an MBR partition table, and create a single FAT32 partition (you can ignore any "Partition #1 contains a vfat signature." warning message):

    fdisk -w always $mydev <<EOF o n p 1 2048 -0 t 0c a w EOF

  5. Format the new FAT32 partition with a FAT32 filesystem:

    mkdosfs -F32 ${mydev}1

  6. Copy the syslinux executable boot code into the bootstrap code area of the MBR boot sector (if you're not currently using Alpine Linux you may need to adjust the path to syslinux's mbr.bin file):

    dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/mbr.bin of=$mydev

  7. Install the syslinux bootloader files onto the FAT32 filesystem. (Ignore the "Hidden (2048) does not match sectors (62)" messages - modern systems use the partition table. If you are getting "no previous syslinux boot sector found" error, try adding --install flag):

    syslinux ${mydev}1

  8. Copy the Alpine files to the FAT32 filesystem (to copy the contents of an Alpine .tar.gz tarball instead of copying /media/cdrom, set $alpinetarball to the path to the tarball and replace the 'cp' line with: tar -p -s --atime-preserve --same-owner --one-top-level=/media/$mydevname -zxvf "$alpinetarball"):

    mydevname=$(basename $mydev)1 mkdir -p /media/$mydevname mount -t vfat ${mydev}1 /media/$mydevname cp -aT /media/cdrom /media/$mydevname # -T to copy hidden files umount /media/$mydevname

  9. (Optional) Remove any .apkovl overlay files that were transferred as part of the copy process. Do this if you want an unmodified, vanilla install.

    mount -t vfat ${mydev}1 /media/$mydevname rm /media/$mydevname/*.apkovl.tar.gz umount /media/$mydevname


Finishing installation

After one has booted the previously created Alpine Linux bootable USB medium, one has to prepare USB stick to hold local customizations and run setup-alpine to finish the installation.

First let's find out where is our just booted USB media mounted, the location could vary.

# mount | grep /media
/dev/sdU1 on /media/sdU1 type vfat (rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=utf8,shortname=mixed,errors=remount-ro)

Create local directory on USB media to hold local APK cache (see APK Local Cache for details).

# mount -o remount,rw /media/sdU1
# mkdir /media/sdU1/cache
# setup-apkcache /media/sdU1/cache
# ls -l /etc/apk/cache
lrwxrwxrwx    1 root     root            17 Oct 19 13:16 /etc/apk/cache -> /media/sdU1/cache

Now run setup-alpine and proceed until a question about local disk selection - in diskless mode we won't use any disk (ie. our bootable media files is basically untouched) and we are going to use sdU1 to hold our system customization.

# setup-alpine
...
Which disk(s) would you like to use? (or '?' for help or 'none') [none] 
Enter where to store configs ('floppy', 'sdU1', 'usb' or 'none') [sdU1]: 
Enter apk cache directory (or '?' or 'none') [/media/sdU1/cache]:

After the installer finished you can see how many created/modified files are detected and will be added to the backup:

# lbu status
# lbu status | wc -l
59
# lbu commit
# ls -l /media/sdU1/*apkovl.tar.gz
-rwxr-xr-x    1 root     root          9591 Oct 19 15:23 /media/sdU1/foo.apkovl.tar.gz

Now all the customization are saved into the foo.apkovl.tar.gz compressed tarball on the USB stick itself.


Troubleshooting

Wrong Device Name

If you cannot boot from the boot device and you see something like:

Mounting boot media failed.
initramfs emergency recovery shell launched. Type 'exit' to continue boot

then it is likely that the device name in syslinux.cfg is wrong. You should replace the device name in this line:

append initrd=/boot/grsec.gz alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet

with the proper device name.

  • For boot from USB, the device name should be 'usbdisk' (as shown above)
  • For other options, you can run cat /proc/partitions to see the available disks (i.e. 'sda' or 'sdb')

Non-FAT32 Filesystems

When the boot device is formatted with a filesystem other than those supported by default, the necessary initfs features need to be added to the modloop using update-kernel. See: Alpine_Linux_package_management#Upgrading_.22diskless.22_and_.22data.22_disk_mode_installs

Mount the boot device and edit the syslinux.cfg file.

Then locate the "append" line, and change the alpine_dev= setting to match the used filesystem and add the filesystem's kernel module to the modules= list.

For example, change

append [...] alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet

to

append [...] alpine_dev=usbdisk:ext4 modules=loop,cramfs,sd-mod,usb-storage,ext4 quiet

in the case of an ext4 formatted partition. (Or correspondingly for other filesystems, if they are supported by syslinux and the Alpine Linux kernel.)

Slow USB Devices

Specifying the 'waitusb=X' option at the end of the syslinux.cfg line might help with certain USB devices that take a bit longer to register. X stands for the amount of seconds kernel will wait before looking for the installation media.

append initrd=/boot/grsec.gz alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet waitusb=3


CF card readers

Some CF card readers have problems with the faster CF cards on the market. If you experience problems booting the CF card even after checking BIOS settings, you may need to use an older card.

Also, many CF card readers don't support DMA correctly, so you may need to add nodma to the append line of the syslinux.cfg file.