jacobpascual/openzfs-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update build instructions in NixOS

Browse Source 
various minor fixes; bump archlive to nov 2021

use dkms in live

Signed-off-by: Maurice Zhou <jasper@apvc.uk>
This commit is contained in:
Maurice Zhou
2021-11-03 00:16:31 +08:00
committed by George Melikov
parent f60e80083d
commit 783877d147
14 changed files with 33 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Getting Started/Arch Linux/0-archzfs-repo.rst
View File

@@ -13,7 +13,7 @@ You can use it as follows.
#. Import keys of archzfs repository:: #. Import keys of archzfs repository::
curl -L https://archzfs.com/archzfs.gpg | pacman-key -a - curl -L https://archzfs.com/archzfs.gpg | pacman-key -a -
curl -L https://git.io/JsfVS | xargs -i{} pacman-key --lsign-key {} pacman-key --lsign-key $(curl -L https://git.io/JsfVS)
curl -L https://git.io/Jsfw2 > /etc/pacman.d/mirrorlist-archzfs curl -L https://git.io/Jsfw2 > /etc/pacman.d/mirrorlist-archzfs
#. Add archzfs repository:: #. Add archzfs repository::

4
docs/Getting Started/Arch Linux/2-zfs-dkms.rst
View File

@@ -25,7 +25,9 @@ Installation
#. Check kernel variant:: #. Check kernel variant::
INST_LINVAR=$(sed 's|.*linux|linux|' /proc/cmdline | sed 's|.img||g' | awk '{ print $1 }') INST_LINVAR=$(sed 's|.*linux|linux|' /proc/cmdline | sed 's|.img||g' | awk '{ print $1 }')
#for live image
If you are using live image, use the hard-coded value::
#INST_LINVAR=linux #INST_LINVAR=linux
#. Check kernel version:: #. Check kernel version::

6
docs/Getting Started/Arch Linux/Root on ZFS/1-preparation.rst
View File

@@ -7,13 +7,13 @@ Preparation
:local: :local:
#. Download #. Download
`2021.09.01 <https://mirrors.ocf.berkeley.edu/archlinux/iso/2021.09.01/archlinux-2021.09.01-x86_64.iso>`__ `2021.11.01 <https://mirrors.ocf.berkeley.edu/archlinux/iso/2021.11.01/archlinux-2021.11.01-x86_64.iso>`__
Live ISO and `signature <https://archlinux.org/iso/2021.09.01/archlinux-2021.09.01-x86_64.iso.sig>`__. Live ISO and `signature <https://archlinux.org/iso/2021.11.01/archlinux-2021.11.01-x86_64.iso.sig>`__.
#. Follow `installation guide on Arch wiki <https://wiki.archlinux.org/title/Installation_guide>`__ #. Follow `installation guide on Arch wiki <https://wiki.archlinux.org/title/Installation_guide>`__
up to **Update the system clock**. up to **Update the system clock**.
#. Set root password or ``/root/authorized_keys``. #. Set root password or ``/root/.ssh/authorized_keys``.
#. Start SSH server:: #. Start SSH server::
systemctl start sshd systemctl start sshd

16
docs/Getting Started/Arch Linux/Root on ZFS/4-optional-configuration.rst
View File

@@ -17,10 +17,14 @@ instance of an operating system. Within the context of this installation,
boot environments can be created on-the-fly to preserve root file system boot environments can be created on-the-fly to preserve root file system
states before pacman transactions. states before pacman transactions.
Install ``bieaz`` from AUR. Optionally install ``rozb3-pac`` from AUR Install an AUR helper of choice then install ``rozb3-pac`` from AUR
for pacman integration. for pacman integration::
See `home page <https://nu8.org/pages/projects/bieaz/>`__ for details. pacman -S --needed git base-devel
git clone https://aur.archlinux.org/paru-bin.git
cd paru-bin
makepkg -si
paru -S rozb3-pac
Supply password with SSH Supply password with SSH
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -256,9 +260,9 @@ boot from it. This enables system recovery and re-installation.
mkdir /boot/efi/iso mkdir /boot/efi/iso
cd /boot/efi/iso cd /boot/efi/iso
# select a mirror # curl -O https://mirrors.ocf.berkeley.edu/archlinux/iso/2021.09.01/archlinux-2021.09.01-x86_64.iso # select a mirror # curl -O https://mirrors.ocf.berkeley.edu/archlinux/iso/2021.11.01/archlinux-2021.11.01-x86_64.iso
curl -O https://archlinux.org/iso/2021.09.01/archlinux-2021.09.01-x86_64.iso.sig curl -O https://archlinux.org/iso/2021.11.01/archlinux-2021.11.01-x86_64.iso.sig
gpg --auto-key-retrieve --verify archlinux-2021.09.01-x86_64.iso.sig gpg --auto-key-retrieve --verify archlinux-2021.11.01-x86_64.iso.sig
Additionally you can build your own live image Additionally you can build your own live image
with `archiso package <https://gitlab.archlinux.org/archlinux/archiso>`__. with `archiso package <https://gitlab.archlinux.org/archlinux/archiso>`__.

