From 6edad9c6cbf8d5c8974e58b7fad49672d7392a61 Mon Sep 17 00:00:00 2001 From: "Scot W. Stevenson" Date: Mon, 15 Apr 2019 18:35:06 +0200 Subject: [PATCH] Move ZFS docs to own folder --- docs/overview.md | 45 +++++++++++++++-------------- docs/{ => zfs}/zfs_configuration.md | 8 ++--- docs/{ => zfs}/zfs_overview.md | 0 3 files changed, 25 insertions(+), 28 deletions(-) rename docs/{ => zfs}/zfs_configuration.md (98%) rename docs/{ => zfs}/zfs_overview.md (100%) diff --git a/docs/overview.md b/docs/overview.md index 3332f0b7..82808580 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -47,28 +47,30 @@ technologies involved and be able to set up the basic stuff yourself. As a to-do list, before you can even install Ansible-NAS, you'll have to: -1. Choose, buy, configure, and test your own **hardware**. Note that ZFS loves - RAM, and it is [recommended](zfs_overview.md) you use ECC RAM. ZFS also - prefers to have the hard drives all to itself. If you're paranoid (a good - mindset when dealing with servers), you'll probably want an uninterruptible - power supply (UPS) of some sort as well and SMART monitoring for your hard - drives. See the [FreeNAS hardware +1. Choose, buy, configure, and test your own **hardware**. If you're paranoid (a + good mindset when dealing with servers), you'll probably want an + uninterruptible power supply (UPS) of some sort as well as SMART monitoring + for your hard drives. See the [FreeNAS hardware requirements](https://freenas.org/hardware-requirements/) as a guideline, but - remember you'll also be running Docker. + remember you'll also be running Docker. If you use ZFS (see below), take into + account it [loves RAM](zfs/zfs_overview.md) and prefers to have the hard + drives all to itself. -1. Install **Ubuntu Server**, preferably a Long Term Support (LTS) edition such - as 18.04, and keep it updated. You'll probably want to perform other basic - setup tasks like hardening SSH and including email notifications. There are - [various guides](https://devanswers.co/ubuntu-18-04-initial-server-setup/) - for this, but if you're just getting started, you'll probably need a book. +1. Install **Ubuntu Server**, currently 18.04 LTS, and keep it updated. You'll + probably want to perform other basic setup tasks like hardening SSH and + including email notifications. There are [various + guides](https://devanswers.co/ubuntu-18-04-initial-server-setup/) for this, + but if you're just getting started, you'll probably need a book. -1. Install **ZFS** and set up storage. You can use a different file system and - volume manager, but Ansible-NAS historically tends towards ZFS. You'll have - to create datasets for various parts of the system, some form of automatic - snapshot handling, and possibly automatic backups to another server or an - external hard drive. If you are completely new to ZFS, expect a brutal - learning curve. A [brief introduction](zfs_overview.md) is included here, as - well as a [basic example](zfs_configuration.md) of a very simple ZFS setup. +You will probably want to install a specialized filesystem for bulk storage such +as [ZFS](http://www.open-zfs.org/wiki/Main_Page) or +[Btrfs](https://btrfs.wiki.kernel.org/index.php/Main_Page). Both offer features +such as snapshots, checksumming and scrubing to protect your data against +bitrot, ransomware and other nasties. Ansible-NAS historically prefers **ZFS** +because this lets you swap storage pools with +[FreeNAS](https://freenas.org/zfs/). A [brief introduction](zfs/zfs_overview.md) +to ZFS is included in the Ansible-NAS documentation, as well as [an +example](zfs_configuration.md) of a very simple ZFS setup. After that, you can continue with the actual [installation](installation.md) of Ansible-NAS. @@ -78,6 +80,5 @@ Ansible-NAS. The easiest way to take Ansible-NAS for a spin is in a virtual machine, for instance in [VirtualBox](https://www.virtualbox.org/). You'll want to create three virtual hard drives for testing: One of the actual NAS, and the two others -to create a mirrored ZFS pool. A virtual machine will probably not be happy or -fast, but this will let you experiment with installing, configuring, and running -a complete system. +to create a mirrored ZFS pool. This will let you experiment with installing, +configuring, and running a complete system. diff --git a/docs/zfs_configuration.md b/docs/zfs/zfs_configuration.md similarity index 98% rename from docs/zfs_configuration.md rename to docs/zfs/zfs_configuration.md index ffeefd39..8260257f 100644 --- a/docs/zfs_configuration.md +++ b/docs/zfs/zfs_configuration.md @@ -7,8 +7,8 @@ overview](zfs_overview.md) introduction first. Unlike other NAS variants, Ansible-NAS does not install, configure or manage the disks or file systems for you. It doesn't care which file system you use - ZFS, Btrfs, XFS or EXT4, take your pick. Nor does it provides a mechanism for -external backups, snapshots or disk monitoring. As Tony Stark said to Loki in -_Avengers_: It's all on you. +snapshots or disk monitoring. As Tony Stark said to Loki in _Avengers_: It's all +on you. However, Ansible-NAS has traditionally been used with the powerful ZFS filesystem. Since out of the box support for [ZFS on @@ -222,11 +222,7 @@ ZED_NOTIFY_VERBOSE=1 If `zed` is not enabled, you might have to run `systemctl enable zed`. You can test the setup by manually starting a scrub with `sudo zpool scrub tank`. - ## Setting up automatic snapshots See [sanoid](https://github.com/jimsalterjrs/sanoid/) as a tool for snapshot management. - - - diff --git a/docs/zfs_overview.md b/docs/zfs/zfs_overview.md similarity index 100% rename from docs/zfs_overview.md rename to docs/zfs/zfs_overview.md