Setting up disks manually: Difference between revisions

From Alpine Linux
(clarified on the bootloader based on man page)
(fixed links, templates moved and removed sentences to reduce redundancy)
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
Alpine Linux can be installed to run in [[Diskless Mode|Diskless]], [[#Data Disk Mode|Data]] and [[#System Disk Mode|system  Disk]] modes using <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> script. For traditional or classic '''harddisk''' install, refer [[#System_Disk_Mode_Installation|System Disk Mode Installation]].
System Disk Mode is the traditional or classic harddisk installation of Alpine Linux. This installation mode is suitable for most use cases including generic [[:Category:Desktop|desktop]], development machines etc.  


==='''Data Disk Mode'''===
If an entire hard disk(s) is available for Alpine Linux, [[Installation#setup-alpine_based_System_Disk_Install|setup-alpine based install]] is the recommended way to install Alpine Linux. For all other use cases, follow the [[Alpine_setup_scripts#setup-disk|<code>setup-disk</code>]] based Installation given below.
In Data Disk mode also the operating system runs from system RAM, thus it enjoys the same accelerated operation speed as "diskless" mode. However, swap storage and the entire {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> backup commits and the package cache. This mode is useful for having RAM accelerated servers with variable amounts of user-data that exceed the available RAM size. It enables the entire current system state (not just the boot state) to survive a system crash in accordance with the particular filesystem guarantees.  


==== Data Disk Mode Installation ====
== setup-disk based Installation ==


Following the [[Installation#Installation_Step_Details|Installation steps]] to complete the [[Installation#Base_configuration|base configuration]] completes the pre-setup of [[Diskless_Mode|"diskless"]] Alpine Linux system. In data disk mode, the boot device may also remain the initial (and possibly read-only) installation media, or be copied to a partition (e.g. /dev/sdXY) with <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>. Refer [[Create_a_Bootable_Device|Creating a bootable device]] for creating a bootable medium to boot the Data Disk Mode Installation.
To perform a traditional hard-disk installation of Alpine Linux with basic to complex partitioning needs, complete the [[Installation#Base_configuration|base configuration]] first. Then [[#Creating_partitions|partition]], [[#Formatting_partitions|format]] and mount your partitions on a MOUNTPOINT {{Path|'''/mnt'''}}. Finally, run the command {{Codeline|'''<Code>setup-disk -m sys /mnt</Code>'''}} to install Alpine Linux with {{Path|'''/mnt'''}} as root.  


As per Bug: [https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 #10474], <Code>setup-alpine</Code> script will create the data partition and mount it as /var, but '''setup-alpine's "data" disk mode can not yet configure lbu config storage settings automatically'''. The '''current workaround''', is to select "none" at the 'where to store configs' prompt (as the new data partition is not listed anyway) and configure lbu manually after <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:
# Follow the [[Installation#General_course_of_action|Installation guide]] to complete the [[Installation#Base_configuration|base configuration]], if not already done.  
 
# If necessary formatted partition(s) are unavailable, manually [[#Creating_partitions|create]] them first and [[#Formatting_partitions|format]] them with appropriate [[Filesystems|filesystem]] tools.
# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Mount the '''/ (root)'''  partition on a mount point i.e say {{Path|/mnt}} as follows: {{Cmd|# mount /dev/sdXY /mnt}}
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# If you're using EFI, make sure you create a mount point <code>/mnt/boot</code>.  {{Cmd|# mkdir -p /mnt/boot}}
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# Find the correct partition name for <code>esp</code> partition and mount it on the above mount point: {{Cmd|# mount /dev/sdXY /mnt/boot}}
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> again.
# If [[Filesystems#Swap_Partition|swap]] partition is available, you can also enable it now: {{Cmd|# swapon /dev/sdXY }}
 
# Install Alpine Linux using the following command: {{Cmd|# setup-disk -m sys /mnt}}
==='''System Disk Mode'''===
# <code>setup-disk</code> will perform a traditional hard disk install of your running system, detects your file system layout and generates {{Path|/etc/fstab}} and installs a [[Bootloaders|bootloader]] based on the <Code>BOOTLOADER</Code> [[Alpine_setup_scripts#Environment_Variables|environment variable]].
 
# At the end of Installation, you can [[Installation#Reboot|reboot]] to boot into the newly installed Alpine Linux and [[Installation#Post-Installation|configure]] further.
System Disk Mode is the traditional harddisk installation. This is the mode suitable for most use cases including generic [[:Category:Desktop|desktop]], development machines etc..
 
==== System Disk Mode Installation ====
 
If entire hard disk(s) is available for Alpine Linux and [[#Default_Layout|default layout]] is sufficient, using <code>setup-alpine</code> script with optional [[Installation#Environment variables|environment variables]] is the quickest and easiest way to [[Installation#setup-alpine_based_System_Disk_Install|install Alpine Linux]]. Refer [[Setting_up_disks_manually#Custom_Layout|custom layout]] for all other use cases.
 
===== Default Layout  =====
 
All existing partitions on the chosen hard disk(s) are deleted and 3 partitions i.e  '''(/)'''root partition, a '''/boot''' partition and a '''swap''' partition are created with ext4 [[Filesystems|filesystem]]. The <code>setup-alpine</code> script based [[Installation#setup-alpine_based_System_Disk_Install|installation]] runs the command <code>setup-disk DISKDEV</code> which supports only default layout. However, this can be customized by using the '''optional''' [[Installation#Environment variables|environment variables]].  
 
The manual pages of <code>setup-disk</code> refers this as DISKDEV mode, as entired Disk Device is used. If DISKDEV is specified, then <code>setup-disk</code> uses the specified disk(s) without asking. If multiple disks are specified then set them up in a RAID array. If there are more than 2 disks, then use [[#RAID|raid level 5]] instead of [[#RAID|raid level 1]].
 
===== Custom Layout =====
 
To perform a traditional hard-disk installation of Alpine Linux without any constraints, <code>setup-disk</code> must be called with a MOUNTPOINT. <code>setup-disk</code> will then perform a traditional harddisk or [[#System_Disk_mode|System Disk mode]] install with MOUNTPOINT as root.
 
To install Alpine Linux using custom layout follow the [[Installation#General_course_of_action|Installation guide]] to complete the [[#Base_configuration|base configuration]]. If necessary partition(s) are unavailable, manually [[#Creating_partitions|create]], [[#Formatting_partitions|format]] and mount them on a mount point i.e say {{Path|/mnt}} or any other as follows:
 
{{Cmd|# mount /dev/sdXY /mnt}}
 
If you're using EFI, make sure you create a mount point <code>/mnt/boot</code>.   
 
{{Cmd|# mkdir -p /mnt/boot}}
 
Find the correct partition name for <code>esp</code> partition and mount it on the above mount point :
 
{{Cmd|# mount /dev/sdXY /mnt/boot}}
 
If swap partition is available, you can also enable it now:
 
{{Cmd|# swapon /dev/sdXY }}
 
Install Alpine Linux using the following command:
 
{{Cmd|# setup-disk -m sys /mnt}}
 
<code>setup-disk</code> will perform a traditional disk install of Alpine Linux with MOUNTPOINT as root. It uses the [[Filesystems|filesystem]] used during [[#Formatting_partitions|formatting]] step and generates {{Path|/etc/fstab}} automatically. If <Code>BOOTLOADER</Code> [[Installation#Environment_variables|environment variable]] is specified, the specified [[Bootloaders|bootloader]] will be used. If no bootloader is specified, the default bootloader is syslinux(extlinux) except when EFI is detected or explicitly set by <Code>USE_EFI</Code> [[Installation#Environment_variables|environment variable]] which will select grub. In most cases, you can just [[Installation#Reboot|reboot]] to boot into newly installed Alpine Linux. You can also choose to [[Installation#Post-Installation|customize]] further.


== Manual partitioning ==
== Manual partitioning ==
<br>
{{Warning|Make sure to choose the correct disk device in the below section. If you choose the wrong device, you will lose your data. Make a backup first and do not proceed, if you are unsure.}}


=== Partitioning tools ===
=== Partitioning tools ===
Line 65: Line 25:


=== Creating partitions ===
=== Creating partitions ===
 
{{Warning|Make sure to choose the correct disk device in the below section. If you choose the wrong device, you will lose your data. Make a backup first and do not proceed, if you are unsure.}}
<code>cfdisk</code> will be used in all examples here as it is based on text menu without any dependencies. However, installing the package {{Pkg|<code>cfdisk</code>}} requires network to be available if using Standard ISO boot image. Alternately, {{Pkg|<code>sfdisk</code>}} is available and can be installed without network.
<code>cfdisk</code> will be used in all examples here as it is based on text menu without any dependencies. However, installing the package {{Pkg|<code>cfdisk</code>}} requires network to be available if using Standard ISO boot image. Alternately, {{Pkg|<code>sfdisk</code>}} is available and can be installed without network.


Line 85: Line 45:


=== Resizing an existing partition ===
=== Resizing an existing partition ===
{{Warning|Make sure to choose the correct disk device in the below section. If you choose the wrong device, you will lose your data. Make a backup first and do not proceed, if you are unsure.}}


<code>cfdisk</code> and <code>resize2fs</code> can be used to resize existing partitions of ext2/3/4 filsystem on the disk. For other filsystems, the necessary [[Filesystems#Filesystem_Tools|filesystem tools]] must be installed. This can be done while booted.  
<code>cfdisk</code> and <code>resize2fs</code> can be used to resize existing partitions of ext2/3/4 filsystem on the disk. For other filsystems, the necessary [[Filesystems#Filesystem_Tools|filesystem tools]] must be installed. This can be done while booted.  
Line 105: Line 66:
=== Formatting partitions ===
=== Formatting partitions ===


Install the necessary [[Filesystems#Filesystem_Tools|filesystem tools]] to [[Filesystems#Formatting_Partitions|format]] the newly [[#Creating_partitions|created]] partitions.  
Whenever a partition is [[#Creating_partitions|created]], the partition must be formatted first before using it.  Depending on the filesystem to be used, the necessary [[Filesystems#Filesystem_Tools|formatting tool]] for the filesystem must be installed first. Commonly used formatting tools like <code> mkfs.ext4</code>, <code>mkfs.vfat</code>, <code>mkfs.btrfs</code> are part of file system tools {{pkg|dosfstools|repo=main}}, {{pkg|e2fsprogs|repo=main}}, {{pkg|btrfs-progs|repo=main}} respectively. Install the [[Filesystems#Filesystem_Tools|filesystem tools]] first, if not done already.
Refer the [[Filesystems|filesystem]] page for the choices available in Alpine Linux.  
 
{{Warning|The {{Path|/dev/sdXY}} is only an example. Make sure you choose the right partition to format!  If you choose the wrong partition, your will lose your data. Make a backup first and do not proceed, if you are unsure.}}
The following examples show how to use the formatting tools for different filesystems:
 
* e2fsprogs for ext4,ext3 and ext2. ext4 is the default filesystem in Alpine Linux.
{{Cmd|# mkfs.ext4 /dev/sdaXY}}
* btrfs-progs for [[btrfs]] filesystem
{{Cmd|# mkfs.btrfs /dev/sdaXY}}
*dosfstools for fat12/fat16/fat32 filesystem
{{Cmd|# mkfs.vfat /dev/sdaXY}}
* f2fs-tools for [[F2FS]] filesystem
{{Cmd|# mkfs.f2fs /dev/sdaXY}}


== Disk layouts ==
== Disk layouts ==

Latest revision as of 11:37, 9 November 2024

System Disk Mode is the traditional or classic harddisk installation of Alpine Linux. This installation mode is suitable for most use cases including generic desktop, development machines etc.

If an entire hard disk(s) is available for Alpine Linux, setup-alpine based install is the recommended way to install Alpine Linux. For all other use cases, follow the setup-disk based Installation given below.

setup-disk based Installation

To perform a traditional hard-disk installation of Alpine Linux with basic to complex partitioning needs, complete the base configuration first. Then partition, format and mount your partitions on a MOUNTPOINT /mnt. Finally, run the command setup-disk -m sys /mnt to install Alpine Linux with /mnt as root.

  1. Follow the Installation guide to complete the base configuration, if not already done.
  2. If necessary formatted partition(s) are unavailable, manually create them first and format them with appropriate filesystem tools.
  3. Mount the / (root) partition on a mount point i.e say /mnt as follows:

    # mount /dev/sdXY /mnt

  4. If you're using EFI, make sure you create a mount point /mnt/boot.

    # mkdir -p /mnt/boot

  5. Find the correct partition name for esp partition and mount it on the above mount point:

    # mount /dev/sdXY /mnt/boot

  6. If swap partition is available, you can also enable it now:

    # swapon /dev/sdXY

  7. Install Alpine Linux using the following command:

    # setup-disk -m sys /mnt

  8. setup-disk will perform a traditional hard disk install of your running system, detects your file system layout and generates /etc/fstab and installs a bootloader based on the BOOTLOADER environment variable.
  9. At the end of Installation, you can reboot to boot into the newly installed Alpine Linux and configure further.

Manual partitioning

Partitioning tools

The installation image enviroment may have only the very basic busybox built-in fdisk command available. Busybox `fdisk` is rather limited for edit operations. Instead, alpine allows you to install more complete partitioning tool packages like sfdisk (scriptable fdisk), gptfdisk, parted (CLI), cfdisk (text menus), or even gparted (after setting up a graphical environment). These tools can be installed even during Installation immediately after setting up base configuration.

Creating partitions

Warning: Make sure to choose the correct disk device in the below section. If you choose the wrong device, you will lose your data. Make a backup first and do not proceed, if you are unsure.


cfdisk will be used in all examples here as it is based on text menu without any dependencies. However, installing the package cfdisk requires network to be available if using Standard ISO boot image. Alternately, sfdisk is available and can be installed without network.

The following step installs the package cfdisk:

# apk add cfdisk

cfdisk will be used to create partitions. Before using cfdisk, the disk name must be identified by using blkid:

# blkid

/dev/sdX1: LABEL="some" UUID="..." TYPE="vfat"
/dev/sdX2: LABEL="other" UUID="..." TYPE="ext4"

When cfdisk is run as follows, it looks for existing partitions on the disk /dev/sdX :

# cfdisk /dev/sdX

For Alpine Linux, only the (/)root partition is mandatory to. Even a /boot partition and swap are optional, when using

Resizing an existing partition

Warning: Make sure to choose the correct disk device in the below section. If you choose the wrong device, you will lose your data. Make a backup first and do not proceed, if you are unsure.


cfdisk and resize2fs can be used to resize existing partitions of ext2/3/4 filsystem on the disk. For other filsystems, the necessary filesystem tools must be installed. This can be done while booted.

cfdisk screenshot

To resize disk, launch the cfdisk:

# cfdisk /dev/sda

  1. Select the target partition, here as per image /dev/sda3
  2. Select Resize from the bottom menu.
  3. Enter the new Size at the prompt.
  4. Select Write, then Quit

If a filesystem is resized with -f (online mode), then the system must be rebooted immediately after the change is made.

# resize2fs -f /dev/sda3 # reboot

Formatting partitions

Whenever a partition is created, the partition must be formatted first before using it. Depending on the filesystem to be used, the necessary formatting tool for the filesystem must be installed first. Commonly used formatting tools like mkfs.ext4, mkfs.vfat, mkfs.btrfs are part of file system tools dosfstools, e2fsprogs, btrfs-progs respectively. Install the filesystem tools first, if not done already.

Warning: The /dev/sdXY is only an example. Make sure you choose the right partition to format! If you choose the wrong partition, your will lose your data. Make a backup first and do not proceed, if you are unsure.


The following examples show how to use the formatting tools for different filesystems:

  • e2fsprogs for ext4,ext3 and ext2. ext4 is the default filesystem in Alpine Linux.

# mkfs.ext4 /dev/sdaXY

  • btrfs-progs for btrfs filesystem

# mkfs.btrfs /dev/sdaXY

  • dosfstools for fat12/fat16/fat32 filesystem

# mkfs.vfat /dev/sdaXY

  • f2fs-tools for F2FS filesystem

# mkfs.f2fs /dev/sdaXY

Disk layouts

This material is work-in-progress ...

This entire section including RAID, Encryption and LVM needs to be updated.
(Last edited by Prabuanand on 9 Nov 2024.)

It is possible to have one or more of RAID, encrypted, and/or Logical Volume on your / (root) volume. However, the Alpine init script only knows how to handle them when they're layered in that order, and your initram and extlinux.conf files in the /boot partition are configured properly.

Your /boot directory cannot reside on an encrypted or LVM volume, at least not with Alpine's default bootloader (extlinux). (Grub2 can deal with /boot being on an LVM volume.) The usual practice is to create a small partition for /boot, then devote the rest of your disk to a separate partition on which you layer one or more of RAID, encryption, and/or Logical Volumes.

Sometimes /boot is also set up as a mirrored (RAID1) volume. However, this is just for post-init access. That way, when you write a new kernel or bootloader config file to /boot, it gets written to multiple physical partitions. During the pre-init, bootloader phase, only one of those partitions will be read from.

A typical setup might look like this:

One-disk system
---------------
  +------------------------------------------------+
  |  small partition (32--100M), holding           |
  |  only /boot, filesystem needn't be journaled   |
  +------------------------------------------------+
  |  rest of disk in second partition              |
  |  +------------------------------------------+  |
  |  | cryptsetup volume                        |  |
  |  |  +-------------------------------------+ |  |
  |  |  |  LVM PV, containing single VG,      | |  |
  |  |  |  containing multiple LVs, holding   | |  |
  |  |  |  /, /home, swap, etc                | |  |
  |  |  +-------------------------------------+ |  |
  |  +------------------------------------------+  |
  +------------------------------------------------+


Two-disk system
---------------
  +------------------------------------------------+  +------------------------------------------------+
  |  small partition (32--100M), holding           |  |  small partition (32--100M), holding           | These 2 partitions might
  |  only /boot, filesystem needn't be journaled   |  |  only /boot, filesystem needn't be journaled   | form a mirrored (RAID1)
  +------------------------------------------------+  +------------------------------------------------+ volume
  |  rest of disk in second partition              |  |  rest of disk in second partition              |
  | T================================================================================================T | These 2 partitions form
  | T +--------------------------------------------------------------------------------------------+ T | a second mirrored
  | T | cryptsetup volume                                                                          | T | (RAID1) volume
  | T |  +---------------------------------------------------------------------------------------+ | T |
  | T |  | LVM PV, containing single VG,                                                         | | T |
  | T |  | containing multiple LVs, holding                                                      | | T |
  | T |  | /, /home, swap, etc                                                                   | | T |
  | T |  +---------------------------------------------------------------------------------------+ | T |
  | T +--------------------------------------------------------------------------------------------+ T |
  | T================================================================================================T |
  |                                                |  |                                                |
  +------------------------------------------------+  +------------------------------------------------+

In a three-disk system, the /boot would still be RAID1, but the larger partition might, in that case, be RAID5.

RAID

setup-disk will automatically build a RAID array if you supply the -r switch, or if you specify more than one device.

If you want to build your RAID array manually, see Setting up a software RAID array. Then you can add additional layers of encryption and/or Logical Volumes, or just assemble the RAID array, and supply the /dev/mdi device directly to setup-disk. When you're finished, be sure to disassemble the RAID array before rebooting.

If setup-disk sees that you're using RAID, either because you gave it the -r switch, or multiple devices, or a /dev/mdi device, then it will set up your initramfs and extlinux.conf file properly. However, in other cases, such as when you're also using encryption, or you invoke setup-disk with a mounted directory argument, these might not be properly set up for RAID. In that case, you may need to manually edit/rebuild them. The following assumes that $MNT holds the root directory you're installing into:

echo "/sbin/mdadm" > $MNT/etc/mkinitfs/files.d/raid echo "/etc/mdadm.conf" >> $MNT/etc/mkinitfs/files.d/raid # edit $MNT/etc/mkinitfs/mkinitfs.conf to make sure features="..." # includes raid (this field is space-separated and quoted) mkinitfs -c $MNT/etc/mkinitfs/mkinitfs.conf -b $MNT # edit $MNT/etc/update-extlinux.conf to make sure modules=... contains # raid1 or raid456 (whichever your / is on; this field is comma-separated) # also check the root= setting extlinux --raid --install $MNT/boot --update

Todo: Does adding the --update option to extlinux ... suffice to make /boot/extlinux.conf be regenerated? Or do we need to manually tweak that file, or run update-extlinux, as well?


You might also need to manually tweak $MNT/etc/fstab. And you might need to copy /usr/share/syslinux/mbr.bin to your disk's MBR.

Encryption

See Setting up encrypted volumes with LUKS. You can add an additional Logical Volume layer, or just unlock the volume you've created (using cryptsetup luksOpen ...), and supply the /dev/mapper/something device directly to setup-disk. When you're finished, be sure to relock the volume (using cryptsetup luksClose ...) before rebooting.

If you install your / (root) on an encrypted volume, you'll need to manually edit/rebuild your initram and your extlinux.conf file. The following assumes that $MNT holds the root directory you're installing into, that you've created the cryptvolume on the device /dev/md2, and that you want to unlock the encrypted volume into a virtual volume named "crypt":

# edit $MNT/etc/mkinitfs/mkinitfs.conf to make sure features="..." # includes cryptsetup (this field is space-separated and quoted) mkinitfs -c $MNT/etc/mkinitfs/mkinitfs.conf -b $MNT # edit $MNT/etc/update-extlinux.conf to make sure default_kernel_opts="..." # contains cryptroot=/dev/md1 and cryptdm=crypt (this field is also space-separated and quoted) # also check the root= setting extlinux --install $MNT/boot --update

Todo: Does adding the --update option to extlinux ... suffice to make /boot/extlinux.conf be regenerated? Or do we need to manually tweak that file, or run update-extlinux, as well?


You might also need to manually tweak $MNT/etc/fstab.

LVM

setup-disk will automatically build and use volumes in a LVM group if you supply the -L switch.

If you instead want to build your LVM system manually, see Setting up Logical Volumes with LVM. Then vgchange -ay, format and mount your volumes, and supply the root mountpoint to setup-disk. When you're finished, be sure to

umount ... vgchange -an

before rebooting.


If setup-disk sees that you're using LVM, perhaps because you gave it the -L switch, then it will set up your initram and extlinux.conf file properly. However, in other cases, these might not be properly set up. In that case, you may need to manually edit/rebuild them. The following assumes that $MNT holds the root directory you're installing into:

# edit $MNT/etc/mkinitfs/mkinitfs.conf to make sure features="..." # includes lvm (this field is space-separated and quoted) mkinitfs -c $MNT/etc/mkinitfs/mkinitfs.conf -b $MNT # edit $MNT/etc/update-extlinux.conf to make sure root= is set correctly extlinux --install $MNT/boot --update

Todo: Does adding the --update option to extlinux ... suffice to make /boot/extlinux.conf be regenerated? Or do we need to manually tweak that file, or run update-extlinux, as well?


You might also need to manually tweak $MNT/etc/fstab.


see also