2
docs/Getting Started/Fedora/Root on ZFS/1-preparation.rst
View File

@@ -13,7 +13,7 @@ Preparation
- `Fedora Workstation (GNOME) <https://download.fedoraproject.org/pub/fedora/linux/releases/34/Workstation/x86_64/iso/>`__ - `Fedora Workstation (GNOME) <https://download.fedoraproject.org/pub/fedora/linux/releases/34/Workstation/x86_64/iso/>`__
- `Fedora Spins (Xfce, i3, ...) <https://download.fedoraproject.org/pub/fedora/linux/releases/34/Spins/x86_64/iso/>`__ - `Fedora Spins (Xfce, i3, ...) <https://download.fedoraproject.org/pub/fedora/linux/releases/34/Spins/x86_64/iso/>`__
#. Set root password or ``/root/authorized_keys``. #. Set root password or ``/root/.ssh/authorized_keys``.
#. Start SSH server:: #. Start SSH server::
echo PermitRootLogin yes >> /etc/ssh/sshd_config echo PermitRootLogin yes >> /etc/ssh/sshd_config

5
docs/Getting Started/Fedora/Root on ZFS/2-system-installation.rst
View File

@@ -238,3 +238,8 @@ System Installation
#. Install ZFS:: #. Install ZFS::
dnf --installroot=/mnt -y install zfs zfs-dracut dnf --installroot=/mnt -y install zfs zfs-dracut
#. Optional: enable boot environment support and dnf integration::
dnf --installroot=/mnt copr enable -y m0p/bieaz
dnf --installroot=/mnt install -y bieaz python3-dnf-plugin-rozb3

21
docs/Getting Started/Fedora/Root on ZFS/4-optional-configuration.rst
View File

@@ -1,21 +0,0 @@
.. highlight:: sh
Optional Configuration
======================
.. contents:: Table of Contents
:local:
Skip to `bootloader <5-bootloader.html>`__ section if
no optional configuration is needed.
Boot environment manager
~~~~~~~~~~~~~~~~~~~~~~~~
A boot environment is a dataset which contains a bootable
instance of an operating system.
Install ``bieaz`` from COPR. Optionally install ``python3-dnf-plugin-rozb3`` from COPR
for dnf integration.
See `home page <https://nu8.org/pages/projects/bieaz/>`__ for details.

2
docs/Getting Started/Fedora/Root on ZFS/5-bootloader.rst
View File

@@ -212,7 +212,7 @@ Post installaion
Install package groups:: Install package groups::
dnf group list # query package groups dnf group list --hidden -v # query package groups
dnf group install 'i3 Desktop' dnf group install 'i3 Desktop'
dnf group install 'Fedora Workstation' # GNOME dnf group install 'Fedora Workstation' # GNOME
dnf group install 'Web Server' dnf group install 'Web Server'

3
docs/Getting Started/NixOS/index.rst
View File

@@ -70,7 +70,7 @@ Contribute
#. Launch an ephemeral nix-shell with the following packages:: #. Launch an ephemeral nix-shell with the following packages::
nix-shell -p python39 python39Packages.pip gnumake \ nix-shell -p python39 python39Packages.pip gnumake \
python39Packages.setuptools python39Packages.sphinx python39Packages.setuptools
#. Create python virtual environment and install packages:: #. Create python virtual environment and install packages::
@@ -84,7 +84,6 @@ Contribute
#. Test:: #. Test::
cd docs
make html make html
sensible-browser _build/html/index.html sensible-browser _build/html/index.html

