From 8c2dccad6652a535a6c549a2c4133afd9eb251ed Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Mon, 13 Feb 2023 20:05:25 -0500
Subject: add docs

---
 roles/grub/README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 roles/grub/README.md

(limited to 'roles/grub')

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
+````
-- 
cgit