Ansible Role: aisbergg.zfs

This Ansible role installs the ZFS filesystem module, creates or imports zpools and manages ZFS datasets on Debian and CentOS systems.

Requirements

• System needs to be managed with Systemd

Role Variables

Bold variables are required.

Dependencies

Depends on community.general collection.

Example Playbook

- hosts: all
  vars:
    #
    # Service
    #

    # generate mount points using systemd
    zfs_use_zfs_mount_generator: true
    # use zfs_mount_generator but don't invoke ZED (Docker triggers it quite often)
    zfs_service_zed_enabled: false


    #
    # Configuration
    #

    # https://openzfs.github.io/openzfs-docs/Performance%20and%20Tuning/Module%20Parameters.html#zfs-module-parameters
    zfs_kernel_module_parameters:
      # use 1/4 of the memory for ZFS ARC
      zfs_arc_max: "{{ (ansible_memtotal_mb * 1024**2 * 0.25) | int }}"

    # schedule for ZFS scrubs
    zfs_scrub_schedule: monthly
    # schedule for TRIM
    zfs_trim_schedule: weekly

    _zfs_performance_tuning_default:
      # store less metadata (still redundant in mirror setups)
      redundant_metadata: most
      # use standard behaviour for synchronous writes
      sync: standard

    _zfs_performance_tuning_async_only:
      # store less metadata (still redundant in mirror setups)
      redundant_metadata: most
      # turn synchronous writes into asynchronous ones
      sync: disabled

    _zfs_performance_tuning_ssd:
      # use standard behaviour for synchronous writes
      sync: standard
      # store less metadata (still redundant in mirror setups)
      redundant_metadata: most
      # optimize synchronous operations to write directly to disk instead of writing
      # to log. On HDDs this decreases the latency, but won't do much on SSDs.
      logbias: throughput

    _zfs_filesytems_properties:
      canmount: true
      snapdir: hidden

      # make ZFS behave like a Linux FS
      casesensitivity: sensitive
      normalization: formD
      utf8only: on
      setuid: true
      atime: false

      # enable use of ACLs
      acltype: posix
      xattr: sa

      # compression and deduplication
      compression: lz4
      dedup: false

    zfs_filesystems_properties_defaults: "{{
        _zfs_filesytems_properties | combine(
        _zfs_performance_tuning_async_only
      )}}"

    _zfs_volumes_properties:
      volblocksize: 8K
      volsize: 1G
      compression: lz4
      dedup: false

    # https://openzfs.github.io/openzfs-docs/man/7/zfsprops.7.html
    zfs_volumes_properties_defaults: "{{
        _zfs_volumes_properties | combine(
        _zfs_performance_tuning_async_only
      )}}"


    #
    # ZPools
    #

    zfs_pools:
    - name: rpool
      vdev: >-
        mirror
          r1
          r2
      scrub: true
      properties:
        ashift: 12
      filesystem_properties:
        # don't mount, just supply a base path for sub datasets
        canmount: off
        mountpoint: /

    - name: bpool
      vdev: >-
        mirror
          {{ _zfs_boot_partition1 }}
          {{ _zfs_boot_partition2 }}
      scrub: true
      properties:
        ashift: 12
        "feature@async_destroy": enabled
        "feature@bookmarks": enabled
        "feature@embedded_data": enabled
        "feature@empty_bpobj": enabled
        "feature@enabled_txg": enabled
        "feature@extensible_dataset": enabled
        "feature@filesystem_limits": enabled
        "feature@hole_birth": enabled
        "feature@large_blocks": enabled
        "feature@lz4_compress": enabled
        "feature@spacemap_histogram": enabled
      dont_enable_features: true
      filesystem_properties:
        canmount: off
        mountpoint: /boot


    #
    # Datasets
    #

    zfs_filesystems: "{{ _zfs_filesystems_system }}"
    _zfs_filesystems_system:
      # root
      - name: rpool/ROOT
        properties:
          canmount: off
          mountpoint: none
      - name: rpool/ROOT/default
        properties:
          canmount: noauto
          mountpoint: /

      - name: rpool/home
      - name: rpool/home/root
        properties:
          mountpoint: /root
      - name: rpool/var/lib/docker
      - name: rpool/var/log
      - name: rpool/var/spool
      - name: rpool/var/cache

      # boot
      - name: bpool/default
        properties:
          mountpoint: /boot


    #
    # Automatic Snapthots Using ZREPL
    #

    zfs_zrepl_enabled: true
    zfs_zrepl_config:
      jobs:
        - name: storage
          type: snap
          filesystems: {
            "rpool<": true,
            "rpool/var<": false,
          }
          snapshotting:
            type: periodic
            interval: 12h
            prefix: auto_
          pruning:
            keep:
              # prune automatic snapshots
              - type: grid
                # in first 24 hours keep all snapshots
                # in first 7 days 1 snapshot each day
                # in first month keep 1 snapshot each week
                # discard the rest
                # details see: https://zrepl.github.io/configuration/prune.html#policy-grid
                grid: 1x24h(keep=all) | 7x1d(keep=1) | 3x7d(keep=1)
                regex: "^auto_.*"

              # keep manual snapshots
              - type: regex
                regex: "^manual_.*"

  roles:
    - aisbergg.zfs

License

MIT

Author Information

Andre Lehmann (aisberg@posteo.de)