Skip to content

RECIPE.md

Latest commit

 

History

History
320 lines (204 loc) · 9.86 KB

RECIPE.md

File metadata and controls

320 lines (204 loc) · 9.86 KB

Recipe commands

Setup

label

Create a new partition table on the disk.

Accepts:

  • LabelType (string): The partitioning scheme. Either mbr or gpt.

mkpart

Create a new partition on the disk.

Accepts:

  • Name (string): The name for the partition.
  • FsType (string): The filesystem for the partition. Can be either none, btrfs, ext[2,3,4], linux-swap, ntfs*, reiserfs*, udf*, or xfs*. If FsType is prefixed with luks- (e.g. luks-btrfs), the partition will be encrypted using LUKS2.
  • Start (int): The start position on disk for the new partition (in MiB).
  • End (int): The end position on disk for the new partition (in MiB), or -1 for using all the remaining space.
  • LUKSPassword (optional string): The password used to encrypt the partition. Only relevant if FsType is prefixed with luks-.

* = Not fully tested. Please create an issue if you encouter problems.

rm

Delete a partition from the disk.

Accepts:

  • PartNum (int): The partition number on disk (e.g. /dev/sda3 is partition 3).

resizepart

Resize a partition on disk.

Accepts:

  • PartNum (int): The partition number on disk (e.g. /dev/sda3 is partition 3).
  • PartNewSize (int): The new size in MiB for the partition.

namepart

Rename the specified partition.

Accepts:

  • PartNum (int): The partition number on disk (e.g. /dev/sda3 is partition 3).
  • PartNewName (string): The new name for the partition.

setlabel

Set the filesystem label of the specified partition.

Accepts:

  • PartNum ('int'): The partition number on disk (e.g. '/dev/sda3' is partition 3).
  • Label ('string'): The filesystem label

setflag

Set the value of a partition flag, from the flags supported by parted. See parted(8) for the full list.

Accepts:

  • PartNum (int): The partition number on disk (e.g. /dev/sda3 is partition 3).
  • FlagName (string): The name of the flag.
  • State (bool): The value to apply to the flag. Either true or false.

format

Format an existing partition to a specified filesystem. This operation will destroy all data.

Accepts:

  • PartNum (int): The partition number on disk (e.g. /dev/sda3 is partition 3).
  • FsType (string): The filesystem for the partition. Can be either btrfs, ext[2,3,4], linux-swap, ntfs*, reiserfs*, udf*, or xfs*.
  • Label (optional string): An optional filesystem label. If not given, no label will be set.

luks-format

Same as format but encrypts the partition with LUKS2.

Accepts:

  • PartNum (int): The partition number on disk (e.g. /dev/sda3 is partition 3).
  • FsType (string): The filesystem for the partition. Can be either btrfs, ext[2,3,4], linux-swap, ntfs*, reiserfs*, udf*, or xfs*.
  • Password (string): The password used to encrypt the partition.
  • Label (optional string): An optional filesystem label. If not given, no label will be set.

pvcreate

Creates a new LVM physical volume from a partition.

Accepts:

  • Partition (string): The partition to use as PV.

pvresize

Resizes an LVM physical volume.

Accepts:

  • PV (string): The physical volume path.
  • Size (optional float): The PV's desired size in MiB. If not provided, the PV will expand to the size of the underlying partition.

pvremove

Remove LVM labels from a partition.

Accepts:

  • PV (string): The physical volume path.

vgcreate

Creates a new LVM volume group.

Accepts:

  • Name (string): The VG name.
  • PVs (optional [string]): List containing paths for PVs to add to the newly created VG.

vgrename

Renames an LVM volume group.

Accepts:

  • OldName (string): The VG's current name.
  • NewName (string): The VG's new name.

vgextend

Adds PVs to an LVM volume group.

Accepts:

  • Name (string): The target VG's name.
  • PVs ([string]): A list containing the paths of the PVs to be included.

vgreduce

Removes PVs to an LVM volume group.

Accepts:

  • Name (string): The target VG's name.
  • PVs ([string]): A list containing the paths of the PVs to be removed.

vgremove

Deletes LVM volume group.

Accepts:

  • Name (string): The volume group name.

lvcreate

Create LVM logical volume.

Accepts:

  • Name (string): Logical volume name.
  • VG (string): Volume group name.
  • Type (string): Logical volume type. See lvcreate(8) for available types. If unsure, use linear.
  • Size (float or string): Logical volume size in MiB or a string containing a relative size (e.g. "100%FREE").

lvrename

Renames an LVM logical volume.

Accepts:

  • OldName (string): The LV's current name.
  • NewName (string): The LV's new name.
  • VG (string): Volume group the LV belongs to.