4
docs/Getting Started/RHEL-based distro/RHEL 8-based distro Root on ZFS/1-preparation.rst
View File

@@ -10,7 +10,7 @@ Preparation
#. Download a variant of `Rocky Linux 8.4 Live #. Download a variant of `Rocky Linux 8.4 Live
ISO <https://dl.rockylinux.org/pub/rocky/8.4/Live/x86_64/>`__ and boot from it. ISO <https://dl.rockylinux.org/pub/rocky/8.4/Live/x86_64/>`__ and boot from it.
#. Set root password or ``/root/authorized_keys``. #. Set root password or ``/root/.ssh/authorized_keys``.
#. Start SSH server:: #. Start SSH server::
echo PermitRootLogin yes >> /etc/ssh/sshd_config echo PermitRootLogin yes >> /etc/ssh/sshd_config
@@ -42,8 +42,6 @@ Preparation
#. Install ZFS packages:: #. Install ZFS packages::
dnf config-manager --disable zfs
dnf config-manager --enable zfs-kmod
dnf install -y epel-release dnf install -y epel-release
dnf install -y zfs dnf install -y zfs

5
docs/Getting Started/RHEL-based distro/RHEL 8-based distro Root on ZFS/2-system-installation.rst
View File

@@ -251,3 +251,8 @@ System Installation
source /mnt/etc/os-release source /mnt/etc/os-release
RHEL_ZFS_REPO_NEW=https://zfsonlinux.org/epel/zfs-release.el${VERSION_ID/./_}.noarch.rpm RHEL_ZFS_REPO_NEW=https://zfsonlinux.org/epel/zfs-release.el${VERSION_ID/./_}.noarch.rpm
dnf install --installroot=/mnt -y $RHEL_ZFS_REPO_NEW || true dnf install --installroot=/mnt -y $RHEL_ZFS_REPO_NEW || true
#. Optional: enable boot environment support and dnf integration::
dnf --installroot=/mnt copr enable -y m0p/bieaz
dnf --installroot=/mnt install -y bieaz python3-dnf-plugin-rozb3

21
docs/Getting Started/RHEL-based distro/RHEL 8-based distro Root on ZFS/4-optional-configuration.rst
View File

@@ -1,21 +0,0 @@
.. highlight:: sh
Optional Configuration
======================
.. contents:: Table of Contents
:local:
Skip to `bootloader <5-bootloader.html>`__ section if
no optional configuration is needed.
Boot environment manager
~~~~~~~~~~~~~~~~~~~~~~~~
A boot environment is a dataset which contains a bootable
instance of an operating system.
Install ``bieaz`` from COPR. Optionally install ``python3-dnf-plugin-rozb3`` from COPR
for dnf integration.
See `home page <https://nu8.org/pages/projects/bieaz/>`__ for details.

2
docs/Getting Started/RHEL-based distro/RHEL 8-based distro Root on ZFS/5-bootloader.rst
View File

@@ -234,5 +234,5 @@ Post installaion
Install package groups:: Install package groups::
dnf group list # query package groups dnf group list --hidden -v # query package groups
dnf group install 'Virtualization Host' dnf group install 'Virtualization Host'

2
docs/Getting Started/RHEL-based distro/index.rst
View File

@@ -40,7 +40,7 @@ For RHEL/CentOS versions 6 and 7 run::
yum install https://zfsonlinux.org/epel/zfs-release$(rpm -E %distro).noarch.rpm yum install https://zfsonlinux.org/epel/zfs-release$(rpm -E %distro).noarch.rpm
rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-zfsonlinux rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-zfsonlinux
And for RHEL/CentOS 8 and newer:: And for RHEL/CentOS 8 and newer (tested with `Rocky Linux <https://rockylinux.org/>`__ 8)::
source /etc/os-release source /etc/os-release
dnf install https://zfsonlinux.org/epel/zfs-release.el${VERSION_ID/./_}.noarch.rpm dnf install https://zfsonlinux.org/epel/zfs-release.el${VERSION_ID/./_}.noarch.rpm