Mirrors/ansible-nas
2
0
Fork 0
mirror of https://github.com/davestephens/ansible-nas synced 2025-01-13 03:58:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

Move ZFS docs to own folder

Browse source
This commit is contained in:
Scot W. Stevenson 2019-04-15 18:35:06 +02:00
parent fdf29103cc
commit 6edad9c6cb
3 changed files with 25 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
docs/overview.md
View file

@ -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: 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 1. Choose, buy, configure, and test your own **hardware**. If you're paranoid (a
RAM, and it is [recommended](zfs_overview.md) you use ECC RAM. ZFS also good mindset when dealing with servers), you'll probably want an
prefers to have the hard drives all to itself. If you're paranoid (a good uninterruptible power supply (UPS) of some sort as well as SMART monitoring
mindset when dealing with servers), you'll probably want an uninterruptible for your hard drives. See the [FreeNAS hardware
power supply (UPS) of some sort as well and SMART monitoring for your hard
drives. See the [FreeNAS hardware
requirements](https://freenas.org/hardware-requirements/) as a guideline, but 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 1. Install **Ubuntu Server**, currently 18.04 LTS, and keep it updated. You'll
as 18.04, and keep it updated. You'll probably want to perform other basic probably want to perform other basic setup tasks like hardening SSH and
setup tasks like hardening SSH and including email notifications. There are including email notifications. There are [various
[various guides](https://devanswers.co/ubuntu-18-04-initial-server-setup/) guides](https://devanswers.co/ubuntu-18-04-initial-server-setup/) for this,
for this, but if you're just getting started, you'll probably need a book. 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 You will probably want to install a specialized filesystem for bulk storage such
volume manager, but Ansible-NAS historically tends towards ZFS. You'll have as [ZFS](http://www.open-zfs.org/wiki/Main_Page) or
to create datasets for various parts of the system, some form of automatic [Btrfs](https://btrfs.wiki.kernel.org/index.php/Main_Page). Both offer features
snapshot handling, and possibly automatic backups to another server or an such as snapshots, checksumming and scrubing to protect your data against
external hard drive. If you are completely new to ZFS, expect a brutal bitrot, ransomware and other nasties. Ansible-NAS historically prefers **ZFS**
learning curve. A [brief introduction](zfs_overview.md) is included here, as because this lets you swap storage pools with
well as a [basic example](zfs_configuration.md) of a very simple ZFS setup. [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 After that, you can continue with the actual [installation](installation.md) of
Ansible-NAS. Ansible-NAS.
@ -78,6 +80,5 @@ Ansible-NAS.
The easiest way to take Ansible-NAS for a spin is in a virtual machine, for 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 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 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 to create a mirrored ZFS pool. This will let you experiment with installing,
fast, but this will let you experiment with installing, configuring, and running configuring, and running a complete system.
a complete system.

8
docs/zfs_configuration.md → docs/zfs/zfs_configuration.md
View file

@ -7,8 +7,8 @@ overview](zfs_overview.md) introduction first.
Unlike other NAS variants, Ansible-NAS does not install, configure or manage the 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, 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 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 snapshots or disk monitoring. As Tony Stark said to Loki in _Avengers_: It's all
_Avengers_: It's all on you. on you.
However, Ansible-NAS has traditionally been used with the powerful ZFS However, Ansible-NAS has traditionally been used with the powerful ZFS
filesystem. Since out of the box support for [ZFS on 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 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`. test the setup by manually starting a scrub with `sudo zpool scrub tank`.
## Setting up automatic snapshots ## Setting up automatic snapshots
See [sanoid](https://github.com/jimsalterjrs/sanoid/) as a tool for snapshot See [sanoid](https://github.com/jimsalterjrs/sanoid/) as a tool for snapshot
management. management.

0
docs/zfs_overview.md → docs/zfs/zfs_overview.md
View file