lvremove

Deletes LVM logical volume.

Accepts:

  • Name (string): The logical volume name.

make-thin-pool

Creates a new LVM thin pool from two LVs: one for metadata and another one for the data itself.

Accepts:

  • ThinDataLV (string): The LV for storing data (in format vg_name/lv_name).
  • ThinMetaLV (string): The LV for storing pool metadata (in format vg_name/lv_name).

lvcreate-thin

Same as lvcreate, but creates a thin LV instead.

Accepts:

  • Name (string): Thin logical volume name.
  • VG (string): Volume group name.
  • Size (float): Volume group size in MiB.
  • Thinpool (string): Name of the thin pool to create the LV from.

lvm-format

Same as format, but formats an LVM logical volume.

Accepts:

  • Name (string): Thin logical volume name (in format vg_name/lv_name).
  • FsType (string): The filesystem for the partition. Can be either btrfs, ext[2,3,4], linux-swap, ntfs*, reiserfs*, udf*, or xfs*.
  • Label (optional string): An optional filesystem label. If not given, no label will be set.

lvm-luks-format

Same as luks-format, but formats an LVM logical volume.

Accepts:

  • Name (string): Thin logical volume name (in format vg_name/lv_name).
  • FsType (string): The filesystem for the partition. Can be either btrfs, ext[2,3,4], linux-swap, ntfs*, reiserfs*, udf*, or xfs*.
  • Password (string): The password used to encrypt the volume.
  • Label (optional string): An optional filesystem label. If not given, no label will be set.

Post-Installation

adduser

Create a new user.

Accepts:

  • Username (string): The username of the new user.
  • Fullname (string): The full name (display name) of the new user.
  • Groups ([string]): A list of groups the new user belongs to (the new user is automatically part of its own group).
  • Password (optional string): The password for the user. If not provided, password login will be disabled.
  • UID (optional int): The UID for the user. Will be determined automatically if not provided.
  • GID (optional int): The GID for the user. Will be determined automatically if not provided.

timezone

Set the timezone.

Accepts:

  • TZ (string): The timezone code (e.g. America/Sao_Paulo).

shell

Run a shell command. This command accepts a variable number or parameters, where each parameter is a separate command to run.

Accepts:

  • Command(s) (...string): The shell command(s) to execute.

pkgremove

Given a file containing a list of packages, use the specified package manager to remove them.

Accepts:

  • PkgRemovePath (string): The path containing the list of packages to remove.
  • RemoveCmd (string): The package manager command to remove packages (e.g. apt remove).

hostname

Set the system's hostname.

Accepts:

  • NewHostname (string): The hostname to set.

locale

Set the system's locale, using locale-gen to generate the locale if not present.

Accepts:

  • LocaleCode (string): The locale code to use. See /etc/locale.gen for the full list of locale codes.

swapon

Use the provided partition as swap space.

Accepts:

  • Partition (string): The partition to use as swap.

keyboard

Set the system keyboard layout. See keyboard(5) for more details.

Accepts:

  • Layout (string): The keyboard's layout (XKBLAYOUT).
  • Model (string): The keyboard's model (XKBMODEL).
  • Variant (string): The keyboard's variant (XKBVARIANT).

grub-install

Install GRUB to the specified partition.

Accepts:

  • BootDirectory (string): The path for the boot dir (usually /boot).
  • InstallDevice (string): The disk where the boot partition is located.
  • Target (string): The target firmware. Either bios for legacy systems or efi for UEFI systems.
  • EntryName (string): Name of the boot entry.
  • Removable (bool): Only relevant for EFI installations. If the drive is a removable (e.g. USB stick).
  • EFIDevice (optional string): Only required for EFI installations. The partition where the EFI is located.

grub-default-config

Write key-value pairs into /etc/default/grub. This command accepts a variable number of parameters, where each parameter represents a new item to add to the file.

Accepts:

  • KV(s) (...string): The KEY=value pair(s) to add to the GRUB default file.

grub-add-script

Add one or more script files into /etc/default/grub.d. This command accepts a variable number of parameters, where each parameter represents a new file to add to the directory.

Accepts:

  • ScriptPath(s) (...string): The file path(s) for each script to add.

grub-remove-script

Remove one or more script files from /etc/default/grub.d. This command accepts a variable number of parameters, where each parameter represents a file to delete from the directory.

Accepts:

  • ScriptPath(s) (...string): The file path(s) for each script to be removed.

grub-mkconfig

Run the grub-mkconfig command to generate a new GRUB configuration into the specified output path.

Accepts:

  • OutputPath (string): The target path for the generated config.