From 15f717f3f231659e4c35841895e89f72320e8388 Mon Sep 17 00:00:00 2001 From: George Melikov Date: Sat, 16 May 2020 20:46:27 +0300 Subject: [PATCH] Adopt Getting Started section Signed-off-by: George Melikov --- docs/Debian-Buster-Encrypted-Root-on-ZFS.rst | 47 ------------------- .../Debian/Debian Buster Root on ZFS.rst} | 10 +++- ...Debian GNU Linux initrd documentation.rst} | 9 ++-- .../Debian/Debian Stretch Root on ZFS.rst} | 12 +++-- .../Debian/index.rst} | 36 +++++++++----- docs/{ => Getting Started}/Fedora.rst | 3 ++ .../RHEL and CentOS.rst} | 3 ++ .../Ubuntu/Ubuntu 16.04 Root on ZFS.rst} | 8 +++- .../Ubuntu/Ubuntu 18.04 Root on ZFS.rst} | 10 +++- docs/Getting Started/Ubuntu/index.rst | 13 +++++ .../index.rst} | 23 +++++---- ...-Linux-to-a-Native-ZFS-Root-Filesystem.rst | 1 - docs/Ubuntu.rst | 10 ---- 13 files changed, 95 insertions(+), 90 deletions(-) delete mode 100644 docs/Debian-Buster-Encrypted-Root-on-ZFS.rst rename docs/{Debian-Buster-Root-on-ZFS.rst => Getting Started/Debian/Debian Buster Root on ZFS.rst} (99%) rename docs/{Debian-GNU-Linux-initrd-documentation.rst => Getting Started/Debian/Debian GNU Linux initrd documentation.rst} (96%) rename docs/{Debian-Stretch-Root-on-ZFS.rst => Getting Started/Debian/Debian Stretch Root on ZFS.rst} (99%) rename docs/{Debian.rst => Getting Started/Debian/index.rst} (76%) rename docs/{ => Getting Started}/Fedora.rst (99%) rename docs/{RHEL-and-CentOS.rst => Getting Started/RHEL and CentOS.rst} (99%) rename docs/{Ubuntu-16.04-Root-on-ZFS.rst => Getting Started/Ubuntu/Ubuntu 16.04 Root on ZFS.rst} (99%) rename docs/{Ubuntu-18.04-Root-on-ZFS.rst => Getting Started/Ubuntu/Ubuntu 18.04 Root on ZFS.rst} (99%) create mode 100644 docs/Getting Started/Ubuntu/index.rst rename docs/{Getting-Started.rst => Getting Started/index.rst} (50%) delete mode 100644 docs/HOWTO-install-Debian-GNU-Linux-to-a-Native-ZFS-Root-Filesystem.rst delete mode 100644 docs/Ubuntu.rst diff --git a/docs/Debian-Buster-Encrypted-Root-on-ZFS.rst b/docs/Debian-Buster-Encrypted-Root-on-ZFS.rst deleted file mode 100644 index f3813cf..0000000 --- a/docs/Debian-Buster-Encrypted-Root-on-ZFS.rst +++ /dev/null @@ -1,47 +0,0 @@ -This experimental guide has been made official at [[Debian Buster Root -on ZFS]]. - -If you have an existing system installed from the experimental guide, -adjust your sources: - -:: - - vi /etc/apt/sources.list.d/buster-backports.list - deb http://deb.debian.org/debian buster-backports main contrib - deb-src http://deb.debian.org/debian buster-backports main contrib - - vi /etc/apt/preferences.d/90_zfs - Package: libnvpair1linux libuutil1linux libzfs2linux libzpool2linux zfs-dkms zfs-initramfs zfs-test zfsutils-linux zfs-zed - Pin: release n=buster-backports - Pin-Priority: 990 - -This will allow you to upgrade from the locally-built packages to the -official buster-backports packages. - -You should set a root password before upgrading: - -:: - - passwd - -Apply updates: - -:: - - apt update - apt dist-upgrade - -Reboot: - -:: - - reboot - -If the bpool fails to import, then enter the rescue shell (which -requires a root password) and run: - -:: - - zpool import -f bpool - zpool export bpool - reboot diff --git a/docs/Debian-Buster-Root-on-ZFS.rst b/docs/Getting Started/Debian/Debian Buster Root on ZFS.rst similarity index 99% rename from docs/Debian-Buster-Root-on-ZFS.rst rename to docs/Getting Started/Debian/Debian Buster Root on ZFS.rst index 334c40d..8915565 100644 --- a/docs/Debian-Buster-Root-on-ZFS.rst +++ b/docs/Getting Started/Debian/Debian Buster Root on ZFS.rst @@ -1,3 +1,9 @@ +Debian Buster Root on ZFS +========================= + +.. contents:: Table of Contents + :local: + Caution ~~~~~~~ @@ -653,12 +659,12 @@ or whether ``zfs-import-scan.service`` is enabled. DefaultDependencies=no Before=zfs-import-scan.service Before=zfs-import-cache.service - + [Service] Type=oneshot RemainAfterExit=yes ExecStart=/sbin/zpool import -N -o cachefile=none bpool - + [Install] WantedBy=zfs-import.target diff --git a/docs/Debian-GNU-Linux-initrd-documentation.rst b/docs/Getting Started/Debian/Debian GNU Linux initrd documentation.rst similarity index 96% rename from docs/Debian-GNU-Linux-initrd-documentation.rst rename to docs/Getting Started/Debian/Debian GNU Linux initrd documentation.rst index 00a638f..1a0ef04 100644 --- a/docs/Debian-GNU-Linux-initrd-documentation.rst +++ b/docs/Getting Started/Debian/Debian GNU Linux initrd documentation.rst @@ -1,5 +1,8 @@ +Debian GNU Linux initrd documentation +===================================== + Supported boot parameters -========================= +************************* - rollback= Do a rollback of specified snapshot. - zfs_debug= Debug the initrd script @@ -21,7 +24,7 @@ filesystem, is that there are a lot of different ways too boot ZFS out there, and I wanted to make sure I supported them all. Pool imports -============ +************ Import using /dev/disk/by-\* ---------------------------- @@ -47,7 +50,7 @@ If that ALSO fails, it will try one more time, without any -d or -c options. Booting -======= +******* Booting from snapshot: ---------------------- diff --git a/docs/Debian-Stretch-Root-on-ZFS.rst b/docs/Getting Started/Debian/Debian Stretch Root on ZFS.rst similarity index 99% rename from docs/Debian-Stretch-Root-on-ZFS.rst rename to docs/Getting Started/Debian/Debian Stretch Root on ZFS.rst index 5157a8a..215c034 100644 --- a/docs/Debian-Stretch-Root-on-ZFS.rst +++ b/docs/Getting Started/Debian/Debian Stretch Root on ZFS.rst @@ -1,7 +1,13 @@ +Debian Stretch Root on ZFS +========================== + +.. contents:: Table of Contents + :local: + Newer release available ~~~~~~~~~~~~~~~~~~~~~~~ -- See [[Debian Buster Root on ZFS]] for new installs. +- See :doc:`Debian Buster Root on ZFS <./Debian Buster Root on ZFS>` for new installs. Caution ~~~~~~~ @@ -569,12 +575,12 @@ or whether ``zfs-import-scan.service`` is enabled. DefaultDependencies=no Before=zfs-import-scan.service Before=zfs-import-cache.service - + [Service] Type=oneshot RemainAfterExit=yes ExecStart=/sbin/zpool import -N -o cachefile=none bpool - + [Install] WantedBy=zfs-import.target diff --git a/docs/Debian.rst b/docs/Getting Started/Debian/index.rst similarity index 76% rename from docs/Debian.rst rename to docs/Getting Started/Debian/index.rst index a2bdd76..373f235 100644 --- a/docs/Debian.rst +++ b/docs/Getting Started/Debian/index.rst @@ -1,4 +1,6 @@ -Offical ZFS on Linux +Debian +====== + `DKMS `__ style packages are available from the `Debian GNU/Linux repository `__ for the @@ -9,11 +11,8 @@ new installations. **Debian Releases:** Stretch (oldstable), Buster (stable), and newer (testing, sid) **Architectures:** amd64 -Table of contents -================= - -- `Installation <#installation>`__ -- `Related Links <#related-links>`__ +.. contents:: Table of Contents + :local: Installation ------------ @@ -21,9 +20,11 @@ Installation For Debian Buster, ZFS packages are included in the `contrib repository `__. -If you want to boot from ZFS, see [[Debian Buster Root on ZFS]] instead. -For troubleshooting existing installations on Stretch, see [[Debian -Stretch Root on ZFS]]. +If you want to boot from ZFS, see +:doc:`Debian Buster Root on ZFS <./Debian Buster Root on ZFS>` +instead. +For troubleshooting existing installations on Stretch, see +:doc:`Debian Stretch Root on ZFS <./Debian Stretch Root on ZFS>`. The `backports repository `__ often @@ -60,8 +61,17 @@ Install the zfs packages: # apt-get install zfs-dkms zfsutils-linux -Related Links -------------- +Root on ZFS +----------- +.. toctree:: + :maxdepth: 1 + :glob: -- [[Debian GNU Linux initrd documentation]] -- [[Debian Buster Root on ZFS]] + *Root on ZFS + +Related topics +-------------- +.. toctree:: + :maxdepth: 1 + + Debian GNU Linux initrd documentation \ No newline at end of file diff --git a/docs/Fedora.rst b/docs/Getting Started/Fedora.rst similarity index 99% rename from docs/Fedora.rst rename to docs/Getting Started/Fedora.rst index 3e764cd..457d323 100644 --- a/docs/Fedora.rst +++ b/docs/Getting Started/Fedora.rst @@ -1,3 +1,6 @@ +Fedora +====== + Only `DKMS `__ style packages can be provided for Fedora from the official diff --git a/docs/RHEL-and-CentOS.rst b/docs/Getting Started/RHEL and CentOS.rst similarity index 99% rename from docs/RHEL-and-CentOS.rst rename to docs/Getting Started/RHEL and CentOS.rst index 4c14c22..421376d 100644 --- a/docs/RHEL-and-CentOS.rst +++ b/docs/Getting Started/RHEL and CentOS.rst @@ -1,3 +1,6 @@ +RHEL and CentOS +=============== + `kABI-tracking kmod `__ or diff --git a/docs/Ubuntu-16.04-Root-on-ZFS.rst b/docs/Getting Started/Ubuntu/Ubuntu 16.04 Root on ZFS.rst similarity index 99% rename from docs/Ubuntu-16.04-Root-on-ZFS.rst rename to docs/Getting Started/Ubuntu/Ubuntu 16.04 Root on ZFS.rst index 29a39f2..cc6ca81 100644 --- a/docs/Ubuntu-16.04-Root-on-ZFS.rst +++ b/docs/Getting Started/Ubuntu/Ubuntu 16.04 Root on ZFS.rst @@ -1,7 +1,13 @@ +Ubuntu 16.04 Root on ZFS +======================== + +.. contents:: Table of Contents + :local: + Newer release available ~~~~~~~~~~~~~~~~~~~~~~~ -- See [[Ubuntu 18.04 Root on ZFS]] for new installs. +- See :doc:`Ubuntu 18.04 Root on ZFS <./Ubuntu 18.04 Root on ZFS>` for new installs. Caution ~~~~~~~ diff --git a/docs/Ubuntu-18.04-Root-on-ZFS.rst b/docs/Getting Started/Ubuntu/Ubuntu 18.04 Root on ZFS.rst similarity index 99% rename from docs/Ubuntu-18.04-Root-on-ZFS.rst rename to docs/Getting Started/Ubuntu/Ubuntu 18.04 Root on ZFS.rst index bde9b21..adfde07 100644 --- a/docs/Ubuntu-18.04-Root-on-ZFS.rst +++ b/docs/Getting Started/Ubuntu/Ubuntu 18.04 Root on ZFS.rst @@ -1,3 +1,9 @@ +Ubuntu 18.04 Root on ZFS +======================== + +.. contents:: Table of Contents + :local: + Caution ~~~~~~~ @@ -618,12 +624,12 @@ or whether ``zfs-import-scan.service`` is enabled. DefaultDependencies=no Before=zfs-import-scan.service Before=zfs-import-cache.service - + [Service] Type=oneshot RemainAfterExit=yes ExecStart=/sbin/zpool import -N -o cachefile=none bpool - + [Install] WantedBy=zfs-import.target diff --git a/docs/Getting Started/Ubuntu/index.rst b/docs/Getting Started/Ubuntu/index.rst new file mode 100644 index 0000000..257add4 --- /dev/null +++ b/docs/Getting Started/Ubuntu/index.rst @@ -0,0 +1,13 @@ +Ubuntu +====== + +ZFS packages are `provided by the +distribution `__. + +Root on ZFS +----------- +.. toctree:: + :maxdepth: 1 + :glob: + + * \ No newline at end of file diff --git a/docs/Getting-Started.rst b/docs/Getting Started/index.rst similarity index 50% rename from docs/Getting-Started.rst rename to docs/Getting Started/index.rst index c8c30d4..00294e2 100644 --- a/docs/Getting-Started.rst +++ b/docs/Getting Started/index.rst @@ -1,14 +1,21 @@ +Getting Started +=============== + To get started with OpenZFS refer to the provided documentation for your distribution. It will cover the recommended installation method and any distribution specific information. First time OpenZFS users are encouraged to check out Aaron Toponce's `excellent documentation `__. -| `ArchLinux `__ -| [[Debian]] -| [[Fedora]] -| `FreeBSD `__ -| `Gentoo `__ -| `openSUSE `__ -| [[RHEL and CentOS]] -| [[Ubuntu]] +.. toctree:: + :maxdepth: 3 + :glob: + + ArchLinux + Debian/index + Fedora + FreeBSD + Gentoo + openSUSE + RHEL and CentOS + Ubuntu/index diff --git a/docs/HOWTO-install-Debian-GNU-Linux-to-a-Native-ZFS-Root-Filesystem.rst b/docs/HOWTO-install-Debian-GNU-Linux-to-a-Native-ZFS-Root-Filesystem.rst deleted file mode 100644 index 1845d61..0000000 --- a/docs/HOWTO-install-Debian-GNU-Linux-to-a-Native-ZFS-Root-Filesystem.rst +++ /dev/null @@ -1 +0,0 @@ -This page has moved to [[Debian Jessie Root on ZFS]]. diff --git a/docs/Ubuntu.rst b/docs/Ubuntu.rst deleted file mode 100644 index 3d04320..0000000 --- a/docs/Ubuntu.rst +++ /dev/null @@ -1,10 +0,0 @@ -ZFS packages are `provided by the -distribution `__. - -If you want to use ZFS as your root filesystem, see these instructions: - -- [[Ubuntu 18.04 Root on ZFS]] - -For troubleshooting existing installations, see: - -- 16.04: [[Ubuntu 16.04 Root on ZFS]]