diff --git a/README.md b/README.md index 53e0a7a..d5e2cac 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -zfs\_dkms -========= +# zfs\_dkms Ansible Role for installing [ZFS](https://zfsonlinux.org/) on [Fedora](https://openzfs.github.io/openzfs-docs/Getting%20Started/Fedora/index.html), @@ -11,33 +10,30 @@ For pools/volumes, see: 1. [community.general.zpool](https://docs.ansible.com/ansible/latest/collections/community/general/zpool_module.html) 2. [community.general.zfs](https://docs.ansible.com/ansible/latest/collections/community/general/zfs_module.html) -Requirements ------------- +## Requirements None. -Role Variables --------------- +## Role Variables | Variable | Description | Role Default | Upstream Default | |----------|:------------|-------------:|-----------------:| -| `zfs_dkms_arc_pct_min` | _Minimum_ physical memory (%) for ARC _(Adaptive Read Cache)_. | `0` | `0` | +| `zfs_dkms_arc_pct_min` | _Minimum_ physical memory (%) for ARC
_(Adaptive Read Cache)_. | `0` | `0` | | `zfs_dkms_arc_pct_max` | _Peak_ physical memory (%) for ARC. | `16` | `0` | | `zfs_dkms_timeout` | Seconds to wait while rebooting `Fedora`, `RHEL`, or derivatives for kernel/header currency.
Skipped if the `zfs` kernel module is already loaded. | `3600` | _N/A_ | -Dependencies ------------- +## Dependencies 1. `community.general` -Example Playbook ----------------- +## Example Playbook - - hosts: servers - roles: - - { role: zfs_dkms } +```yaml +- hosts: servers + roles: + - { role: zfs_dkms } +``` -License -------- +## License MIT