From 02379f37151ff9a86bbe6e781c6854d2c8b02f35 Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Mon, 20 Feb 2023 21:38:14 -0500
Subject: tuned: add docs

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

(limited to 'roles/tuned/README.md')

diff --git a/roles/tuned/README.md b/roles/tuned/README.md
new file mode 100644
index 0000000..bc42bf0
--- /dev/null
+++ b/roles/tuned/README.md
@@ -0,0 +1,32 @@
+Tuned
+=====
+
+Description
+-----------
+
+The `tuned` role sets the host's [TuneD](https://tuned-project.org/) performance
+profile.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable        | Default   | Description
+----------------|-----------|------------
+`tuned_profile` | `balanced | TuneD profile name
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: set tuned profile
+  hosts: proxmox_instanced
+  roles:
+    - role: tuned
+      vars:
+        tuned_profile: virtual-guest
+````
-- 
cgit