README: highlight example, md, line break for ARC
This commit is contained in:
parent
eb474bc6cd
commit
108831895c
1 changed files with 12 additions and 16 deletions
28
README.md
28
README.md
|
@ -1,5 +1,4 @@
|
||||||
zfs\_dkms
|
# zfs\_dkms
|
||||||
=========
|
|
||||||
|
|
||||||
Ansible Role for installing [ZFS](https://zfsonlinux.org/)
|
Ansible Role for installing [ZFS](https://zfsonlinux.org/)
|
||||||
on [Fedora](https://openzfs.github.io/openzfs-docs/Getting%20Started/Fedora/index.html),
|
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)
|
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)
|
2. [community.general.zfs](https://docs.ansible.com/ansible/latest/collections/community/general/zfs_module.html)
|
||||||
|
|
||||||
Requirements
|
## Requirements
|
||||||
------------
|
|
||||||
|
|
||||||
None.
|
None.
|
||||||
|
|
||||||
Role Variables
|
## Role Variables
|
||||||
--------------
|
|
||||||
|
|
||||||
| Variable | Description | Role Default | Upstream Default |
|
| 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<br />_(Adaptive Read Cache)_. | `0` | `0` |
|
||||||
| `zfs_dkms_arc_pct_max` | _Peak_ physical memory (%) for ARC. | `16` | `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.<br />Skipped if the `zfs` kernel module is already loaded. | `3600` | _N/A_ |
|
| `zfs_dkms_timeout` | Seconds to wait while rebooting `Fedora`, `RHEL`, or derivatives for kernel/header currency.<br />Skipped if the `zfs` kernel module is already loaded. | `3600` | _N/A_ |
|
||||||
|
|
||||||
Dependencies
|
## Dependencies
|
||||||
------------
|
|
||||||
|
|
||||||
1. `community.general`
|
1. `community.general`
|
||||||
|
|
||||||
Example Playbook
|
## Example Playbook
|
||||||
----------------
|
|
||||||
|
|
||||||
- hosts: servers
|
```yaml
|
||||||
roles:
|
- hosts: servers
|
||||||
- { role: zfs_dkms }
|
roles:
|
||||||
|
- { role: zfs_dkms }
|
||||||
|
```
|
||||||
|
|
||||||
License
|
## License
|
||||||
-------
|
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue