aboutsummaryrefslogtreecommitdiffstats
path: root/roles/grub/README.md
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 20:05:25 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 20:05:52 -0500
commit8c2dccad6652a535a6c549a2c4133afd9eb251ed (patch)
tree6760ba328fe606693601f9c1c51bfd7b010a974b /roles/grub/README.md
parent3e94667b6b73c588ea8503138b5e201b45686978 (diff)
downloadselfhosted-8c2dccad6652a535a6c549a2c4133afd9eb251ed.tar.gz
selfhosted-8c2dccad6652a535a6c549a2c4133afd9eb251ed.zip
add docs
Diffstat (limited to 'roles/grub/README.md')
-rw-r--r--roles/grub/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/roles/grub/README.md b/roles/grub/README.md
new file mode 100644
index 0000000..d8a9b36
--- /dev/null
+++ b/roles/grub/README.md
@@ -0,0 +1,32 @@
+Grub
+====
+
+Description
+-----------
+
+The `grub` role sets the Grub prompt timeout and the default Linux kernel
+command line.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+---------------|---------|------------
+`grub_timeout` | 1 | Grub menu timeout (seconds)
+`grub_cmdline` | &nbsp; | Kernel command line
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: proxmox_instances
+ roles:
+ - role: grub
+ vars:
+ grub_timeout: 1
+ grub_cmdline: console=ttyS0,115200n8 no_timer_check net.ifnames=0
+````